Help centerCreative API
WARNING
Authentication token is required when calling this API. See Token Usage Guide for details.
Request URL
https://scaler.taurusx.com/openapi/creative_info
Request Method
GET
Request Parameters
| Field | Required | Type | Default | Description |
|---|---|---|---|---|
| campaign_ids | No | string | - | Campaign IDs, separated by commas (,) |
| adgroup_ids | No | string | - | Ad Group IDs, separated by commas (,) |
| creative_ids | No | string | - | Creative IDs, separated by commas (,) |
| page | Yes | int | 1 | Page number, must be an integer ≥ 1 |
| page_size | Yes | int | 50 | Number of results per page, maximum value is 100 |
Note:
To handle results in batches, you can include a batch-id field in the request header. It can be any unique string such as a timestamp or an MD5 hash.
Response Field Description
| Name | Parent | Type | Description |
|---|---|---|---|
| code | - | int | 200 indicates success; other values indicate failure |
| data | - | json | Result object |
| data_list | data | array<json> | List of creatives |
| campaign_name | data_list | string | Campaign name |
| campaign_id | data_list | string | Campaign ID |
| adgroup_name | data_list | string | Ad Group name |
| adgroup_id | data_list | string | Ad Group ID |
| creative_name | data_list | string | Creative name |
| creative_id | data_list | string | Creative ID |
| ad_type | data_list | string | Creative type: video or image |
| info | data_list | json | Creative asset information |
| type | info | string | Asset type: image or video |
| w | info | int | Asset width |
| h | info | int | Asset height |
| bit_rate | info | number | Video bitrate (only for video creatives) |
| duration | info | number | Video duration in seconds (only for video creatives) |
| companion | data_list | json | Companion ad information |
| type | companion | string | Asset type: image |
| w | companion | int | Asset width |
| h | companion | int | Asset height |
Example Response
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 Promo",
"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 Promo",
"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"
}