A+内容API使用案例指南

亚马逊SPAPI

# 什么是A+内容API?

通过A+内容API,您可以建立应用程序,使销售伙伴能够创建和编辑A+内容.这为买家提供了丰富的、高质量的内容,帮助他们做出购买决定.

# 销售伙伴API角色

要访问A+内容API,你必须拥有产品列表角色.你可以在注册为开发者时申请产品列表角色 (opens new window),或者通过更新你现有的开发者资料https://sellercentral.amazon.com/developer/register (opens new window).

在开发者资料表格的角色部分,选择产品 列表复选框. 然后在使用案例部分的文本框中,指出你想使用A+内容API. 点击注册提交你的请求,一个支持案例将自动为你创建.

我们将审查您的请求,并通过您的支持案例联系您的下一步工作. 您可以在卖方中心的案例日志中访问您的支持案例.

另外,当你注册你的应用程序时 (opens new window),一定要选择产品列表的角色.关于角色的更多信息,见销售伙伴API中的角色 (opens new window).

# 教程创建和编辑A+内容并将其发布到你的ASINs上

本教程告诉你如何创建一个新的内容文件,将ASINs添加到内容文件中,并使内容文件得到批准以便发布.

# 前提条件

要完成本教程,你需要

1.来自你为之打电话的销售伙伴的授权.参见授权销售伙伴API应用 (opens new window),以获得更多信息. 2.一个或多个您想发布内容的ASIN. 3. 您想发布的内容.

步骤

步骤1.检查现有的A+内容

第2步.创建一个内容文件

步骤3.让内容文件得到批准出版

# 步骤1.检查现有的A+内容

在创建和发布新的A+内容之前,您可以获得有关销售伙伴已经创建和发布的内容文件的信息.

任务

任务1.找出哪些内容文件被发布到ASIN

任务2.获取销售伙伴创建的所有内容文件

# 任务1.找出哪些内容文件是发布给ASIN的

调用searchContentPublishRecords操作来获取销售伙伴已经发布到ASIN的内容文件的发布记录列表.销售伙伴可以使用这些信息来决定他们是否要发布新的内容文件到该ASIN.

  1. Call the searchContentPublishRecords (opens new window) operation, passing the following parameters:

查询参数

ParameterDescriptionRequired
asin

The 亚马逊标准识别码(ASIN).

类型string

Yes
marketplaceId

发布A+内容的市场标识.

Type: string

Yes

请求的例子

GET https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentPublishRecords?marketplaceId=ATVPDKIKX0DER&asin=ZZZZZZZZZZ
1

响应

响应属性

[block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "publishRecordList", "0-1": "A+内容发布记录的列表.\nTypePublishRecordList", "1-0": "警告" "2-0": "nextPageToken", "1-1": "给用户的一组信息,如警告或评论. \nType: MessageSet", "2-1": "当调用的结果超过页面大小时,会返回一个页面令牌.要获得另一个页面的结果,请再次调用该操作,将此值与pageToken参数一起传入.n/nType: string" }, "cols": 2, "行": 3 } [/block] 响应示例

