adjust-icon

ディープリンクジェネレーター API

ディープリンクジェネレーターAPIを使用して、アプリ用の短いおよび長いディープリンクを個別または一括で作成できます。これらのカスタマイズされたディープリンクは、さまざまなプラットフォームでユーザー体験を向上させます。

事前準備

はじめに、以下の設定手順をご覧ください。

ご利用の条件

  • ディープリンクジェネレーターAPIは、TrueLinkのCoreまたはEnterpriseのパッケージにご契約のお客様にご利用いただけます。
  • ディープリンクジェネレーターAPIを使用して作成されたリンクは、 Campaign Labに表示されません。
  • ディープリンクジェネレーターAPIを使用して作成されたショートリンクのTTL（有効期間）は120日です。

要件

認証

ディープリンクジェネレーターは、ベアラートークンを使用して認証します。ディープリンクジェネレーターAPIへの各リクエストには、Adjust APIトークンをAuthorizationヘッダーに必ず含める必要があります。

自社でシングルサインオン（SSO）を有効にしている場合は、 Adjustの担当者またはsupport@adjust.comにお問い合わせください。APIトークンの取得方法についてサポートいたします。

SSO以外のアカウントの場合、APIガイドはユーザーの プロフィール に表示されます。トークンを確認するには、以下の手順に従ってください。

  1. アカウント（ユーザー）アイコンを選択します。
  2. アカウント設定（Account Settings） を選択します。
  3. マイプロフィール（My Profile） を選択します。
  4. APIトークン が ユーザー情報（User details） に表示されます。コピーボタンを選択して、トークンをクリップボードにコピーします。

Adjust APIトークンをリセットする

Adjust APIトークンはいつでもリセットできます。トークンをリセットすると、古いトークンは無効になります。Adjust APIトークンをリセットした場合、使用中の古いトークンを新しいトークンに置き換える必要があります。無効になったトークンを使用したリクエストは、Adjustによって拒否されます。

Adjust APIトークンをリセットする方法：

  1. アカウント（ユーザー）アイコンを選択します。
  2. アカウント設定（Account Settings） を選択します。
  3. マイプロフィール（My Profile） を選択します。
  4. APIトークン が ユーザー情報（User details） に表示されます。
  5. APIトークンをリセットする（Reset API token） を選択します。
  6. 表示されたモーダルにアカウントのパスワードを入力し、 リセット を選択してAPIトークンをリセットします。画面の右上に確認メッセージが表示されます。
  7. APIトークン の横にあるコピーボタンを選択して、トークンをクリップボードにコピーします。

パラメーター

パラメーターデータタイプ入力する値説明
adjust_auth_tokenString説明Adjust APIトークン
link_tokenStringボディカスタムリンクのリンクトークン。複合リンクからディープリンクを生成している場合、Campaign Labで組み合わせたカスタムリンクの正しいリンクトークンを使用していることを確認してください。
shorten_urlBooleanボディリンクが短縮されるかどうか。リンクはデフォルトでは短縮されません。デフォルト値 - false
campaignString または nullボディキャンペーンの名前
adgroupString または nullボディアドグループの名前
creativeString または nullボディクリエイティブの名前
deep_link_pathStringボディユーザーが遷移するアプリ内の遷移先を指定。シングルプラットフォームアプリにはこれを使用してください。
ios_deep_link_pathStringボディユーザーが遷移するiOSのアプリ内の遷移先を指定。マルチプラットフォームのiOSアプリまたは複合リンクにはこれを使用してください。
android_deep_link_pathStringボディユーザーが遷移するiOSのアプリ内の遷移先を指定。マルチプラットフォームのiOSアプリまたは複合リンクにはこれを使用してください。
fallbackStringボディオフプラットフォームのユーザーを送るランディングページ。フォールバックURLを指定する際には、macOSユーザー向けにredirect_macosを指定することをお勧めします。
redirect_macosStringボディmacOSのAdjustのデフォルトリダイレクトを上書きするリダイレクトURL。`fallback` を指定する場合は、macOSユーザー向けにfallbackを指定することをお勧めします。
labelStringボディリンクにカスタムデータを追加します。このパラメーターを使用して、ユーザーがアプリからショートリンクを共有した際に自動入力される一意のユーザー紹介IDを追加できます。
og_titleStringボディリンクのソーシャル共有プレビューのタイトル。
og_descriptionStringボディリンクのソーシャル共有プレビューの説明。
og_imageStringボディソーシャル共有プレビューに使用する、200 x 200 ピクセル以上のJPGまたはPNG形式の画像のURLを指定。

