产品资源
“产品”资源允许你管理 Microsoft 商家中心商店中的产品/服务 (MMC) 。 有关使用产品资源的信息,请参阅 管理产品。 有关演示如何添加、删除和获取产品的示例,请参阅 代码示例。
基 URI
下面是将模板追加到的基 URI。
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
模板
若要创建用于管理产品/服务的终结点,请将相应的模板追加到基 URI。
模板 | HTTP 谓词 | 说明 | 资源 |
---|---|---|---|
{mmcMerchantId}/products/batch |
POST | 使用 在单个请求中执行多个插入 (更新) 、获取和删除。 该批不能包含针对同一产品的多个操作。 例如,请求不得尝试插入和删除同一产品。 设置为 {mmcMerchantId} MMC 存储 ID。 |
请求: Batch 响应: Batch |
{mmcMerchantId}/products/{productUniqueId} |
DELETE | 使用 从商店中删除单个产品/服务。 设置为 {mmcMerchantId} MMC 存储 ID。设置为 {productUniqueId} 完全限定的产品 ID (例如 Online:en:US:Sku123) 。如果在多个目录中插入具有相同 ID 的产品,则会从所有目录中将其删除。 已删除的产品最多可能需要 12 小时才能停止交付。 建议在删除之前将产品可用性更新为“缺货”。 |
请求:不适用 响应:不适用 |
{mmcMerchantId}/products/{productUniqueId} |
GET | 使用 从商店获取单个产品/服务。 设置为 {mmcMerchantId} MMC 存储 ID。设置为 {productUniqueId} 完全限定的产品 ID (例如 Online:en:US:Sku123) 。如果在多个目录中插入具有相同 ID 的产品,则服务只返回其中一个,哪个是不确定的。 |
请求:不适用 响应: 产品 |
{mmcMerchantId}/products |
GET | 使用 获取商店中的产品列表。 设置为 {mmcMerchantId} MMC 存储 ID。 |
请求:不适用 响应: 产品 |
{mmcMerchantId}/products |
POST | 使用 在商店中插入 (更新) 单个产品/服务。 如果产品不存在,则添加它;否则,将更新产品。 由于更新会覆盖当前产品/服务,因此必须包括构成产品/服务的所有字段。 若要将产品/服务插入到特定目录中,请指定 bmc-catalog-id 查询参数;否则,产品将插入到商店的默认目录中。 设置为 {mmcMerchantId} MMC 存储 ID。请注意 ,由于 Get/List 和 Delete 请求针对应用商店而不是特定目录,因此不应将具有相同 渠道、 contentLanguage、 targetCountry 和 offerId 的产品插入到多个目录中。 |
请求: 产品 响应: 产品 |
查询参数
终结点可能包括以下查询参数。
参数 | 说明 |
---|---|
alt | 可选。 使用 指定请求和响应中使用的内容类型。 可能的值为 json 和 xml 。 默认值为 json 。 |
bmc-catalog-id | 可选。 使用 指定要将更新) 产品/服务插入 (目录。 如果商店包含多个目录,请使用此参数。 如果未指定此参数,则会将产品插入到商店的默认目录中。 此参数仅用于插入产品/服务。 对于 Get、List 和 Delete 请求,将忽略此参数,因为它们跨目录操作。 |
干运行 | 可选。 调试应用程序时使用 以测试调用。 包含此参数的调用不会影响生产数据, (不会) 插入或删除产品;但是,响应将包含调用生成的任何错误。 使用此参数时,请考虑以下限制。
|
max-results | 可选。 使用 指定要在 List 请求中返回的最大项数。 可以指定的最大值为 250。 默认值为 25。 |
start-token | 可选。 使用 分页浏览商店的产品列表。 该令牌标识在列表请求中返回的下一页产品。 不要在第一个 List 请求中指定此参数。 如果目录包含的产品数超过请求的数量, (看到 max-results 查询参数) ,则响应将包含 nextPageToken 字段 (“ 产品) ”,其中包含在下一个列表请求中使用的标记值。 |
标题
下面是请求和响应标头。
头 | 说明 |
---|---|
AuthenticationToken | 请求标头。 将此标头设置为 OAuth 访问令牌。 有关获取访问令牌的信息,请参阅 对凭据进行身份验证。 |
Content-Location | 响应标头。 标识产品插入到的商店的 URL。 此标头包含在 Insert 请求的响应中。 |
Content-Type | 请求和响应标头。 请求或响应正文中的内容类型。 对于 POST,如果使用 JSON,请将此标头设置为 application/json 。 否则,如果使用 XML,请将此标头设置为 application/xml 。 |
CustomerAccountId | 请求标头。 代表标头中指定的客户管理的任何帐户的帐户 ID CustomerId 。 指定哪个帐户并不重要。 仅当代表客户管理帐户时,才指定此标头。 |
CustomerId | 请求标头。 你管理的商店的客户的客户 ID。 仅当代表客户管理应用商店时,才指定此标头。 如果设置此标头,还必须设置 CustomerAccountId 标头。 |
DeveloperToken | 请求标头。 客户端应用程序的开发人员令牌。 每个请求都必须包含此标头。 有关获取令牌的信息,请参阅 是否有Microsoft广告凭据和开发人员令牌? |
位置 | 响应标头。 标识产品插入到的商店的 URL。 此标头包含在 Insert 请求的响应中。 |
WebRequestActivityId | 响应标头。 包含请求详细信息的日志条目的 ID。 如果发生错误,应始终捕获此 ID。 如果无法确定和解决问题,请包含此 ID 以及你向支持团队提供的其他信息。 |
请求和响应对象
下面是 API 使用的请求和响应对象。
每个对象定义使用的 JSON 键名称和 XML 元素名称,具体取决于为请求指定的内容类型。
Object | 说明 |
---|---|
批 | 定义在批处理请求中要处理的项列表。 |
错误 | 定义错误。 |
ErrorResponse | 定义单个产品插入的顶级错误对象。 |
BatchItemError | 定义在批处理期间为项发生的错误。 |
项目 | 在批处理请求或响应中定义项。 |
产品 | 定义产品。 |
ProductCustomAttribute | 定义自定义属性。 |
ProductCustomGroup | 定义一组自定义属性。 |
ProductDestination | 定义目标。 |
ProductPrice | 定义产品的价格。 |
ProductTax | 定义确定适用税款的地理位置。 |
产品 | 定义产品列表。 |
ProductShipping | 定义运输成本。 |
ProductShippingWeight | 定义项目的发货重量。 |
UnitPricing | 定义每个单价的项。 |
警告 | 定义警告消息。 |
批
定义在批处理请求中要处理的项列表。 请注意 ,此对象用于批处理请求和响应。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
条目 | 要在批处理请求中处理的项数组。 可指定的最大项数为 12,000。 但是,最大请求大小为 4 MB,因此实际项数取决于产品属性的数量 (例如,包括大小、颜色、图案) 以及是否压缩数据。 例如,如果压缩数据,则可能能够指定 12,000 项,但如果不指定,则可能只能指定 2,000 项。 |
Item[] | <批> |
BatchItemError
定义在批处理期间为项发生的错误。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
错误 | 处理项时发生的错误的列表。 | Error[] | <错误> |
code | 错误的 HTTP 状态代码。 | String | |
消息 | 与错误关联的消息。 | String |
错误
定义错误。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
domain | 仅供内部使用。 | String | <域> |
位置 | 未使用。 | String | <location type=“string”> |
locationType | 未使用。 | String | 请参阅 location> 元素的 <type 属性 |
消息 | 错误说明。 | String | <internalReason> |
reason | 请求失败的原因。 例如,产品验证失败。 | String | <原因> |
ErrorResponse
定义单个产品插入的顶级错误对象。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
error | 处理项时发生的错误的列表。 | Errors[] | <错误> |
错误
定义产品/服务的错误和警告列表。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
错误 | 处理项时发生的错误的列表。 | Error[] | <错误> |
警告 | 处理项时发生的警告列表。 产品/服务已接受,但你应该尽早解决问题。 例如,如果未指定 gtin、 mpn 和 品牌 标识符(如果应该知道这些标识符),MMC 将返回警告。 | Warning[] | <警告> |
code | HTTP 状态代码或错误。 | String | |
消息 | 与错误关联的消息。 | String |
项目
定义批处理请求中的项。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
batchId | 用户定义的 ID,用于在批处理请求中标识此项。 例如,如果批包含 10 个项目,则可以为其分配 ID 1 到 10。 | 无符号整数 | <entry batch_id=“unsigned integer” method=“string”> |
错误 | 一个 error 对象,其中包含发生的验证错误列表。 仅当发生错误时,响应才会包含此字段。 | BatchItemError | <错误> |
merchantId | 商家中心商店 ID。 | 无符号 Long | <merchant_id> |
方法 | 要应用于项的操作。 可取值为:insert 、get 和 delete 。 如果项目正在添加或更新产品/服务,请将方法设置为 insert ;如果项目正在删除产品,请将 方法delete 设置为 ;如果项目正在获取产品,请将 方法设置为 get 。 字符串不区分大小写。 |
String |
method 请参阅 entry> 元素的 <属性 |
产品 | 产品/服务。 仅当插入 (更新) 产品时,才在请求中指定此字段。 响应将包括获取和插入的此字段, (更新仅) 。 | 产品 | <产品> |
productId | 完全限定的产品 ID (例如 Online:en:US:Sku123) 。 仅在获取或删除产品/服务时包含此字段。 不要在批处理请求中包含具有相同产品 ID 的多个项。 |
String | <product_id> |
产品
定义产品。 有关此对象中的字段的详细信息,请参阅 如何组织源文件?
JSON 和 XML 名称 | 值 | 类型 | 插入时需要 |
---|---|---|---|
additionalImageLinks <additional_image_link> |
可在产品广告中使用的其他产品图像的 URL。 若要指定多个图像, MMC 不使用其他映像;包含此字段是为了实现 Google 兼容性。 |
String[] | 否 |
adult <成人> |
一个布尔值,用于确定商品是否为成人产品。 如果商品的目标市场是成人,则设置为 true 。 默认值为 false。 请注意,成人产品不受支持,将被拒绝。 |
Boolean | 否 |
adwordsGrouping <adwords_grouping> |
按购置成本 (CPA) 出价的一组项。 MMC 不使用此字段;它包含在 Google 兼容性中。 |
字符串 | 否 |
adwordsLabels <adwords_label> |
分组项的标签 (请参阅 adwordsGrouping) 。 仅适用于每次单击成本 (CPC) 。 MMC 不使用此字段;它包含在 Google 兼容性中。 |
String[] | 否 |
adwordsRedirect <adwords_redirect> |
在产品广告中使用的 URL。 如果指定,则此 URL 必须重定向到 链接中指定的 URL。 | 字符串 | 否 |
ageGroup <age_group> |
项目的目标年龄组。 下面是可能的值。
|
字符串 | 否 |
可用性 <可用性> |
产品的可用性状态。 下面是可能的值。
|
字符串 | 是 |
availabilityDate <availability_date> |
预购产品可发货的 UTC 日期 (请参阅 availability 字段) 。 此字段是可选的,但如果知道预购产品可发货的日期,则应设置此字段。 以 ISO 8601 格式指定日期。注意: MMC 当前忽略此字段的内容。 |
字符串 | 否 |
品牌 <品牌> |
项目的品牌、制造商或发布者。 该字符串最多可以包含 10 个单词和 1,000 个字符。 若要确保字符串在 UX 中显示良好,应将品牌名称限制为不超过 70 个字符。 | 字符串 | 是 |
渠道 <渠道> |
产品的销售渠道。 下面是可能不区分大小写的值。
|
字符串 | 是 |
color <颜色> |
产品的主导颜色。 如果颜色是混合颜色,则可以指定最多 3 种颜色的斜杠分隔列表, (例如红色/绿色/蓝色) 。 如果一件衣服有多种颜色,则可以为每个颜色创建一个产品,并使用 itemGroupId 对产品的变体进行分组。 字段限制为 100 个字符。 建议用于服装项目。 |
字符串 | 否 |
条件 <条件> |
产品的条件。 下面是可能的值。
|
字符串 | 是 |
contentLanguage <content_language> |
产品的双字母 ISO 639-1 语言代码。 下面是可能不区分大小写的值:
|
字符串 | 是 |
customAttributes <custom_attribute> |
商家使用的自定义属性列表。 | ProductCustomAttribute[] | 否 |
customGroups<custom_group> | 商家使用的自定义组列表。 | ProductCustomGroup[] | 否 |
customLabel0 <custom_label_0> |
自定义标签 0,用于筛选Microsoft购物市场活动的产品。 标签限制为 100 个字符。 | 字符串 | 否 |
customLabel1 <custom_label_1> |
自定义标签 1,用于筛选Microsoft购物市场活动的产品。 标签限制为 100 个字符。 | 字符串 | 否 |
customLabel2 <custom_label_2> |
自定义标签 2,用于筛选Microsoft购物市场活动的产品。 标签限制为 100 个字符。 | 字符串 | 否 |
customLabel3 <custom_label_3> |
自定义标签 3,用于筛选Microsoft购物市场活动的产品。 标签限制为 100 个字符。 | 字符串 | 否 |
customLabel4 <custom_label_4> |
自定义标签 4,用于筛选Microsoft购物市场活动的产品。 标签限制为 100 个字符。 | 字符串 | 否 |
description <描述> |
产品说明。 说明可能不包含促销文本。 说明限制为最多 10,000 个字符,并且可能包含任何 Unicode 字符。 描述将接受编辑评审。 |
字符串 | 否 |
目的地 <目的地> |
产品的预期目标。 MMC 不使用此字段;它包含在 Google 兼容性中。 |
ProductDestination[] | 否 |
energyEfficiencyClass <energy_efficiency_class> |
欧盟指令 2010/30/EU 中定义的能效等级。 下面是可能的值。
|
字符串 | 否 |
expirationDate <expiration_date> |
指定产品到期时间的 UTC 日期和时间。 如果未指定到期日期,则产品将从添加或更新产品的日期和时间起 30 天过期, (日期和时间基于Microsoft服务器的时区) 。 使用此字段可以指定从今天起不到 30 天的到期日期。 到期日期应始终包含时间组件,并指定时区或偏移量信息。 否则,API 将尝试使用 targetCountry 来确定时区。 对于具有多个时区的国家或地区,API 确定要使用的时区。 例如,如果国家/地区是美国,则 API 将使用太平洋标准时间 (PST) 。 应跟踪即将过期和到期前的产品,或者更新其到期日期,或者只需更新产品 (无需更新产品的任何字段) 这将自动将到期日期再延长 30 天。 如果显式设置到期日期,则必须自行设置新的到期日期:在这种情况下,更新产品不会自动将到期日期再延长 30 天。 |
字符串 | 否 |
gender <性> |
产品所面向的性别。 下面是可能的值。
|
字符串 | 否 |
googleProductCategory <google_product_category> |
产品位于的产品类别。 可以指定类别字符串 (例如,动物 & 宠物用品 > 宠物用品 > 鸟用品) 或类别 ID (例如 3) 。 对于类别字符串,子类别列表由大于符号 (''>) 分隔。 字段限制为 255 个字符。 | 字符串 | 否 |
gtin <gtin> |
由制造商分配的全球贸易项编号 (GTIN) 。 如果制造商分配了 GTIN,则必须指定它。 以下是 GTIN 的类型。
|
字符串 | 是 |
id <id> |
完全限定的产品 ID。ID 是 channel、 contentLanguage、 targetCountry 和 offerId 的组合。 ID 区分大小写。 使用此 ID 获取或删除产品。 |
字符串 | 否 |
identifierExists <identifier_exists> |
一个布尔值,确定产品/服务是指定 gtin、 mpn 还是 品牌 标识符。 默认值为 true。 如果未指定所有三个标识符,则设置为 false 。 唯一产品标识符定义全球市场中的产品。 使用唯一标识符标记产品可使客户更轻松地找到你的产品。 应指定所有三个标识符(如果已知)。 |
Boolean | 否 |
imageLink <image_link> |
可在产品广告中使用的产品图像的 URL。 URL 限制为 1,000 个字符,可以使用 HTTP 或 HTTPS 协议。 允许的图像类型包括 bmp、gif、exif、jpg、png 和 tiff。 建议的图像大小为 200x200 像素。 映像不能超过 3.9 MB。 图像将接受编辑评审。 |
字符串 | 是 |
isBundle <is_bundle> |
一个布尔值,确定产品是否是商家定义的捆绑包。 如果产品是捆绑包,则值为 true 。 | Boolean | 否 |
itemGroupId <item_group_id> |
可用于对同一产品的所有变体进行分组的 ID。 例如,如果连衣裙有 3 种颜色,则可以为每个颜色创建一个产品,并使用此 ID 对它们进行分组。 通常,对因颜色、材料、图案或大小而异的项进行分组。 ID 在目录中必须唯一,并且限制为 50 个字符。 |
字符串 | 否 |
kind <类> |
对象的类型。 此字段设置为 content#product 。 |
字符串 | 否 |
链接 <链接> |
网站上产品页面的 URL。 URL 限制为 2,000 个字符,可以使用 HTTP 或 HTTPS 协议。 域必须与存储的域匹配。 链接用于产品广告。 可能无法重定向该 URL。 若要在产品广告中使用可能重定向到此 URL 的另一个 URL,请参阅 adwordsRedirect。 此链接指向的网页将接受编辑评审。 |
字符串 | 是 |
材料 <材料> |
产品的主导材料。 如果材料是材料的混合,则可以指定一个斜杠分隔列表,最多包含 3 个材料 (例如皮革/绒面革/丝绸) 。 如果一件衣服在多种材料中可用,则可以为每个材料创建一个产品,并使用 itemGroupId 对产品的变体进行分组。 字段限制为 200 个字符。 建议用于服装项目。 |
字符串 | 否 |
mobileLink <mobile_link> |
网页的移动优化版本的 URL,其中包含有关产品的信息 (查看 链接) 。 | 字符串 | 否 |
multipack <multipack> |
例如,单个单位销售的相同产品的数量 (例如,4个手电筒) 。 设置价格时,它必须是多包的总价格。 | 整数 | 否 |
mpn <mpn> |
制造商部件号 (产品的 MPN) 。 如果制造商分配了 MPN,则必须指定它。 MPN 限制为 70 个字符。 | 字符串 | 是 |
offerId <offer_id> |
正在提供的产品的用户定义 ID。 产品/服务 ID 不区分大小写,在目录中必须唯一,最多只能包含 50 个字符。 由于产品/服务 ID 用于创建产品 ID,因此在将产品添加到应用商店后不能更改此字段。 |
字符串 | 是 |
onlineOnly <online_only> |
一个布尔值,确定产品是否只能在线购买。 如果产品仅联机可用,则值为 true 。 默认值为 false。 | Boolean | 否 |
模式 <模式> |
产品的图案或图形打印 (例如格子) 。 该模式限制为 100 个字符。 如果一件衣服有多种模式可用,则可以为每个图案创建一个产品,并使用 itemGroupId 对产品的变体进行分组。 建议用于服装项目。 |
字符串 | 否 |
价格 <价格> |
产品的价格。 以目标国家/地区的货币指定价格。 有关是否在价格中包含税款的信息,请参阅 Microsoft商家中心目录税政策。 价格必须与产品网页上显示的价格匹配, (看到 链接) ,并且必须在 0.01 (1 美分) 到 100000000000000000000000000000000000000000000000000000000 (1000 万) 的范围内。 但是,如果满足以下条件,可以将价格设置为 0.0 (零) 。 1. googleProductCategory 字段设置为以下类别之一: - 电子 > 通信 > 电话 > 移动电话 - 电子 > 计算机 > 平板电脑 2. 标题 字段包含以下关键字之一: -合同 -分期付款 -租赁 -付款 上述关键字以英语显示:但是,标题和关键字 (keyword) 必须使用指定市场的语言。 通常,标题将包含诸如“...与分期付款计划“或”...仅包含合同”。 合同关键字 (keyword) 可用于所有市场;但是,分期付款、付款和租赁只能在美国市场使用。 |
ProductPrice | 是 |
productType <product_type> |
广告客户定义的产品类别,可能与 不同 googleProductCategory 。 例如,动物 & 宠物用品 > 宠物用品 > 鸟类用品 > 兽医。 子类别列表由大于符号 ('>') 分隔。 字段限制为 750 个字符。可以指定多个以逗号分隔的类别字符串。 例如,服装 & 配件 > 假发配件 > 假发帽,服装 & 配件 > 假发配件 > 假发胶。 |
字符串 | 否 |
promotionId <promotion_id> |
以逗号分隔的 ID 列表,用于标识促销源中的促销。 最多可以指定 10 个促销 ID。 ID 必须至少包含 1 个字符,最多 60 个字符。 允许的字符是任意字母数字字符、 ( ) 短划线和下划线 (_) 。 市场 (看到 contentLanguage 的所有 ID 和 targetCountry) 必须是唯一的。 例如,在市场中,你可能不使用 PROMO1 和 promo1,但可以在 en-US 市场使用 PROMO1 ,在 en-GB 市场使用 promo1 。 你可以在一个或多个产品上指定相同的唯一促销 ID。 如果指定的 ID 与促销源中的促销 ID 匹配, (同一目标国家/地区) ,Microsoft促销产品。 仅当大小写相同时,ID 才匹配。 例如,如果产品的 ID 为 PROMO1 且源的 ID 为 PROMO1,则 ID 匹配,但如果源的 ID 为 Promo1,则 ID 不匹配。 若要确保将来不会意外促销产品,应删除已结束促销的 ID。 尽管在促销结束后 6 个月内无法在促销源中再次使用该 ID,但如果在此之后的另一个促销中重复使用该 ID,则产品将被推广。 |
字符串 | 否 |
salePrice <sale_price> |
商品的销售价格。 销售价格必须介于 0.01 (1 美分) 到 1000 万 (1000 万) 。 对于销售项目,请同时设置销售价格和销售生效日期 (请参阅 salePriceEffectiveDate ) 。 如果您设置销售价格,但未设置销售价格生效日期,则销售价格将继续使用,直到产品到期或您设置生效日期。如果满足以下条件,可以将销售价格设置为 0.0 (零) 。 1. googleProductCategory 字段设置为以下类别之一: - 电子 > 通信 > 电话 > 移动电话 - 电子 > 计算机 > 平板电脑 2. 标题 字段包含以下关键字之一: -合同 -分期付款 -租赁 -付款 上述关键字以英语显示:但是,标题和关键字 (keyword) 必须使用指定市场的语言。 通常,标题将包含诸如“...与分期付款计划“或”...仅包含合同”。 合同关键字 (keyword) 可用于所有市场;但是,分期付款、付款和租赁只能在美国市场使用。 |
ProductPrice | 否 |
salePriceEffectiveDate <sale_price_effective_date> |
销售的 UTC 开始和结束日期。 以 ISO 8601 格式指定日期。 例如,2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (使用斜杠 ('/') 分隔开始日期和结束日期) 。 有关详细信息,请参阅 salePrice 。 |
字符串 | 否 |
sellerName <seller_name> |
销售产品的商家的名称。 仅由聚合器用来标识商家。 聚合器是代表单个商家行事的第三方网站。 聚合器代表商家提交的产品必须遵守Microsoft广告政策和 服务条款。 聚合器必须将此字段设置为卖家名称。 如果调用方不是聚合器,并且未设置此字段,则它将默认为存储名称。 名称限制为 255 个字符。 |
字符串 | 否 |
航运 <航运> |
根据位置交付产品的价格。 注意:如果目标国家/地区是 DE (德国) ,则需要发货;否则,它是可选的。 |
ProductShipping[] | 是 |
shippingLabel <shipping_label> |
发货标签。 注意:如果目标国家/地区是 DE (德国) ,则需要发货信息;否则,它是可选的。 |
字符串 | 是 |
shippingWeight <shipping_weight> |
产品的重量。 重量用于发货目的。 注意:如果目标国家/地区是 DE (德国) ,则需要发货信息;否则,它是可选的。 |
ProductShippingWeight | 是 |
大小 <大小> |
产品的可用大小。 例如,小型、中型和大型。 一致地应用大小调整。 大小值是用户定义的,但应基于目标国家/地区。 面向法国、德国、英国和美国时,所有服装 & 配件产品都需要此字段。 | String[] | 否 |
sizeSystem <size_system> |
用于调整产品大小的度量系统。 例如,可以使用美国系统或英国系统调整鞋子的大小。 下面是可能的值。
|
字符串 | 否 |
sizeType <size_type> |
产品的剪切。 下面是可能的值。
|
字符串 | 否 |
targetCountry <target_country> |
目标国家/地区的 双字母 ISO 3166 国家/地区代码 (要) 宣传产品的国家/地区。 国家/地区必须与目录指定的市场匹配。 下面是可能不区分大小写的值:
|
字符串 | 是 |
税 <税> |
产品的税务信息。 MMC 不使用此字段;它包含在 Google 兼容性中。 |
ProductTax[] | 否 |
标题 <标题> |
产品的标题 (例如女鞋) 。 标题不能包含促销文本。 标题限制为最多 150 个字符,并且可能包含任何 Unicode 字符。 标题将接受编辑评审。 |
字符串 | 是 |
unitPricingBaseMeasure <unit_pricing_base_measure> |
例如,产品的定价基准度量值 (100ml 表示价格是根据 100ml 单位) 计算的。
|
UnitPricing | 否 |
unitPricingMeasure <unit_pricing_measure> |
销售时产品的度量值和维度。
|
UnitPricing | 否 |
validatedDestinations <validated_destination> |
已通过验证的目标的只读列表。 MMC 不使用此字段;它包含在 Google 兼容性中。 |
String[] | 否 |
警告 | 有关产品/服务问题的警告列表。 产品/服务已接受,但你应该尽早解决问题。 例如,如果未指定 gtin、 mpn 和 品牌 标识符(如果应该知道这些标识符),MMC 将返回警告。 产品/服务仅在插入/更新的响应中包括此字段。 |
Warning[] | 否 |
ProductCustomAttribute
定义自定义属性。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
name | 获取或设置属性的名称。 | String | <名字> |
type | 获取或设置属性的类型。 下面是可能的值。
|
String | <类型> |
单位 | 获取或设置特性的度量单位。 仅用于 INT 和 FLOAT 类型的值。 | String | <单位> |
值 | 获取或设置特性的值。 | String | <价值> |
ProductCustomGroup
定义一组客户属性。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
attributes | 获取或设置组的属性。 | ProductCustomAttribute | <属性> |
name | 获取或设置组的名称。 | String | <名字> |
ProductDestination
定义目标。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
意图 | 下面是可能的值。
|
String | <意图> |
destinationName | 获取或设置目标的名称。 | String | <destination_name> |
ProductPrice
定义产品的价格或销售价格。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
货币 | 获取或设置价格所声明的货币。 使用 ISO 4217 货币代码指定货币。 下面是可能的值。
|
String |
currency 属性。例如,<price currency=“USD”。> |
值 | 获取或设置项的价格。 请勿包含货币符号,例如“$”。 | 双精度 | 文本值。 例如, <price currency=“USD”>38.0<\price>。 |
产品
定义产品列表。 请注意 ,这是 List 请求返回的顶级对象。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
kind | 获取对象的类型。 此字段设置为 content#productsListResponse。 | String | <类> |
nextPageToken | 获取用于获取下一页结果的令牌。 如果对象不包含此字段,则不再有要获取的页面。 请参阅 start-token。 | String | <next_page_token> |
resources | 获取产品列表。 如果目录不包含任何产品/服务,则数组为空。 | Product[] | <产品> |
ProductShipping
定义运输成本。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
country | 获取或设置将商品寄送到的国家/地区的双字母 ISO 3166 国家/地区代码。 | String | <国家> |
locationGroupName | 获取或设置位置组名称。 | String | <location_group_name> |
locationId | 获取或设置将商品寄送到的地理位置的 ID。 有关 ID 的列表,请参阅 地理位置代码。 | String | <location_id> |
postalCode | 获取或设置将商品寄送到的地点的邮政编码或邮政编码范围。 可以按如下所示指定邮政编码:
|
String | <postal_code> |
价格 | 获取或设置将商品寄送到指定位置的固定价格。 | ProductPrice | <价格> |
地区 | 获取或设置将商品寄送到 (例如邮政编码) 的地理区域。 | String | <地区> |
服务 | 获取或设置描述服务类或交付速度的文本说明。 | String | <服务> |
ProductShippingWeight
定义项目的发货重量。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
单位 | 获取或设置度量单位。 | String |
unit 属性。例如,<shipping_weight unit=“oz”。> |
值 | 获取或设置项的重量,用于计算项目的运输成本。 | String | 文本值。 例如, <shipping_weight unit=“oz”>20.3<shipping_weight>。 |
ProductTax
定义确定适用税款的地理位置。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
country | 获取或设置适用税率的国家/地区。 使用双字母 ISO 3166 国家/地区代码。 | String | <国家> |
locationId | 获取或设置适用税率的地理位置的 ID。 有关 ID 的列表,请参阅 地理位置代码。 | 长型 | <location_id> |
postalCode | 获取或设置适用税率的邮政编码的邮政编码范围。 可以按如下所示指定邮政编码:
|
String | <postal_code> |
率 | 获取或设置要应用于项目价格的百分比税率。 若要指定 5% 的速率,请将此字段设置为 5。 若要指定 9.8% 速率,请将此字段设置为 9.8。 | 双精度 | <率> |
地区 | 获取或设置适用税率的地理区域。 | String | <地区> |
taxShip | 获取或设置一个布尔值,该值确定是否将税款应用于运输成本。 如果在发货时收取税款,则设置为 true 。 | 布尔值 | <船> |
UnitPricing
定义每个单价的项。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
单位 | 获取或设置度量单位。 例如,如果价格为每盎司,则为 盎司 。 | String |
unit 属性。例如, <unit_pricing_measure unit=“oz”> |
值 | 获取或设置每单位的价格。 | 双精度 | 文本值。 例如, <unit_pricing_measure unit=“oz”>34.5<\unit_pricing_measure> |
警告
定义警告消息。
名称 | 值 | 类型 | XML 元素名称 |
---|---|---|---|
domain | 仅供内部使用。 | String | <域> |
消息 | 警告的说明。 | String | <internalReason> |
reason | 产品/服务生成警告的原因。 例如,当已知制造商分配了标识符 (gtin、 mpn 或 品牌) 时,你没有提供标识符。 | String | <原因> |
HTTP 状态代码
请求可能会返回以下 HTTP 状态代码。
状态代码 | 说明 |
---|---|
200 | 成功。 |
204 | 已成功删除产品。 |
400 | 错误请求。 查询参数值无效或请求正文中的某些内容无效。 批处理:如果发生错误,失败的批处理项将包括错误。 |
401 | 未经授权。 用户的凭据无效。 |
404 | 未找到。 |
409 | 冲突。 由于与资源的当前状态冲突,操作无法完成。 |
413 | 请求实体太大。 请求的大小超出了允许的最大大小。 |
500 | 服务器错误。 |