广告组接口

注意

调用接口需携带身份验证参数 Token,详见 Token 使用说明

请求地址

https://scaler.taurusx.com/openapi/adgroup_info

请求方法

GET

请求参数

字段是否必填字段类型默认值字段说明
campaign_idsstring-Campaign ID,多个用英文逗号 , 分隔
adgroup_idsstring-Adgroup ID,多个用英文逗号 , 分隔
pageint1当前请求页码,需为大于等于 1 的整数
page_sizeint50每页返回数量,最大值为 100

响应字段说明

名称父节点类型描述
code-int200 表示成功,其他表示失败
data-json返回数据主体
data_listdataarray<json>广告组列表
campaign_namedata_liststring推广名称
campaign_iddata_liststringCampaign ID
adgroup_namedata_liststring广告组名称
adgroup_iddata_liststringAdgroup ID
promote_iddata_listint推广产品 ID
promote_namedata_liststring推广产品名称
click_through_urldata_liststring点击跳转链接
budget_totaldata_listnumber总预算,单位为目标币种
budget_dailydata_listnumber每日预算,单位为目标币种
bid_typedata_liststring出价方式:CPI、CPA、ROAS0、ROAS7、ROAS
bid_valuedata_listnumber出价金额,适用于非 CPA 计费方式
bid_cpadata_listjson出价为 CPA 时的结构体
targetingdata_listjson定向配置
regiontargetingarray<string>定向国家或地区,如 ["BR"]
citytargetingarray<string>定向城市,如 ["BR|Roraima"]
languagetargetingarray<string>定向语言,如 ["en"]
ostargetingstring操作系统:AndroidiOS
os_version_mintargetingstring操作系统最小版本,如 11.0
devicetargetingarray<string>设备定向,如 ["iPhone 13"]
networktargetingstring网络类型:"" 表示不限,mobile 表示移动网络,wifi 表示无线网络

响应示例

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"
}