Help centerAd Group API
WARNING
Authentication token is required when calling this API. See Token Usage Guide for details.
Request URL
https://scaler.taurusx.com/openapi/adgroup_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 (,) |
| 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
| Name | Parent | Type | Description |
|---|---|---|---|
| code | - | int | Status code: 200 indicates success, others indicate failure |
| data | - | json | Response data object |
| data_list | data | array<json> | List of ad groups |
| 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 |
| promote_id | data_list | int | Promote product ID |
| promote_name | data_list | string | Promote product name |
| click_through_url | data_list | string | Click-through URL |
| budget_total | data_list | number | Total budget, in the target currency |
| budget_daily | data_list | number | Daily budget, in the target currency |
| bid_type | data_list | string | Bidding type: CPI, CPA, ROAS0, ROAS7, ROAS |
| bid_value | data_list | number | Bid amount, applicable to non-CPA billing types |
| bid_cpa | data_list | json | CPA bidding structure |
| targeting | data_list | json | Targeting configuration |
| region | targeting | array<string> | Targeted countries or regions, e.g., ["BR"] |
| city | targeting | array<string> | Targeted cities, e.g., ["BR|Roraima"] |
| language | targeting | array<string> | Targeted languages, e.g., ["en"] |
| os | targeting | string | Operating system: Android or iOS |
| os_version_min | targeting | string | Minimum OS version, e.g., 11.0 |
| device | targeting | array<string> | Targeted devices, e.g., ["iPhone 13"] |
| network | targeting | string | Network type: "" (no limit), mobile (mobile network), wifi (Wi-Fi) |
Example Response
json
{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 1,
"campaign_name": "test name",
"adgroup_id": 138,
"adgroup_name": "name",
"promote_id": 1,
"promote_name": "name",
"click_through_url": "",
"budget_total": 100,
"budget_daily": 100,
"bid_type": "CPI",
"bid_value": 1,
"bid_cpa": {},
"targeting": {
"region": ["BR"],
"city": ["BR|Roraima", "BR|Goias"],
"language": ["en"],
"os": "Android",
"os_version_min": "11.0",
"device": ["Xiaomi 11i HyperCharge", "Cellacom"],
"network": ""
}
}
],
"total": 1
},
"msg": "ok"
}{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 1,
"campaign_name": "test name",
"adgroup_id": 138,
"adgroup_name": "name",
"promote_id": 1,
"promote_name": "name",
"click_through_url": "",
"budget_total": 100,
"budget_daily": 100,
"bid_type": "CPI",
"bid_value": 1,
"bid_cpa": {},
"targeting": {
"region": ["BR"],
"city": ["BR|Roraima", "BR|Goias"],
"language": ["en"],
"os": "Android",
"os_version_min": "11.0",
"device": ["Xiaomi 11i HyperCharge", "Cellacom"],
"network": ""
}
}
],
"total": 1
},
"msg": "ok"
}