Lingxing
切换旧版

SB广告组

POST/pb/openapi/newad/hsaAdGroups

接口信息

API Path请求协议请求方式令牌桶容量
/pb/openapi/newad/hsaAdGroupsHTTPSPOST10

请求头

标签必填说明类型示例
X-API-VERSION是【兼容旧版本】不加此头部标签,offset 为分页页码,从1开始;值为 2 时,表示 offset 为分页偏移量,从0开始[int]2

请求参数

sidinteger必填
店铺id ,对应查询亚马逊店铺列表接口对应字段【sid】
profile_idinteger必填
VC广告店铺profile_id,对应查询广告账号列表接口对应字段【profile_id】,sid跟profile_id其中一个必填
statestring
状态:状态:【不传默认为所有】
enabled
paused
archived
offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认15
next_tokenstring
分页游标,上次分页结果中的next_token
(第一次分页无需填写,当next_token 和 offset同时存在时以next_token为主

返回结果

Json Object

codeinteger必填
状态码,0 成功
示例 0
messagestring必填
消息提示
示例 操作成功
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 d02f8062-36c0-45f4-9aa8-32d295389b36
response_timestring必填
响应时间
示例 2023-05-09 16:38:06
totalinteger必填
总数
示例 740
next_tokenstring必填
分页游标,填入下次请求中的next_token
示例 "ODAwMDAwMDAwMDAwMDAyNDE3"
dataarray<object>必填
响应数据
隐藏子属性
campaign_idnumber必填
广告活动id
示例 57765830151100
ad_group_idnumber必填
广告组id
示例 800000000000080800
namestring必填
名称
示例 test0331
statestring必填
状态
示例 enabled
creation_datenumber必填
创建时间
示例 1655548464
last_updated_datenumber必填
最后一次更新时间
示例 1655548467
profile_idnumber必填
亚马逊店铺数字id
示例 121923590660074
serving_statusstring必填
服务状态
示例 CAMPAIGN_PAUSED

返回成功示例

{
    "code": 0,
    "message": "操作成功",
    "error_details": [],
    "request_id": "d02f8062-36c0-45f4-9aa8-32d295389b36",
    "response_time": "2023-05-09 16:38:06",
    "total": 1,
    "next_token": "ODAwMDAwMDAwMDAwMDAyNDE3",
    "data": [
        {
            "profile_id": 121923590660074,
            "campaign_id": 1640591439,
            "ad_group_id": 21640591440,
            "name": null,
            "state": null,
            "creation_date": 0,
            "last_updated_date": 0,
            "serving_status": null
        }
    ]
}