素材

视频私信卡片

在 Postman 中运行 ❯

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

GET accounts/:account_id/cards/video_direct_message

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

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_ids
可选

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

类型：string

示例：5a8av
count
可选

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

类型：int

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

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

类型：string

示例：8x7v00oow
q
可选

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

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

类型：string

示例：aerial
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_direct_message?card_ids=5a8av

响应示例

{
  "request": {
    "params": {
      "card_type": "video_direct_message",
      "card_ids": [
        "5a8av"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video direct message card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
      "recipient_user_id": "756201191646691328",
      "video_owner_id": "756201191646691328",
      "media_key": "13_953023103654797312",
      "id": "5a8av",
      "created_at": "2018-01-30T18:18:00Z",
      "card_uri": "card://958403939703054336",
      "updated_at": "2018-01-30T18:18:00Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
      "deleted": false,
      "card_type": "VIDEO_DIRECT_MESSAGE"
    }
  ]
}

GET accounts/:account_id/cards/video_direct_message/:card_id

检索属于当前账号的特定视频私信卡片。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：5a8av
with_deleted
可选

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

类型：boolean

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

请求示例

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

响应示例

{
  "request": {
    "params": {
      "card_type": "video_direct_message",
      "card_id": "5a8av",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video direct message card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:18:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  }
}

POST accounts/:account_id/cards/video_direct_message

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

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
first_cta
必需

第一个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：DM me
first_cta_welcome_message_id
必需

要与第一个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：865707372148174852
media_key
必需

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

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

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

类型：string

示例：13_1168079965037467209
name
必需

卡片名称。

类型：string

示例：video direct message card
recipient_user_id
必需

从与卡片交互的用户角度来看，与其启动对话的用户。

注意：此参数所指用户必须是指定欢迎私信的拥有者。

类型：long

示例：756201191646691328
poster_media_key
可选

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

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

类型：long

示例：3_882726458191298561
second_cta
可选

第二个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Browse Moments
second_cta_welcome_message_id
可选

要与二个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：905953936925695848
third_cta
可选

第三个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Play a bot song
third_cta_welcome_message_id
可选

要与第三个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：933237054790401013
fourth_cta
可选

第四个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Play Twitter Trivia
fourth_cta_welcome_message_id
可选

要与第四个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：929280268839051451

请求示例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_direct_message?first_cta=DM me&first_cta_welcome_message_id=865707372148174852&name=video direct message card&recipient_user_id=756201191646691328&media_key=13_953023103654797312

响应示例

{
  "data": {
    "name": "video direct message card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:18:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "video direct message card",
      "first_cta": "DM me",
      "first_cta_welcome_message_id": "865707372148174852",
      "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
      "recipient_user_id": "756201191646691328",
      "video_owner_id": "756201191646691328",
      "media_key": "13_953023103654797312",
      "account_id": "18ce54d4x5t",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_DIRECT_MESSAGE"
    }
  }
}

PUT accounts/:account_id/cards/video_direct_message/:card_id

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

注意：无法更新 recipient_user_id，因为所有欢迎私信必须属于创建 (POST) 请求中指定的用户。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：4zjee
first_cta
可选

第一个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Tell me a joke
first_cta_welcome_message_id
可选

要与第一个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：930384951649221544
second_cta
可选

第二个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Browse Moments
second_cta_welcome_message_id
可选

要与二个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：915193968850536077
third_cta
可选

第三个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Play a bot song
third_cta_welcome_message_id
可选

要与第三个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：908983224974380367
fourth_cta
可选

第四个选项的行动号召 (CTA) 文本。最大长度：20 个字符。

类型：string

示例：Play Twitter Trivia
fourth_cta_welcome_message_id
可选

要与第四个 CTA 关联的欢迎私信 ID。

注意：此欢迎私信必须属 recipient_user_id 中指定的用户拥有。

类型：long

示例：936232223055682535
media_key
可选

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

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

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

类型：string

示例：13_1168079965037467209
name
可选

卡片名称。

类型：string

示例：winter card
poster_media_key
可选

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

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

类型：long

示例：3_882726458191298561

请求示例

PUT https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_direct_message/5a8av?name=winter card

响应示例

{
  "data": {
    "name": "winter card",
    "first_cta": "DM me",
    "first_cta_welcome_message_id": "865707372148174852",
    "media_url": "https://video.twimg.com/amplify_video/vmap/953023103654797312.vmap",
    "recipient_user_id": "756201191646691328",
    "video_owner_id": "756201191646691328",
    "media_key": "13_953023103654797312",
    "id": "5a8av",
    "created_at": "2018-01-30T18:18:00Z",
    "card_uri": "card://958403939703054336",
    "updated_at": "2018-01-30T18:24:54Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/953023103654797312/img/56BNaul3VVrxf9Hw.jpg",
    "deleted": false,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_DIRECT_MESSAGE",
      "card_id": "5a8av",
      "name": "winter card"
    }
  }
}

DELETE accounts/:account_id/cards/video_direct_message/:card_id

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

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

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：4zjee

请求示例

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

响应示例

{
  "data": {
    "name": "video DM card",
    "id": "4zjee",
    "created_at": "2017-11-06T04:35:44Z",
    "updated_at": "2017-11-06T04:43:42Z",
    "deleted": true,
    "card_type": "VIDEO_DIRECT_MESSAGE"
  },
  "request": {
    "params": {
      "card_id": "4zjee",
      "card_type": "video_direct_message",
      "account_id": "18ce54d4x5t"
    }
  }
}