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

FieldRequiredField typeDefault valueField description
campaign_idsOptionalstring-Campaign ID. Separate with commas for multiple IDs.
adgroup_idsOptionalstring-Adgroup ID. Separate with commas for multiple IDs.
pageRequiredint1The current page number of the request, an integer greater than or equal to 1
page_sizeRequiredint50The number of requests each time, up to 100

Response results

NameParent NodeTypeDescription
codeint200 means success, others mean failure
datajsonResult list
data_listdataarray<json>
campaign_namedata_liststringCampaign name
campaign_iddata_liststringCampaign ID
adgroup_namedata_liststringAdgroup name
adgroup_iddata_liststringAdgroup ID
ptomote_iddata_listintPromote product ID
ptomote_namedata_liststringPromote product name
click_through_urldata_liststringClick Through Url
budget_totaldata_listnumberTotal budget
budget_dailydata_listnumberDaily budget
bid_typedata_liststringPricing model,CPI,CPC,CPM,CPA,CPL
bid_valuedata_listnumberBid value, pricing model other than CPA bid
bid_cpadata_listjsonBid value when the pricing model is CPA
targetingdata_listjsontargeting config
regiontargetingarray<string>targeting region
citytargetingarray<string>targeting city
languagetargetingarray<string>targeting language
ostargetingstringtargeting os,Android|IOS
os_version_mintargetingstringminimum version of targeting os
devicetargetingarray<string>targeting device
networktargetingstringtargeting 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"
}