Creatives
Cards Fetch
GET accounts/:account_id/cards¶
Retrieve a specific card, by card_uri
, associated with the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
card_uri required |
A card URI reference to the card you are operating with in the request. Type: string Example: |
with_deleted optional |
Include deleted results in your request. Type: boolean Default: false Possible values: true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/cards?card_uri=card://928910245920829440
Example Response¶
{
"request": {
"params": {
"card_uri": "card://928910245920829440",
"account_id": "18ce54d4x5t"
}
},
"data": {
"video_poster_height": "9",
"name": "video website card",
"video_height": "9",
"video_url": "https://video.twimg.com/amplify_video/vmap/867520357225418752.vmap",
"content_duration_seconds": "21",
"video_owner_id": "756201191646691328",
"video_content_id": "13_867520357225418752",
"preview_url": null,
"website_display_url": "developer.twitter.com",
"id": "508pf",
"account_id": "18ce54d4x5t",
"video_width": "16",
"video_hls_url": "https://video.twimg.com/amplify_video/867520357225418752/pl/TPHeH5ZlHFCa2TeJ.m3u8",
"website_dest_url": "https://developer.twitter.com/en/docs/ads/creatives/api-reference/video-website#post-accounts-account-id-cards-video-website",
"created_at": "2017-11-10T09:00:35Z",
"card_uri": "card://928910245920829440",
"title": "VWC",
"website_url": "https://t.co/F81hp59pUF",
"updated_at": "2018-01-05T05:43:31Z",
"video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/867520357225418752/img/E3pnXM0sCKnRsFih.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
}
}
GET accounts/:account_id/cards/all/:card_id¶
Retrieve a specific card, by card_id
, associated with the current account.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/all/:card_id
Parameters¶
Name | Description |
---|---|
account_id required |
The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: |
card_id required |
A reference to the card you are operating with in the request. Type: string Example: |
with_deleted optional |
Include deleted results in your request. Type: boolean Default: false Possible values: true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/cards/all/508pf
Example Response¶
{
"request": {
"params": {
"card_id": "508pf",
"account_id": "18ce54d4x5t"
}
},
"data": {
"video_poster_height": "9",
"name": "video website card",
"video_height": "9",
"video_url": "https://video.twimg.com/amplify_video/vmap/867520357225418752.vmap",
"content_duration_seconds": "21",
"video_owner_id": "756201191646691328",
"video_content_id": "13_867520357225418752",
"preview_url": null,
"website_display_url": "developer.twitter.com",
"id": "508pf",
"account_id": "18ce54d4x5t",
"video_width": "16",
"video_hls_url": "https://video.twimg.com/amplify_video/867520357225418752/pl/TPHeH5ZlHFCa2TeJ.m3u8",
"website_dest_url": "https://developer.twitter.com/en/docs/ads/creatives/api-reference/video-website#post-accounts-account-id-cards-video-website",
"created_at": "2017-11-10T09:00:35Z",
"card_uri": "card://928910245920829440",
"title": "VWC",
"website_url": "https://t.co/F81hp59pUF",
"updated_at": "2018-01-05T05:43:31Z",
"video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/867520357225418752/img/E3pnXM0sCKnRsFih.jpg",
"video_poster_width": "16",
"deleted": false,
"card_type": "VIDEO_WEBSITE"
}
}