A+内容管理API参考

亚马逊SPAPI

# A+内容管理的销售伙伴API

# 概述

通过A+内容API,您可以构建应用程序,帮助销售伙伴在其亚马逊产品详情页上添加丰富的营销内容.A+内容帮助销售伙伴分享其品牌和产品故事,从而帮助买家做出明智的购买决定.销售伙伴通过从内容模块中选择并添加图片和文本来组装内容.

# Version information

版本 : 2020-11-01

# Contact information

联系信息 : 销售伙伴API开发者支持
联系网址 : https://sellercentral.amazon.com/gp/mws/contactus.html

# License information

许可证 : Apache许可证2.0
许可网址 : http://www.apache.org/licenses/LICENSE-2.0

# URI计划

主机 : sellingpartnerapi-na.amazon.com
方案 : HTTPS

# Consumes

  • 应用/json

# Produces

  • 应用/json

# Operations

searchContentDocuments
createContentDocument
getContentDocument
updateContentDocument
listContentDocumentAsinRelations
postContentDocumentAsinRelations
validateContentDocumentAsinRelations
searchContentPublishRecords
postContentDocumentApprovalSubmission
postContentDocumentSuspendSubmission

# 路径

# GET /aplus/2020-11-01/contentDocuments

操作:搜索ContentDocuments

# Description

返回分配给销售伙伴的所有A+内容文档的列表.该操作只返回A+内容文档的元数据.调用getContentDocument操作来获得A+内容文档的实际内容.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Query pageToken
optional
A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is return when the results of a call exceed the page size. To get the next page of results, 要获得下一页的结果,需要调用该操作并将pageToken作为唯一的参数.指定pageToken和任何其他参数将导致请求失败.当没有返回nextPageToken值时,就没有更多的页面可以返回.一个pageToken值不能在不同的操作中使用.
minLength 1
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
SearchContentDocumentsResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentDocuments

操作:创建ContentDocument

# Description

创建一个新的A+内容文档.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Body postContentDocumentRequest
required
The content document request details. PostContentDocumentRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
PostContentDocumentResponse

错误状态代码、描述和模式,见错误响应和模式.

# GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}

操作:getContentDocument

# Description

如果有的话,返回一个A+级的内容文档.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+ Content文档的唯一参考键.内容参考键不能形成固定链接,并且将来可能会改变.内容参考键不保证与任何A+ Content标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Query includedDataSet
required
响应中包含的A+内容数据类型集合.
Min count : 1
< enum (IncludedDataSet) > array(csv)

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetContentDocumentResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}

操作:updateContentDocument

# Description

更新一个现有的A+内容文档.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+ Content文档的唯一参考键.内容参考键不能形成固定链接,并且将来可能会改变.内容参考键不保证与任何A+ Content标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Body postContentDocumentRequest
required
The content document request details. PostContentDocumentRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
PostContentDocumentResponse

错误状态代码、描述和模式,见错误响应和模式.

# GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins

操作:listContentDocumentAsinRelations

# Description

返回与指定的A+内容文件相关的ASINs列表(如果有的话).如果你不包括asinSet参数,该操作会返回与内容文件相关的所有ASINs.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+ Content文档的唯一参考键.内容参考键不能形成固定链接,并且将来可能会改变.内容参考键不保证与任何A+ Content标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Query includedDataSet
optional
响应中包含的A+内容数据类型集合.如果不包含这个参数,操作会返回没有元数据的相关ASIN.
Min count : 0
< enum (IncludedDataSet) > array(csv)
Query asinSet
optional
The set of ASINs.
< string > array(csv)
Query pageToken
optional
A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, 要获得下一页的结果,需要调用该操作,并将pageToken作为唯一的参数.指定pageToken的任何其他参数将导致请求失败.当没有返回nextPageToken值时,就没有更多的页面可以返回.一个pageToken值不能在不同的操作中使用.
minLength : 1
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
ListContentDocumentAsinRelationsResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins

操作:postContentDocumentAsinRelations

# Description

