Creatives
Image App Download Cards¶
Note: card_uri
is replacing preview_url
. This moves
associating a card with a Tweet from the Tweet text to a Tweet parameter. To
associate a card with a Tweet, use the card_uri
parameter with either the
POST accounts/:account_id/tweet, POST statuses/update, or
POST accounts/:account_id/scheduled_tweets endpoints. This allows users to
use more characters in their Tweets.
GET accounts/:account_id/cards/image_app_download¶
Retrieve details for some or all image app download cards associated with the current account.
This card is part of our Mobile App Promotion product suite.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/image_app_download
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_ids
optional
|
Scope the response to just the desired image app download cards by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided. Type: string Example: |
count
optional
|
Specifies the number of records to try and retrieve per distinct request. Type: int Default:
200 Min, Max:
1 , 1000 |
cursor
optional
|
Specifies a cursor to get the next page of results. See Pagination for more information. Type: string Example: |
q
optional
|
An optional query to scope cards by Type: string Example: |
sort_by
optional
|
Sorts by supported attribute in ascending or descending order. See Sorting for more information. Type: string Example: |
with_deleted
optional
|
Include deleted results in your request. Type: boolean Default:
false Possible values:
true , false |
with_total_count
optional
|
Include the Note: This parameter will be ignored if Note: Requests which include Type: boolean Default:
false Possible values:
true , false |
Example Request¶
GET https://ads-api.twitter.com/4/accounts/18ce54d4x5t/cards/image_app_download?card_ids=59wiu
Example Response¶
{
"request": {
"params": {
"card_type": "image_app_download",
"card_ids": [
"59wiu"
],
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"name": "image app download card",
"googleplay_app_id": "com.twitter.android",
"image_display_height": "418",
"preview_url": null,
"id": "59wiu",
"account_id": "18ce54d4x5t",
"country_code": "US",
"wide_app_image": "https://pbs.twimg.com/media/DOxqHTWV4AAL7Bk.jpg",
"created_at": "2018-01-27T00:40:39Z",
"image_display_width": "800",
"card_uri": "card://957050688416112640",
"updated_at": "2018-01-27T00:40:39Z",
"app_cta": "INSTALL",
"deleted": false,
"card_type": "IMAGE_APP_DOWNLOAD"
}
]
}
GET accounts/:account_id/cards/image_app_download/:card_id¶
Retrieve a specific image app download card associated with the current account.
This card is part of our Mobile App Promotion product suite.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/image_app_download/: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 image app download 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/image_app_download/59wiu
Example Response¶
{
"request": {
"params": {
"card_type": "image_app_download",
"card_id": "59wiu",
"account_id": "18ce54d4x5t"
}
},
"data": {
"name": "image app download card",
"googleplay_app_id": "com.twitter.android",
"image_display_height": "418",
"preview_url": null,
"id": "59wiu",
"account_id": "18ce54d4x5t",
"country_code": "US",
"wide_app_image": "https://pbs.twimg.com/media/DOxqHTWV4AAL7Bk.jpg",
"created_at": "2018-01-27T00:40:39Z",
"image_display_width": "800",
"card_uri": "card://957050688416112640",
"updated_at": "2018-01-27T00:40:39Z",
"app_cta": "INSTALL",
"deleted": false,
"card_type": "IMAGE_APP_DOWNLOAD"
}
}
POST accounts/:account_id/cards/image_app_download¶
Create a new image app download card associated with the current account.
This card is part of our Mobile App Promotion product suite.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/image_app_download
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: |
name
required
|
The name for the card. Type: string Example: |
country_code
required
|
The two-letter ISO code for the country where the app is sold. Type: string Example: |
ipad_app_id
sometimes required
|
The iPad app ID. Note: At least one of following is required: Note: When not specified, this will be set to to the Note: This can be retrieved from the Apple App Store URL. Type: long Example: |
iphone_app_id
sometimes required
|
The iPhone app ID. Note: At least one of following is required: Note: This can be retrieved from the Apple App Store URL. Type: long Example: |
googleplay_app_id
sometimes required
|
The Google Play application package name. Note: At least one of following is required: Type: string Example: |
app_cta
optional
|
The Call-To-Action (CTA) text for the card button. Type: enum Possible values: |
ipad_deep_link
optional
|
A deep link into the iPad app you’re promoting. Note: Can only be used if an Note: When not specified, this will be set to to the Type: string |
iphone_deep_link
optional
|
A deep link into the iPhone app you’re promoting. Note: Can only be used if an Type: string |
googleplay_deep_link
optional
|
A deep link into the Android app you’re promoting. Note: Can only be used if a Type: string |
wide_app_image_media_id
sometimes required
|
A This is a write-only field. In the response, the API will provide a Twitter URL for this image. Note: Required if Note: A minimum image width of 800px and a width:height aspect ratio of either 1:1 or 1.91:1 is required. Type: long Example: |
wide_app_image_media_key
sometimes required
|
A This is a write-only field. In the response, the API will provide a Twitter URL for this image. Note: The image must be in the account’s media library. Note: Required if Note: A minimum image width of 800px and a width:height aspect ratio of either 1:1 or 1.91:1 is required. Type: string Example: |
Example Request¶
POST https://ads-api.twitter.com/3/accounts/18ce54d4x5t/cards/image_app_download?wide_app_image_media_key=3_931235896644460544&name=image app download card&country_code=US&googleplay_app_id=com.twitter.android
Example Response¶
{
"data": {
"name": "image app download card",
"googleplay_app_id": "com.twitter.android",
"image_display_height": "418",
"preview_url": null,
"id": "59wiu",
"account_id": "18ce54d4x5t",
"country_code": "US",
"wide_app_image": "https://pbs.twimg.com/media/DOxqHTWV4AAL7Bk.jpg",
"created_at": "2018-01-27T00:40:39Z",
"image_display_width": "800",
"card_uri": "card://957050688416112640",
"updated_at": "2018-01-27T00:40:39Z",
"app_cta": "INSTALL",
"deleted": false,
"card_type": "IMAGE_APP_DOWNLOAD"
},
"request": {
"params": {
"wide_app_image_media_key": "3_931235896644460544",
"name": "image app download card",
"googleplay_app_id": "com.twitter.android",
"image_display_height": "418",
"account_id": "18ce54d4x5t",
"country_code": "US",
"wide_app_image": "https://pbs.twimg.com/media/DOxqHTWV4AAL7Bk.jpg",
"image_display_width": "800",
"app_cta": "INSTALL",
"card_type": "IMAGE_APP_DOWNLOAD"
}
}
}
PUT accounts/:account_id/cards/image_app_download/:card_id¶
Update the specified image app download card belonging to the current account.
This card is part of our Mobile App Promotion product suite.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/image_app_download/: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 image app download card you are operating with in the request. Type: string Example: |
country_code
optional
|
The two-letter ISO code for the country where the app is sold. Type: string Example: |
app_cta
optional
|
The Call-To-Action (CTA) text for the card button. Type: enum Possible values: |
ipad_app_id
optional
|
The iPad app ID. Note: At least one of following is required: Note: When the Note: This can be retrieved from the Apple App Store URL. Type: long Example: |
ipad_deep_link
optional
|
A deep link into the iPad app you’re promoting. Note: Can only be used if an Note: When the Type: string |
iphone_app_id
optional
|
The iPhone app ID. Note: At least one of following is required: Note: This can be retrieved from the Apple App Store URL. Type: long Example: |
iphone_deep_link
optional
|
A deep link into the iPhone app you’re promoting. Note: Can only be used if an Type: string |
googleplay_app_id
optional
|
The Google Play application package name. Note: At least one of following is required: Type: string Example: |
googleplay_deep_link
optional
|
A deep link into the Android app you’re promoting. Note: Can only be used if a Type: string |
name
optional
|
The name for the card. Type: string Example: |
wide_app_image_media_id
optional
|
A This is a write-only field. In the response, the API will provide a Twitter URL for this image. Note: A minimum image width of 800px and a width:height aspect ratio of either 1:1 or 1.91:1 is required. Type: long Example: |
wide_app_image_media_key
optional
|
A This is a write-only field. In the response, the API will provide a Twitter URL for this image. Note: The image must be in the account’s media library. Note: A minimum image width of 800px and a width:height aspect ratio of either 1:1 or 1.91:1 is required. Type: string Example: |
Example Request¶
PUT https://ads-api.twitter.com/4/accounts/18ce54d4x5t/cards/image_app_download/59wiu?wide_app_image_media_key=3_917438348871983104
Example Response¶
{
"data": {
"name": "image app download card",
"image_display_height": "418",
"preview_url": null,
"id": "59wiu",
"account_id": "18ce54d4x5t",
"wide_app_image": "https://pbs.twimg.com/media/DLtlUUfV4AArIgW.jpg",
"created_at": "2018-01-27T00:40:39Z",
"image_display_width": "800",
"card_uri": "card://957050688416112640",
"updated_at": "2018-01-27T00:40:39Z",
"app_cta": "INSTALL",
"deleted": false,
"card_type": "IMAGE_APP_DOWNLOAD"
},
"request": {
"params": {
"wide_app_image_media_key": "3_917438348871983104",
"image_display_height": "418",
"account_id": "18ce54d4x5t",
"card_id": "59wiu",
"wide_app_image": "https://pbs.twimg.com/media/DLtlUUfV4AArIgW.jpg",
"image_display_width": "800",
"card_type": "IMAGE_APP_DOWNLOAD"
}
}
}
DELETE accounts/:account_id/cards/image_app_download/:card_id¶
Permanently delete the specified image app download card belonging to the current account.
Note: This is a hard delete. As a result, it is not possible to retrieve deleted cards.
This card is part of our Mobile App Promotion product suite.
Resource URL¶
https://ads-api.twitter.com/4/accounts/:account_id/cards/image_app_download/: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 image app download card you are operating with in the request. Type: string Example: |
Example Request¶
DELETE https://ads-api.twitter.com/4/accounts/18ce54d4x5t/cards/image_app_download/4ca39
Example Response¶
{
"data": {
"name": "img",
"id": "4ca39",
"account_id": "18ce54d4x5t",
"created_at": "2017-06-08T05:18:03Z",
"updated_at": "2017-08-23T13:20:04Z",
"deleted": true,
"card_type": "IMAGE_APP_DOWNLOAD"
},
"request": {
"params": {
"card_id": "4ca39",
"card_type": "image_app_download",
"account_id": "18ce54d4x5t"
}
}
}