素材

视频对话卡片

在 Postman 中运行 ❯

注意：要将卡片关联到推文，请通过 POST accounts/:account_id/tweet、POST statuses/update 或 POST accounts/:account_id/scheduled_tweets 端点，使用 card_uri 参数来完成。

GET accounts/:account_id/cards/video_conversation

检索与当前账号关联的部分或所有视频对话卡片详细信息。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_ids
可选

通过指定以逗号分隔的标识符列表，将响应范围限定至所需的视频对话卡片。最多可提供 200 个 ID。

类型：string

示例：5a86h
count
可选

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

类型：int

默认值：200
最小值、最大值：1、1000
cursor
可选

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

类型：string

示例：8x7v00oow
q
可选

可选查询，按 name 指定卡片范围。省略此参数可检索所有卡片。最大长度：80 个字符。

注意：执行不区分大小写的前缀匹配。

类型：string

示例：night sky
sort_by
可选

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

类型：string

示例：created_at-asc
with_deleted
可选

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

类型：boolean

默认值：false
可能值：true、false
with_total_count
可选

包含 total_count 响应属性。

注意：不包含此参数和 cursor。

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

类型：boolean

默认值：false
可能值：true、false

请求示例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_conversation?card_ids=5a86h

响应示例

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_ids": [
        "5a86h"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "id": "5a86h",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "created_at": "2018-01-30T17:53:04Z",
      "card_uri": "card://958397665015775232",
      "title": "Developers",
      "updated_at": "2018-01-30T17:53:04Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "deleted": false,
      "card_type": "VIDEO_CONVERSATION"
    }
  ]
}

GET accounts/:account_id/cards/video_conversation/:card_id

检索与当前账号关联的指定视频对话卡片。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/cards/video_conversation/:card_id

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

请求中对正在操作的视频对话卡片的引用。

类型：string

示例：4i0ya
with_deleted
可选

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

类型：boolean

默认值：false
可能值：true、false

请求示例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_conversation/5a86h

响应示例

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_id": "5a86h",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  }
}

POST accounts/:account_id/cards/video_conversation

创建与指定账号关联的新视频对话卡片。

请参见上传媒体，获取上传图像至我们端点的相关有用信息。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
first_cta
必需

第一个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#APIs
first_cta_tweet
必需

点击第一个 CTA 后要使用的推文文本。

类型：string

示例：Ads API
media_key
必需

在本卡片中使用的视频媒体密钥。

注意：视频必须位于账号的媒体库。

注意：宽高比必须为 16:9。

类型：string

示例：13_1168079965037467209
name
必需

卡片名称。

类型：string

示例：video conversation card
thank_you_text
必需

点击 CTA 后要显示的文本。最大长度：23 个字符。

类型：string

示例：Build it
title
有时为必需

卡片标题，将出现在视频下方和 CTA 上方。最大长度：23 个字符。

类型：string

注意：如果未 (not) 设置 second_cta，则为必需。

示例：Developers
second_cta
有时为必需

第二个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

注意：如果未 (not) 设置 title，则为必需。

示例：#ShareAgain
second_cta_tweet
有时为必需

点击第二个 CTA 后要使用的推文文本。

注意：如果 second_cta 已设置，则为必需。

类型：string

示例：I Heart @AdsAPI Again
poster_media_key
可选

在本卡片中使用的海报图像媒体密钥。如未指定，则使用视频第一帧画面。

注意：视频必须位于账号的媒体库。

类型：long

示例：3_882726458191298561
third_cta
可选

第三个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#ShareMore
third_cta_tweet
有时为必需

点击第三个 CTA 后要使用的推文文本。

类型：string

注意：如果 third_cta 已设置，则为必需。

示例：I Heart @TwitterDev
fourth_cta
可选

第四个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#ShareExtra
fourth_cta_tweet
有时为必需

点击第四个 CTA 后要使用的推文文本。

类型：string

注意：如果 fourth_cta 已设置，则为必需。

示例：I Heart @TwitterDev Again
thank_you_url
可选

要显示的 URL，其中带有感谢的文本。

类型：string

示例：https://example.com/thankyou
unlocked_image_media_key
可选

图像的 media_key，将在立即解锁情景下使用。

此字段为只写字段。在响应中，API 将为此图像提供 Twitter URL。