替换与指定的A+内容文档相关的所有ASIN,如果有的话.这可能会增加或删除ASIN,这取决于当前相关的ASIN集合.删除一个ASIN的副作用是暂停该ASIN的内容文档.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+内容文档的唯一参考键.内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不保证与任何A+内容标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Body postContentDocumentAsinRelationsRequest
required
The content document ASIN relations request details. PostContentDocumentAsinRelationsRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
PostContentDocumentAsinRelationsResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentAsinValidations

操作:验证ContentDocumentAsinRelations

# Description

检查A+内容文件是否在一组ASINs上有效使用.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Query asinSet
optional
ASINs的集合.
< string > array(csv)
Body postContentDocumentRequest
required
The content document request details. PostContentDocumentRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
ValidateContentDocumentAsinRelationsResponse

关于错误状态代码、描述和模式,见错误响应和模式.

# GET /aplus/2020-11-01/contentPublishRecords

操作:搜索ContentPublishRecords

# Description

搜索A+内容发布记录,如果有的话.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string
Query asin
required
亚马逊标准标识号(ASIN).
minLength : 10
string
Query pageToken
optional
A page token from the nextPageToken response element returned by your previous call to this operation. nextPageToken is returned when the results of a call exceed the page size. To get the next page of results, 要获得下一页的结果,需要调用该操作,并将pageToken作为唯一的参数.指定pageToken的任何其他参数将导致请求失败.当没有返回nextPageToken值时,就没有更多的页面可以返回.一个pageToken值不能在不同的操作中使用.
minLength : 1
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
SearchContentPublishRecordsResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions

操作:postContentDocumentApprovalSubmission

# Description

提交一个A+级内容文件供审查、批准和发布.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+内容文档的唯一参考键.内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不保证与任何A+内容标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
PostContentDocumentApprovalSubmissionResponse

错误状态代码、描述和模式,见错误响应和模式.

# POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions

操作:postContentDocumentSuspendSubmission

# Description

提交一个暂停可见的A+内容的请求.这既不删除内容文件,也不删除ASIN关系.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path contentReferenceKey
required
A+内容文档的唯一参考键.内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不保证与任何A+内容标识符匹配.
minLength : 1
string
Query marketplaceId
required
发布A+内容的市场的标识符.
minLength : 1
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
PostContentDocumentSuspendSubmissionResponse

错误状态代码、描述和模式,见错误响应和模式.

# 错误响应和模式

该表包含HTTP状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 Request有缺失或无效的参数,无法解析.
Headers
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
**头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
404 指定的资源不存在.

x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
410 指定的资源已不存在.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
429 请求的频率超过了允许的范围.
标题
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
503 服务器的临时超载或维护.
头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识.
ErrorList

:唯一的请求参考标识符

# Definitions

# AplusResponse

当请求成功或部分成功时,所有A+内容操作的基本响应数据.个别操作可以用额外的数据扩展它.

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet

# AplusPaginatedResponse

分页的A+内容操作的基本响应数据.个别操作可以用额外的数据来扩展它.如果不返回nextPageToken,就没有更多的页面可以返回.

多态性 : 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
nextPageToken
optional
当调用的结果超过页面大小时返回的页面标记.要获得另一页的结果,再次调用该操作,用pageToken参数传入这个值. PageToken

# ErrorList

当一个请求不成功时的错误响应.

Name Description Schema
errors
required
A list of error responses returned when a request is unsuccessful. < Error> array

# MessageSet

一组给用户的信息,如警告或评论.

类型 < Error >数组

独特的项目 : true

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
识别错误条件类型的代码.
minLength : 1
string
message
required
对错误状况的可读描述.
minLength : 1
string
details
optional
额外的信息,如果有的话,以澄清错误条件.
minLength : 1
string

# ContentMetadataRecordList

A+内容元数据记录的列表.

类型< ContentMetadataRecord>数组

独特的项目 : false

# ContentMetadataRecord

A+内容文件的元数据,包括用于内容管理的额外信息.

Name Description Schema
内容参考键
必须的
A+内容文件的唯一参考键.内容参考键不能形成固定链接,将来可能会改变.内容参考键不保证与任何A+内容标识符匹配. 内容参考键
contentMetadata
required
一个A+内容文件的元数据. ContentMetadata

