Measurement

アプリイベントプロバイダー構成

Postmanで実行 ❯

GET accounts/:account_id/app_event_provider_configurations

現在のアカウントに関連付けられている一部またはすべてのアプリイベントプロバイダー構成（モバイルアプリケーションのコンバージョントラッキングのコア構成）の詳細を取得します。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/app_event_provider_configurations

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
count
任意

個別のリクエストごとに試行および取得するレコード数を指定します。

タイプ: 整数

デフォルト: 200
最小、最大: 1、1000
cursor
任意

結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。

タイプ: 文字列

例: 8x7v00oow
ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的の構成のみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 25n
sort_by
任意

サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。

タイプ: 文字列

例: created_at-asc
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false
with_total_count
任意

total_count応答属性を含めます。

注: このパラメーターとcursorとは相互に排他的です。

注: total_countを含むリクエストの場合、レート制限が低くなります。現在15分あたり200に設定されています。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n

応答の例

{
  "data": [
    {
      "provider_name": "Answers powered by Fabric",
      "id": "25n",
      "provider_advertiser_id": "54ac2766f0de9e1f7a00001a",
      "created_at": "2016-12-08T07:49:58Z",
      "provider_advertiser_identifier": "54ac2766f0de9e1f7a00001a",
      "updated_at": "2017-05-12T21:37:15Z",
      "deleted": false
    }
  ],
  "next_cursor": null,
  "request": {
    "params": {
      "ids": [
        "25n"
      ],
      "account_id": "18ce54d4x5t"
    }
  }
}

GET accounts/:account_id/app_event_provider_configurations/:id

現在のアカウントに関連付けられているイベントプロバイダー構成（モバイルアプリケーションのコンバージョントラッキングのコア構成）の特定のIDを取得します。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/app_event_provider_configurations/:id

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
id
必須

リクエストで操作するアプリイベントプロバイダー構成への参照。

タイプ: 文字列

例: 25n
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/app_event_provider_configurations/25n

応答の例

{
  "data_type": "app_event_provider_configuration",
  "data": {
    "provider_name": "API McTestface",
    "id": "25n",
    "provider_advertiser_id": "123",
    "created_at": "2017-03-24T22:24:56Z",
    "provider_advertiser_identifier": "123",
    "updated_at": "2017-03-24T22:24:56Z",
    "deleted": false
  },
  "request": {
    "params": {
      "id": "25n",
      "account_id": "18ce54d4x5t"
    }
  }
}

POST accounts/:account_id/app_event_provider_configurations

現在のアカウントに関連付けられている新しいアプリイベントプロバイダー構成を作成します。特定の広告アカウントに関連付けることができるのは、1つのMACTプロバイダーのみです。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/app_event_provider_configurations

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
provider_advertiser_id
必須

プロバイダーサイトからの広告主のID

タイプ: 文字列

例: client1

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1

応答の例

{
  "data": {
    "provider_name": "InternalTestProvider",
    "id": "e5g",
    "provider_advertiser_id": "client1",
    "created_at": "2017-08-30T05:40:07Z",
    "provider_advertiser_identifier": "client1",
    "updated_at": "2017-09-06T06:39:03Z",
    "deleted": false
  },
  "request": {
    "params": {
      "provider_advertiser_id": "client1",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/app_event_provider_configurations/:id

現在のアカウントに属する、指定されたアプリイベントプロバイダー構成を削除します。

リソースURL

https://ads-api.x.com/10/accounts/:account_id/app_event_provider_configurations/:id

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
id
必須

リクエストで操作するアプリイベントプロバイダー構成への参照。

タイプ: 文字列

例: e5g

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/app_event_provider_configurations/e5g

応答の例

{
  "data": {
    "provider_name": "InternalTestProvider",
    "id": "e5g",
    "provider_advertiser_id": "client1",
    "created_at": "2017-08-30T05:40:07Z",
    "provider_advertiser_identifier": "client1",
    "updated_at": "2017-08-30T05:40:26Z",
    "deleted": true
  },
  "request": {
    "params": {
      "id": "e5g",
      "account_id": "18ce54d4x5t"
    }
  }
}