At a glance: Create, update, retrieve, and delete OneLink short URLs via the OneLink REST API.

Overview

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

  • Create, get, update, and delete OneLink short URLs automatically.
  • Generate a large number of OneLink custom attribution links.
    Note: For referral links, see the User invite attribution article
  • あなたのブランド名でOneLinkのURLをカスタマイズするとき。この機能では、OneLinkサブドメインではなくあなたのブランドのサブドメインで計測URLが生成されます。

 Example

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

Who is involved: 

Marketer and developer

Procedures

To set up OneLink API:

  1. Create a OneLink template.
  2. Record the OneLink ID. 

  3. Record the OneLink API key. The account admin needs to retrieve the API key. Team members do not have access to the API Key. 
    • In the AppsFlyer dashboard, go to Integration > API Access, and scroll down to the OneLink API section.

      OL_API_key.png

  4. Give the OneLink ID and the OneLink API key to the developer.
  5. Tell the developer to follow the instructions in the dev hub.

Limitations

Limitation

Remarks

API rate

The rate limit of creating OneLink attribution links via API is 250K per day, per account.

Custom links

  • Links created via the API do not appear in the list of OneLink custom links in the AppsFlyer dashboard.
  • There is no API that lists all OneLink custom links created with the API.

TTL 

  • Each OneLink attribution link created by the API has a default Time to Live (TTL) of 31 days. After 31 days this attribution link record is removed from our systems. Clicking on such a link once the TTL expires still defaults to the behavior defined in OneLink base configuration, but the attribution will not work.
  • Maximum TTL is 31 days. Any TTL value larger than 31 is overridden with the default TTL of 31.
  • TTL value can be specified in days (default), minutes or hours (for example, 10m, 20h, 14d).
  • You can send an update request to specify the TTL. Any update request resets the TTL to the one specified in the request body.

 

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