{
  "警告": [],
  "nextPageToken": null,
  "publishRecordList": [{
      "marketplaceId": "atvpdkikx0der",
      "locale": "en_US",
      "asin": "ZZZZZZZZ",
      "contentType": "EBC",
      "contentSubType": "",
      "contentReferenceKey": "d54a4096-f864-4326-bc80-ce8807497f98"
    }, {
      "marketplaceId": "atvpdkikx0der",
      "locale": "es_US",
      "asin": "ZZZZZZZZ",
      "contentType": "EBC",
      "contentSubType": "",
      "contentReferenceKey": "f58cf4d7-b1b2-4f43-b900-5fd75cb688c5"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
  1. 要获得返回记录的内容文件和/或元数据,请调用getContentDocument (opens new window)操作,传入你想要的内容文件的contentReferenceKey值.

# 任务2.获取所有由销售伙伴创建的内容文档

在创建一个新的内容文件之前,对销售伙伴来说,看到他们已经创建的所有内容文件是有帮助的.这个任务告诉你如何获得销售伙伴已经创建的内容文件,以及相关的元数据.

  1. Call the searchContentDocuments (opens new window) operation, passing in the following parameter:

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

请求的例子

GET https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments?marketplaceId=ATVPDKIKX0DER
1

响应

响应属性

[block:parameters] { "数据"{ "0-0": "contentMetadataRecords", "1-0": "警告", "2-0": "nextPageToken", "2-1": "当调用的结果超过页面大小时返回的页面令牌.要获得另一页的结果,请再次调用操作,将此值与pageToken参数一起传入.n\nType: string" "1-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet", "0-1": "A+内容元数据记录的列表.n\nTypeContentMetadataRecordList", "h-0": "名称" "h-1": "描述" }, "cols": 2, "行": 3 } [/block] 响应示例

{
  "警告": [],
  "nextPageToken": null,
  "contentMetadataRecords": [{
      "contentReferenceKey": "436e986d-4a94-4511-a857-58802f3ba7b0",
      "contentMetadata": {
        "名称": "内容文件的名称"
        "marketplaceId": "atvpdkikx0der",
        "状态": "DRAFT",
        "badgeSet": [null, "STANDARD"],
        "更新时间": null
      }
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  1. 为了得到返回的记录的内容文件,调用getContentDocument (opens new window)操作,传入你想要的内容文件的contentReferenceKey值.

# 步骤2.创建一个内容文档

创建内容文件是一个多-步骤的过程,首先是构建一个内容文件.

任务

任务1.构建一个JSON内容文档

任务2.为图像创建上传目的地

任务3.上传图片

任务4.提交内容文件进行验证

任务5.创建一个内容文件

任务6.将ASINs添加到内容文件中

# 任务1.构建一个JSON内容文档

构建一个JSON内容文档基于A+内容API参考中的ContentDocument定义,构建一个JSON内容文档.同时参见Content document example在 "A+内容实例 "指南中,有一个内容文档的例子和内容模块的例子.

内容文档是由一个或多个内容模块组成的.针对销售伙伴的内容文档最多可以包含七个模块,而针对供应商的内容文档最多可以包含五个内容模块.

ContentDocument的定义

Name Description Schema
名称
要求
A+内容文件名称.
minLength : 1
最大长度 : 100
string
contentType
required
The A+ Content document type. ContentType
contentSubType
optional
A+内容文档的子类型.这代表A+内容文档的一个特殊-目的类型.不是每个A+内容文档类型都会有一个子类型而且子类型可能随时改变. ContentSubType
locale
required
IETF语言标签.这只支持主要语言子标签与一个次要语言子标签.次要语言子标签几乎都是区域指定的.这不支持主要和次要子标签之外的额外子标签.
**模式 ** ^[a-z]{2,}-[A-Z0-9]{2,}$
LanguageTag
contentModuleList
required
A list of A+ content modules. ContentModuleList

contentDocument的例子

{
  "contentDocument": {
    "名称": "内容文件范例",
    "contentType": "EMC",
    "locale": "en-US",
    "contentModuleList": [
      {
        "contentModuleType": "standard_header_image_text",
        "standardHeaderImageText": {
          "头条": {
            "价值": "Lorem ipsum",
            "decoratorSet": []
          },
          "block": {
            "图像": {
              "uploadDestinationId": "SampleID",
              "imageCropSpecification": {
                "size": {
                  "宽度": {
                    "值": 970,
                    "单位": "像素"
                  },
                  "高度": {
                    "值": 600
                    "单位": "像素"
                  }
                },
                "offset": {
                  "x": {
                    "值": 7,
                    "单位": "像素"
                  },
                  "y": {
                    "值": 0,
                    "单位": "像素"
                  }
                }
              },
              "altText": "Lorem ipsum"
            },
            "头条"{
              "价值": "Nunc faucibus neque auctor faucibus pretium.",
              "decoratorSet": []
            },
            "body": {
              "textList": [
                {
                  "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc faucibus neque auctor faucibus pretium. Quisque sed blandit nunc. Pellentesque malesuada lorem vitae justo efficitur viverra." 
                  "decoratorSet": []
                }
              ]
            }
          }
        }
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# 任务2.为图像创建上传目的地

这个任务为图像文件创建一个上传目的地,并返回将图像文件上传到目的地所需的信息.为你的内容文件中的每个图像完成这个任务.

1.调用Uploads API的createUploadDestinationForResource (opens new window)操作,传入以下参数

查询参数

ParameterDescriptionRequired
marketplaceIds

A 市场标识符的列表.这指定了上传的市场.只能指定一个市场.

类型string

Yes
contentMD5

将提交给上传目的地的内容的MD5哈希值.这个值用来确定数据在运输过程中是否被破坏或篡改.

Type: string

Yes
contentType

待上传文件的内容类型.

Type: string

No

路径参数

ParameterDescriptionRequired
resource

The 您正在创建的上传目的地的资源的URL. 例如创建一个内容文件的上传目的地,{resource}将是aplus/2020-11-01/contentDocuments,路径将是/uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments

Typestring

Yes

请求的例子

POST https://sellingpartnerapi-na.amazon.com/uploads/2020-11-01/uploadDestinations/aplus/2020-11-01/contentDocuments?contentType=image/jpeg&contentMD5=9e92dc1ed22ffc814f063f02b1c0f233&marketplaceIds=ATVPDKIKX0DER
1

响应

响应属性

[block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "有效载荷" "0-1": "关于一个上传目的地的信息.n\nType: UploadDestination", "1-0": "错误" "1-1": "当请求不成功时返回的错误响应列表.n\nTypeErrorList" }, "cols": 2, "行": 2 } [/block] 响应示例

{
  "errors": [],
  "payload": {
    "uploadDestinationId": "sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png",
    "url": "https://aplus-media.s3.amazonaws.com/?x-amz-date=20201116T184623Z&x-amz-signature=c5c8efd95d883b6787a2b1a93c7c066f01cb4e8d7be3ece4360aa800332e0cf9&x-amz-meta-owner=A2CZ04NGKYDXDV&acl=private&key=sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png&x-amz-algorithm=AWS4-HMAC-SHA256&policy=eyJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJhcGx1cy1tZWRpYS1iZXRhIn0seyJrZXkiOiJzb3RhLzdhZTJkM2IxLWZkZDMtNDJjNC05OGM0LTljYzUwOWZiOTVkOC5wbmcifSx7ImFjbCI6InByaXZhdGUifSx7IngtYW16LW1ldGEtb3duZXIiOiJBMkNaMDROR0tZRFhEViJ9LHsieC1hbXotYWxnb3JpdGhtIjoiQVdTNC1ITUFDLVNIQTI1NiJ9LHsieC1hbXotY3JlZGVudGlhbCI6IkFLSUE2TDZSN1FFNTZGNkdNRzVFLzIwMjAxMTE2L3VzLWVhc3QtMS9zMy9hd3M0X3JlcXVlc3QifSx7IngtYW16LWRhdGUiOiIyMDIwMTExNlQxODQ2MjNaIn0sWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMSwzMTQ1NzI4XV0sImV4cGlyYXRpb24iOiIyMDIwLTExLTE2VDIxOjQ2OjIzLjg2OFoifQ==&x-amz-credential=AKIA6L6R7QE56F6GMG5E/20201116/us-east-1/s3/aws4_request",
    "头文件": null
  }
}
1
2
3
4
5
6
7
8

2.保存uploadDestinationId值,以包括在你的内容文件中Task 4.提交内容文件进行 validation. Save the url value for Task 3. Upload images.

# 任务3.上传图片

这项任务将图像文件上传到在任务2.为图像创建上传目的地.为你的内容文件中的每个图像完成这项任务.

1.使用cURL命令上传图片文件(JPEG、PNG或TIF),使用前一个任务中返回的url响应元素的值.

cURL命令的例子

curl -F \"key=sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png\" \\\n-F \"acl=private\" \\\n-F \"policy=eyJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJhcGx1cy1tZWRpYS1iZXRhIn0seyJrZXkiOiJzb3RhLzdhZTJkM2IxLWZkZDMtNDJjNC05OGM0LTljYzUwOWZiOTVkOC5wbmcifSx7ImFjbCI6InByaXZhdGUifSx7IngtYW16LW1ldGEtb3duZXIiOiJBMkNaMDROR0tZRFhEViJ9LHsieC1hbXotYWxnb3JpdGhtIjoiQVdTNC1ITUFDLVNIQTI1NiJ9LHsieC1hbXotY3JlZGVudGlhbCI6IkFLSUE2TDZSN1FFNTZGNkdNRzVFLzIwMjAxMTE2L3VzLWVhc3QtMS9zMy9hd3M0X3JlcXVlc3QifSx7IngtYW16LWRhdGUiOiIyMDIwMTExNlQxODQ2MjNaIn0sWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMSwzMTQ1NzI4XV0sImV4cGlyYXRpb24iOiIyMDIwLTExLTE2VDIxOjQ2OjIzLjg2OFoifQ==\" \\\n-F \"x-amz-credential=AKIA6L6R7QE56F6GMG5E/20201116/us-east-1/s3/aws4_request\" \\\n-F \"x-amz-algorithm=AWS4-HMAC-SHA256\" \\\n-F \"x-amz-date=20201203T011128Z\" \\\n-F \"x-amz-signature=c5c8efd95d883b6787a2b1a93c7c066f01cb4e8d7be3ece4360aa800332e0cf9\" \\\n-F \"x-amz-meta-owner=A2CZ04NGKYDXDV\" \\\n-F \"[email protected]\" \\\nhttps://aplus-media.s3.amazonaws.com"
1

2.确认你在响应中收到200状态代码,这表明图像文件被正确上传.

# 任务4.提交内容文件进行验证

调用validateContentDocumentAsinRelations操作来提交你的内容文件,根据你指定的一组ASINs进行自动验证.

1.如果你的内容文件包括图片,请将你从任务2.创建图片的上传目的地中得到的uploadDestinationId值加入你的内容文件.见以下请求示例. 2.调用validateContentDocumentAsinRelations操作,传入下列参数

查询参数

ParameterDescriptionRequired
marketplaceId

The A+内容托管或发布的亚马逊市场的标识符.

类型string

Yes
asinSet

The set of ASINs.

Type: <string> array(csv)

No

身体参数

[block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "postContentDocumentRequest", "0-1": "内容文件请求详情.n\nTypepostContentDocumentRequest", "0-2": "是的" }, "cols": 3, "行": 1 } [/block] 请求示例

POST https: //sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentAsinValidations?marketplaceId=ATVPDKIKX0DER&asinSet=0123456789&asinSet=ZZZZZZZZZZ
{
  "contentDocument": {
    "名称": "内容文件示例"
    "contentType": "EMC",
    "locale": "en-US",
    "contentModuleList": [
      {
        "contentModuleType": "standard_header_image_text",
        "standardHeaderImageText": {
          "头条": {
            "价值": "Lorem ipsum",
            "decoratorSet": []
          },
          "block": {
            "图像": {
              "uploadDestinationId": "sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png",
              "imageCropSpecification": {
                "size": {
                  "宽度": {
                    "值": 970,
                    "单位": "像素"
                  },
                  "高度": {
                    "值": 600
                    "单位": "像素"
                  }
                },
                "offset": {
                  "x": {
                    "值": 7,
                    "单位": "像素"
                  },
                  "y": {
                    "值": 0,
                    "单位": "像素"
                  }
                }
              },
              "altText": "Lorem ipsum"
            },
            "头条"{
              "价值": "Nunc faucibus neque auctor faucibus pretium.",
              "decoratorSet": []
            },
            "body": {
              "textList": [
                {
                  "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc faucibus neque auctor faucibus pretium. Quisque sed blandit nunc. Pellentesque malesuada lorem vitae justo efficitur viverra." 
                  "decoratorSet": []
                }
              ]
            }
          }
        }
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

响应

错误响应示例

{
  "警告": [],
  "错误": [
    {
      "代码": "content_failed_validation"
      "消息": "这些关键词违反了我们的社区准则$.",
      "详情": ""
    }
  ]
}
1
2
3
4
5
6
7
8
9
10

检查错误. 如果你收到一个错误,纠正错误并重试. 重复直到你没有收到错误.

注意: 响应中的200状态代码意味着亚马逊对您的内容文档进行了验证,而不是说您的内容文档通过了验证. 当validateContentDocumentAsinRelations操作没有返回错误时,您的内容文档已经通过了验证.

# 任务5.创建一个内容文档

创建一个内容文件,以后可以添加ASINs,提交审批,并发布.

-调用createContentDocument操作,传入下列参数

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

身体参数

[block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "postContentDocumentRequest", "0-1": "内容文件请求详情.n\nTypePostContentDocumentRequest", "0-2": "是的" }, "cols": 3, "行": 1 } [/block] 请求示例

POST https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments?marketplaceId=ATVPDKIKX0DER
{
  "contentDocument": {
    "名称": "内容文件示例"
    "contentType": "EMC",
    "locale": "en-US",
    "contentModuleList": [
      {
        "contentModuleType": "standard_header_image_text",
        "standardHeaderImageText": {
          "头条": {
            "价值": "Lorem ipsum",
            "decoratorSet": []
          },
          "block": {
            "图像": {
              "uploadDestinationId": "sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png",
              "imageCropSpecification": {
                "size": {
                  "宽度": {
                    "值": 970,
                    "单位": "像素"
                  },
                  "高度": {
                    "值": 600
                    "单位": "像素"
                  }
                },
                "offset": {
                  "x": {
                    "值": 7,
                    "单位": "像素"
                  },
                  "y": {
                    "值": 0,
                    "单位": "像素"
                  }
                }
              },
              "altText": "Lorem ipsum"
            },
            "头条"{
              "价值": "Nunc faucibus neque auctor faucibus pretium.",
              "decoratorSet": []
            },
            "body": {
              "textList": [
                {
                  "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc faucibus neque auctor faucibus pretium. Quisque sed blandit nunc. Pellentesque malesuada lorem vitae justo efficitur viverra." 
                  "decoratorSet": []
                }
              ]
            }
          }
        }
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet", "1-0": "contentReferenceKey", "1-1": "A+内容文件的唯一参考键.内容参考键不能形成固定链接,将来可能会改变.内容参考键不保证与任何A+内容标识符相匹配.n\nTypeContentReferenceKey" }, "cols": 2, "行": 2 } [/block] 响应示例

{
  "警告": [],
  "contentReferenceKey": "52c2534c-d37a-4854-b9b3-79e2f8a86bfa"
}
1
2
3
4

# 任务6.在内容文件中添加ASINs

将ASINs添加到你的内容文件中.

1.调用postContentDocumentAsinRelations操作,传入以下参数

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

身体参数 [block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "postContentDocumentAsinRelationsRequest", "0-1": "内容文件ASIN关系请求详情.n\nTypePostContentDocumentAsinRelationsRequest", "0-2": "是的" }, "cols": 3, "行": 1 } [/block] 请求示例

POST https: //sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa/asins?marketplaceId=ATVPDKIKX0DER
{
  "asinSet": ["0123456789", "ZZZZZZZZZZ"]
}
1
2
3
4

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的信息集,如警告或评论.n\nTypeMessageSet" }, "cols": 2, "行": 1 } [/block] 响应示例

{
  " warnings": []
}
1
2
3

# 步骤3.使内容文件得到批准以便发布

在创建你的内容文件并添加ASINs后,使用postContentDocumentApprovalSubmission操作提交内容文件供审核和批准.然后你可以使用getContentDocument操作检查内容文件的提交状态.

任务

任务1.提交你的内容文件供批准

任务2.检查你提交的文件的批准状态

# 任务1.提交你的内容文件供批准

调用postContentDocumentApprovalSubmission操作,提交你的内容文件供审核和批准.

  1. Call the postContentDocumentApprovalSubmission operation, passing in the following parameters:

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

请求的例子

POST https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa/approvalSubmissions?marketplaceId=ATVPDKIKX0DER
1

响应 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet" }, "cols": 2, "行": 1 } [/block] 响应示例

{
  "警告": [
    {
      "代码": "asin_failed_validation",
      "消息": "",
      "详情": "0123456789"
    }
  ]
}
1
2
3
4
5
6
7
8
9
  1. 检查警告和错误. 如果你收到一个警告或错误,纠正并重试. 重复,直到你没有收到警告错误.

# 任务2.检查你提交的文件的批准状态

通过调用getContentDocument操作来检查您提交的文件的批准状态.对于您要检查批准状态的每个内容文件,每小时调用该操作不超过一次.

  1. Call the getContentDocument (opens new window) operation, passing in the following parameters:

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

查询参数 [block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "marketplaceId", "0-1": "发布A+内容的市场的标识符.n\nType: string" "0-2": "是" "1-0": "includedDataSet", "1-1": "响应中包含的A+内容数据类型集.指定METATDATA以获得提交状态,而不是内容文件本身.n\nTypeIncludedDataSet", "1-2": "是的" }, "cols": 3, "行": 2 } [/block] 请求示例

GET https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa?marketplaceId=ATVPDKIKX0DER&includedDataSet=METADATA
1

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "1-0": "contentRecord", "0-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet", "1-1": "一个带有附加信息的内容文件,用于内容管理.参见status属性,了解提交状态.n/nTypeContentRecord" }, "cols": 2, "行": 2 } [/block] 响应示例

{
  "警告": [],
  "contentRecord": {
    "contentReferenceKey": "52c2534c-d37a-4854-b9b3-79e2f8a86bfa",
    "contentMetadata": {
      "名称": "内容文件示例",
      "marketplaceId": "atvpdkikx0der",
      "状态": "批准"
      "badgeSet": ["STANDARD"],
      "updateTime": "2020-11-18T03:05:50.052Z"
    },
    "contentDocument": null
  }
}          
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  1. 检查到status属性以了解你提交的状态. status属性值
    • APPROVED. 该内容已被批准,将被发布到所申请的ASINs.
    • REJECTED. 该内容在审核中被拒绝. 根据提供的拒绝原因修改内容并重新提交.
    • DRAFT. 该内容尚未提交审批.等待至少一个小时并重新提交.
    • SUBMITTED. 该内容已提交审批,目前正在等待审核.等待至少一个小时后重新提交.

# 教程管理现有内容

本教程包含管理现有内容的任务.

任务从所有应用的ASINs中暂停一个内容文件中暂停

任务Get previously published content

任务Update a content document

任务获取与内容文件相关的ASINs的ASINs

任务从内容文件中添加或删除ASINs中删除

# 任务从所有应用的ASIN中暂停一个内容文件

调用postContentDocumentSuspendSubmission操作,将一个内容文件从其所有相关的ASINs中暂停提交.

注意. 当你发布一个内容文件到一个已经有内容发布的ASIN,或者当你从一个内容文件中删除一个ASIN时,现有的内容会自动从ASIN中暂停. 因此你在这些情况下不需要postContentDocumentSuspendSubmission操作.

  1. Call the postContentDocumentSuspendSubmission operation, passing in the following parameters:

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

请求的例子

POST https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa/suspendSubmissions?marketplaceId=ATVPDKIKX0DER
1

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的信息集,如警告或评论.n\nTypeMessageSet" }, "cols": 2, "行": 1 } [/block]

响应示例

{
  " warnings": []
}
1
2
3

# 任务获取以前发布的内容

Call the getContentDocument operation 来获取销售伙伴之前发布的内容. 指定includedDataSet=METADATA来获取内容元数据. 指定includedDataSet=CONTENTS来获取内容文档.

请求示例

GET https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa?marketplaceId=ATVPDKIKX0DER&includedDataSet=CONTENTS&includedDataSet=METADATA

**响应**

响应示例

```json
{
  "警告": [],
  "contentRecord": {
    "contentReferenceKey": "52c2534c-d37a-4854-b9b3-79e2f8a86bfa",
    "contentMetadata": {
      "名称": "内容文件示例",
      "marketplaceId": "atvpdkikx0der",
      "状态": "批准"
      "badgeSet": ["STANDARD"],
      "updateTime": "2020-11-14T02:04:05.502Z"
    },
    "contentDocument": {
      "名称": "内容文件示例"
      "contentType": "EMC",
      "locale": "en-US",
      "contentModuleList": [
        {
          "contentModuleType": "standard_header_image_text",
          "standardHeaderImageText": {
            "头条": {
              "价值": "Lorem ipsum",
              "decoratorSet": []
            },
            "block": {
              "图像": {
                "uploadDestinationId": "sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png",
                "imageCropSpecification": {
                  "size": {
                    "宽度": {
                      "值": 970,
                      "单位": "像素"
                    },
                    "高度": {
                      "值": 600
                      "单位": "像素"
                    }
                  },
                  "offset": {
                    "x": {
                      "值": 7,
                      "单位": "像素"
                    },
                    "y": {
                      "值": 0,
                      "单位": "像素"
                    }
                  }
                },
                "altText": "Lorem ipsum"
              },
              "头条"{
                "价值": "Nunc faucibus neque auctor faucibus pretium.",
                "decoratorSet": []
              },
              "body": {
                "textList": [
                  {
                    "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc faucibus neque auctor faucibus pretium. Quisque sed blandit nunc. Pellentesque malesuada lorem vitae justo efficitur viverra." 
                    "decoratorSet": []
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# 任务更新一个内容文件

调用 updateContentDocument 操作来编辑一个现有的内容文件.

1.调用updateContentDocument操作,传入下列参数

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

身体参数 [block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "postContentDocumentRequest", "0-1": "内容文件请求详情.n\nTypePostContentDocumentRequest", "0-2": "是的" }, "cols": 3, "行": 1 } [/block] 请求示例

POST https: //sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa?marketplaceId=ATVPDKIKX0DER
{
  "contentDocument": {
    "名称": "内容文件示例"
    "contentType": "EMC",
    "locale": "en-US",
    "contentModuleList": [
      {
        "contentModuleType": "standard_header_image_text",
        "standardHeaderImageText": {
          "头条": {
            "值": "头条示例",
            "decoratorSet": []
          },
          "块": {
            "图像": {
              "uploadDestinationId": "sc/7ae2d3b1-fdd3-42c4-98c4-9cc509fb95d8.png",
              "imageCropSpecification": {
                "size": {
                  "宽度": {
                    "值": 970,
                    "单位": "像素"
                  },
                  "高度": {
                    "值": 600
                    "单位": "像素"
                  }
                },
                "offset": {
                  "x": {
                    "值": 7,
                    "单位": "像素"
                  },
                  "y": {
                    "值": 0,
                    "单位": "像素"
                  }
                }
              },
              "altText": "示例性alt文本"
            },
            "头条"{
              "值": "示例标题",
              "decoratorSet": []
            },
            "body": {
              "textList": [
                {
                  "值": "示例文本."
                  "decoratorSet": []
                }
              ]
            }
          }
        }
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

响应

响应属性

[block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet", "1-0": "contentReferenceKey", "1-1": "A+内容文件的唯一参考键.内容参考键不能形成固定链接,将来可能会改变.内容参考键不保证与任何A+内容标识符相匹配.n\nTypeContentReferenceKey" }, "cols": 2, "行": 2 } [/block]

响应示例

{
  "警告": [],
  "contentReferenceKey": "52c2534c-d37a-4854-b9b3-79e2f8a86bfa"
}
1
2
3
4

# 任务获取与一个内容文件相关的ASINs

如果你需要找出哪些ASINs与内容文件相关,以便评估、添加或删除内容文件中的ASINs,请使用listContentDocumentAsinRelations操作. 来获取元数据,以便对ASINs进行分类和评估指定includedDataSet=METADATA. 当ASINs列表已知时,为了减少处理时间(例如,在发布内容文档后检查ASIN状态是否有潜在错误),使用asinSet参数指定ASINs.

1.调用listContentDocumentAsinRelations,传入下列参数

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从Task 5.创建一个内容文档.

类型中获取此值string

Yes

查询参数 [block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "marketplaceId", "1-0": "includedDataSet", "2-0": "asinSet", "0-1": "发布A+内容的市场的标识符.n/nType: string" "0-2": "是" "1-1": "在响应中包含的A+内容数据类型集合.n\nType< enum IncludedDataSet > array(csv)", "1-2": "No\n\nDefault: no metadata is returned." "2-1": "ASINs的集合.n\nType< string > array(csv)" "2-2": "No\n\nDefault: 所有应用于内容文件的ASINs都被返回." }, "cols": 3, "行": 3 } [/block] 请求示例

GET https://sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa/asins?marketplaceId=ATVPDKIKX0DER&amp;includedDataSet=METADATA&amp;asinSet=0123456789&amp;asinSet=ZZZZZZZZZZ
1

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "1-0": "nextPageToken", "2-0": "asinMetadataSet", "0-1": "一组给用户的信息,如警告或评论.n\nType: MessageSet", "1-1": "当调用的结果超过页面大小时,将返回一个页面令牌.要获得另一个页面的结果,请再次调用该操作,将此值与pageToken参数一起传入.n\nTypePageToken", "2-1": "ASIN元数据的集合.\n\nTypeAsinMetadataSet" }, "cols": 2, "行": 3 } [/block] 响应示例

{
  "警告": [],
  "nextPageToken": null,
  "asinMetadataSet": [
    {
      "asin": "ZZZZZZZZ",
      "badgeSet": null,
      "家长": "ZZZZZZZZ",
      "标题": "标题示例"
      "imageUrl": null,
      "contentReferenceKeySet": null
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# Task: 从内容文件中添加或删除ASINs

调用postContentDocumentAsinRelations操作,从一个内容文件中添加或删除ASINs.

你发布的ASIN将取代当前与内容文档相关的所有ASIN. 这可能导致增加或删除ASIN,这取决于当前与内容文档相关的ASIN集合. 删除ASIN有一个副作用,即暂停内容文档与ASIN的关系. 要确保总是发布你希望与内容文档相关的整个ASIN集合.

1.调用postContentDocumentAsinRelations操作,传入下列参数

路径参数

ParameterDescriptionRequired
contentReferenceKey

The A+内容文件的唯一参考键. A 内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不能保证与任何A+内容标识符相匹配.从任务5.创建一个内容文档.

类型中获取此值string

Yes

查询参数

ParameterDescriptionRequired
marketplaceId

The 发布A+内容的市场的标识符.

类型string

Yes

身体参数 [block:parameters] { "数据"{ "h-0": "参数", "h-1": "描述" "h-2": "需要" "0-0": "postContentDocumentAsinRelationsRequest", "0-1": "内容文件ASIN关系请求详情.n\nTypePostContentDocumentAsinRelationsRequest", "0-2": "是的" }, "cols": 3, "行": 1 } [/block] 请求示例

POST https: //sellingpartnerapi-na.amazon.com/aplus/2020-11-01/contentDocuments/52c2534c-d37a-4854-b9b3-79e2f8a86bfa/asins?marketplaceId=ATVPDKIKX0DER
{
  "asinSet": ["0123456789", "ZZZZZZZZZZ"]
}
1
2
3
4

响应

响应属性 [block:parameters] { "数据"{ "h-0": "名称", "h-1": "描述" "0-0": "警告" "0-1": "给用户的一组信息,如警告或评论.n\nTypeMessageSet" }, "cols": 2, "行": 1 } [/block]

响应示例

{
  " warnings": []
}
1
2
3
Last Updated: 2022/10/20 下午11:58:42