# ContentMetadata

一个A+级内容文件的元数据.

Name Description Schema
名称
要求
A+内容文件名称.
minLength : 1
最大长度 : 100
string
marketplaceId
required
发布A+内容的市场的标识符. MarketplaceId
status
required
内容文件的提交状态. ContentStatus
badgeSet
required
内容徽章的集合. ContentBadgeSet
updateTime
required
A+内容文件和元数据的大概年龄. string (date-time)

# ContentType

A+内容的文件类型.

类型 : 枚举

Value Description
EBC A+ 通过卖方中心的A+内容管理器发布的内容.
EMC A+ 通过供应商中心的A+内容管理器发布的内容.

# ContentSubType

A+内容文档的子类型.这代表了A+内容文档的一个特殊-目的类型.不是每个A+内容文档类型都会有一个子类型,而且子类型可能在任何时候改变.

类型:字符串

minLength : 1

# ContentStatus

内容文件的提交状态.

类型 : 枚举

Value Description
APPROVED 内容已被批准,并将发布到应用的ASINs.
DRAFT 该内容尚未提交批准.
REJECTED 该内容在审核中被拒绝,需要根据提供的拒绝理由进行修改并重新提交.
SUBMITTED 该内容已提交审批,目前正在等待审核.

# ContentBadgeSet

内容徽章的集合.

类型 < ContentBadge>数组

独特的项目 : true

# ContentBadge

一个标志,提供关于A+内容文件的额外信息.

类型 : 枚举

Value Description
BULK 此内容批量应用于ASINs.
GENERATED 此内容由自动程序生成.如果任何用户修改此内容,它将失去GENERATED徽章.
LAUNCHPAD Launchpad content.
PREMIUM Premium content
STANDARD Standard content.

# AsinBadgeSet

ASIN徽章的集合.

类型< AsinBadge >阵列

独特的项目 : true

# AsinBadge

一个提供关于ASIN的额外信息的标志.这是有背景的,可能会根据产生它的请求而改变.

类型 : 枚举

Value Description
BRAND_NOT_ELIGIBLE 这个ASIN不属于当前用户的品牌.如果当前用户更正他们的品牌注册,包括这个ASIN,它将失去BrandNotEligible徽章.
CATALOG_NOT_FOUND 这个ASIN在亚马逊目录中没有找到.如果任何用户创建或恢复这个ASIN,它将失去CatalogNotFound徽章.
CONTENT_NOT_PUBLISHED 这个ASIN没有发布指定的A+内容.如果当前用户为这个ASIN发布了指定的内容,它将失去ContentNotPublished徽章.
CONTENT_PUBLISHED 这个ASIN已经发布了指定的A+内容.如果当前用户暂停了这个ASIN的指定内容,它将失去ContentPublished徽章.

# MarketplaceId

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

类型:字符串

最小长度 1

# LanguageTag

IETF的语言标签.这只支持主要语言副标签和一个次要语言副标签.次要语言副标签几乎都是区域指定的.这不支持主要和次要副标签以外的额外副标签. Pattern: ^[a-z]{2,}-[A-Z0-9]{2,}$

类型:字符串

最小长度 : 5

# AsinSet

ASINs的集合.

类型 : < Asin > 数组

独特的项目 : true

# Asin

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

类型 :字符串

最小长度 10

# AsinMetadataSet

ASIN元数据的集合.

类型< AsinMetadata >数组

独特的项目 : true

# AsinMetadata

带有额外元数据的A+内容ASIN,用于内容管理. 如果在调用listContentDocumentAsinRelations操作时不包括includedDataSet参数,则返回的相关ASIN没有元数据.

Name Description Schema
asin
required
亚马逊标准识别码(ASIN). Asin
badgeSet
optional
一套ASIN徽章. AsinBadgeSet
**parent
optional
亚马逊标准识别码(ASIN). Asin
title
optional
亚马逊目录中ASIN的标题.
minLength 1
string
imageUrl
optional
亚马逊目录中ASIN的默认图片.
minLength 1
string
contentReferenceKeySet
optional
一组内容参考键. ContentReferenceKeySet

# PublishRecordList

A+内容发布记录的列表.