シングルまたはマルチプラットフォームのアプリ用に、長いまたは短縮ディープリンクを生成するには、POSTリクエストを送信します。

エンドポイント

https://automate.adjust.com/engage/deep-links

例

シングルプラットフォームアプリ

リクエスト - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "1c52mluz",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "deep_link_path": "/custom-path",
     "shorten_url": true
   }'
レスポンス
{"url": "https://insights.go.link/fryYl"}

マルチプラットフォームアプリ

リクエスト - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "2d41nkvy",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "android_deep_link_path": "/custom-path",
     "redirect_macos": "https://www.example.com/redirectmacos",
     "shorten_url": true
   }'
レスポンス
{ "url": "https://insights.go.link/jlbKj" }

複合リンク

ディープリンクジェネレーターAPIを使用してディープリンクを生成する前に、Campaign Labで複合カスタムリンクを作成してください。

リクエスト - cURL
curl --location 'https://automate.adjust.com/engage/deep-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
     "link_token": "1c2n7ybx_1cjet4nl",
     "redirect": "https://example.com/redirect",
     "fallback": "https://example.com/fallback",
     "ios_deep_link_path": "/custom-path-ios",
     "android_deep_link_path": "/custom-path-android",
     "redirect_macos": "https://www.example.com/redirectmacos",
     "shorten_url": true
   }'
レスポンス
{"url": "https://insights.go.link/6JtQx"}

シングルまたはマルチプラットフォームのアプリ用に、長いまたは短縮ディープリンクを一括で生成するには、POSTリクエストを送信します。

エンドポイント

https://automate.adjust.com/engage/deep-links/bulk

例

リクエスト - cURL
curl --location 'https://automate.adjust.com/engage/deep-links/bulk' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
"data": [
    {
    "link_token": "1doptv0c",
    "redirect": "https://example.com/redirect",
    "fallback": "https://example.com/fallback",
    "campaign": "custom-campaign",
    "shorten_url": true
    },
    {
      "link_token": "1df3xslh_1dsykkaa",
      "redirect": "https://example.com/redirect",
      "fallback": "https://example.com/fallback",
      "ios_deep_link_path": "/custom-path-ios",
      "android_deep_link_path": "/custom-path-android",
      "shorten_url": true
    },
    {
      "link_token": "1dzwtdjt",
      "redirect": "https://example.com/redirect",
      "fallback": "https://example.com/fallback",
      "android_deep_link_path": "/custom-path",
      "shorten_url": true
    }
  ]
}'
レスポンス
{
   "data": [
      {
         "url": "https://kapp.go.link/4IlkC"
      },
      {
         "url": "https://kapp.go.link/6KnoE"
      },
      {
         "url": "https://insights.go.link/5JmnD"
      }
   ]
}

PUTリクエストを送信して、ディープリンク内の既存のショートリンクトークンを長いリンクに更新します。

エンドポイント

https://automate.adjust.com/engage/deep-links/{short_token}

例

リクエスト - cURL
curl --location --request PUT 'https://automate.adjust.com/engage/deep-links/4IlkC' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer adjustApiToken' \
--data '{
  "link_token": "1doptv0c",
  "redirect": "https://example.com/new-redirect",
  "fallback": "https://example.com/new-fallback",
  "deep_link_path": "/new-custom-path"
}'
レスポンス
204 No Content