Lingxing
切换旧版

SB广告创意

POST/pb/openapi/newad/hsaProductAds

接口信息

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

请求参数

参数名说明必填类型示例
sid店铺id是[int]9013
profile_idVC广告店铺profile_id，对应查询广告账号列表接口对应字段【profile_id】，sid跟profile_id其中一个必填是[int]123456
offset分页偏移量，默认0否[int]1
length分页长度，默认15否[int]1
next_token分页游标，上次分页结果中的next_token
(第一次分页无需填写，当next_token 和 offset同时存在时以next_token为主		否[string]"MTAx"

返回结果

参数名说明必填类型示例
code状态码，0 成功是[int]0
message提示消息是[string]操作成功
error_details错误信息是[array]
request_id请求链路id是[string]6bb694e1-3d25-4821-8db8-d55dc903f6ba
response_time响应时间是[string]2023-02-17 09:59:19
total总数是[int]1
next_token分页游标，填入下次请求中的next_token是[string]"ODAwMDAwMDAwMDAwMDAyNDE3"
data响应数据是[array]
data>>campaign_id广告活动id是[number]800000000000137200
data>>ad_group_id广告组id是[number]800000000000137700
data>>ad_creative_id广告创意id（亚马逊）是[number]448868552891455
data>>creative_id广告创意id（已作废）是[number]26
data>>name广告创意名称是[string]demo sb ads 2023-02-27 7db7
data>>state广告创意状态：
ENABLED 启用
PAUSED 暂停
ARCHIVED 归档		是[string]enabled
data>>creation_date创建时间是[number]1704643200000
data>>last_updated_date最后一次更新时间是[number]1704643200000
data>>profile_id亚马逊店铺数字id是[number]9000000000000013
data>>serving_status服务状态：
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		是[string]AD_STATUS_LIVE
data>>asin广告创意基础数据中ASIN字段是[array]["B09MT9BKGH","B0BB389BKQ","B09MYZ614S"]
data>>creative广告创意是[json]详见返回成功示例
data>>creative_type广告创意类型是[string]PRODUCT_COLLECTION
data>>landing_page着落页是[json]{"url": null, "asins": ["B085M6Q95G", "B085M76XY1", "B09HZM3HG3"], "pageType": "STORE"}
data>>video_creatives当前广告关联的全部本地广告创意记录，不按创意状态过滤；无关联创意时返回空数组是[array]
data>>video_creatives>>creative_version广告创意版本，不能作为视频素材版本使用是[string]creative-9
data>>video_creatives>>creative_status广告创意状态是[string]DRAFT
data>>video_creatives>>creative_type广告创意类型是[string]VIDEO
data>>video_creatives>>videos当前创意引用的视频素材列表；无视频素材时返回空数组是[array]
data>>video_creatives>>videos>>asset_id视频素材id，保留广告创意中的原始值，可能包含:version_xxx后缀是[string]asset-a:version_v1
data>>video_creatives>>videos>>versions视频素材在本地保存的全部版本，按本地记录id升序返回；未找到素材时返回空数组是[array]
data>>video_creatives>>videos>>versions>>asset_version视频素材版本，按数据库字符串原值返回是[string]2
data>>video_creatives>>videos>>versions>>name本地视频素材名称是[string]商品演示视频
data>>video_creatives>>videos>>versions>>url本地视频素材地址，对应storage_location_urls.defaultUrl；地址缺失或格式异常时返回null是[string]https://example.com/video-2.mp4

返回成功示例 

{
  "code": 0,
  "message": "操作成功",
  "data": [
    {
      "campaign_id": 800000000000137259,
      "ad_group_id": 800000000000137743,
      "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"
}