キャンペーン API
キャンペーン APIの使用方法は?
キャンペーンAPIを使用すると、Adjust管理画面を使用しなくても、トラッカー、サブトラッカー、およびパートナーの情報を取得できます。この機能を使用すると、複数のトラッカーをリモートで作成し、アプリのネットワーク、キャンペーン、広告グループ、およびクリエイティブレベルのトラッカーすべてにアクセスすることもできるようになります。
この機能のユースケースのシナリオを示すには、出張中のクライアントがさまざまな地域のユーザーに新しいオファーを展開しており、ApplovinとAdcolonyでそのキャンペーンの新しいキャンペーンを実行することを計画していると想像してください。これらのキャンペーンでは、地域ごとに分類された新しいトラッカーが必ず必要になります。また、彼らはそれらのキャンペーンの広告費用を計測したいと考えており、Campaign APIで計測できるようになります。方法は次のとおりです。
- AppLovinとAdColonyと連携しているトラッカーがあるかどうかを確認するため、エンドポイント「GET Network Trackers」を使用します。
- トラッカーがまだ作成されていない場合、両パートナーにはエンドポイント「CREATE Network Tracker 」(レベル 1)」を使用します。
- 次に、エンドポイント「GET Partner List」を使用して、利用予定の配信ネットワークのパートナーIDを検索し、それらのパートナーにリンクできるようにすることもできます。
- パートナーIDを取得したら、「UPDATE Tracker」で作成したトラッカーをパートナーにリンクし、コストパラメーターを設定することができます。
これで、デフォルトのAppLovinおよびAdColonyのパラメーターをトラッカーの各階層に付与することができました。Adcolonyには、コストパラメーターとネットワークがトラッカーに追加する他のデフォルトパラメーターが追加されます。
以下に、キャンペーン APIへのクエリを使用してトラッカーを作成し、キャンペーン情報を受信する方法を説明します。
バージョン
キャンペーン APIのバージョンは、大きなリリースがある度に更新されます。重大な変更を伴わないリリースにおいては、新しいバージョンに更新する必要はありません。APIバージョンは、全てのリクエストのURLパスで設定されます。
バージョン1の例: https://api.adjust.com/public/v1/apps/{app_token}/trackers
次のドキュメントは、API V1に固有のものです。
API認証
キャンペーン APIにアクセスするには、ユーザーに関連付けられたAPIトークンを指定します(Adjust管理画面の「マイアカウント (My Account)>ユーザー情報 (User Details)> APIトークン(API Token)」の下にあります)。ここでは、このユーザートークンを認証トークンと呼びます。
ユーザートークンとその管理画面ユーザーには、同一のユーザー権限があります。
APIの使用時にリクエストを認証するには、リクエストに次のHTTPヘッダーを入力します。
Authorization: Token token=user_token_here
レスポンスの形式
キャンペーン APIへのリクエストはapplication/json
形式であり、json
レスポンスを返します。
レスポンスの構造は、大まかにGoogleのJSON APIスタイルガイドに基づいています。
成功レスポンス
適切な手順で進めるために、リクエストに成功するキャンペーン APIレスポンスの構造を以下に示します。
{
"data": {
"api_version": //request_api_version,
"request_id": //alphanumeric_request_id,
"timestamp": //server_timestamp,
"paging": {
"page_size": //page_size,
"collection_size": //total_elements_on_current_page,
"total": //total_elements,
"next": //url_for_next_page,
"previous": //url_for_previous_page,
"cursors": {
"after": //after_cursor,
"before": //before_cursor
},
},
"items": [
/// The list of elements requested
]
}
}
フィールドの定義
フィールド | 形式 | 説明 | 例 |
api_version | 文字列 | APIレスポンスのバージョン(リクエストを実行するときにユーザーが指定したバージョンと一致します) | 1 |
request_id | 文字列 | ユーザーが行ったリクエストのユニーク識別子 | FcK55-tdJUDOWQIAABsB |
timestamp | 文字列 YYYY-MM-DDTHH:MM:MMZ | リクエスト時のサーバーの日付 | 2019-09-09T09:07:06Z |
paging | オブジェクト | ページネーションのフィールドを含む | |
paging.total | 文字列(数値) | データベース内の要素の合計サイズ | 1000 |
paging.page_size | 文字列(数値) | 現在のページの要素の最大量 | 50 |
paging.collection_size | 文字列(数値) | 現在のページの要素の量 | 49 |
paging.next | 文字列(url) | 結果の次のページを取得するためのリンク。現在のページが最後のページである場合、値はnilになります | https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50 |
paging.previous | 文字列(url) | 結果の前のページを取得するためのリンク。現在のページが最初のページである場合、値はnilになります | https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?before=g2wAAAACYhW1_gxkAANuaWxq&limit=50 |
paging.cursors | オブジェクト | ページネーションに使用されるカーソルが含まれる(ページネーションの詳細については、次の章で説明します) | |
paging.cursors.after | 文字列 | 次のページを取得するために指定するカーソル | g2wAAAACYhW1_gxkAANuaWxq |
paging.cursors.before | 文字列 | 次のページを取得するために指定するカーソル | g2wAAAACYhW1_gxkAANuaWxq |
items | 配列 | APIからリクエストされた要素のリスト(アイテムの説明については、対応するエンドポイントの資料を参照してください) |
エラーのレスポンス
エラーを含むリクエストに対するキャンペーン APIレのレスポンス構造を以下に示します。
{
"error": {
"api_version": //request_api_version,
"request_id": //alphanumeric_request_id,
"timestamp": //server_timestamp,
"message": //error_message
}
}
フィールドの定義
フィールド | 形式 | 説明 | 例 |
api_version | 文字列 | APIレスポンスのバージョン(リクエストを実行するときにユーザーが指定したバージョンと一致します) | 1 |
request_id | 文字列 | ユーザーが行ったリクエストのユニーク識別子 | FcK55-tdJUDOWQIAABsB |
timestamp | 文字列"YYYY-MM-DDTHH:MM:MMZ" | リクエスト時のサーバーの日付 | 2019-09-09T09:07:06Z |
message | 文字列 | リクエストが失敗した理由を示す、対応するエラーメッセージ | "User not authenticated" |
ページネーション
データのリクエスト(GETリクエスト)は、次のURLと前のURLを含むページ分割された結果を返します。キャンペーン APIは、カーソルベースのページネーションを使用します。全てのGETレスポンスには、after cursorとbefore cursorが含まれます。さらに、全てのリクエストはカーソル値を指定したafterおよびbeforeパラメーターを受け取ります。ページ制限をカスタマイズするには、limitパラメーターを使用します(それ以外の場合、デフォルトのページ制限は50要素です)。
ページネーションフローの例:
app_token yxs12pfewq
のトラッカーを取得するには、次の初期リクエストを送信します。
GET https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers
レスポンスには、次のような paging
セクションが表示されます。
"paging": {
"page_size": "50",
"collection_size": "49",
"total": "199"
"cursors": {
"after": "g2wAAAACYhW1_gxkAANuaWxq",
"before": nil // (the first page has no previous page)
},
"next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
"previous": nil // (the first page has no previous page)
}
2番目のページに移動するには、(カーソル内にある)after値を、パラメーター内の次のGETリクエストに(対応するパラメーター名と共に)追加します。例:
GET https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq
または、ページング要素の次の属性でURLを使用します。
GET https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50
前のページに移動するには、同じフローに従いますが、before値またはpreviousに設定されたURLを使用します。
エンドポイント
ネットワークトラッカーの取得
このエンドポイントを使用して、指定したアプリのネットワークレベルのトラッカーを取得します。
エンドポイント
GET https://api.adjust.com/public/v1/apps/{app_token}/trackers
URLパラメーター
パラメーター | 形式 | 説明 | 例 |
app_token | 文字列 | アプリケーショントークン | yxs12pfewg |
クエリパラメーター
パラメーター | 形式 | 説明 | 例 |
after | 文字列 | 次のページから要素を取得するカーソル(オプション) | g2wAAAACYhW1_gxkAANuaWxq |
before | 文字列 | 前のページから要素を取得するカーソル(オプション) | g2wAAAACYhYGiAhkAANuaWxq |
limit | 0以上の数値 | リクエストされたページの要素の最大量 | 50 |
詳細については、ページネーションを参照してください。
レスポンスの形式
アイテムの定義
フィールド | 形式 | 説明 | 例 |
name | 文字列 | トラッカーの名前 | Adroll |
label | 文字列 | トラッカーの名前の最後のレベルの部分 | Adroll |
level | 整数 | Adjustのキャンペーン構造に従ったトラッカーのレベル(ネットワーク=1、キャンペーン=2、アドグループ=3、およびクリエイティブ=4) | 1 |
archived | ブーリアン値(true/false) | トラッカーがアーカイブされたかどうかを指定します | true |
has_subtrackers | ブーリアン値(true/false) | トラッカーにサブトラッカーがあるかどうかを示します | true |
partner_id | 整数 | トラッカーに付与されているパートナーのIDを示します。たとえば、パートナーであるAdrollのIDは3です | 3 |
cost_data_enabled | ブーリアン値(true/false) | トラッカーでcost_dataが有効になっているかどうかを示します | false |
impression_url | 文字列 | インプレッション計測用のトラッカーのURL | https://view.adjust.com/impression/abc123 |
url | 文字列 | 計測用のトラッカーのURL | https://app.adjust.com/abc123 |
click_url | 文字列 | クリック計測用のトラッカーのURL | https://app.adjust.com/abc123 |
アイテムの例:
{
"name": "Adroll",
"token": "abc123",
"label": "Adroll",
"level": 1,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/abc123",
"click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1",
}
レスポンスの例(1つのトラッカーのみを含む):
GET https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?limit=1
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"paging": {
"page_size": "1",
"collection_size": "1",
"total": "199",
"next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
"previous": nil,
"cursors": {
"after": "g2wAAAACYhW1_gxkAANuaWxq",
"before": nil
}
},
"items": [
{
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"label": "Adroll",
"level": 1,
"name": "Adroll",
"token": "abc123",
"url": "https://app.adjust.com/abc123",
"click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1",
}
]
}
}
サブトラッカーの取得
このエンドポイントを使用して、指定したトラッカーのサブトラッカーを取得します。
エンドポイント
GET https://api.adjust.com/public/v1/apps/{app_token}/trackers/{tracker_token}/children
パラメーター | 形式 | 説明 | 例 |
app_token | 文字列 | アプリケーショントークン | yxs12pfewq |
tracker_token | 文字列 | トラッカートークン | abc123 |
クエリパラメーター
パラメーター | 形式 | 説明 | 例 |
after | 文字列 | 次のページから要素を取得するカーソル(オプション) | g2wAAAACYhW1_gxkAANuaWxq |
before | 文字列 | 前のページから要素を取得するカーソル(オプション) | g2wAAAACYhYGiAhkAANuaWxq |
limit | 0以上の数値 | リクエストされたページの要素の最大量 | 50 |
詳細については、ページネーションを参照してください。
レスポンス
戻り値は、レスポンスの形式を使用してサブトラッカーをリストします。
アイテムの定義
フィールド | 形式 | 説明 | 例 |
name | 文字列 | トラッカーの名前 | Adroll::SpringCampaign |
label | 文字列 | トラッカーの名前の最後のレベルの部分 | SpringCampaign |
level | 整数 | トラッカーのレベル | 2 |
archived | ブーリアン値(true/false) | トラッカーがアーカイブされたかどうかを指定します | true |
has_subtrackers | ブーリアン値(true/false) | トラッカーにサブトラッカーがあるかどうかを示します | true |
partner_id | 整数 | トラッカーに付与されているパートナーのIDを示します | 3 |
cost_data_enabled | ブーリアン値(true/false) | トラッカーでcost_dataが有効になっているかどうかを示します | false |
impression_url | 文字列 | インプレッション計測用のトラッカーのURL | https://view.adjust.com/impression/abc123 |
url | 文字列 | 計測用のトラッカーのURL | https://view.adjust.com/impression/abc123 |
アイテムの例:
{
"name": "Adroll::SpringCampaign",
"token": "xyz456",
"label": "SpringCampaign",
"level": 2,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/xyz456",
"click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1",
}
レスポンスの例(1つのトラッカーを含む):
GET https://api.adjust.com/public/v1/apps/yxs12pfew/trackers/abc123/children?limit=1
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"paging": {
"page_size": "1",
"collection_size": "1",
"total": "199",
"next": "https://api.adjust.com/public/v1/apps/yxs12pfew/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
"previous": nil,
"cursors": {
"after": "g2wAAAACYhW1_gxkAANuaWxq",
"before": nil
}
},
"items": [
{
"name": "Adroll::SpringCampaign",
"token": "xyz456",
"label": "SpringCampaign",
"level": 2,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/xyz456",
"click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1",
}
]
}
}
トラッカーの作成
このエンドポイントを使用して、新しいトラッカーまたはサブトラッカーを作成します。
エンドポイント:POST https://api.adjust.com/public/v1/apps/{app_token}/trackers
URLパラメーター
パラメーター | 形式 | 説明 | 例 |
app_token | 文字列 | アプリケーショントークン | yxs12pfewg |
リクエスト本文
リクエスト本文は、クエリパラメーターまたはapplication/json
コンテンツとして送信できます。
パラメーター | 形式 | 説明 | 例 |
name | 文字列 | 新しいトラッカーの名前 | Adroll |
parent_token | 文字列 | 親トラッカーのトラッカートークン(サブトラッカーの作成時にのみ必要) | abc123 |
リクエストの例:
ネットワークトラッカー
jsonペイロードの例:
POST https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers
{
"name": "Adroll"
}
サブトラッカー(任意のレベル)
jsonペイロードの例:
POST https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers
{
"name": "Adroll"
"parent_token": "abc123"
}
レスポンス:
戻り値には、レスポンスの形式を使用した新しいトラッカーが含まれます。
アイテムの定義
フィールド | 形式 | 説明 | 例 |
name | 文字列 | トラッカーの名前 | Adroll::Spring Campaign::PubID123 |
label | 文字列 | トラッカーの名前の最後のレベルの部分 | PubID123 |
level | 整数 | Adjustのキャンペーン構造に従ったトラッカーのレベル(ネットワークは1、キャンペーンは2、アドグループは3、およびクリエイティブは4) | 3 |
archived | ブーリアン値(true/false) | トラッカーがアーカイブされたかどうかを指定します | true |
has_subtrackers | ブーリアン値(true/false)/td> | トラッカーにサブトラッカーがあるかどうかを示します | true |
partner_id | 整数 | トラッカーに付与されているパートナーのIDを示します。たとえば、パートナーであるAdrollのIDは3です | 3 |
cost_data_enabled | ブーリアン値(true/false) | トラッカーでcost_dataが有効になっているかどうかを示します | true |
impression_url | 文字列 | インプレッション計測用のトラッカーのURL | https://view.adjust.com/impression/xyz456 |
url | 文字列 | 計測用のトラッカーのURL | https://view.adjust.com/impression/xyz456 |
アイテムの例:
{
"name": "Adroll::SpringCampaign::PubID123",
"token": "ghi789",
"label": "PubId123",
"level": 3,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/ghi789",
"click_url": "https://app.adjust.com/ghi789?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/ghi789?idfa={idfa}&s2s=1",
}
レスポンスの例(ネットワークレベルトラッカー用):
POST https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers
{
"name": "Adroll"
}
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"items": [
{
"name": "Adroll",
"token": "abc123",
"label": "Adroll",
"level": 1,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/abc123",
"click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1",
}
]
}
}
レスポンスの例(サブトラッカー用):
POST https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers
{
"parent_tracker": "Adroll"
"name": "SpringCampaign"
}
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"items": [
{
"name": "Adroll::SpringCampaign",
"token": "xyz456",
"label": "SpringCampaign",
"level": 2,
"archived": false,
"has_subtrackers": false,
"partner_id": 3,
"cost_data_enabled": false,
"url": "https://app.adjust.com/xyz456",
"click_url": "https://app.adjust.com/xyz456?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
"impression_url": "https://s2s.adjust.com/impression/xyz456?campaign={campaign_name}&idfa={idfa}&s2s=1",
}
]
}
}
トラッカーの更新
このエンドポイントを使用して、ユーザーがトラッカーを更新できます。
エンドポイント:
PATCH https://api.adjust.com/public/v1/apps/{app_token}/trackers/{tracker_token}
URLパラメーター
パラメーター | 形式 | 説明 | 例 |
app_token | 文字列 | アプリケーショントークン | yxs12pfewq |
tracker_token | 文字列 | トラッカートークン | abc123 |
リクエスト本文
リクエスト本文は、クエリパラメーターまたはapplication/jsonコンテンツとして送信できます。パラメーターは不要です。このAPIは指定されたもののみを更新します。
パラメーター | 形式 | 説明 | 例 |
partner_id | 整数 | トラッカーに付与されるパートナーのID | 1 |
cost_data_enabled | ブーリアン値(true/false) | トラッカーで費用データを有効にするかどうかを示します | true |
リクエストの例:
jsonペイロードの例:
PATCH https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers/abc123
{
"partner_id": 1,
"cost_data_enabled": false
}
レスポンス
レスポンスの形式を使用して、更新されたトラッカーを返します。
アイテムの定義
フィールド | 形式 | 説明 | 例 |
name | 文字列 | トラッカーの名前 | AdColony |
label | 文字列 | トラッカーの名前の最後のレベルの部分 | AdColony |
level | 整数 | Adjustのキャンペーン構造に従ったトラッカーのレベル(ネットワークは1、キャンペーンは2、アドグループは3、およびクリエイティブは4) | 1 |
archived | ブーリアン値(true/false) | トラッカーがアーカイブされたかどうかを指定します | true |
has_subtrackers | ブーリアン値(true/false) | トラッカーにサブトラッカーがあるかどうかを示します | true |
partner_id | 整数 | トラッカーに付与されているパートナーのIDを示します。たとえば、パートナーであるAdcolonyのIDは174です | 174 |
cost_data_enabled | ブーリアン値(true/false) | トラッカーでcost_dataが有効になっているかどうかを示します | true |
impression_url | 文字列 | インプレッション計測用のトラッカーのURL | https://view.adjust.com/impression/klm789 |
url | 文字列 | 計測用のトラッカーのURL | https://view.adjust.com/impression/klm789 |
アイテムの例:
{
"name": "Adcolony",
"token": "klm789",
"label": "Adcolony",
"level": 1,
"archived": false,
"has_subtrackers": false,
"partner_id": 174,
"cost_data_enabled": true,
"url": "https://app.adjust.com/klm789",
"impression_url": "https://s2s.adjust.com/impression/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address= [IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD,
"click_url": "https://s2s.app.adjust.com/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=[IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD"
}
レスポンスの例:
PATCH https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers/klm789?partner_id=174&cost_data_enabled=true
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"items": [
{
"name": "Adcolony",
"token": "klm789",
"label": "Adcolony",
"level": 1,
"archived": false,
"has_subtrackers": false,
"partner_id": 174,
"cost_data_enabled": true,
"url": "https://app.adjust.com/klm789",
"impression_url": "https://s2s.adjust.com/impression/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address= [IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD,
"click_url": "https://s2s.app.adjust.com/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=[IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD"
}
]
}
}
パートナーの取得
このエンドポイントを使用して、パートナーのリストを取得します。
エンドポイント:GET https://api.adjust.com/public/v1/partners
クエリパラメーター
パラメーター | 形式 | 説明 | 例 |
after | 文字列 | 次のページから要素を取得するカーソル(オプション) | g2wAAAACYhW1_gxkAANuaWxq |
before | 文字列 | 前のページから要素を取得するカーソル(オプション) | g2wAAAACYhYGiAhkAANuaWxq |
limit | 0以上の数値 | リクエストされたページの要素の最大量 | 50 |
詳細については、ページネーションを参照してください。
レスポンス:
戻り値は、レスポンスの形式を使用してパートナーをリストします。
アイテムの定義:
フィールド | 形式 | 説明 | 例 |
id | 整数 | パートナーのID | 174 |
display_name | 文字列 | パートナーの名前 | AdColony |
support_cost_data | ブーリアン値(true/false) | パートナーがコストデータのパラメーターをサポートしているかどうかを示します | true |
アイテムの例:
{
"id": 174,
"display_name": "Adcolony",
"supports_cost_data": true
}
レスポンスの例(1つのパートナーを含む):
GET https://api.adjust.com/public/v1/partners?limit=1
{
"data": {
"api_version": "1",
"request_id": "FcK55-tdJUDOWQIAABsB",
"timestamp": "2019-09-09T09:07:06Z",
"paging": {
"page_size": "1",
"collection_size": "1",
"total": "199",
"next": "https://api.adjust.com/public/v1/partners?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
"previous": nil,
"cursors": {
"after": "g2wAAAACYhW1_gxkAANuaWxq",
"before": nil
}
},
"items": [
{
"id": 174,
"display_name": "Adcolony",
"supports_cost_data": true
}
]
}
}