类型 < PublishRecord > 阵列

独特的项目 : false

# PublishRecord

一个A+内容发布事件的完整上下文.

Name Description Schema
marketplaceId
required
发布A+内容的市场的标识符. MarketplaceId
locale
required
IETF语言标签.这只支持主要语言子标签与一个次要语言子标签.次要语言子标签几乎都是区域指定的.这不支持主要和次要子标签之外的其他子标签.
**模式 ** ^[a-z]{2,}-[A-Z0-9]{2,}$
LanguageTag
asin
required
亚马逊标准识别码(ASIN). Asin
内容类型
要求
A+内容文件类型. 内容类型
内容子类型
可选
A+内容文件子类型.这代表A+内容文件的一个特殊-目的类型.不是每个A+内容文件类型都会有一个子类型,子类型可能随时改变. 内容子类型
内容参考键
必须的
A+内容文件的唯一参考键.内容参考键不能形成固定链接,而且将来可能会改变.内容参考键不保证与任何A+内容标识符相匹配. 内容参考键

# ContentReferenceKeySet

一组内容参考键.

类型 < ContentReferenceKey>数组

独特的项目 : true

# ContentReferenceKey

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

类型 :字符串

minLength : 1

# PageToken

当调用的结果超过页面大小时,将返回一个页面令牌.要获得另一个页面的结果,请再次调用该操作,用pageToken参数传入这个值.

类型:字符串

minLength : 1

# ImageCropSpecification

对图像进行选择性裁剪的说明.如果不需要裁剪,则将尺寸设置为原始图像的大小.如果图像被裁剪且没有提供偏移值,则被裁剪图像的左上角相对于原始图像的坐标被默认为(0,0).

Name Description Schema
size
required
从被裁剪图像的左上角开始延伸的尺寸,如果没有裁剪,则从原始图像的左上角开始延伸.只允许用pixels作为ImageDimensions. ImageDimensions
offset
optional
被裁剪的图像的左上角,在原始图像的坐标空间中指定. ImageOffsets

# ImageDimensions

从被裁剪图像的左上角开始延伸的尺寸,如果没有裁剪,则从原图像的左上角开始延伸.只允许用像素作为ImageDimensions的单位值.

Name Description Schema
宽度
要求的
一个整数尺寸及其测量单位.例如,这可以代表100像素. IntegerWithUnits
height
required
A whole number dimension and its unit of measurement. 例如,这可以代表100像素. IntegerWithUnits

# ImageOffsets

Name Description Schema
x
要求的
一个整数尺寸及其测量单位.例如,这可以代表100个像素. IntegerWithUnits
y
要求的
一个整数维度和它的测量单位. 例如,这可以代表100个像素. IntegerWithUnits

# IntegerWithUnits

一个整数维度和它的测量单位.例如,这可以代表100个像素.

Name Description Schema

要求的
尺寸值. 整数
units
required
测量单位. string

# ContentRecord

一个含有额外信息的内容文件,用于内容管理.|字符串

Name Description Schema
内容参考键
必须的
A+内容文件的唯一参考键.内容参考键不能形成固定链接,将来可能会改变.内容参考键不保证与任何A+内容标识符匹配. 内容参考键
内容元数据
可选
A+内容文件的元数据. 内容元数据
contentDocument
optional
The A+ Content document.这是发布在产品详细页面的增强内容. ContentDocument

# ContentDocument

A+内容文件.这是发布在产品详细页上的强化内容.

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

# ContentModuleList

A+内容模块的列表.

类型< ContentModule >数组

最小项目 : 1
最大项目 : 100
独特的项目 : false

# ContentModule

一个A+内容模块.一个A+内容文档是由内容模块组成的. contentModuleType属性选择要使用的内容模块类型.

