Languages 
  • English
  • 中文
  • 日本語

キャンペーン API

キャンペーン APIの使用方法は?

Campaign APIを使用すると、Adjust管理画面を使用しなくても、トラッカー、サブトラッカー、およびパートナーの情報を取得できます。この機能により、複数のトラッカーをリモートで作成し、アプリのネットワーク、キャンペーン、広告グループ、およびクリエイティブレベルのトラッカー全てにアクセスできるようになります。

例えば、ある旅行アプリがApplovinとAdcolonyと連携して、さまざまな地域のユーザーに新しいオファーを展開しようとしています。このようなキャンペーンでは、地域ごとに分類された新しいトラッカーが必要になります。また、キャンペーン 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スタイルガイド( https://google.github.io/styleguide/jsoncstyleguide.xml)に基づいています。

成功レスポンス

適切な手順で進めるために、リクエストに成功するキャンペーン 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_versionstringAPIレスポンスのバージョン(リクエストを実行するときにユーザーが指定したバージョンと一致します)1
request_idstringユーザーが行ったリクエストのユニーク識別子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.afterstring次のページを取得するために指定するカーソルg2wAAAACYhW1_gxkAANuaWxq
paging.cursors.beforestring次のページを取得するために指定するカーソルg2wAAAACYhW1_gxkAANuaWxq
items配列APIからリクエストされた要素のリスト(アイテムの説明については、対応するエンドポイントの資料を参照してください) 

エラーのレスポンス

エラーを含むリクエストに対するキャンペーン APIレのレスポンス構造を以下に示します。

{
  "error": {
    "api_version": //request_api_version,
    "request_id": //alphanumeric_request_id,
    "timestamp": //server_timestamp,
    "message": //error_message
  }
}

フィールドの定義

フィールド形式説明
api_versionstringAPIレスポンスのバージョン(リクエストを実行するときにユーザーが指定したバージョンと一致します)1
request_idstringユーザーが行ったリクエストのユニーク識別子FcK55-tdJUDOWQIAABsB
timestamp文字列"YYYY-MM-DDTHH:MM:MMZ"リクエスト時のサーバーの日付2019-09-09T09:07:06Z
messagestringリクエストが失敗した理由を示す、対応するエラーメッセージ"ユーザーが認証されていません"

データのリクエスト(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_tokenstringアプリケーショントークンyxs12pfewg

クエリパラメータ

パラメーター形式説明
afterstring次のページから要素を取得するカーソル(オプション)g2wAAAACYhW1_gxkAANuaWxq
beforestring前のページから要素を取得するカーソル(オプション)g2wAAAACYhYGiAhkAANuaWxq
limit0以上の数値リクエストされたページの要素の最大量50

詳細については、ページネーションを参照してください。

レスポンスの形式

アイテムの定義

フィールド形式説明
namestringトラッカーの名前Adroll
labelstringトラッカーの名前の最後のレベルの部分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_urlstringインプレッション計測用のトラッカーのURLhttps://view.adjust.com/impression/abc123​
urlstring計測用のトラッカーのURLhttps://app.adjust.com/abc123
click_urlstringクリック計測用のトラッカーのURLhttps://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_tokenstringアプリケーショントークンyxs12pfewq
tracker_tokenstringトラッカートークンabc123

クエリパラメータ

パラメーター形式説明
afterstring次のページから要素を取得するカーソル(オプション)g2wAAAACYhW1_gxkAANuaWxq
beforestring前のページから要素を取得するカーソル(オプション)g2wAAAACYhYGiAhkAANuaWxq
limit0以上の数値リクエストされたページの要素の最大量50

詳細については、ページネーションを参照してください。

レスポンス

戻り値は、レスポンスの形式を使用してサブトラッカーをリストします。

アイテムの定義

フィールド形式説明
namestringトラッカーの名前Adroll::SpringCampaign
labelstringトラッカーの名前の最後のレベルの部分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_urlstringインプレッション計測用のトラッカーのURLhttps://view.adjust.com/impression/abc123​
urlstring計測用のトラッカーのURLhttps://view.adjust.com/impression/abc123​

アイテムの例:

{
  "name": "Adroll::SpringCampaign",
  "token": "def456",
  "label": "SpringCampaign",
  "level": 2,
  "archived": false,
  "has_subtrackers": false,
  "partner_id": 3,
  "cost_data_enabled": false,
  "url": "https://app.adjust.com/def456",
  "click_url": "https://app.adjust.com/def456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
  "impression_url": "https://s2s.adjust.com/impression/def456?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": "def456",
        "label": "SpringCampaign",
        "level": 2,
        "archived": false,
        "has_subtrackers": false,
        "partner_id": 3,
        "cost_data_enabled": false,
        "url": "https://app.adjust.com/def456",
        "click_url": "https://app.adjust.com/def456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
        "impression_url": "https://s2s.adjust.com/impression/def456?idfa={idfa}&s2s=1",
      }
    ]
  }
}

