API reference 目次

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

アプリイベントタグ

ウェブイベントタグ

アプリリスト

コンバージョンアトリビューション

コンバージョンイベント

アプリリスト

Postmanで実行 ❯

GET accounts/:account_id/app_lists¶

現在のアカウントに関連付けられている一部またはすべてのアプリリストの詳細を取得します。

リソースURL¶

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

パラメーター¶

名前	説明
account_id 必須	利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。タイプ: 文字列例: `18ce54d4x5t`
app_list_ids 任意	カンマ区切りのIDリストを指定して、応答の範囲を目的のアプリリストのみに設定します。最大200件のIDを指定できます。タイプ: 文字列例: `wm7x`
count 任意	個別のリクエストごとに試行および取得するレコード数を指定します。タイプ: 整数デフォルト: `200` 最小、最大: `1`、`1000`
cursor 任意	結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。タイプ: 文字列例: `8x7v00oow`
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_lists?app_list_ids=wm7x

応答の例¶

{
  "request": {
    "params": {
      "app_list_ids": [
        "wm7x"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "id": "wm7x",
      "name": "foo @ 14026528192426843"
    }
  ]
}

GET accounts/:account_id/app_lists/:app_list_id¶

現在のアカウントに関連付けられている特定のアプリリストを取得します。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

app_list_id
必須

リクエスト内で操作するアプリリストへの参照。

タイプ: 文字列

例: 28ukf

with_deleted
任意

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

タイプ: ブール値

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

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/app_lists/28ukf

応答の例¶

{
  "data": {
    "name": "twitter @ 262689209670784",
    "id": "28ukf",
    "created_at": "2017-08-17T17:07:42Z",
    "updated_at": "2017-08-17T17:07:42Z",
    "deleted": false,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_list_id": "28ukf",
      "account_id": "18ce54d4x5t"
    }
  }
}

POST accounts/:account_id/app_lists¶

現在のアカウントに関連付けられているapp_listを作成します。

現在、account_idあたり100 app_listオブジェクト、app_listあたり500アプリに制限されています。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

タイプ: 文字列

例: 18ce54d4x5t

app_store_identifiers
必須

app_listに含めるアプリストアID

タイプ: 文字列

例: com.twitter.android

name
必須

app_listに割り当てる名前

タイプ: 文字列

例: My First App List

リクエストの例¶

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android

応答の例¶

{
  "data": {
    "name": "app list",
    "id": "2a4um",
    "created_at": "2017-09-06T07:17:26Z",
    "updated_at": "2017-09-06T07:17:26Z",
    "deleted": false,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_store_identifiers": [
        "com.twitter.android"
      ],
      "name": "app list",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/app_lists/:app_list_id¶

現在のアカウントに関連付けられている指定されたアプリリストを削除します。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

タイプ: 文字列

例: 18ce54d4x5t

app_list_id
必須

リクエスト内で操作するアプリリストへの参照。

タイプ: 文字列

例: 28ukf

リクエストの例¶

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/app_lists/28ukf

応答の例¶

{
  "data": {
    "name": "twitter @ 262689209670784",
    "id": "28ukf",
    "created_at": "2017-08-17T17:07:42Z",
    "updated_at": "2017-09-12T22:20:33Z",
    "deleted": true,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_list_id": "28ukf",
      "account_id": "18ce54d4x5t"
    }
  }
}