Name Description Schema
contentModuleType
required
A+内容模块的类型. ContentModuleType
standardCompanyLogo
optional
The standard company logo image. StandardCompanyLogoModule
standardComparisonTable
optional
The standard product comparison table. StandardComparisonTableModule
标准四幅图像文本
可选
四幅标准图像与文本,在单行中呈现. 标准四幅图像文本模块
standardFourImageTextQuadrant
optional
四个标准图像与文字,呈现在四个象限的网格上. StandardFourImageTextQuadrantModule
standardHeaderImageText
optional
标准的标题文字,一张图片和正文. StandardHeaderImageTextModule
standardImageSidebar
optional
两张图片,两段文字,以及两个带圆点的列表.一张图片比较小,显示在侧边栏. StandardImageSidebarModule
标准图像文本叠加
可选
A标准背景图像与浮动文本框. 标准图像文本叠加模块
standardMultipleImageText
optional
带有文字的标准图像,一次呈现一个.用户点击缩略图查看每个区块. StandardMultipleImageTextModule
standardProductDescription
optional
Standard product description text. StandardProductDescriptionModule
standardSingleImageHighlights
optional
一张标准的图片,上面有几个段落和一个列举式清单. StandardSingleImageHighlightsModule
standardSingleImageSpecsDetail
optional
A标准图像,带有段落和圆点列表,并有额外空间用于技术细节. StandardSingleImageSpecsDetailModule
standardSingleSideImage
optional
A标准的标题和正文,侧面有一个图像. StandardSingleSideImageModule
标准技术规格
可选
技术特征名称和定义的标准表. 标准技术规格模块
standardText
optional
A标准标题和正文. StandardTextModule
标准三幅图像文本
可选
三幅标准图像与文本,在单行中呈现. 标准三幅图像文本模块

# ContentModuleType

A+内容模块的类型.

类型 : 枚举

Value Description
STANDARD_COMPANY_LOGO 标准的公司标志图像.
STANDARD_COMPARISON_TABLE 标准产品比较表或图表.
STANDARD_FOUR_IMAGE_TEXT 四张标准的图像与文字,在单行中呈现.
*STANDARD_FOUR_IMAGE_TEXT_QUADRANT 四张标准图像,带文本,在四个象限的网格上呈现.
STANDARD_HEADER_IMAGE_TEXT 标准的标题文字,一个图像,和正文.
STANDARD_IMAGE_SIDEBAR 两张图片,两段文字和两个圆点清单.一张图片较小,显示在侧边栏.
STANDARD_IMAGE_TEXT_OVERLAY 一个标准的背景图片和一个浮动的文本框.
STANDARD_MULTIPLE_IMAGE_TEXT 带有文字的标准图像,一次呈现一个.用户点击缩略图查看每块.
STANDARD_PRODUCT_DESCRIPTION 标准的产品描述文本.
STANDARD_SINGLE_IMAGE_HIGHLIGHTS 一张标准的图片,上面有几个段落和一个圆括号列表.
STANDARD_SINGLE_IMAGE_SPECS_DETAIL 一张标准的图片,有几个段落和一个带圆点的列表,还有额外的空间用于技术细节.
STANDARD_SINGLE_SIDE_IMAGE 一个标准的标题和正文,在侧面有一个图片.
STANDARD_TECH_SPECS 技术特征名称和定义的标准表格.
STANDARD_TEXT 标准的标题和正文.
STANDARD_THREE_IMAGE_TEXT 三张标准图像与文字,在一行中呈现.

# StandardCompanyLogoModule

标准的公司标志图片.

Name Description Schema
companyLogo
required
A reference to an image, hosted in A+ Content media library. ImageComponent

# StandardComparisonTableModule

标准产品比较表.

Name Schema
productColumns
optional
< StandardComparisonProductBlock > array
metricRowLabels
optional
< PlainTextItem > array

# StandardFourImageTextModule

四个标准图像与文字,在单行中呈现.

Name Description Schema
headline
optional
Rich text content. TextComponent
block1
optional
A+内容的标准图像和文本框. StandardImageTextBlock
block2
optional
A+ Content的标准图像和文本框. StandardImageTextBlock
block3
optional
A+ Content的标准图像和文本框. StandardImageTextBlock
block4
optional
A+ Content的标准图像和文本框. StandardImageTextBlock

# StandardFourImageTextQuadrantModule

四个标准图像与文字,呈现在四个象限的网格上.

