Creative information
You need to use Token, for more details, please check token
Request address
https://scaler.taurusx.com/openapi/creative_info
Request method
GET
Request parameters
Field | Required | Field type | Default value | Field description |
---|---|---|---|---|
campaign_ids | Optional | string | - | Campaign ID. Separate with commas for multiple IDs. |
adgroup_ids | Optional | string | - | Adgroup ID. Separate with commas for multiple IDs. |
creative_ids | Optional | string | - | Creative ID. Separate with commas for multiple IDs. |
page | Required | int | 1 | The current page number of the request, an integer greater than or equal to 1 |
page_size | Required | int | 50 | The number of requests each time, up to 100 |
Note
When you need to return results in batches, you can include the batch-id
field in the request header. The format is a timestamp or MD5 string or other unique string.
Response results
Name | Parent node | Type | Description |
---|---|---|---|
code | int | 200 means success, others mean failure | |
data | json | Result list | |
data_list | data | array<json> | |
campaign_name | data_list | string | Campaign name |
campaign_id | data_list | string | Campaign ID |
adgroup_name | data_list | string | Adgroup name |
adgroup_id | data_list | string | Adgroup ID |
creative_name | data_list | string | Creative name |
creative_id | data_list | string | Creative ID |
ad_type | data_list | string | Creative type:video,image |
info | data_list | json | Creative infomation |
type | info | string | Creative type,image|video |
w | info | int | Creative width |
h | info | int | Creative height |
bit_rate | info | number | Video bitrate, in bits per second. This field is present in video materials. |
duration | info | number | Video duration, in seconds. This field is present in video materials. |
companion | data_list | json | Companion Advertising information |
type | companion | string | Creative type,image |
w | companion | int | Creative width |
h | companion | int | Creative height |
Response example
JSON
{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 138,
"campaign_name": "name",
"adgroup_id": 138,
"adgroup_name": "name",
"creative_id": 138,
"creative_name": "E-commerce promotion",
"ad_type": "video",
"info": {
"type": "video",
"bit_rate": 1521.651,
"duration": 29.68,
"w": 1280,
"h": 720
},
"companion": {
"type": "image",
"w": 704,
"h": 396
}
}
],
"total": 1
},
"msg": "ok"
}
{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 138,
"campaign_name": "name",
"adgroup_id": 138,
"adgroup_name": "name",
"creative_id": 138,
"creative_name": "E-commerce promotion",
"ad_type": "video",
"info": {
"type": "video",
"bit_rate": 1521.651,
"duration": 29.68,
"w": 1280,
"h": 720
},
"companion": {
"type": "image",
"w": 704,
"h": 396
}
}
],
"total": 1
},
"msg": "ok"
}