开发人员指南概述

亚马逊广告 API 概览

管理素材

在管理广告活动时,您可能需要创建现有素材的最新版本。

搜索素材

您可以使用 GET /assetsPOST /assets/search 来检索之前创建的素材。

GET /assets

GET /assets 根据 assetId 查询参数返回单个素材。

curl --location 'https://advertising-api.amazon.com/assets?assetId=amzn1.assetlibrary.xxxxxxxxxx' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx'

POST /assets/search

POST /assets/search 可让您按标签、ASIN、广告活动、创建日期、尺寸等搜索所有素材。

要查看与您的配置文件相关的所有素材,请将请求的正文留空。

curl --location 'https://advertising-api.amazon.com/assets/search' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
--header 'Content-Type: text/plain' \
--data '{}'

您也可以按各项条件进行筛选。如果您希望查看所有选项,请参阅 API 参考

curl --location 'https://advertising-api.amazon.com/assets/search' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--data '{
  "filterCriteria": {
    "valueFilters": [
      {
        "values": [
          "IMAGE"
        ],
        "valueField": "ASSET_TYPE"
      }
    ],
    "rangeFilters": [
      {
        "ranges": [
          {
            "start": "1",
            "end": "5000"
          }
        ],
        "rangeField": "SIZE"
      }
    ]
  },
  "sortCriteria": {
    "field": "CREATED_TIME",
    "order": "ASC"
  }
}'

更新素材

素材的每次更新都会生成该素材的最新版本。更新后的素材将具有相同的 assetId,并在末尾附加一个版本。

创建新版本的流程与“创建素材”部分所述的流程大致相同。首先创建上传 URL,然后上传素材。在第三步中,您将在 versionInfo 下指定要更新的素材的 assetId。

注意

上传的文件必须使用与当前版本中的文件名不同的名称。如果文件相同,则会返回现有的 assetId 和版本。只有在上传新文件时才会生成新版本。

请求(request)示例

curl --location 'https://advertising-api.amazon.com/assets/register' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Content-Type: text/plain' \
--data '{
  "url": "https://al-na-9d5791cf-3faf.s3.amazonaws.com/xxxxxxxxx",
  "name": "My asset",
  "assetType": "IMAGE",
  "assetSubTypeList": [
    "LOGO"
  ],
  "versionInfo": {
    "linkedAssetId": "amzn1.assetlibrary.asset1.xxxxxxx"
  }
}

响应(response)示例

{
 "assetId": "amzn1.assetlibrary.asset1.xxxxxxxx",
 "failedSpecChecks": [],
 "programPolicyValidationsList": **null**,
 "versionId": "version_v2"
}

然后,您可以使用 assetIdversionId 的组合作为创意素材的一部分,例如 amzn1.assetlibrary.asset1.xxxxxxxx:version_v2