Campaign API
WARNING
Authentication token is required when calling this API. See Token Usage Guide for details.
Request URL
https://scaler.taurusx.com/openapi/campaign_info
Request Method
GET
Request Parameters
| Field | Required | Type | Default | Description |
|---|---|---|---|---|
| campaign_ids | No | string | - | Campaign IDs, separated by commas (,) |
| page | Yes | int | 1 | Page number, must be an integer ≥ 1 |
| page_size | Yes | int | 50 | Number of records per page, maximum value is 100 |
Response Field Description
| Field Name | Parent | Type | Description |
|---|---|---|---|
| code | - | int | Status code: 200 indicates success; other values indicate failure |
| data | - | json | Data object |
| data_list | data | array<json> | Array of campaign information |
| campaign_id | data_list | string | Campaign ID |
| campaign_name | data_list | string | Campaign name |
| promote_goal | data_list | string | Promotion goal: APP for App Promotion | WEB for Web Promotion |
| budget_type | data_list | string | Budget type: total (Total Budget) | daily (Daily Budget) | unlimited |
| budget | data_list | number | Budget value; -1 indicates unlimited budget |
Example Response
json
{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 138,
"campaign_name": "E-commerce Promotion",
"promote_goal": "APP",
"budget_type": "total",
"budget": 100
}
],
"total": 1
},
"msg": "ok"
}{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 138,
"campaign_name": "E-commerce Promotion",
"promote_goal": "APP",
"budget_type": "total",
"budget": 100
}
],
"total": 1
},
"msg": "ok"
}