素材

视频应用下载卡片

在 Postman 中运行 ❯

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

GET accounts/:account_id/cards/video_app_download

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

此卡片属于我们的移动应用推广产品套装内容。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_ids
可选

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

类型：string

示例：5a4z3
count
可选

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

类型：int

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

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

类型：string

示例：8x7v00oow
q
可选

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

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

类型：string

示例：twitter
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_app_download?card_ids=5a4z3

响应示例

{
  "request": {
    "params": {
      "card_type": "video_app_download",
      "card_ids": [
        "5a4z3"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video app download",
      "googleplay_app_id": "com.twitter.android",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958231855240589313",
      "id": "5a4z3",
      "country_code": "US",
      "created_at": "2018-01-30T07:00:24Z",
      "card_uri": "card://958233417929261056",
      "updated_at": "2018-01-30T07:00:24Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
      "app_cta": "INSTALL",
      "deleted": false,
      "card_type": "VIDEO_APP_DOWNLOAD"
    }
  ]
}

GET accounts/:account_id/cards/video_app_download/:card_id

检索与当前账号关联的特定视频应用下载卡片。

此卡片属于我们的移动应用推广产品套装内容。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：5a4z3
with_deleted
可选

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

类型：boolean

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

请求示例

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

响应示例

{
  "request": {
    "params": {
      "card_type": "video_app_download",
      "card_id": "5a4z3",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video app download",
    "googleplay_app_id": "com.twitter.android",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "country_code": "US",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:00:24Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "INSTALL",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  }
}

POST accounts/:account_id/cards/video_app_download

创建与当前账号关联的新视频应用下载卡片。

此卡片属于我们的移动应用推广产品套装内容。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
country_code
必需

出售应用的国家/地区 ISO 代码，长度为两个字母。

类型：string

示例：US
media_key
必需

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

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

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

类型：string

示例：13_1168079965037467209
name
必需

卡片名称。

类型：string

示例：video app download card
ipad_app_id
有时为必需

iPad 应用 ID。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

注意：未指定时，将设置为 iphone_app_id 值（如提供）。

注意：此参数可从 Apple App Store URL 检索。

类型：long

示例：333903271
iphone_app_id
有时为必需

iPhone 应用 ID。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

注意：此参数可从 Apple App Store URL 检索。

类型：long

示例：333903271
googleplay_app_id
有时为必需

Google Play 应用程序包名称。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

类型：string

示例：com.twitter.android
app_cta
可选

卡片按钮的行动号召 (CTA) 文本。

类型：enum

可能值：BOOK、CONNECT、INSTALL、OPEN、ORDER、PLAY、SHOP
ipad_deep_link
可选

正在推广的 iPad 应用的深层链接。

注意：仅可在已提供 ipad_app_id 时使用。

注意：未指定时，将设置为 iphone_deep_link 值（如提供）。

类型：string
iphone_deep_link
可选

正在推广的 iPhone 应用的深层链接。

注意：仅可在已提供 iphone_app_id 时使用。

类型：string
googleplay_deep_link
可选

正在推广的 Android 应用的深层链接。

注意：仅可在已提供 googleplay_app_id 时使用。

类型：string
poster_media_key
可选

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

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

类型：long

示例：3_882726458191298561

请求示例

POST https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_app_download?country_code=US&name=video app download&media_key=13_958231855240589313&googleplay_app_id=com.twitter.android

响应示例

{
  "data": {
    "name": "video app download",
    "googleplay_app_id": "com.twitter.android",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "country_code": "US",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:00:24Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "INSTALL",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "name": "video app download",
      "googleplay_app_id": "com.twitter.android",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
      "video_stream_content_type": "video/mp4; codecs="avc1.42E01E, mp4a.40.2"",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958231855240589313",
      "account_id": "18ce54d4x5t",
      "country_code": "US",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
      "app_cta": "INSTALL",
      "card_type": "VIDEO_APP_DOWNLOAD"
    }
  }
}

PUT accounts/:account_id/cards/video_app_download/:card_id

更新属于当前账号的指定视频应用下载卡片。

此卡片属于我们的移动应用推广产品套装内容。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：5a4z3
country_code
可选

出售应用的国家/地区 ISO 代码，长度为两个字母。

类型：string

示例：US
app_cta
可选

卡片按钮的行动号召 (CTA) 文本。

类型：enum

可能值：BOOK、CONNECT、INSTALL、OPEN、ORDER、PLAY、SHOP
ipad_app_id
可选

iPad 应用 ID。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

注意：iphone_app_id 已指定，而此参数未指定时，将设置 iPhone 应用值。

注意：此参数可从 Apple App Store URL 检索。

类型：long

示例：333903271
ipad_deep_link
可选

正在推广的 iPad 应用的深层链接。

注意：仅可在已提供 ipad_app_id 时使用。

注意：iphone_deep_link 已指定，而此参数未指定时，将设置 iPhone 深度链接值。

类型：string
iphone_app_id
可选

iPhone 应用 ID。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

注意：此参数可从 Apple App Store URL 检索。

类型：long

示例：333903271
iphone_deep_link
可选

正在推广的 iPhone 应用的深层链接。

注意：仅可在已提供 iphone_app_id 时使用。

类型：string
googleplay_app_id
可选

Google Play 应用程序包名称。

注意：必须填写以下值之一：ipad_app_id、iphone_app_id 或 googleplay_app_id。

类型：string

示例：com.twitter.android
googleplay_deep_link
可选

正在推广的 Android 应用的深层链接。

注意：仅可在已提供 googleplay_app_id 时使用。

类型：string
media_key
可选

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

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

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

类型：string

示例：13_1168079965037467209
name
可选

卡片名称。

类型：string

示例：aerial card
poster_media_key
可选

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

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

类型：long

示例：3_882726458191298561

请求示例

PUT https://ads-api.twitter.com/10/accounts/18ce54d4x5t/cards/video_app_download/5a4z3?name=aerial card

响应示例

{
  "data": {
    "name": "aerial card",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958231855240589313.vmap",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958231855240589313",
    "id": "5a4z3",
    "created_at": "2018-01-30T07:00:24Z",
    "card_uri": "card://958233417929261056",
    "updated_at": "2018-01-30T07:32:00Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958231855240589313/img/rjhswYG084qYYgF6.jpg",
    "app_cta": "install",
    "deleted": false,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_APP_DOWNLOAD",
      "card_id": "5a4z3",
      "name": "aerial card"
    }
  }
}

DELETE accounts/:account_id/cards/video_app_download/:card_id

永久删除属于当前账号的指定视频应用下载卡片。

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

此卡片属于我们的移动应用推广产品套装内容。

资源 URL

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

参数

名称 说明
account_id
必需

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

类型：string

示例：18ce54d4x5t
card_id
必需

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

类型：string

示例：4hug6

请求示例

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

响应示例

{
  "data": {
    "name": "video app download",
    "id": "4hug6",
    "created_at": "2017-07-05T23:01:42Z",
    "updated_at": "2017-08-23T13:21:40Z",
    "deleted": true,
    "card_type": "VIDEO_APP_DOWNLOAD"
  },
  "request": {
    "params": {
      "card_id": "4hug6",
      "card_type": "video_app_download",
      "account_id": "18ce54d4x5t"
    }
  }
}