キャンペーン API

キャンペーン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トークン の横にあるコピーボタンを選択して、トークンをクリップボードにコピーします。

パートナーを取得する

GET https://api.adjust.com/public/v1/partners

このエンドポイントを使用して、パートナーの一覧と関連データを取得します。データはパートナーオブジェクトの配列で返されます。

パラメーター

次のパラメーターを クエリパラメーター としてパスすることができます。

after （String）: リクエストを開始するカーソルの位置。
before （String）: リクエストを終了するカーソルの位置。
limit （Integer）: レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50です。

ページネーション

このエンドポイントからの結果は、カーソルを使用してページ分割されています。各ページには、 previousとnextページの位置が返されます。特定のページを返すために、これらをコールに含めることができます。

各結果のページには、カーソルの位置を含むpagingオブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、最初のページには次のようなpagingオブジェクトが含まれます。

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

2ページ目に移動するには、after値をafterパラメーター内の次のリクエストに追加します。例：

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

レスポンスの形式

1
{
2
   "data": {
3
      "api_version": "string",
4
      "request_id": "string",
5
      "timestamp": "datetime",
6
      "paging": {
7
         "page_size": "string",
8
         "collection_size": "string",
9
         "total": "string",
10
         "next": "string",
11
         "previous": "string",
12
         "cursors": {
13
            "after": "string",
14
            "before": "string"
15
         }
16
      },
17
      "items": [
18
         {
19
            "id": 100,
20
            "display_name": "string",
21
            "supports_cost_data": true
22
         }
23
      ]
24
   }
25
}

例

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X 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": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "id": 174,
            "display_name": "Adcolony",
            "supports_cost_data": true
         }
      ]
   }
}

リンクを取得する

GET https://api.adjust.com/public/v2/apps/{app_token}/trackers

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers

このエンドポイントを使用して、アプリに関連するネットワークレベルのリンクを取得します。

パラメーター

リクエストのパスに、以下のパラメーターを含める必要があります。

app_token （String）: アプリを識別する英数字のトークン。12文字で設定してください。

次のパラメーターを クエリパラメーター としてパスすることができます。

cursor （String）: カーソルの位置。
limit （Integer）: レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50です。

リクエストのパスに、以下のパラメーターを含める必要があります。

app_token （String）: アプリを識別する英数字のトークン。12文字で設定してください。

次のパラメーターを クエリパラメーター としてパスすることができます。

after （String）: リクエストを開始するカーソルの位置。
before （String）: リクエストを終了するカーソルの位置。
limit （Integer）: レスポンスに含む結果の最大数。この値は正の整数であることが必須です。デフォルトは50です。

ページネーション

このエンドポイントからの結果は、カーソルを使用して表示されます。各結果ページには、カーソルの位置を含むpagingオブジェクトが含まれています。これらのカーソルを使って、プログラムでページ間を移動することができます。例えば、1つ目のページには以下のような結果が含まれます。

"paging": {
   "next": "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

2ページ目に移動するには、nextリンクをたどって、次に指定されたcursorの位置から結果を返します。

$ curl "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50"

結果の特定の場所に戻るには、リクエスト クエリパラメーター でcursor値をパスしてください。

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

2ページ目に移動するには、nextリンクをたどって、次に指定されたcursorの位置から結果を返します。

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

レスポンスの形式

全てのリンクは、以下の形式でアイテムとして返されます。

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

例

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?limit=1'

{
   "data": {
      "paging": {
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq",
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1"
      },
      "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"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/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/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "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/v2/apps/{app_token}/trackers/{link_token}/children

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}/children

このエンドポイントを使用して、指定したアプリのサブリンクを取得します。

パラメーター

リクエストのパスに、以下のパラメーターをパスする必要があります。

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": {
   "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

2ページ目に移動するには、nextリンクをたどって、次に指定されたcursorの位置から結果を返します。

$ curl "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq"

結果の特定の場所に戻るには、リクエスト クエリパラメーター でcursor値をパスしてください。

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

2ページ目に移動するには、nextリンクをたどって、次に指定されたcursorの位置から結果を返します。

$ curl "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq"

レスポンスの形式

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 2,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": null,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

例

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?limit=1' \

{
   "data": {
      "paging": {
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "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"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/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/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "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

このエンドポイントを使用して、アプリに新規リンクまたはサブリンクを作成します。

パラメーター

リクエストのパスに、以下のパラメーターを含める必要があります。

app_token （String）: アプリを識別する英数字のトークン。12文字で設定してください。

リクエストの データ に以下のパラメーターをパスする必要があります。

name （String）: 新しいリンクの名前。

リクエストの データ に、以下のトークンをパスことができます。

parent_token （String）: サブリンクがネストされている 親リンク のリンクトークン。サブリンクを作成する場合にのみ必要です。

レスポンスの形式

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

以下のlevel値が利用可能です：

1: ネットワークレベル
2: キャンペーンレベル
3: アドグループレベル
4: クリエイティブレベル

例

以下の例は、 リンク と サブリンク の作成方法を示します。

リンクを作成する

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"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"
         }
      ]
   }
}

サブリンクを作成する

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"parent_token": "abc123", "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/{link_token}

このエンドポイントを使用して、アプリの既存のリンクまたはサブリンクを更新します。リンクに新規パートナーを追加したり、コストデータを有効にするかどうかを管理することができます。

パラメーター

リクエストのパスに、以下のパラメーターをパスする必要があります。

app_token （String）: アプリを識別する英数字のトークン。12文字で設定してください。
tracker_token （String）: 更新したいリンクのトークン。

リクエストの データ に、以下のパラメーターをパスすることができます

partner_id （Integer）: リンクに付与したいパートナーのID。パートナーとパートナーIDの一覧を取得するには、上記のパートナーを取得するを参照してください。
cost_data_enabled （Boolean）: リンクに対し、広告費用データを有効化するかどうか。

レスポンスのパラメーター

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

以下のlevel値が利用可能です：

1: ネットワークレベル
2: キャンペーンレベル
3: アドグループレベル
4: クリエイティブレベル

例

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--location --request PATCH 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/klm789' \
--data-raw '{"partner_id": 174, "cost_data_enabled": false}'

{
   "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"
         }
      ]
   }
}