前置行动号召

GET accounts/:account_id/preroll_call_to_actions

检索与当前账号下行项目关联的部分或所有前置行动号召 (CTA) 详细信息。

资源 URL

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

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

line_item_ids
可选

通过指定以逗号分隔的标识符列表,将响应范围限定为与指定行项目关联的前置 CTA。最多可提供 200 个 ID。

类型:string

示例:8v53k

count
可选

指定每个不同请求尝试检索的记录数量。

类型:int

默认值:200
最小值、最大值:11000
cursor
可选

指定光标以获取下一页结果。参阅分页了解更多信息。

类型:string

示例:8x7v00oow

preroll_call_to_action_ids
可选

通过指定以逗号分隔的标识符列表,将响应范围限定至所需的前置 CTA。最多可提供 200 个 ID。

类型:string

示例:8f0

sort_by
可选

根据支持的属性,按升序或降序排序。参阅排序了解更多信息。

类型:string

示例:created_at-asc

with_deleted
可选

在请求中包含已删除的结果。

类型:boolean

默认值:false
可能值:truefalse
with_total_count
可选

包含 total_count 响应属性。

注意:不包含此参数和 cursor

注意:包含 total_count 的请求速率限制较低,目前设置为每 15 分钟 200 次。

类型:boolean

默认值:false
可能值:truefalse

请求示例

GET https://ads-api.twitter.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.twitter.com/10/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

preroll_call_to_action_id
必需

请求中对正在操作的前置行动号召的引用。

类型:string

示例:8f0

with_deleted
可选

在请求中包含已删除的结果。

类型:boolean

默认值:false
可能值:truefalse

请求示例

GET https://ads-api.twitter.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.twitter.com/10/accounts/:account_id/preroll_call_to_actions

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

call_to_action
必需

广告内所显示按钮的 CTA 文本。

类型:enum

可能值:GO_TOSEE_MORESHOPVISIT_SITEWATCH_NOW

call_to_action_url
必需

点击 CTA 按钮后,为用户重定向的 URL。

类型:string

示例:https://www.twitter.com

line_item_id
必需

请求中对正在操作的行项目的引用。

类型:string

示例:8v53k

请求示例

POST https://ads-api.twitter.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.twitter.com/10/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

preroll_call_to_action_id
必需

请求中对正在操作的前置 CTA 的引用。

类型:string

示例:8f0

call_to_action
可选

广告内所显示按钮的 CTA 文本。

类型:enum

可能值:GO_TOSEE_MORESHOPVISIT_SITEWATCH_NOW

call_to_action_url
可选

点击 CTA 按钮后,为用户重定向的 URL。

类型:string

示例:https://www.twitter.com

请求示例

PUT https://ads-api.twitter.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.twitter.com/10/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

参数

名称 说明
account_id
必需

所使用账号的标识符。出现在资源路径中,通常是所有广告商 API 请求的必要参数,不包含 GET accounts。指定账号必须与已验证的用户关联。

类型:string

示例:18ce54d4x5t

preroll_call_to_action_id
必需

请求中对正在操作的前置 CTA 的引用。

类型:string

示例:8f0

请求示例

DELETE https://ads-api.twitter.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"
    }
  }
}