/pb/openapi/newad/hsaProductAds{
"operation": {
"method": "POST",
"path": "/pb/openapi/newad/hsaProductAds"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 10,
"text": ""
},
"responseExample": {
"code": 0,
"message": "操作成功",
"data": [
{
"campaign_id": 800000000000137200,
"ad_group_id": 800000000000137700,
"ad_creative_id": 448868552891455,
"creative_id": 26,
"name": "demo sb ads 2023-02-27 7db7",
"state": "ENABLED",
"creation_date": 1704643200000,
"last_updated_date": 1704643200000,
"profile_id": 9000000000000013,
"serving_status": "AD_STATUS_LIVE",
"asin": [
"B09MT9BKGH",
"B0BB389BKQ",
"B09MYZ614S"
],
"creative_type": "PRODUCT_COLLECTION",
"creative": {
"type": "PRODUCT_COLLECTION",
"asins": [
"B085M6Q95G",
"B085M76XY1",
"B09HZM3HG3"
],
"headline": "demo34demo34",
"brandName": "demo34demo34",
"brandLogoAssetID": "CQD921XpVdf9WBJSXliI",
"customImageAssetId": null
},
"landing_page": {
"url": null,
"asins": [
"B085M6Q95G",
"B085M76XY1",
"B09HZM3HG3"
],
"pageType": "STORE"
}
}
],
"total": 1,
"next_token": "ODAwMDAwMDAwMDAwMDAyNDE3",
"error_details": [],
"request_id": "6bb694e1-3d25-4821-8db8-d55dc903f6ba",
"response_time": "2024-05-22 15:52:53"
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | sid | 店铺id | int | 9013 | 必填 | 店铺id |
| 2 | profile_id | VC广告店铺profile_id | int | 123456 | 必填 | VC广告店铺profile_id,对应查询广告账号列表接口对应字段【profile_id】,sid跟profile_id其中一个必填 |
| 3 | offset | 分页偏移量 | int | 1 | 可选 | 分页偏移量,默认0 |
| 4 | length | 分页长度 | int | 1 | 可选 | 分页长度,默认15 |
| 5 | next_token | 分页游标 | string | "MTAx" | 可选 | 分页游标,上次分页结果中的next_token (第一次分页无需填写,当next_token 和 offset同时存在时以next_token为主 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | int | 0 | 必填 | 状态码,0 成功 |
| 2 | message | 提示消息 | string | 操作成功 | 必填 | 提示消息 |
| 3 | error_details | 错误信息 | array | — | 必填 | 错误信息 |
| 4 | request_id | 请求链路id | string | 6bb694e1-3d25-4821-8db8-d55dc903f6ba | 必填 | 请求链路id |
| 5 | response_time | 响应时间 | string | 2023-02-17 09:59:19 | 必填 | 响应时间 |
| 6 | total | 总数 | int | 1 | 必填 | 总数 |
| 7 | next_token | 分页游标 | string | "ODAwMDAwMDAwMDAwMDAyNDE3" | 必填 | 分页游标,填入下次请求中的next_token |
| 8 | data | 响应数据 | array | — | 必填 | 响应数据 |
| 8.1 | campaign_id | 广告活动id | number | 800000000000137200 | 必填 | 广告活动id |
| 8.2 | ad_group_id | 广告组id | number | 800000000000137700 | 必填 | 广告组id |
| 8.3 | ad_creative_id | 广告创意id(亚马逊) | number | 448868552891455 | 必填 | 广告创意id(亚马逊) |
| 8.4 | creative_id | 广告创意id(已作废) | number | 26 | 必填 | 广告创意id(已作废) |
| 8.5 | name | 广告创意名称 | string | demo sb ads 2023-02-27 7db7 | 必填 | 广告创意名称 |
| 8.6 | state | 广告创意状态 | string | enabled | 必填 | 广告创意状态: ENABLED 启用 PAUSED 暂停 ARCHIVED 归档 |
| 8.7 | creation_date | 创建时间 | number | 1704643200000 | 必填 | 创建时间 |
| 8.8 | last_updated_date | 最后一次更新时间 | number | 1704643200000 | 必填 | 最后一次更新时间 |
| 8.9 | profile_id | 亚马逊店铺数字id | number | 9000000000000013 | 必填 | 亚马逊店铺数字id |
| 8.10 | serving_status | 服务状态 | string | AD_STATUS_LIVE | 必填 | 服务状态: AD_POLICING_SUSPENDED INELIGIBLE REJECTED CAMPAIGN_OUT_OF_BUDGET CAMPAIGN_ARCHIVED ADVERTISER_PAYMENT_FAILURE CAMPAIGN_PAUSED AD_STATUS_LIVE PORTFOLIO_OUT_OF_BUDGET AD_GROUP_PAUSED PORTFOLIO_ENDED AD_PAUSED |
| 8.11 | asin | 广告创意基础数据中ASIN字段 | array | ["B09MT9BKGH","B0BB389BKQ","B09MYZ614S"] | 必填 | 广告创意基础数据中ASIN字段 |
| 8.12 | creative | 广告创意 | json | 详见返回成功示例 | 必填 | 广告创意 |
| 8.13 | creative_type | 广告创意类型 | string | PRODUCT_COLLECTION | 必填 | 广告创意类型 |
| 8.14 | landing_page | 着落页 | json | {"url": null, "asins": ["B085M6Q95G", "B085M76XY1", "B09HZM3HG3"], "pageType": "STORE"} | 必填 | 着落页 |
| 8.15 | video_creatives | 当前广告关联的全部本地广告创意记录 | array | — | 必填 | 当前广告关联的全部本地广告创意记录,不按创意状态过滤;无关联创意时返回空数组 |
| 8.15.1 | creative_version | 广告创意版本 | string | creative-9 | 必填 | 广告创意版本,不能作为视频素材版本使用 |
| 8.15.2 | creative_status | 广告创意状态 | string | DRAFT | 必填 | 广告创意状态 |
| 8.15.3 | creative_type | 广告创意类型 | string | VIDEO | 必填 | 广告创意类型 |
| 8.15.4 | videos | 当前创意引用的视频素材列表 | array | — | 必填 | 当前创意引用的视频素材列表;无视频素材时返回空数组 |
| 8.15.4.1 | asset_id | 视频素材id | string | asset-a:version_v1 | 必填 | 视频素材id,保留广告创意中的原始值,可能包含:version_xxx后缀 |
| 8.15.4.2 | versions | 视频素材在本地保存的全部版本 | array | — | 必填 | 视频素材在本地保存的全部版本,按本地记录id升序返回;未找到素材时返回空数组 |
| 8.15.4.2.1 | asset_version | 视频素材版本 | string | 2 | 必填 | 视频素材版本,按数据库字符串原值返回 |
| 8.15.4.2.2 | name | 本地视频素材名称 | string | 商品演示视频 | 必填 | 本地视频素材名称 |
| 8.15.4.2.3 | url | 本地视频素材地址 | string | https://example.com/video-2.mp4 | 必填 | 本地视频素材地址,对应storage_location_urls.defaultUrl;地址缺失或格式异常时返回null |
领星ERP的接口:SB广告创意(/pb/openapi/newad/hsaProductAds),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。