注意：图像必须位于账号的媒体库。

类型：string

示例：3_883112887618682880
unlocked_video_media_key
可选

GET accounts/:account_id/media_library 端点中视频的标识符，将在立即解锁情景下使用。

类型：string

示例：13_867520357225418752

请求示例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_conversation?first_cta=#APIs&first_cta_tweet=Ads API&name=video conversation card&thank_you_text=Build it&title=Developers&media_key=13_958388276489895936

响应示例

{
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "account_id": "18ce54d4x5t",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "title": "Developers",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_CONVERSATION"
    }
  }
}

PUT accounts/:account_id/cards/video_conversation/:card_id

更新属于当前账号的指定视频对话卡片。

请参见上传媒体，获取上传图像至我们端点的相关有用信息。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/cards/video_conversation/:card_id

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

请求中对正在操作的视频对话卡片的引用。

类型：string

示例：5a86h
first_cta
可选

第一个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#APIs
first_cta_tweet
可选

点击第一个 CTA 后要使用的推文文本。

类型：string

示例：Ads API
second_cta
可选

第二个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

注意：如果未 (not) 设置 title，则为必需。

示例：#ShareAgain
second_cta_tweet
可选

点击第二个 CTA 后要使用的推文文本。

注意：如果 second_cta 已设置，则为必需。

类型：string

示例：I Heart @AdsAPI Again
third_cta
可选

第三个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#ShareMore
third_cta_tweet
可选

点击第三个 CTA 后要使用的推文文本。

类型：string

注意：如果 third_cta 已设置，则为必需。

示例：I Heart @TwitterDev
fourth_cta
可选

第四个选项的行动号召 (CTA) 话题标签。最大长度：20 个字符（# 除外）。

类型：string

示例：#ShareExtra
fourth_cta_tweet
可选

点击第四个 CTA 后要使用的推文文本。

类型：string

注意：如果 fourth_cta 已设置，则为必需。

示例：I Heart @TwitterDev Again
media_key
可选

在本卡片中使用的视频媒体密钥。

注意：视频必须位于账号的媒体库。

注意：宽高比必须为 16:9。

类型：string

示例：13_1168079965037467209
name
可选

卡片名称。

类型：string

示例：developers card
poster_media_key
可选

在本卡片中使用的海报图像媒体密钥。如未指定，则使用视频第一帧画面。

注意：视频必须位于账号的媒体库。

类型：long

示例：3_882726458191298561
thank_you_text
可选

点击 CTA 后要显示的文本。最大长度：23 个字符。

类型：string

示例：Build it
thank_you_url
可选

要显示的 URL，其中带有感谢的文本。

类型：string

示例：https://example.com/thankyou
title
可选

卡片标题，将出现在视频下方和 CTA 上方。最大长度：23 个字符。

类型：string

注意：如果未 (not) 设置 second_cta，则为必需。

示例：Start a conversation
unlocked_image_media_key
可选

图像的 media_key，将在立即解锁情景下使用。

此字段为只写字段。在响应中，API 将为此图像提供 Twitter URL。

注意：图像必须位于账号的媒体库。

类型：string

示例：3_883112887618682880
unlocked_video_media_key
可选

GET accounts/:account_id/media_library 端点中视频的标识符，将在立即解锁情景下使用。

类型：string

示例：13_867520357225418752

请求示例

PUT https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_conversation/5a86h?name=developers card

响应示例

{
  "data": {
    "name": "developers card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T18:02:15Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_CONVERSATION",
      "card_id": "5a86h",
      "name": "developers card"
    }
  }
}

DELETE accounts/:account_id/cards/video_conversation/:card_id

永久删除属于当前账号的指定视频对话卡片。

注意：此操作为硬删除。删除后，将无法恢复删除的卡片。

资源 URL

https://ads-api.twitter.com/10/accounts/:account_id/cards/video_conversation/:card_id

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

请求中对正在操作的视频对话卡片的引用。

类型：string

示例：4i0ya

请求示例

DELETE https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_conversation/4i0ya

响应示例

{
  "data": {
    "name": "video conversation card",
    "id": "4i0ya",
    "created_at": "2017-07-07T01:36:39Z",
    "updated_at": "2017-08-23T13:29:13Z",
    "deleted": true,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0ya",
      "card_type": "video_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}