OneLink API

プレミアム機能
推奨
マーケター 開発者
最終更新:

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

OneLink API

OneLink APIは以下の目的で使用されます：

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

 例

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

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

APIのクエリ制限を増やしたい方は、担当CSMまでご連絡ください。

セットアップ

OneLink APIの設定方法：

  1. OneLinkテンプレートを作成します。
  2. OneLink IDを記録してください。 

  3. OneLink API Keyキーを記録してください。アドミンユーザーがAPIキーを取得する必要があります。アカウントユーザーはアクセス権限がありません。
    • AppsFlyer管理画面にて、エクスペリエンス＆ディープリンク > OneLink API > OneLink API Keyを確認を開いてください。
    • アドミンユーザーにOneLink APIキーが表示されない場合、必要なパッケージをご契約いただいていません。CSMまでお問合せください。
  4. OneLink IDとOneLink APIキーをディベロッパーに渡してください。
  5. ディベロッパーにDev Hubの手順に従うように依頼してください。

管理画面

OneLink API管理画面では以下を確認できます：

  • 1日、1ヶ月、3ヶ月のAPI使用状況。
  • OneLink APIキー。

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

AppsFlyerにて、エクスペリエンス＆ディープリンク> OneLink APIを開いてください。

特性と制限

特性

備考

API回数制限
  • OneLink API を使用して OneLinkリンクを作成、編集、または削除する場合の制限は、アカウントあたり、1か月 750万リンクです（UTC時間基準）。
  • この回数を超えた後に行われたリクエストはすべて処理されず、リンクも作成されません。APIコールはエラーステータスコード 429を受け取り、"Monthly quota exceeded" というメッセージが表示されます。
  • 使用済み / 残っている回数制限の量に関する情報は、OneLink API画面で確認できます。

コール頻度の制限
  • アカウントあたりの APIレート制限は、毎秒 500リクエスト (毎分 30000) です。
  • 毎秒 500リクエスト (毎分 30000) を超えて行われたすべての要求は処理されず、リンクは作成されません。APIコールは、エラーステータスコード 429 "Rate limit exceeded" というメッセージを受け取ります。

リンクの可視性
  • APIを介して作成されたリンクは、AppsFlyer管理画面のOneLinkカスタムリンクのリストには表示されません。
  • ベストプラクティス：APIで作成されたリンクをローカルの表などに保存し、今後リンクにアクセスできるようにしてください。

TTL 
  • OneLink APIを使用して作成された OneLinkショートURLのデフォルトの有効期間 (TTL) は 31 日です。
    このTTLは、リンクがクリックされるたびに 31 日間延長されます。
    有効期限が切れた後にこれらのリンクをクリックするした場合、OneLinkの基本設定で定義された動作がデフォルトになりますが、アトリビューション計測は機能しません。
    • TTLの有効期限が切れた後、OneLinkショートURLが削除されるまでに最大48時間かかる場合があります。
  • 最大TTLは31日です。31より大きいTTLの値は、デフォルトの31日に上書きされます。
  • デフォルトのTTLを変更するには、パラメーター ttl={value}を追加します。 日数、時間数、または分数を指定します。
    例：     ttl=7d ttl=12h /  ttl=10m。
  • 更新リクエストを送信し、TTLを指定することができます。これらの更新リクエストは既存リンクのTTLをリセットし、リクエストボディ内で指定されたものを設定します。
    • これは TTL が置き換えられることを意味します。例えば、現在TTLが29dで設定されているリンクをTTL 2d でに更新すると、TTL=2d (31dではなく) に変更されます。
    • 更新リクエストコールは、計測リンクの寿命を延ばす可能性があります。例えば、現在 TTL 20d であるが 5日が超過したリンクに対して TTL 31d で更新コールを行った場合、TTL は更新時から 31d になります。
  • リンクのTTLを自動延長したくない場合は、リンクに パラメーター renew_ttl=false を追加してください。
    このパラメーターの値はboolean値で、true (デフォルト) または false のいずれかを付与してください。
  • パラメータ renew_ttl は、実際のURLには表示されません。

特殊文字

 APIで作成されたリンクに使用する場合は、次の文字をエンコードする必要があります： ;、*、!、@、#、?、$、^、:、&、~、'、=、+、'、>、<、/
これらの文字をエンコードしないと、空白に置き換えられ、リンクとその機能が壊れる可能性があります。

ペイロード

ペイロードのクエリ文字列は2,048文字を超えないでください。

URL ID

URL ID（またはショートリンク ID）を編集して、キャンペーンのオファー内容を強調表示できます。
例：https:// myapp.onelink.me/abc123/apples
URL IDは50文字を超えてはならず、文字と数字の組み合わせにすることができます。
デフォルト：8文字のランダムな英数字

注意：

  • URL IDを編集できるのは、現在の IDがまだ使用されていない場合のみです。
  • URL IDが既に使用されている場合、リンクの作成は失敗し、エラー応答 (400) が返されます。あなたとあなたの開発者は、そのようなイベントで何が起こるかを決定し、構成する必要があります。
  • 失敗した呼び出しは、引き続き毎月の API クォータにカウントされます。