概要: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の設定方法:

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

  3. OneLink API Keyキーを記録してください。アカウントアドミンがAPIキーを取得する必要があります。チームメンバーはAPIキーにアクセスする権限がありません。
    • AppsFlyer管理画面にて、インテグレーション > APIアクセスを開き、OneLink APIセクションへスクロールダウンしてください。
    • アドミンにOneLink APIキーが表示されない場合は、必要なパッケージをご利用ではありませんので、担当CSMへお問合せください。  

      OL_API_key.png

  4. OneLink IDとOneLink APIキーをディベロッパーに渡してください。
  5. ディベロッパーにDev Hubの手順に従うように依頼してください

制限事項

制限事項

備考

APIレート

  • API経由でOneLink計測リンクを作成できるレート制限は、アカウントにつき1ヵ月あたり750万件(UTCタイムゾーン)です。
  • 750万を超過した後の全てのリクエストは処理されず、リンクは作成されません。APIコールは、エラーステータスコード429とメッセージ "throttling limit exceeded" (スロットリング制限の超過) を受信します。
  • レート制限がどれだけ消費されているかについての情報は現在入手できません。

カスタムリンクの可視性

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

TTL 

  • APIにより作成された各OneLink計測リンクは、デフォルトで31日間のTTL(有効期限)があります。31日後、この計測リンクの記録はAppsFlyerシステムから削除されます。有効期限が切れた後にこれらのリンクをクリックするした場合、OneLinkの基本設定で定義された動作がデフォルトになりますが、アトリビューションは機能しません。
  • 最大TTLは31日です。31より大きいTTLの値は、デフォルトの31日に上書きされます。
  • TTL値は、日(デフォルト)、分、時間で指定できます(例:10m, 20h, 14d)。
  • 更新リクエストを送信し、TTLを指定することができます。これらの更新リクエストは既存リンクのTTLをリセットし、リクエストボディ内で指定されたものを設定します。
    • これは TTL が置き換えられることを意味します。例えば、現在TTLが29dで設定されているリンクをTTL 2d でに更新すると、TTL=2d (31dではなく) に変更されます。
    • 更新リクエストコールは、計測リンクの寿命を延ばす可能性があります。例えば、現在 TTL 20d であるが 5日が超過したリンクに対して TTL 31d で更新コールを行った場合、TTL は更新時から 31d になります。

特殊文字

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

 

この記事は役に立ちましたか?