トラッカーの作成

このエンドポイントを使用して、新しいトラッカーまたはサブトラッカーを作成します。

エンドポイント:POST https://api.adjust.com/public/v1/apps/{app_token}/trackers

URLパラメーター

パラメーター形式説明
app_tokenstringアプリケーショントークンyxs12pfewg

リクエスト本文

リクエスト本文は、クエリパラメーターまたはapplication/jsonコンテンツとして送信できます。

パラメーター形式説明
namestring新しいトラッカーの名前Adroll
parent_tokenstring親トラッカーのトラッカートークン(サブトラッカーの作成時にのみ必要)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"
}

レスポンス:

戻り値には、レスポンスの形式を使用した新しいトラッカーが含まれます。

アイテムの定義

フィールド形式説明
namestringトラッカーの名前Adroll::Spring Campaign::PubID123
labelstringトラッカーの名前の最後のレベルの部分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_urlstringインプレッション計測用のトラッカーのURLhttps://view.adjust.com/impression/def456
urlstring計測用のトラッカーのURLhttps://view.adjust.com/impression/def456

アイテムの例:

{
  "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": "def456",
        "label": "SpringCampaign",
        "level": 2,
        "archived": false,
        "has_subtrackers": false,
        "partner_id": 3,
        "cost_data_enabled": false,
        "url": "https://app.adjust.com/def456",
        "click_url": "https://app.adjust.com/def456?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
        "impression_url": "https://s2s.adjust.com/impression/def456?campaign={campaign_name}&idfa={idfa}&s2s=1",
      }
    ]
  }
}

トラッカーの更新

このエンドポイントを使用して、ユーザーがトラッカーを更新できます。

エンドポイント:

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

URLパラメーター

パラメーター形式説明
app_tokenstringアプリケーショントークンyxs12pfewq
tracker_tokenstringトラッカートークンabc123

リクエスト本文

リクエスト本文は、クエリパラメーターまたはapplication/jsonコンテンツとして送信できます。パラメーターは不要です。このAPIは指定されたもののみを更新します。

パラメーター形式説明
partner_id整数トラッカーに付与されるパートナーのID1
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
}

レスポンス

レスポンスの形式を使用して、更新されたトラッカーを返します。

アイテムの定義

フィールド形式説明
namestringトラッカーの名前AdColony
labelstringトラッカーの名前の最後のレベルの部分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_urlstringインプレッション計測用のトラッカーのURLhttps://view.adjust.com/impression/klm789
urlstring計測用のトラッカーのURLhttps://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

クエリパラメータ

パラメーター形式説明
afterstring次のページから要素を取得するカーソル(オプション)g2wAAAACYhW1_gxkAANuaWxq
beforestring前のページから要素を取得するカーソル(オプション)g2wAAAACYhYGiAhkAANuaWxq
limit0以上の数値リクエストされたページの要素の最大量50

詳細については、ページネーションを参照してください。

レスポンス:

戻り値は、レスポンスの形式を使用してパートナーをリストします。

アイテムの定義:

フィールド形式説明
id整数パートナーのID174
display_namestringパートナーの名前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
      }
    ]
  }
}