大規模キャンペーンでのリンク作成にOneLink APIを使用する

プレミアム機能

推奨

最終更新日： 2025年01月03日 14:16

概要：OneLink APIは、大規模なキャペーンやSMS向けのパーソナライズされたリンクを生成することで、エンドユーザーとのエンゲージメントを促進しオウンドメディアを活用するのに役立ちます。マーケティング担当者と開発者の両方が実装作業をする必要があります。

OneLink API

OneLink APIは、次のような用途に使用されるプレミアム機能です：

カスタムパラメーターを使用して、自動的にOneLinkショートURLを作成、title取得title、アップデート、title削除titleできます。
パラメーターは次のいずれかに該当します：
- メディアソース、キャンペーン、アセットなどのマーケティング活動の計測と分析に使用されるアトリビューション関連のパラメーターです。注意：メディアソース（pid）パラメーターは必須です。
- 関連するリンクからアプリを開くときにカスタマイズされたユーザーエクスペリエンスを設定できるパーソナライゼーションパラメーター。これらのパラメーターを使用すると、ユーザーをアプリ内の特定の商品画面やクーポンコード、プロモーションなど、カスタマイズされたアプリ内のコンテンツに誘導できます。
ウェブサイトとアプリのコンテンツをモバイルユーザーに直接共有できるようにします（これによりモバイルエンゲージメントとインストールの増加が見込めます）。
大量のOneLinkカスタム計測リンクを即座に作成できます。
注意：ユーザー招待のリンクに関しては、ユーザー招待用の計測リンクをご覧ください。

例

食料品配達サービスである "Feed Me"社は、既存顧客にSMS経由でパーソナライズされたURLを送信し、”Feed Me”のアプリをダウンロードしてバナナを購入してもらいたいと考えています。それを実現するために彼らは、顧客のいる国の情報を基に、OneLink REST APIを使用して国毎の特別な情報、ユーザー情報、販売中のバナナのセール情報を含んだカスタムOneLink URLを作成しています。

OneLink APIのクエリを実行できる回数は、お客様のアカウントタイプによって異なります。クエリの実行回数と残りのクエリ回数は、OneLink API管理画面にて確認できます。

APIの使用回数制限を増やしたい場合は、担当CSMまでご連絡ください。

設定方法

OneLink APIの設定方法：

OneLinkテンプレートを作成します。
OneLink テンプレートの準備ができました！
OneLink APIトークンをコピーします。アドミンユーザーがAPIキーを取得する必要があります。アカウントユーザーはアクセス権限がありません。
OneLink IDとOneLink APIキーを開発者に渡してください。
開発者にAppsFlyer公式デベロッパーハブの手順に従うように依頼してください。

管理画面

OneLink APIダッシュボードには、過去1日、1ヶ月、3ヶ月のAPI使用量が表示されます。

OneLink API管理画面を表示する方法：

AppsFlyer管理画面左メニューエンゲージメント > OneLink管理へ移動します。

特性と制限

特性	備考
API回数制限	OneLink APIを使用してOneLinkリンクを作成、編集、または削除する場合の制限は、アカウントあたり、1か月750万リンクです（UTC時間基準）。この回数を超えた後に行われたリクエストはすべて処理されず、リンクも作成されません。APIコールはエラーステータスコード 429 を受け取り、"Monthly quota exceeded"（当月の制限を超えました）というメッセージが表示されます。使用済み / 残っている回数制限の量に関する情報は、OneLink API画面で確認できます。
コール頻度の制限	アカウントあたりのAPIレート制限は、毎秒500リクエスト（毎分30,000回）です。毎秒 500リクエスト（毎分 30,000回）を超えて行われたすべての要求は処理されず、リンクは作成されません。APIコールは、エラーステータスコード 429 "Rate limit exceeded" というメッセージを受け取ります。
リンクの可視性	API経由で作成されたリンクは、AppsFlyer管理画面のOneLinkカスタムリンクのリストには表示されません。ベストプラクティス：APIで作成されたリンクをローカルの表などに保存し、既存のリンクにアクセスできるようにしてください。
TTL	一括アップロードによって作成されたOneLinkショートURLのデフォルトの有効期間（TTL）は180日です。TTLはリンクがクリックされるたびに、自動的に180日間延長されます。有効期限が切れた後にこれらのリンクをクリックするした場合、OneLinkの基本設定で定義された動作がデフォルトになりますが、アトリビューション計測は機能しません。 TTLの有効期限が切れた後、OneLinkショートリンクが削除されるまでに最大48時間かかる場合があります。最大TTLは31日です。31より大きいTTLの値は、デフォルトの31日に上書きされます。パラメータ `ttl={value}` を追加し、何日、何時間、何分と指定することで、デフォルトのTTLを変更することができます。　例： `ttl=7d`, `ttl=12h`, or `ttl=10m`. 更新リクエストを送信して、TTLを指定することができます。更新リクエストはすべて、既存のリンクのTTLをリクエストボディで指定されたものにリセットします。これはTTLが置き換えられることを意味します。例：現在TTLが29dで設定されているリンクをTTL 2d でに更新すると、TTL=2d (31dではなく) に変更されます。更新リクエストコールは、計測リンクの寿命を延ばす可能性があります。例えば、現在 TTL 20d であるが、5日が超過したリンクに対して TTL 31d で更新コールを行った場合、TTLは更新時点から31日になります。リンクのTTLを自動的に延長させたくない場合は、パラメータ `renew_ttl=false` をリンクに追加してください。このパラメータの値はブール値で、true（デフォルト）またはfalseのどちらです。パラメータ `renew_ttl` は、実際のURLには表示されません。
特殊文字	APIで作成されたリンクに以下の文字を使用する場合は、エンコードする必要があります： ;, *, !, @, #, ?, $, ^, :, &, ~, `, =, +, ', >, <, / これらの文字をエンコードしないと、空白に置き換えられ、リンクとその機能が壊れる可能性があります。注：以下の3つのパラメータは、リンクがクリックされてもデコードされず、エンコードされたままになります： `af_dp` `deep_link_value` `deep_link_sub1`
ペイロード	ペイロードのクエリ文字列は2,048文字を超えないでください。
URL ID	URL ID（またはショートリンクID）を編集して、キャンペーンのオファー内容を強調して表示できます。例：https://myapp.onelink.me/abc123/apples　 / URL IDは50文字を超えてはならず、文字と数字の組み合わせにすることができます。デフォルト：8文字のランダムな英数字注意： URL IDを編集できるのは、現在のIDがまだ使用されていない場合のみです。 URL IDが既に使用されている場合、リンクの作成は失敗し、エラーレスポンス（400）が返されます。マーケティング担当者と開発者は、そのようなイベントで何が起こるかを決定し、構成する必要があります。失敗した呼び出しは、引き続き毎月のAPIに使用回数上限カウントされます。