索引
AccountLabelsService(界面)AccountsService(界面)CssProductInputsService(界面)CssProductsService(界面)QuotaService(界面)Account(消息)Account.AccountType(枚举)AccountLabel(消息)AccountLabel.LabelType(枚举)Attributes(消息)Certification(消息)CreateAccountLabelRequest(消息)CssProduct(消息)CssProductInput(消息)CssProductStatus(消息)CssProductStatus.DestinationStatus(消息)CssProductStatus.ItemLevelIssue(消息)DeleteAccountLabelRequest(消息)DeleteCssProductInputRequest(消息)GetAccountRequest(消息)GetCssProductRequest(消息)HeadlineOfferInstallment(消息)HeadlineOfferSubscriptionCost(消息)InsertCssProductInputRequest(消息)ListAccountLabelsRequest(消息)ListAccountLabelsResponse(消息)ListChildAccountsRequest(消息)ListChildAccountsResponse(消息)ListCssProductsRequest(消息)ListCssProductsResponse(消息)ListQuotaGroupsRequest(消息)ListQuotaGroupsResponse(消息)MethodDetails(消息)ProductDetail(消息)ProductDimension(消息)ProductWeight(消息)QuotaGroup(消息)SubscriptionPeriod(枚举)UpdateAccountLabelRequest(消息)UpdateAccountLabelsRequest(消息)UpdateCssProductInputRequest(消息)
AccountLabelsService
管理 Merchant Center 账号和 CSS 账号标签。
| CreateAccountLabel |
|---|
|
创建一个新标签,不分配给任何账号。
|
| DeleteAccountLabel |
|---|
|
删除标签,并将其从已分配该标签的所有账号中移除。
|
| ListAccountLabels |
|---|
|
列出账号拥有的标签。
|
| UpdateAccountLabel |
|---|
|
更新标签。
|
AccountsService
用于管理 CSS/MC 账号信息的服务。
| GetAccount |
|---|
|
根据 ID 检索单个 CSS/MC 账号。
|
| ListChildAccounts |
|---|
|
列出指定 CSS 账号 ID 下的所有账号,并可选择按标签 ID 和账号名称进行过滤。
|
| UpdateLabels |
|---|
|
更新 CSS 网域为 CSS/MC 账号分配的标签。
|
CssProductInputsService
用于使用 CssProductInput 资源的服务。此服务有助于插入/更新/删除 CSS 商品。
| DeleteCssProductInput |
|---|
|
从您的 CSS Center 账号中删除 CSS 商品输入内容。 删除后,输入内容可能需要几分钟才能不再可用。
|
| InsertCssProductInput |
|---|
|
将 CssProductInput 上传到您的 CSS Center 账号。如果已存在具有相同 contentLanguage、identity、feedLabel 和 feedId 的输入,此方法会替换该条目。 插入、更新或删除 CSS 商品输入后,可能需要几分钟才能检索到处理后的 CSS 商品。
|
| UpdateCssProductInput |
|---|
|
更新 CSS Center 账号中现有的 CSS 商品输入。 插入、更新或删除 CSS 商品输入后,可能需要几分钟才能检索到处理后的 CSS 商品。
|
CssProductsService
用于在 CSS 商品(在内部也称为“汇总商品”)上执行获取和列出操作的服务。
| GetCssProduct |
|---|
|
从您的 CSS Center 账号检索已处理的 CSS 商品。插入、更新或删除商品输入后,可能需要几分钟才能检索到更新后的最终商品。
|
| ListCssProducts |
|---|
|
列出 CSS Center 账号中已处理的 CSS 商品。响应中包含的项可能少于 pageSize 指定的数量。依赖于 pageToken 来确定是否还有更多要请求的项。 插入、更新或删除 CSS 商品输入后,可能需要几分钟才能检索到更新后的处理过的 CSS 商品。
|
QuotaService
用于按 CSS API 方法获取方法调用配额信息的服务。
| ListQuotaGroups |
|---|
|
列出 CSS Center 账号的每日调用配额和每个组的用量。
|
账号
有关 CSS/MC 账号的信息。
| 字段 | |
|---|---|
name |
标签资源名称。格式:accounts/{account} |
full_name |
仅限输出。不可变。CSS/MC 账号的全名。 |
label_ids[] |
由 CSS 父级账号为 CSS/MC 账号分配的手动创建的标签 ID。 |
automatic_label_ids[] |
由 CSS Center 为 MC 账号分配的自动创建的标签 ID。 |
account_type |
仅限输出。此账号的类型。 |
display_name |
CSS/MC 账号的简短显示名称。 |
homepage_uri |
仅限输出。不可变。CSS/MC 账号的主页。 |
parent |
CSS/MC 账号的父级资源。对于 CSS 网域,使用 CSS 组;对于 MC 账号,使用 CSS 网域。仅当用户有权访问父级账号时才会返回。注意:对于 MC 子账号,这也是 MCA 账号的父级资源 CSS 网域,因为我们会有效地扁平化层次结构。” |
AccountType
账号类型。
| 枚举 | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED |
账号类型未知。 |
CSS_GROUP |
CSS 组账号。 |
CSS_DOMAIN |
CSS 网域账号。 |
MC_PRIMARY_CSS_MCA |
MC 主要 CSS MCA 账号。 |
MC_CSS_MCA |
MC CSS MCA 账号。 |
MC_MARKETPLACE_MCA |
MC 购物平台 MCA 账号。 |
MC_OTHER_MCA |
MC 其他 MCA 账号。 |
MC_STANDALONE |
MC 独立账号。 |
MC_MCA_SUBACCOUNT |
MC MCA 子账号。 |
AccountLabel
CSS 网域或 CSS 组为其子账号分配的标签。
| 字段 | |
|---|---|
name |
标识符。标签的资源名称。格式:accounts/{account}/labels/{label} |
label_id |
仅限输出。标签的 ID。 |
account_id |
仅限输出。此标签所属的账号的 ID。 |
label_type |
仅限输出。此标签的类型。 |
display_name |
此标签的显示名称。 |
description |
此标签的说明。 |
LabelType
标签类型。
| 枚举 | |
|---|---|
LABEL_TYPE_UNSPECIFIED |
标签类型未知。 |
MANUAL |
表示标签是手动创建的。 |
AUTOMATIC |
表示该标签由 CSS Center 自动创建。 |
属性
CSS 商品的属性。
| 字段 | |
|---|---|
low_price |
CSS 商品的最低价。 |
high_price |
CSS 商品的最高价。 |
headline_offer_price |
CSS 商品的主推价格。 |
headline_offer_shipping_price |
CSS 商品的主推价格。 |
additional_image_links[] |
商品图片的其他网址。 |
product_types[] |
商品的类别(格式应遵循商品数据规范)。 |
size_types[] |
商品的剪裁方式。它可用于表示服饰商品的组合尺寸类型。最多可以提供两种尺码类型(请参阅 [https://support.google.com/merchants/answer/6324497](尺码类型))。 |
product_details[] |
技术规范或其他商品详情。 |
product_weight |
产品的重量(采用所提供的单位)。该值必须介于 0(不含)到 2000(含)之间。 |
product_length |
产品的长度(以所提供的单位表示)。该值必须介于 0(不含)到 3000(含)之间。 |
product_width |
产品的宽度(采用所提供的单位)。该值必须介于 0(不含)到 3000(含)之间。 |
product_height |
商品的高度(采用所提供的单位)。该值必须介于 0(不含)到 3000(含)之间。 |
product_highlights[] |
用于描述商品最重要的亮点的要点。 |
certifications[] |
CSS 为指定商品声明的证书列表。 |
expiration_date |
商品过期的日期(在插入时指定),采用 ISO 8601 格式。实际到期日期在 |
included_destinations[] |
为此定位目标添加的目标平台列表(对应于 Merchant Center 中选中的复选框)。除非在 |
excluded_destinations[] |
为此定位目标排除的目标平台列表(对应于 Merchant Center 中未选中的复选框)。 |
headline_offer_installment |
分期付款的期数和金额。 |
headline_offer_subscription_cost |
具有关联订阅合约的商品的付款周期(月或年)数和每个周期的付款金额。 |
cpp_link |
直接链接到 CSS 商品详情页面的网址。 |
cpp_mobile_link |
CSS 商品详情页面针对移动设备优化的版本的网址。 |
cpp_ads_redirect |
允许广告客户在商品在商品广告上下文中展示时替换商品网址。 |
number_of_offers |
CSS 商品的数量。 |
headline_offer_condition |
主推优惠的商品使用情况。 |
headline_offer_link |
主推优惠的链接。 |
headline_offer_mobile_link |
指向主推优惠的移动版链接。 |
title |
商品名。 |
image_link |
商品图片的网址。 |
description |
商品的说明。 |
brand |
与商品相关的属性。[14-36] 商品的品牌。 |
mpn |
商品的制造商部件号 (MPN)。 |
gtin |
商品的全球贸易项目代码 (GTIN)。 |
google_product_category |
商品在 Google 中的类别(请参阅 Google 商品类目)。查询商品时,此字段将包含用户提供的值。目前无法通过 API 恢复自动分配的 Google 商品类别。 |
adult |
如果商品的定位为成人商品,则设置为 true。 |
multipack |
商家定义的多件组合装中相同商品的数量。 |
is_bundle |
商品是否为商家定义的套装。套装是商家以单一价格销售的不同商品的自定义组合。 |
age_group |
商品的目标年龄段。 |
color |
商品的颜色。 |
gender |
商品的目标性别。 |
material |
商品的材质。 |
pattern |
商品的图案(例如圆点花纹)。 |
size |
商品的尺寸。仅允许设置一个值。对于不同尺寸的款式/规格,请为每种尺寸分别插入一个商品,并为其使用相同的 |
size_system |
指定尺寸的系统。建议为服饰商品提供。 |
item_group_id |
同一商品所有款式的共用标识符。 |
pause |
此项内容的发布将暂时中止。 |
custom_label_0 |
自定义标签 0,用于自定义购物广告系列中的商品分组。 |
custom_label_1 |
自定义标签 1,用于自定义购物广告系列中的商品分组。 |
custom_label_2 |
自定义标签 2,用于自定义购物广告系列中的商品分组。 |
custom_label_3 |
自定义标签 3,用于自定义购物广告系列中的商品分组。 |
custom_label_4 |
自定义标签 4,用于自定义购物广告系列中的商品分组。 |
认证
产品的认证。您可以使用此属性来描述与商品相关的认证,例如能效等级。
| 字段 | |
|---|---|
name |
认证的名称。目前,最常见的值是“EPREL”,表示欧盟欧洲产品能效标签注册中心 (EPREL) 数据库中的能效认证。 |
authority |
负责颁发认证的权威机构或认证机构。目前,对于欧盟的能效标识,最常见的值是“EC”或“European_Commission”。 |
code |
认证代码。例如,如果 EPREL 认证的链接为 https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456,则代码为 123456。对于欧洲能效标识,必须提供此代码。 |
CreateAccountLabelRequest
'CreateAccountLanel' 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。家长账号。格式:accounts/{account} |
account_label |
必需。要创建的标签。 |
CssProduct
处理后的 CSS 商品。
| 字段 | |
|---|---|
name |
CSS 商品的名称。格式: |
raw_provided_id |
仅限输出。商品的唯一原始标识符。 |
content_language |
仅限输出。商品的双字母 ISO 639-1 语言代码。 |
feed_label |
仅限输出。商品的 Feed 标签。 |
attributes |
仅限输出。商品属性列表。 |
custom_attributes[] |
仅限输出。自定义(CSS 提供)属性的列表。它还可用于以通用形式(例如 |
css_product_status |
仅限输出。商品的状态、数据验证问题,即异步计算的商品相关信息。 |
CssProductInput
此资源代表您为 CSS 商品提交的输入数据,而非您在 CSS Center、Google 购物广告或 Google 各平台上看到的经过处理的 CSS 商品。
| 字段 | |
|---|---|
name |
标识符。CSS 商品输入的名称。格式: |
final_name |
仅限输出。处理的 CSS 商品的名称。格式: |
raw_provided_id |
必需。CSS 商品的唯一标识符。这适用于 CSS 商品输入项和经过处理的 CSS 商品。我们仅允许使用字母数字、下划线和短划线。如需了解详情,请参阅商品 Feed 规范。 |
content_language |
必需。CSS 商品的双字母 ISO 639-1 语言代码。 |
feed_label |
必需。CSS 商品的Feed 标签。Feed 标签与“目标国家/地区”同义,因此应始终是有效的地区代码。例如:德国为“DE”,法国为“FR”。 |
freshness_time |
已弃用。请改用 expiration_date。表示 CSS 商品的现有版本(新鲜度),可用于在同时进行多项更新时保留正确的顺序。 此字段不得设为未来的时间。 如果已设置,则当系统中已有较新版本的商品时,系统会阻止更新(即现有 CSS 商品的上次更新时间晚于更新中设置的新鲜度时间)。如果发生更新,则上次更新时间会设置为此新鲜度时间。 如果未设置,系统将不会阻止更新,并且上次更新时间将默认为 CSS API 收到此请求的时间。 如果操作被阻止,系统会抛出中止异常。 |
attributes |
CSS 商品属性列表。 |
custom_attributes[] |
自定义(CSS 提供)属性的列表。它还可用于以通用形式(例如 |
CssProductStatus
CSS 商品的状态、数据验证问题,即异步计算的 CSS 商品相关信息。
| 字段 | |
|---|---|
destination_statuses[] |
商品的预期目的地。 |
item_level_issues[] |
与商品关联的所有问题的列表。 |
creation_date |
商品的创建日期,采用 ISO 8601 格式。 |
last_update_date |
商品的上次更新日期,采用 ISO 8601 格式。 |
google_expiration_date |
商品的到期日期,采用 ISO 8601 格式。 |
DestinationStatus
商品状态的目标状态。
| 字段 | |
|---|---|
destination |
目的地的名称 |
approved_countries[] |
CSS 商品已获批准的国家/地区代码 (ISO 3166-1 alpha-2) 列表。 |
pending_countries[] |
CSS 商品尚待审批的国家/地区代码 (ISO 3166-1 alpha-2) 列表。 |
disapproved_countries[] |
CSS 商品未获批准的国家/地区代码 (ISO 3166-1 alpha-2) 列表。 |
ItemLevelIssue
商品状态的 ItemLevelIssue。
| 字段 | |
|---|---|
code |
问题的错误代码。 |
servability |
此问题对 CSS 商品的投放有何影响。 |
resolution |
商家是否可以解决此问题。 |
attribute |
属性的名称(如果此问题是由单个属性引发的)。 |
destination |
问题适用的目标位置。 |
description |
以英文编写的简短问题说明。 |
detail |
以英文编写的详细问题说明。 |
documentation |
帮助解决此问题的网页的网址。 |
applicable_countries[] |
存在问题的 CSS 商品适用的国家/地区代码 (ISO 3166-1 alpha-2) 列表。 |
DeleteAccountLabelRequest
“DeleteAccountLabel”方法的请求消息。
| 字段 | |
|---|---|
name |
必需。要删除的标签的名称。格式:accounts/{account}/labels/{label} |
DeleteCssProductInputRequest
DeleteCssProductInput 方法的请求消息。
| 字段 | |
|---|---|
name |
必需。要删除的 CSS 商品输入资源的名称。格式:accounts/{account}/cssProductInputs/{css_product_input},其中最后一个部分 |
supplemental_feed_id |
Content API 补充 Feed ID。如果操作应用于主要 Feed,则不得设置此字段。如果设置了此字段,则商品操作会应用于补充 Feed,而不是主要 Content API Feed。 |
GetAccountRequest
GetAccount 方法的请求消息。
| 字段 | |
|---|---|
name |
必需。受管理的 CSS/MC 账号的名称。格式:accounts/{account} |
parent |
可选。仅在检索 MC 账号信息时才需要。作为 MC 账号父级资源的 CSS 网域。格式:accounts/{account} |
GetCssProductRequest
GetCssProduct 方法的请求消息。
| 字段 | |
|---|---|
name |
必需。要检索的 CSS 商品的名称。 |
HeadlineOfferInstallment
表示分期付款的消息。
| 字段 | |
|---|---|
months |
买家必须支付的分期付款期数。 |
amount |
买家每月必须支付的金额。 |
downpayment |
买家必须支付的预付首付款金额。 |
HeadlineOfferSubscriptionCost
商品的 SubscriptionCost。
| 字段 | |
|---|---|
period |
订阅期的类型。支持的值包括:*“ |
period_length |
买家必须支付的订阅期数。 |
amount |
买家每个订阅期需要支付的金额。 |
InsertCssProductInputRequest
InsertCssProductInput 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。要插入此 CSS 商品的账号。格式:accounts/{account} |
css_product_input |
必需。要插入的 CSS 商品输入。 |
feed_id |
可选。已弃用。CSS 商品不需要 Feed ID。主要 Feed 或补充 Feed ID。如果 CSS 商品已存在,并且提供的 Feed ID 不同,则 CSS 商品将移至新 Feed。注意:目前,CSS 无需提供 Feed ID,因为我们会动态创建 Feed。我们尚不支持 CSS 商品的补充 Feed。 |
ListAccountLabelsRequest
对 ListAccountLabels 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。家长账号。格式:accounts/{account} |
page_size |
要返回的标签的数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个标签。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListAccountLabelsResponse
ListAccountLabels 方法的响应消息。
| 字段 | |
|---|---|
account_labels[] |
指定账号中的标签。 |
next_page_token |
可作为 |
ListChildAccountsRequest
ListChildAccounts 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。家长账号。必须是 CSS 组或网域。格式:accounts/{account} |
page_size |
可选。要返回的账号数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个账号。最大值为 100;高于 100 的值将强制转换为 100。 |
page_token |
可选。从之前的 进行分页时,提供给 |
label_id |
如果设置,则仅返回具有给定标签 ID 的 MC 账号。 |
full_name |
如果设置,则仅返回具有给定名称(区分大小写)的 MC 账号。 |
ListChildAccountsResponse
ListChildAccounts 方法的响应消息。
| 字段 | |
|---|---|
accounts[] |
为指定 CSS 父级账号返回的 CSS/MC 账号。 |
next_page_token |
可作为 |
ListCssProductsRequest
ListCssProducts 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。要为其列出已处理的 CSS 商品的账号/网域。格式:accounts/{account} |
page_size |
要返回的 CSS 商品的数量上限。服务返回的值可能小于此值。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。如果未指定,则系统会返回 CSS 商品的数量上限。 |
page_token |
从之前的 进行分页时,提供给 |
ListCssProductsResponse
ListCssProducts 方法的响应消息。
| 字段 | |
|---|---|
css_products[] |
指定账号中已处理的 CSS 商品。这些是应用规则和补充 Feed 后处理后的 CSS 商品。 |
next_page_token |
可作为 |
ListQuotaGroupsRequest
ListQuotaGroups 方法的请求消息。
| 字段 | |
|---|---|
parent |
必需。拥有方法配额和资源集合的 CSS 账号。在大多数情况下,这是 CSS 网域。格式:accounts/{account} |
page_size |
可选。响应中可返回的配额数量上限,用于分页。默认为 500;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
可选。用于检索后续页面的令牌(如果提供)。所有其他参数都必须与提供页面令牌的原始调用一致。 |
ListQuotaGroupsResponse
ListMethodGroups 方法的响应消息。
| 字段 | |
|---|---|
quota_groups[] |
每组的方法、当前配额用量和限制。该配额会在组中的所有方法之间共享。这些组会按 |
next_page_token |
可作为 |
MethodDetails
CSS API 中每种方法的方法详情。
| 字段 | |
|---|---|
method |
仅限输出。方法的名称,例如 |
version |
仅限输出。方法所属的 API 版本。 |
subapi |
仅限输出。方法所属的子 API。在 CSS API 中,此值始终为 |
path |
仅限输出。方法的路径,例如 |
ProductDetail
商品详情。
| 字段 | |
|---|---|
section_name |
用于对一组商品详情进行分组的部分标题。 |
attribute_name |
商品详情的名称。 |
attribute_value |
商品详情的值。 |
ProductDimension
商品的尺寸。
| 字段 | |
|---|---|
value |
必需。以数字表示的维度值。值最多可精确到小数点后 4 位。 |
unit |
必需。尺寸单位。可接受的值包括:*“ |
ProductWeight
商品的重量。
| 字段 | |
|---|---|
value |
必需。权重,以数字表示。权重最多可精确到小数点后 4 位。 |
unit |
必需。重量单位。可接受的值包括:* " |
QuotaGroup
CSS API 中方法的组信息。该配额会在组中的所有方法之间共享。即使组中的所有方法都没有使用情况,系统也会返回该组的信息。
| 字段 | |
|---|---|
name |
标识符。配额组的资源名称。格式:accounts/{account}/quotas/{group} 示例: |
quota_usage |
仅限输出。当前配额用量,即在给定日期对组中方法已完成的调用次数。每日配额限制会在世界协调时间中午 12:00 重置。 |
quota_limit |
仅限输出。群组每天允许的通话次数上限。 |
quota_minute_limit |
仅限输出。群组每分钟允许的通话次数上限。 |
method_details[] |
仅限输出。适用于方法组配额的所有方法的列表。 |
SubscriptionPeriod
商品的订阅期。
| 枚举 | |
|---|---|
SUBSCRIPTION_PERIOD_UNSPECIFIED |
表示未指定订阅期。 |
MONTH |
表示订阅期为月。 |
YEAR |
表示订阅期为年。 |
UpdateAccountLabelRequest
对 UpdateAccountLabel 方法的请求消息。
| 字段 | |
|---|---|
account_label |
必需。更新后的标签。必须提供所有字段。 |
UpdateAccountLabelsRequest
UpdateLabels 方法的请求消息。
| 字段 | |
|---|---|
name |
必需。标签资源名称。格式:accounts/{account} |
label_ids[] |
要覆盖现有账号标签 ID 的标签 ID 列表。如果列表为空,系统会删除当前分配的所有标签 ID。 |
parent |
可选。仅在更新 MC 账号标签时才需要。作为 MC 账号父级资源的 CSS 网域。格式:accounts/{account} |
UpdateCssProductInputRequest
UpdateCssProductInput 方法的请求消息。
| 字段 | |
|---|---|
css_product_input |
必需。要更新的 CSS 商品输入资源。您提交的信息也会应用于处理后的 CSS 商品。 |
update_mask |
要更新的 CSS 商品属性的列表。 如果省略更新掩码,则系统会将其视为隐式字段掩码,相当于填充的所有字段(具有非空值)。 如果更新掩码中指定的属性在正文中未指定值,则系统会从 CSS 商品中删除该属性。 更新掩码只能针对属性和自定义属性中的顶级字段指定。 如需为自定义属性指定更新掩码,您需要添加 不支持为完整的 CSS 商品替换提供特殊“*”值。 |