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

応答の例¶

{
  "request": {
    "params": {
      "promoted_account_ids": [
        "19pl2"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "9bpb2",
      "user_id": "756201191646691328",
      "id": "19pl2",
      "entity_status": "ACTIVE",
      "created_at": "2017-07-05T05:54:13Z",
      "updated_at": "2017-07-05T05:54:13Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/promoted_accounts/:promoted_account_id¶

現在のアカウントの行項目に関連付けられているアカウントへの特定の参照を取得します。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

promoted_account_id
必須

リクエスト内で操作するプロモアカウントへの参照。

タイプ: 文字列

例: 19pl2

with_deleted
任意

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

タイプ: ブール値

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

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_accounts/19pl2

応答の例¶

{
  "request": {
    "params": {
      "promoted_account_id": "19pl2",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "9bpb2",
    "user_id": "756201191646691328",
    "id": "19pl2",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T05:54:13Z",
    "updated_at": "2017-07-05T05:54:13Z",
    "approval_status": "ACCEPTED",
    "deleted": false
  }
}

POST accounts/:account_id/promoted_accounts¶

指定した行項目にアカウント（user_id）を関連付けます。

指定した行項目がプロモアカウントと関連付けられるよう設定されていない場合、HTTP 400 INCOMPATIBLE_LINE_ITEMエラーが返されます。指定したユーザーがプロモーションの対象でない場合は、HTTP 400が返され、ユーザーはプロモーションされません。指定したユーザーがすでにプロモーションされている場合、リクエストは無視されます。

プロモアカウントの詳細については、「キャンペーン管理」ページを参照してください。

注: プロモアカウントエンティティを更新（PUT）することはできません。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

タイプ: 文字列

例: 18ce54d4x5t

line_item_id
必須

リクエスト内で操作する行項目への参照。

タイプ: 文字列

例: 9bpb2

user_id
必須

リクエスト内で操作するユーザーへの参照。GET users/lookupを使用して、スクリーンネームのユーザーIDを取得します。

タイプ: 長整数型

例: 756201191646691328

リクエストの例¶

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328

応答の例¶

{
  "data": {
    "line_item_id": "9bpb2",
    "user_id": "756201191646691328",
    "id": "19pl2",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T05:54:13Z",
    "updated_at": "2017-07-05T05:54:13Z",
    "approval_status": "ACCEPTED",
    "deleted": false
  },
  "request": {
    "params": {
      "user_id": "756201191646691328",
      "line_item_id": "9bpb2",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/promoted_accounts/:promoted_account_id¶

指定した行項目からアカウントの関連付けを解除します。

リソースURL¶

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

パラメーター¶

名前説明

account_id
必須

タイプ: 文字列

例: 18ce54d4x5t

promoted_account_id
必須

IDは、行項目に関連付けられているプロモアカウントのインスタンスを表します。

タイプ: 文字列

例: 19pl2

リクエストの例¶

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/promoted_accounts/19pl2

応答の例¶

{
  "data": {
    "line_item_id": "9bpb2",
    "user_id": "756201191646691328",
    "id": "19pl2",
    "entity_status": "ACTIVE",
    "created_at": "2017-07-05T05:54:13Z",
    "updated_at": "2017-08-23T18:53:15Z",
    "approval_status": "ACCEPTED",
    "deleted": true
  },
  "request": {
    "params": {
      "promoted_account_id": "19pl2",
      "account_id": "18ce54d4x5t"
    }
  }
}