Name Description Schema
block1
required
A+ Content标准图像和文本框. StandardImageTextBlock
block2
required
A+ Content的标准图像和文本框. StandardImageTextBlock
block3
required
A+ Content的标准图像和文本框. StandardImageTextBlock
block4
required
A+ Content的标准图像和文本框. StandardImageTextBlock

# StandardHeaderImageTextModule

标准的标题文本,一个图像,和正文.

Name Description Schema
headline
optional
Rich text content. TextComponent

选项
A+内容的标准图像和文本框块. StandardImageTextBlock

# StandardImageSidebarModule

两张图片,两段文字,两个项目列表.一张图片较小,显示在侧边栏.

Name Description Schema
headline
optional
Rich text content. TextComponent
imageCaptionBlock
optional
A+内容的标准图像和标题块. StandardImageCaptionBlock
descriptionTextBlock
optional
A+内容的标准文本框块,由一个带有标题的段落组成. StandardTextBlock
descriptionListBlock
optional
A+内容的标准固定长度的文本列表,通常以子弹头形式呈现. StandardTextListBlock
sidebarImageTextBlock
optional
A+ Content的标准图像和文本框. StandardImageTextBlock
sidebarListBlock
optional
A+ Content标准固定长度的文字列表,通常以子弹头的形式呈现. StandardTextListBlock

# StandardImageTextOverlayModule

一个带有浮动文本框的标准背景图片.

Name Description Schema
overlayColorType
required
内容的相对颜色方案. ColorType
block
optional
A+ Content的标准图像和文本框块. StandardImageTextBlock

# StandardMultipleImageTextModule

带文字的标准图像,每次呈现一个.用户点击缩略图查看每块.

Name Schema
blocks
optional
< StandardImageTextCaptionBlock > array

# StandardProductDescriptionModule

标准产品描述文本.

Name Description Schema
body
required
A list of rich text content, usually presented in a text box. ParagraphComponent

# StandardSingleImageHighlightsModule

一张标准图片上有几个段落和一个项目列表.

Name Description Schema
image
optional
对一个图片的引用,托管在A+ Content媒体库中. ImageComponent
headline
optional
Rich text content. TextComponent
textBlock1
optional
A+内容的标准文本框块,由一个带有标题的段落组成. StandardTextBlock
textBlock2
optional
A+内容标准文本框块,由一个带有标题的段落组成. StandardTextBlock
textBlock3
optional
A+ Content标准文本框块,由一个带标题的段落组成. StandardTextBlock
bulletedListBlock
optional
A+标准固定-长度的文本列表,有一个相关的标题. StandardHeaderTextListBlock

# StandardSingleImageSpecsDetailModule

一张标准的图片,有段落和一个项目列表,还有额外的空间用于技术细节.

Name Description Schema
headline
optional
Rich text content. TextComponent
image
optional
对一个图片的引用,托管在A+ Content媒体库中. ImageComponent
descriptionHeadline
optional
Rich text content. TextComponent
descriptionBlock1
optional
A+内容标准文本框块,由一段带标题的文字组成. StandardTextBlock
descriptionBlock2
optional
A+内容标准文本框块,由一个带有标题的段落组成. StandardTextBlock
specificationHeadline
optional
Rich text content. TextComponent
规格ListBlock
可选
A+标准固定-长度的文本列表,有相关的标题. StandardHeaderTextListBlock
规格文本框
可选
A+内容标准文本框块,由一段标题组成. StandardTextBlock

# StandardSingleSideImageModule

一个标准的标题和正文,边上有一个图像.

Name Description Schema
imagePositionType
required
The relative positioning of content. PositionType
block
optional
A+ Content的标准图像和文本框块. StandardImageTextBlock

# StandardTechSpecsModule

技术特征名称和定义的标准表.

Name Description Schema
headline
optional
Rich text content. TextComponent
规范列表
必须的
规范列表. < StandardTextPairBlock >数组
tableCount
optional
要呈现的表的数量.特征在表之间平均分配.
Minimum value : 1
*最大值 : 2
integer

# StandardTextModule

一个标准的标题和正文.

Name Description Schema
headline
optional
Rich text content. TextComponent
body
required
一个富文本内容的列表,通常在文本框中呈现. ParagraphComponent

