AdGroup infomation
You need to use Token, for more details, please check token
Request address
https://scaler.taurusx.com/openapi/adgroup_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. |
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 |
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 |
ptomote_id | data_list | int | Promote product ID |
ptomote_name | data_list | string | Promote product name |
click_through_url | data_list | string | Click Through Url |
budget_total | data_list | number | Total budget |
budget_daily | data_list | number | Daily budget |
bid_type | data_list | string | Pricing model,CPI,CPC,CPM,CPA,CPL |
bid_value | data_list | number | Bid value, pricing model other than CPA bid |
bid_cpa | data_list | json | Bid value when the pricing model is CPA |
targeting | data_list | json | targeting config |
region | targeting | array<string> | targeting region |
city | targeting | array<string> | targeting city |
language | targeting | array<string> | targeting language |
os | targeting | string | targeting os,Android|IOS |
os_version_min | targeting | string | minimum version of targeting os |
device | targeting | array<string> | targeting device |
network | targeting | string | targeting network,""|mobile|wifi,empty value "" means unlimited |
Response example
JSON
{
"code": 200,
"data": {
"data_list": [
{
"campaign_id": 1,
"campaign_name": "test name",
"adgroup_id": 138,
"adgroup_name": "name",
"promote_id": 1,
"ptomote_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,
"ptomote_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"
}