クリエイティブ

プレロールのアクション誘導

Postmanで実行 ❯

GET accounts/:account_id/preroll_call_to_actions

現在のアカウントの行項目に関連付けられている一部またはすべてのプレロールのアクション誘導（CTA）の詳細を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
line_item_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を、指定した行項目に関連付けられているプレロールのCTAのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: 8v53k
count
任意

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

タイプ: 整数

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

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

タイプ: 文字列

例: 8x7v00oow
preroll_call_to_action_ids
任意

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

タイプ: 文字列

例: 8f0
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/preroll_call_to_actions?line_item_ids=8v53k

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8v53k"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8v53k",
      "call_to_action_url": "https://www.twitter.com",
      "call_to_action": "VISIT_SITE",
      "id": "8f0",
      "created_at": "2017-07-07T19:28:40Z",
      "updated_at": "2017-07-07T19:28:40Z",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

このアカウントに関連付けられている特定のアクション誘導（CTA）を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
preroll_call_to_action_id
必須

リクエスト内で操作するプレロールのアクション誘導への参照。

タイプ: 文字列

例: 8f0
with_deleted
任意

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/preroll_call_to_actions/8f0

応答の例

{
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.twitter.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  }
}

POST accounts/:account_id/preroll_call_to_actions

PREROLL_VIEWS行項目の任意のアクション誘導（CTA）を設定します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
call_to_action
必須

広告内に表示されるボタンのCTAテキスト。

タイプ: 列挙

使用可能な値: GO_TO、SEE_MORE、SHOP、VISIT_SITE、WATCH_NOW
call_to_action_url
必須

CTAボタンがクリックされたときにリダイレクトされるURL。

タイプ: 文字列

例: https://www.twitter.com
line_item_id
必須

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

タイプ: 文字列

例: 8v53k

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_id=8v53k&call_to_action=VISIT_SITE&call_to_action_url=https://www.twitter.com

応答の例

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.twitter.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8v53k",
      "call_to_action": "VISIT_SITE",
      "call_to_action_url": "https://www.twitter.com",
      "account_id": "18ce54d4x5t"
    }
  }
}

PUT accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

PREROLL_VIEWS行項目の任意のアクション誘導（CTA）を更新します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
preroll_call_to_action_id
必須

リクエスト内で操作するプレロールのCTAへの参照。

タイプ: 文字列

例: 8f0
call_to_action
任意

広告内に表示されるボタンのCTAテキスト。

タイプ: 列挙

使用可能な値: GO_TO、SEE_MORE、SHOP、VISIT_SITE、WATCH_NOW
call_to_action_url
任意

CTAボタンがクリックされたときにリダイレクトされるURL。

タイプ: 文字列

例: https://www.twitter.com

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/preroll_call_to_actions/8f0?call_to_action=WATCH_NOW

応答の例

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.twitter.com",
    "call_to_action": "WATCH_NOW",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-09-09T05:51:26Z",
    "deleted": false
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "call_to_action": "WATCH_NOW",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

現在のアカウントに属する、指定されたプレロールのアクション誘導（CTA）を削除します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
preroll_call_to_action_id
必須

リクエスト内で操作するプレロールのCTAへの参照。

タイプ: 文字列

例: 8f0

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/preroll_call_to_actions/8f0

応答の例

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.twitter.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-08-30T06:08:21Z",
    "deleted": true
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  }
}