# StandardThreeImageTextModule

三幅标准图像与文字,在单行中呈现.

Name Description Schema
headline
optional
Rich text content. TextComponent
block1
optional
A+内容的标准图像和文本框. StandardImageTextBlock
block2
optional
A+ Content的标准图像和文本框. StandardImageTextBlock
block3
optional
A+ Content的标准图像和文本框. StandardImageTextBlock

# StandardComparisonProductBlock

A+内容标准比较产品块.

Name Description Schema
位置
要求
该比较产品块在模块中的等级或索引.不同的块不能在一个模块中占据相同的位置.
最小值 : 1
最大值 : 6
integer
image
optional
A reference to an image, hosted in the A+ Content media library. ImageComponent
title
optional
The comparison product title.
minLength : 1
*最大长度 : 80
字符串
asin
optional
亚马逊标准识别码(ASIN). Asin
highlight
optional
决定此块内容是否在视觉上突出显示. boolean
metrics
optional
产品的比较指标. < PlainTextItem > 数组

# StandardHeaderTextListBlock

A+标准固定-长度的文本列表,有一个相关的标题.

Name Description Schema
headline
optional
Rich text content. TextComponent
block
optional
A+内容的标准固定长度的文本列表,通常以子弹头形式呈现. StandardTextListBlock

# StandardTextListBlock

A+内容的标准固定长度的文本列表,通常以子弹头的形式呈现.

Name Schema
textList
required
< TextItem > array

# StandardImageTextCaptionBlock

A+内容的标准图像和文本块,以及相关的标题.标题可能不会在所有设备上显示.

Name Description Schema
block
optional
A+ Content标准图片和文本框. StandardImageTextBlock
caption
optional
Rich text content. TextComponent

# StandardImageCaptionBlock

A+内容的标准图像和标题块.

Name Description Schema
image
optional
对图片的引用,托管在A+ Content媒体库. ImageComponent
caption
optional
Rich text content. TextComponent

# StandardImageTextBlock

A+内容的标准图像和文本框.

Name Description Schema
image
optional
对图片的引用,托管在A+ Content媒体库. ImageComponent
headline
optional
Rich text content. TextComponent
body
optional
一个富文本内容的列表,通常在文本框中呈现. ParagraphComponent

# StandardTextBlock

A+内容的标准文本框块,由一个带有标题的段落组成.|名称|

Name Description Schema
headline
optional
Rich text content. TextComponent
body
optional
富文本内容的列表,通常在一个文本框中呈现. ParagraphComponent

# StandardTextPairBlock

A+内容的标准标签和描述块,由一对文本组件组成.

Name Description Schema
label
optional
Rich text content. TextComponent
description
optional
Rich text content. TextComponent

# TextItem

丰富的位置性文本,通常以一系列要点的形式呈现.

Name Description Schema
position
required
这个文本项目在集合中的等级或索引.不同的项目不能在一个集合中占据相同的位置.
最小值 : 1
最大值 : 100
integer
text
required
Rich text content. TextComponent

# PlainTextItem

纯粹的位置文本,用于简短的标签和描述符的集合中.

Name Description Schema
position
required
这个文本项目在集合中的等级或索引.不同的项目不能在一个集合中占据相同的位置.
最小值 : 1
最大值 : 100
integer

要求
实际的纯文本.
minLength : 1
最大长度 : 250
string

# ImageComponent

一个对图片的引用,托管在A+内容媒体库中.

Name Description Schema
uploadDestinationId
required
此标识符由销售伙伴API提供,用于上传.
minLength 1
string
imageCropSpecification
required
对图像进行选择性裁剪的说明.如果不需要裁剪,将尺寸设置为原始图像大小.如果图像被裁剪并且没有提供偏移值那么被裁剪的图像的左上角的坐标,相对于原始图像,默认为(0,0). ImageCropSpecification
altText
required
图像的替代文本.
minLength : 1
最大长度 : 100
string

# ParagraphComponent

一个富文本内容的列表,通常在一个文本框中呈现.

Name Schema
textList
required
< TextComponent > array

# TextComponent

丰富的文本内容.

Name Description Schema

