キャンペーンAPIを使用して、リンク、サブリンクおよびパートナー情報の取得や、リンクの新規作成や、既存のリンクを新しいパートナー情報に更新することができます。
認証
キャンペーンAPIは認証にベアラートークンを使用します。キャンペーンAPIにリクエストを行う全てのリクエストには、Adjust APIトークンをAuthorization
ヘッダーに含める必要があります。
自社でシングルサインオン(SSO)を有効にしている場合は、 Adjustの担当者またはsupport@adjust.comにお問い合わせください。APIトークンの取得方法についてサポートいたします。
SSO以外のアカウントの場合、APIガイドはユーザーの プロフィール に表示されます。トークンを確認するには、以下の手順に従ってください。
- アカウント(ユーザー)アイコンを選択します。
- アカウント設定(Account Settings) を選択します。
- マイプロフィール(My Profile) を選択します。
- APIトークン が ユーザー情報(User details) に表示されます。コピーボタンを選択して、トークンをクリップボードにコピーします。
Adjust APIトークンをリセットする
Adjust APIトークンはいつでもリセットできます。トークンをリセットすると、古いトークンは無効になります。Adjust APIトークンをリセットした場合、使用中の古いトークンを新しいトークンに置き換える必要があります。無効になったトークンを使用したリクエストは、Adjustによって拒否されます。
Adjust APIトークンをリセットする方法:
- アカウント(ユーザー)アイコンを選択します。
- アカウント設定(Account Settings) を選択します。
- マイプロフィール(My Profile) を選択します。
- APIトークン が ユーザー情報(User details) に表示されます。
- APIトークンをリセットする(Reset API token) を選択します。
- 表示されたモーダルにアカウントのパスワードを入力し、 リセット を選択してAPIトークンをリセットします。画面の右上に確認メッセージが表示されます。
- APIトークン の横にあるコピーボタンを選択して、トークンをクリップボードにコピーします。
パートナーを取得する
このエンドポイントを使用して、パートナーの一覧と関連データを取得します。データはパートナーオブジェクトの配列で返されます。
パラメーター
次のパラメーターを クエリパラメーター としてパスすることができます。
after
(String
)
-
リクエストを開始するカーソルの位置。
before
(String
)
-
リクエストを終了するカーソルの位置。
limit
(Integer
)
-
レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50
です。
このエンドポイントからの結果は、カーソルを使用してページ分割されています。各ページには、 previous
とnext
ページの位置が返されます。特定のページを返すために、これらをコールに含めることができます。
各結果のページには、カーソルの位置を含むpaging
オブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、最初のページには次のようなpaging
オブジェクトが含まれます。
2ページ目に移動するには、after
値をafter
パラメーター内の次のリクエストに追加します。例:
例
リンクを取得する
このエンドポイントを使用して、アプリに関連するネットワークレベルのリンクを取得します。
パラメーター
リクエストの パス に、以下のパラメーターを含める必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
次のパラメーターを クエリパラメーター としてパスすることができます。
cursor
(String
)
-
カーソルの位置。
limit
(Integer
)
-
レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50
です。
リクエストの パス に、以下のパラメーターを含める必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
次のパラメーターを クエリパラメーター としてパスすることができます。
after
(String
)
-
リクエストを開始するカーソルの位置。
before
(String
)
-
リクエストを終了するカーソルの位置。
limit
(Integer
)
-
レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50
です。
このエンドポイントからの結果は、カーソルを使用して表示されます。各結果ページには、カーソルの位置を含むpaging
オブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、1つ目のページには以下のような結果が含まれます。
2ページ目に移動するには、next
リンクをたどって、次に指定されたcursor
の位置から結果を返します。
結果の特定の場所に戻るには、リクエスト クエリパラメーター でcursor
値をパスしてください。
このエンドポイントからの結果は、カーソルを使用してページ分割されています。各ページには、 previous
とnext
ページの位置が返されます。特定のページを返すために、これらをコールに含めることができます。
各結果のページには、カーソルの位置を含むpaging
オブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、最初のページには次のようなpaging
オブジェクトが含まれます。
2ページ目に移動するには、next
リンクをたどって、次に指定されたcursor
の位置から結果を返します。
全てのリンクは、以下の形式でアイテムとして返されます。
例
サブリンクを取得する
このエンドポイントを使用して、指定したアプリのサブリンクを取得します。
パラメーター
リクエストの パス に、以下のパラメーターをパスする必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
tracker_token
(String
)
-
サブリンクがネストされている 親リンク のリンクトークン。
次のパラメーターをリクエストの クエリパラメーター としてパスすることができます。
cursor
(String
)
-
カーソルの位置。
limit
(Integer
)
-
レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50
です。
リクエストの パス に、以下のパラメーターをパスする必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
tracker_token
(String
)
-
サブリンクがネストされている 親リンク のリンクトークン。
次のパラメーターをリクエストの クエリパラメーター としてパスすることができます。
after
(String
)
-
リクエストを開始するカーソルの位置。
before
(String
)
-
リクエストを終了するカーソルの位置。
limit
(Integer
)
-
レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50
です。
このエンドポイントからの結果は、カーソルを使用して表示されます。各結果ページには、カーソルの位置を含むpaging
オブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、1つ目のページには以下のような結果が含まれます。
2ページ目に移動するには、next
リンクをたどって、次に指定されたcursor
の位置から結果を返します。
結果の特定の場所に戻るには、リクエスト クエリパラメーター でcursor
値をパスしてください。
このエンドポイントからの結果は、カーソルを使用してページ分割されています。各ページには、 previous
とnext
ページの位置が返されます。特定のページを返すために、これらをコールに含めることができます。
各結果のページには、カーソルの位置を含むpaging
オブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、最初のページには次のようなpaging
オブジェクトが含まれます。
2ページ目に移動するには、next
リンクをたどって、次に指定されたcursor
の位置から結果を返します。
例
リンクを作成する
このエンドポイントを使用して、アプリに新規リンクまたはサブリンクを作成します。
パラメーター
リクエストの パス に、以下のパラメーターを含める必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
リクエストの データ に以下のパラメーターをパスする必要があります。
name
(String
)
-
新しいリンクの名前。
リクエストの データ に、以下のトークンをパスことができます。
parent_token
(String
)
-
サブリンクがネストされている 親リンク のリンクトークン。サブリンクを作成する場合にのみ必要です。
以下のlevel
値が利用可能です:
1
: ネットワークレベル
2
: キャンペーンレベル
3
: アドグループレベル
4
: クリエイティブレベル
例
以下の例は、 リンク と サブリンク の作成方法を示します。
リンクを作成する
サブリンクを作成する
リンクを更新する
このエンドポイントを使用して、アプリの既存のリンクまたはサブリンクを更新します。リンクに新規パートナーを追加したり、コストデータを有効にするかどうかを管理することができます。
パラメーター
リクエストの パス に、以下のパラメーターをパスする必要があります。
app_token
(String
)
-
アプリを識別する英数字のトークン。12文字で設定してください。
tracker_token
(String
)
-
更新したいリンクのトークン。
リクエストの データ に、以下のパラメーターをパスすることができます
partner_id
(Integer
)
-
リンクに付与したいパートナーのID。パートナーとパートナーIDの一覧を取得するには、上記のパートナーを取得するを参照してください。
cost_data_enabled
(Boolean
)
-
リンクに対し、広告費用データを有効化するかどうか。
レスポンスパラメーター
以下のlevel
値が利用可能です:
1
: ネットワークレベル
2
: キャンペーンレベル
3
: アドグループレベル
4
: クリエイティブレベル
例