要求
实际纯文本.
minLength : 1
最大长度 : 10000
string
decoratorSet
optional
A set of content decorators. DecoratorSet

# ColorType

内容的相对颜色方案.

类型 : 枚举

Value Description
DARK 深灰色,半不透明的阴影背景,用于浅色文本覆盖框.
LIGHT 白色,半透明的阴影背景,用于深色文本覆盖的盒子.

# PositionType

内容的相对定位.

类型 : 枚举

Value Description
LEFT 表示内容要放在模块的左边.
*RIGHT 表示内容要放在模块的右边.

# DecoratorSet

一组内容装饰器.

类型< Decorator > 数组

独特的项目 : true

# Decorator

一个应用于内容字符串值的装饰器,以创建富文本.

Name Description Schema
type
optional
富文本装饰器的类型. DecoratorType
offset
optional
该装饰器在内容字符串中的起始字符.第一个字符使用0.
Minimum value : 0
最大值 : 10000
integer
length
optional
用此装饰器改变的内容字符数.装饰器如换行符可以有零长度,并适合在字符之间.
Minimum value : 0
最大值 : 10000
integer
深度
可选
该装饰器的相对强度或变化.例如bullet-points等装饰器,可以有多个缩进深度.
最小值 : 0
最大值 : 100
integer

# DecoratorType

富文本装饰器的类型.

类型 : 枚举

Value Description
LIST_ITEM 格式化的列表项,用于数字或项目列表,在列表外壳内.
LIST_ORDERED Numbered list enclosure.
LIST_UNORDERED Bulleted list enclosure.
STYLE_BOLD Bold文本格式化.
STYLE_ITALIC Italic text formatting.
STYLE_LINEBREAK 新的一行文字.
STYLE_PARAGRAPH Paragraph text formatting.
STYLE_UNDERLINE Underline text formatting.

# SearchContentDocumentsResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
nextPageToken
optional
当调用的结果超过页面大小时返回的页面标记.要获得另一页的结果,再次调用该操作,用pageToken参数传入这个值. PageToken
contentMetadataRecords
required
The content metadata records. ContentMetadataRecordList

# GetContentDocumentResponse

多态性 : 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
contentRecord
required
A content document with additional information for content management. ContentRecord

# PostContentDocumentRequest

Name Description Schema
contentDocument
required
The A+ Content document.这是发布到产品详细页的增强内容. ContentDocument

# PostContentDocumentResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
内容参考键
必须的
A+内容文档的唯一参考键.内容参考键不能形成固定链接,并且将来可能会改变.内容参考键不保证与任何A+内容标识符相匹配. 内容参考键

# ListContentDocumentAsinRelationsResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
nextPageToken
optional
当调用的结果超过页面大小时返回的页面标记.要获得另一页的结果,再次调用该操作,用pageToken参数传入这个值. PageToken
asinMetadataSet
required
ASIN元数据的集合. AsinMetadataSet

# PostContentDocumentAsinRelationsRequest

Name Description Schema
asinSet
required
ASINs的集合. AsinSet

# PostContentDocumentAsinRelationsResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet

# ValidateContentDocumentAsinRelationsResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
errors
required
当请求不成功时返回的错误响应列表. < Error> 数组

# SearchContentPublishRecordsResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet
nextPageToken
optional
当调用的结果超过页面大小时返回的页面标记.要获得另一页的结果,再次调用该操作,将这个值与pageToken参数一起传入. PageToken
publishRecordList
required
A+内容发布记录的列表. PublishRecordList

# PostContentDocumentApprovalSubmissionResponse

多态性 组成

Name Description Schema
warnings
optional
一组给用户的信息,如警告或评论. MessageSet

# PostContentDocumentSuspendSubmissionResponse

多态性 组成

Name Description Schema
警告
可选
一组给用户的信息,如警告或评论. MessageSet

# IncludedDataSet

类型 : 枚举

用于操作(s)getContentDocument

Value Description
CONTENTS 内容文件的内容.
METADATA 内容文件的元数据.

用于操作(s)listContentDocumentAsinRelations

Value Description
METADATA 内容文件的元数据.
Last Updated: 2022/10/20 下午11:58:42