Package google.shopping.merchant.accounts.v1beta

索引

AccountIssueService

用于支持 AccountIssueService API 的服务。

ListAccountIssues

rpc ListAccountIssues(ListAccountIssuesRequest) returns (ListAccountIssuesResponse)

列出 Merchant Center 账号的所有账号问题。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

AccountsService

用于支持 Accounts API 的服务。

CreateAndConfigureAccount

rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)

创建具有额外配置的独立 Merchant Center 账号。将发出请求的用户添加为新账号的管理员。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

删除指定的账号,无论其类型为何(独立账号、MCA 账号或子账号)。删除 MCA 会导致其所有子账号一并被删除。执行此方法需要管理员权限。只有当该账号不向任何其他账号提供服务且没有处理过的商品时,删除才会成功。您可以使用 force 参数替换此设置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

从您的 Merchant Center 账号检索账号。插入、更新或删除账号后,所做更改可能需要几分钟才能生效。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

列出可供发起调用的用户访问且与请求的约束条件(例如页面大小或过滤条件)匹配的账号。这不仅会列出 MCA 的子账号,还会列出发起调用的用户有权访问的所有账号,包括其他 MCA、关联的账号、独立账号等。如果未提供过滤条件,则会返回用户直接添加到其中的账号。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListSubAccounts

rpc ListSubAccounts(ListSubAccountsRequest) returns (ListSubAccountsResponse)

列出指定多客户账号的所有子账号。这是一个适用于更强大的 ListAccounts 方法的便捷封装容器。此方法会产生与使用以下过滤条件调用 ListsAccounts 相同的结果:relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

更新账号,无论其类型为何(独立账号、MCA 账号或子账号)。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

AutofeedSettingsService

用于支持自动 Feed 设置的服务。

GetAutofeedSettings

rpc GetAutofeedSettings(GetAutofeedSettingsRequest) returns (AutofeedSettings)

检索账号的自动 Feed 设置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateAutofeedSettings

rpc UpdateAutofeedSettings(UpdateAutofeedSettingsRequest) returns (AutofeedSettings)

更新账号的自动 Feed 设置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

BusinessIdentityService

用于支持商家身份 API 的服务。

GetBusinessIdentity

rpc GetBusinessIdentity(GetBusinessIdentityRequest) returns (BusinessIdentity)

检索账号的商家身份。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateBusinessIdentity

rpc UpdateBusinessIdentity(UpdateBusinessIdentityRequest) returns (BusinessIdentity)

更新账号的商家身份。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

BusinessInfoService

用于支持商家信息 API 的服务。

GetBusinessInfo

rpc GetBusinessInfo(GetBusinessInfoRequest) returns (BusinessInfo)

检索账号的商家信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateBusinessInfo

rpc UpdateBusinessInfo(UpdateBusinessInfoRequest) returns (BusinessInfo)

更新账号的商家信息。执行此方法需要管理员访问权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

EmailPreferencesService

用于支持 EmailPreferences API 的服务。

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences)

返回 Merchant Center 账号用户的电子邮件接收设置。此服务仅允许检索和更新经过身份验证的用户的电子邮件偏好设置。使用 name=accounts/*/users/me/emailPreferences 别名可获取经过身份验证的用户的偏好设置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateEmailPreferences

rpc UpdateEmailPreferences(UpdateEmailPreferencesRequest) returns (EmailPreferences)

更新 Merchant Center 账号用户的电子邮件接收设置。MCA 用户应指定 MCA 账号,而不是 MCA 的子账号。

未在更新掩码中明确选择的偏好设置将不会更新。

更新不得指定“用户未确认”的用户选择接受状态值。

使用 name=accounts/*/users/me/emailPreferences 别名更新经过身份验证的用户的偏好设置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

HomepageService

用于为商店首页支持 API 的服务。

ClaimHomepage

rpc ClaimHomepage(ClaimHomepageRequest) returns (Homepage)

声明商店的首页。执行此方法需要管理员权限。

如果首页已声明所有权,此操作将重新检查验证状态(除非商家免于声明所有权,这也免于验证),并返回成功的响应。如果无法再验证所有权,则会返回错误,但不会清除版权主张。如果失败,系统会返回规范错误消息:* PERMISSION_DENIED:用户无权访问此 MC 账号;* FAILED_PRECONDITION:- 该账号不是 Merchant Center 账号;- MC 账号没有首页;- 声明失败(在这种情况下,错误消息将包含更多详细信息)。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetHomepage

rpc GetHomepage(GetHomepageRequest) returns (Homepage)

检索商店的首页。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UnclaimHomepage

rpc UnclaimHomepage(UnclaimHomepageRequest) returns (Homepage)

取消声明商店首页的所有权。执行此方法需要管理员访问权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateHomepage

rpc UpdateHomepage(UpdateHomepageRequest) returns (Homepage)

更新商店的首页。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

OnlineReturnPolicyService

该服务有助于管理商家因买家反悔而退货的退货政策配置,涵盖适用于广告和非付费商品详情的退货政策

计划。此 API 定义了以下资源模型:

[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]

GetOnlineReturnPolicy

rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy)

获取现有退货政策。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListOnlineReturnPolicies

rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest) returns (ListOnlineReturnPoliciesResponse)

列出所有现有的退货政策。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ProgramsService

用于管理计划的服务。

计划提供了一种向商家账号添加功能的机制。一个典型的例子就是非付费商品详情计划,该计划可让商家在 Google 各平台上免费展示其商店中的商品。

除了用于明确启用或停用参与各个计划的方法之外,此服务还公开了用于检索商家参与的所有可用计划的方法。

DisableProgram

rpc DisableProgram(DisableProgramRequest) returns (Program)

禁止账号参与指定计划。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

EnableProgram

rpc EnableProgram(EnableProgramRequest) returns (Program)

为账号启用参与指定计划的权限。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetProgram

rpc GetProgram(GetProgramRequest) returns (Program)

检索账号的指定计划。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListPrograms

rpc ListPrograms(ListProgramsRequest) returns (ListProgramsResponse)

检索账号的所有计划。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

RegionsService

管理区域配置。

此 API 定义了以下资源模型:

  • Region
CreateRegion

rpc CreateRegion(CreateRegionRequest) returns (Region)

在 Merchant Center 账号中创建地区定义。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

DeleteRegion

rpc DeleteRegion(DeleteRegionRequest) returns (Empty)

从您的 Merchant Center 账号中删除地区定义。执行此方法需要管理员访问权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetRegion

rpc GetRegion(GetRegionRequest) returns (Region)

检索 Merchant Center 账号中定义的地区。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListRegions

rpc ListRegions(ListRegionsRequest) returns (ListRegionsResponse)

列出 Merchant Center 账号中的地区。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateRegion

rpc UpdateRegion(UpdateRegionRequest) returns (Region)

更新 Merchant Center 账号中的地区定义。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ShippingSettingsService

用于按 Merchant API 方法获取方法调用配送设置信息的服务。

GetShippingSettings

rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings)

检索运费设置信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

InsertShippingSettings

rpc InsertShippingSettings(InsertShippingSettingsRequest) returns (ShippingSettings)

将商家的运费设置替换为申请配送设置。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

TermsOfServiceAgreementStateService

用于支持 TermsOfServiceAgreementState API 的服务。

GetTermsOfServiceAgreementState

rpc GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

返回服务条款协议的状态。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

RetrieveForApplicationTermsOfServiceAgreementState

rpc RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

检索应用服务条款的协议状态。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

TermsOfServiceService

用于支持 TermsOfService API 的服务。

AcceptTermsOfService

rpc AcceptTermsOfService(AcceptTermsOfServiceRequest) returns (Empty)

接受 TermsOfService。执行此方法需要管理员权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetTermsOfService

rpc GetTermsOfService(GetTermsOfServiceRequest) returns (TermsOfService)

检索与所提供的版本关联的 TermsOfService

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

RetrieveLatestTermsOfService

rpc RetrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest) returns (TermsOfService)

检索给定 kindregion_code 的最新版本 TermsOfService

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UserService

用于支持用户 API 的服务。

CreateUser

rpc CreateUser(CreateUserRequest) returns (User)

创建 Merchant Center 账号用户。执行此方法需要管理员访问权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

DeleteUser

rpc DeleteUser(DeleteUserRequest) returns (Empty)

删除 Merchant Center 账号用户。执行此方法需要管理员访问权限。要删除的用户不能是该账号的最后一位管理员用户。此外,如果用户由商家管理工具管理,则不会被删除”

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

GetUser

rpc GetUser(GetUserRequest) returns (User)

检索 Merchant Center 账号用户。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

ListUsers

rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)

列出 Merchant Center 账号的所有用户。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

UpdateUser

rpc UpdateUser(UpdateUserRequest) returns (User)

更新 Merchant Center 账号用户。执行此方法需要管理员访问权限。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

如需了解详情,请参阅 OAuth 2.0 概览

AcceptTermsOfServiceRequest

AcceptTermsOfService 方法的请求消息。

字段
name

string

必需。服务条款版本的资源名称。格式:termsOfService/{version}

account

string

必需。要接受服务条款的账号。

region_code

string

必需。由 CLDR 定义的地区代码。如果服务条款仅适用于某个国家/地区,则此字段应填写相应国家/地区的代码;如果服务条款适用于全球,则应填写 001。

已接受

说明已接受的服务条款。

字段
terms_of_service

string

已接受的termsOfService

accepted_by

string

记录接受情况的账号。这可以是账号本身;如果是子账号,也可以是 MCA 账号。

valid_until

Date

设置后,它会声明接受的 TermsOfService 仅在此日期(采用世界协调时间)结束之前有效。您必须在该日期之前接受新的合作伙伴协议。您可以在必需消息中找到所需 TermsOfService 的信息。

AccessRight

访问权限。

枚举
ACCESS_RIGHT_UNSPECIFIED 默认值。此值未使用。
STANDARD 标准访问权限。
ADMIN 管理员访问权限。
PERFORMANCE_REPORTING 拥有此权限的用户可以访问效果和数据洞见。

账号

账号。

字段
name

string

标识符。账号的资源名称。格式:accounts/{account}

account_id

int64

仅限输出。账号的 ID。

account_name

string

必需。人类可读的账号名称。如需了解详情,请参阅商店名称商家名称

adult_content

bool

此账号是否包含成人内容。

test_account

bool

仅限输出。此账号是否为测试账号。

time_zone

TimeZone

必需。账户的时区。

在写入时,time_zone 会同时设置 reporting_time_zonedisplay_time_zone

对于读取操作,time_zone 始终返回 display_time_zone。如果您的账号不存在 display_time_zone,则 time_zone 为空。

language_code

string

必需。账号的 BCP-47 语言代码,例如 en-USsr-Latn

AccountAggregation

此类型没有字段。

AccountAggregation 载荷。

AccountIssue

AccountIssue

字段
name

string

标识符。账号问题的资源名称。格式:accounts/{account}/issues/{id}

title

string

问题的本地化标题。

severity

Severity

问题的总体严重程度。

impacted_destinations[]

ImpactedDestination

此问题对各种目标平台的影响。

detail

string

有关该问题的进一步本地化详细信息。

documentation_uri

string

指向 Merchant Center 帮助中心的链接,其中详细介绍了此问题以及解决方法。

ImpactedDestination

问题对目标平台的影响。

字段
impacts[]

Impact

给定目标平台在不同地区的负面影响。

reporting_context

ReportingContextEnum

受影响的报告上下文。

影响

问题对某个区域的影响。

字段
region_code

string

此问题适用的 CLDR 地区代码

severity

Severity

目标和地区上问题的严重程度。

严重程度

所有可能的问题严重程度。

枚举
SEVERITY_UNSPECIFIED 严重程度未知。
CRITICAL 该问题会导致优惠无法投放。
ERROR 此问题可能会影响商品(未来),也可能表明商品存在问题。
SUGGESTION 此问题是改进建议。

地址

仓库的送货地址。

字段
street_address

string

地址的街道级部分。例如:111w 31st Street

city

string

必需。城市、城镇或公社。还可以包括乡镇/郊区或子级市行政区(例如街区或郊区)。

administrative_area

string

必需。国家/地区的顶级行政区划。例如,加利福尼亚州(“CA”)或魁北克省(“QC”)等州/省。

postal_code

string

必需。邮政编码(例如“100000”)。

region_code

string

必需。CLDR 国家/地区代码(例如“US”)。

AutofeedSettings

自动 Feed 设置相关的信息集合。

字段
name

string

标识符。自动 Feed 设置的资源名称。格式:accounts/{account}/autofeedSettings

enable_products

bool

必需。为指定账号启用或停用通过自动 Feed 抓取商品的功能。自动 Feed 账号必须满足特定条件,您可以通过 eligible 字段查看这些条件。该账号不得是购物平台。首次启用自动 Feed 后,商品通常会立即显示。重新启用后,商品最多可能需要 24 小时才会显示。

eligible

bool

仅限输出。确定商家是否符合使用自动 Feed 的条件。

BusinessDayConfig

显示仓库的工作日。

字段
business_days[]

Weekday

必需。普通工作日。不得为空。

星期几

枚举
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

BusinessIdentity

商家身份相关的信息集合。

字段
name

string

标识符。商家身份的资源名称。格式:accounts/{account}/businessIdentity

black_owned

IdentityAttribute

可选。指定商家是否自称是黑人经营的商家。此选填字段仅适用于将商家所在国家/地区设为 US 的商家。也不适用于购物平台或购物平台卖家。

women_owned

IdentityAttribute

可选。指定商家是否自称是女性经营的商家。此选填字段仅适用于将商家所在国家/地区设为 US 的商家。也不适用于购物平台或购物平台卖家。

veteran_owned

IdentityAttribute

可选。指定商家是否将自己标识为退伍军人经营的商家。此选填字段仅适用于将商家所在国家/地区设为 US 的商家。也不适用于购物平台或购物平台卖家。

latino_owned

IdentityAttribute

可选。指定商家是否自称是拉丁裔所有。此选填字段仅适用于将商家所在国家/地区设为 US 的商家。此设置也不适用于购物平台或购物平台卖家。

small_business

IdentityAttribute

可选。指定商家是否将自己标识为小型商家。此选填字段仅适用于将商家所在国家/地区设为 US 的商家。此设置也不适用于购物平台。

IdentityAttribute

与身份属性相关的所有信息。

字段
identity_declaration

IdentityDeclaration

必需。此属性的身份声明。

IdentityDeclaration

与声明身份相关的所有可能设置。

枚举
IDENTITY_DECLARATION_UNSPECIFIED 默认值,表示未进行任何选择。
SELF_IDENTIFIES_AS 表示账号使用该属性进行标识。
DOES_NOT_SELF_IDENTIFY_AS 表示账号不具有该属性。

PromotionsConsent

与商家身份相关的所有可能的促销活动设置。

枚举

BusinessInfo

与商家相关的信息集合。

字段
name

string

标识符。商家信息的资源名称。格式:accounts/{account}/businessInfo

address

PostalAddress

可选。商家的地址。

phone

PhoneNumber

仅限输出。商家的电话号码。

phone_verification_state

PhoneVerificationState

仅限输出。商家的电话验证状态。

customer_service

CustomerService

可选。商家的客户服务。

korean_business_registration_number

string

可选。10 位数的韩国企业注册号,以英文短划线分隔,格式为 XXX-XX-XXXXX。

CarrierRate

可由 main_tablesingle_value 引用的运营商费率列表。

字段
name

string

必需。运输公司费率的名称。每个费率组的编号必须是唯一的。

carrier

string

必需。运营商服务,例如 "UPS""Fedex"

carrier_service

string

必需。运营商服务,例如 "ground""2 days"

origin_postal_code

string

必需。此运输公司费率的配送起点。

percentage_adjustment

string

可选。以十进制表示的乘法配送费率修饰符。可以为负数。例如,"5.4" 会将费率提高 5.4%,"-3" 会将费率降低 3%。

flat_adjustment

Price

可选。加法运费修饰符。可以是负数。例如,{ "amount_micros": 1, "currency_code" : "USD" } 会将费率增加 1 美元,{ "amount_micros": -3, "currency_code" : "USD" } 会将费率减少 3 美元。

ClaimHomepageRequest

ClaimHomepage 方法的请求消息。

字段
name

string

必需。要声明所有权的首页的名称。格式:accounts/{account}/homepage

overwrite

bool

可选。将此选项设置为 true 后,系统会移除所请求网站上的所有现有版权主张,并将其替换为发出请求的账号的版权主张。

CreateAndConfigureAccountRequest

CreateAndConfigureAccount 方法的请求消息。

字段
account

Account

必需。要创建的账号。

users[]

CreateUserRequest

可选。要添加到账号中的用户。

service[]

AddAccountService

必需。在创建过程中,系统会初始化要创建的账号与提供方账号之间的账号服务。至少需要提供一项此类服务。目前,其中一个账号必须是 account_aggregation,这意味着您只能通过此方法创建子账号,而不能创建独立账号。可能会提供额外的 account_managementproduct_management 服务。

AddAccountService

有关在创建账号时添加账号服务的其他说明。

字段
联合字段 service_type。要添加的服务类型。service_type 只能是下列其中一项:
account_aggregation

AccountAggregation

提供商是该账号的聚合信息网站。服务类型为“账号汇总”的载荷。

provider

string

必需。服务的提供商。格式:accounts/{account}

CreateRegionRequest

CreateRegion 方法的请求消息。

字段
parent

string

必需。要为其创建地区的账号。格式:accounts/{account}

region_id

string

必需。地区的标识符,在同一账号的所有地区中具有唯一性。

region

Region

必需。要创建的区域。

CreateUserRequest

CreateUser 方法的请求消息。

字段
parent

string

必需。将为其创建用户的账号的资源名称。格式:accounts/{account}

user_id

string

必需。用户的电子邮件地址(例如 john.doe@gmail.com)。

user

User

必需。要创建的用户。

CustomerService

客户服务信息。

字段
uri

string

可选。可以找到客户服务的 URI。

email

string

可选。可联系客户服务的电子邮件地址。

phone

PhoneNumber

可选。可拨打的客户服务电话号码。

CutoffTime

工作日截止时间定义。

字段
hour

int32

必需。截止时间(下单截止时间),订单必须在此之前下单,才能在当天处理。

minute

int32

必需。截止时间的分钟数,订单必须在此时间之前下单,才能在当天处理。

time_zone

string

必需。时区标识符,例如“Europe/Zurich”。

DeleteAccountRequest

DeleteAccount 方法的请求消息。

字段
name

string

必需。要删除的账号的名称。格式:accounts/{account}

force

bool

可选。如果设置为 true,系统会删除该账号,即使该账号向其他账号提供服务或处理了商品交易也是如此。

DeleteRegionRequest

DeleteRegion 方法的请求消息。

字段
name

string

必需。要删除的地区的名称。格式:accounts/{account}/regions/{region}

DeleteUserRequest

DeleteUser 方法的请求消息。

字段
name

string

必需。要删除的用户的名称。格式:accounts/{account}/users/{email}

您还可以使用 me(而不是 accounts/{account}/users/me 中的电子邮件地址)删除与调用方对应的用户。

DeliveryTime

从下单到商品送达所花费的各个方面时间。

字段
warehouse_based_delivery_times[]

WarehouseBasedDeliveryTime

可选。表示应根据所选运输公司的设置,按仓库(发货地点)计算送货时间。设置此字段后,[送货时间][[google.shopping.content.bundles.ShippingSetting.DeliveryTime]] 中的任何其他与运送时间相关的字段均不应设置。

min_transit_days

int32

在运输途中花费的最小工作日天数。0 表示当天送达,1 表示次日送达。必须设置 min_transit_daysmax_transit_daystransit_time_table,但不能同时设置这两者。

max_transit_days

int32

运送所需的最长工作日数。0 表示当天送达,1 表示次日送达。必须大于或等于 min_transit_days

cutoff_time

CutoffTime

工作日截止时间定义。如果未配置,截止时间将默认为太平洋标准时间上午 8 点。

min_handling_days

int32

订单发货前所需的最短工作日天数。0 表示当天发货,1 表示次日发货。“min_handling_days”和“max_handling_days”应同时设置或同时不设置。

max_handling_days

int32

订单发货前所需的最长工作日天数。0 表示当天发货,1 表示次日发货。必须大于或等于 min_handling_days。“min_handling_days”和“max_handling_days”应同时设置或同时不设置。

transit_time_table

TransitTable

运送时间表,根据行和列维度显示运送所需的工作日数。您可以设置 min_transit_daysmax_transit_daystransit_time_table,但不能同时设置这两者。

handling_business_day_config

BusinessDayConfig

可以处理订单的工作日。如果未提供,系统会假定为周一至周五的工作日。

transit_business_day_config

BusinessDayConfig

可以运送订单的工作日。如果未提供,系统会假定为周一至周五的工作日。

DisableProgramRequest

针对 DisableProgram 方法的请求消息。

字段
name

string

必需。要为指定账号停用参与的计划的名称。格式:accounts/{account}/programs/{program}

距离

最大配送半径。只有本地送货配送类型需要此字段。

字段
value

int64

距离的整数值。

unit

Unit

单位可能会因国家/地区而异,参数化为包括英里和公里。

单位

单位可能会因国家/地区而异,其参数包括英里和公里。

枚举
UNIT_UNSPECIFIED 未指定单位
MILES 以英里为单位
KILOMETERS 单位为公里

EmailPreferences

用户选择接收 / 选择停止接收的通知类别。电子邮件接收设置不包括必读的通告,因为用户无法选择不接收这些通告。

字段
name

string

标识符。EmailPreferences 的名称。此端点仅适用于经过身份验证的用户。

news_and_tips

OptInState

可选。有关新功能、提示和最佳做法的最新动态。

OptInState

电子邮件接收设置的状态。

枚举
OPT_IN_STATE_UNSPECIFIED 未指定用户选择接受的状态。
OPTED_OUT 用户已选择不接收此类电子邮件。
OPTED_IN 用户已选择接收此类电子邮件。
UNCONFIRMED 用户已选择接收此类电子邮件,并且系统已发送确认电子邮件,但用户尚未确认选择接收(仅适用于某些国家/地区)。

EnableProgramRequest

EnableProgram 方法的请求消息。

字段
name

string

必需。要为指定账号启用参与的计划的名称。格式:accounts/{account}/programs/{program}

GetAccountRequest

GetAccount 方法的请求消息。

字段
name

string

必需。要检索的账号的名称。格式:accounts/{account}

GetAutofeedSettingsRequest

GetAutofeedSettings 方法的请求消息。

字段
name

string

必需。自动 Feed 设置的资源名称。格式:accounts/{account}/autofeedSettings

GetBusinessIdentityRequest

GetBusinessIdentity 方法的请求消息。

字段
name

string

必需。商家身份的资源名称。格式:accounts/{account}/businessIdentity

GetBusinessInfoRequest

GetBusinessInfo 方法的请求消息。

字段
name

string

必需。商家信息的资源名称。格式:accounts/{account}/businessInfo

GetEmailPreferencesRequest

GetEmailPreferences 方法的请求消息。

字段
name

string

必需。EmailPreferences 资源的名称。格式:accounts/{account}/users/{email}/emailPreferences

GetHomepageRequest

GetHomepage 方法的请求消息。

字段
name

string

必需。要检索的主页的名称。格式:accounts/{account}/homepage

GetOnlineReturnPolicyRequest

GetOnlineReturnPolicy 方法的请求消息。

字段
name

string

必需。要检索的退货政策的名称。格式:accounts/{account}/onlineReturnPolicies/{return_policy}

GetProgramRequest

GetProgram 方法的请求消息。

字段
name

string

必需。要检索的计划的名称。格式:accounts/{account}/programs/{program}

GetRegionRequest

GetRegion 方法的请求消息。

字段
name

string

必需。要检索的地区的名称。格式:accounts/{account}/regions/{region}

GetShippingSettingsRequest

GetShippingSetting 方法的请求消息。

字段
name

string

必需。要检索的配送设置的名称。格式:accounts/{account}/shippingsetting

GetTermsOfServiceAgreementStateRequest

GetTermsOfServiceAgreementState 方法的请求消息。

字段
name

string

必需。服务条款版本的资源名称。格式:accounts/{account}/termsOfServiceAgreementState/{identifier}。标识符格式为:{TermsOfServiceKind}-{country}

GetTermsOfServiceRequest

GetTermsOfService 方法的请求消息。

字段
name

string

必需。服务条款版本的资源名称。格式:termsOfService/{version}

GetUserRequest

GetUser 方法的请求消息。

字段
name

string

必需。要检索的用户的名称。格式:accounts/{account}/users/{email}

您还可以使用 me(而不是 accounts/{account}/users/me 中的电子邮件地址)检索与调用方对应的用户。

标头

表格的行或列标题的非空列表。必须设置 pricesweightsnum_itemspostal_code_group_nameslocation 其中之一。

字段
prices[]

Price

必需。包含上限的订单价格上限列表。通过将价格 amount_micros 设置为 -1,可以将最后一个价格的值设为无穷大。例如,[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] 表示标头“<= $10”“<= $500”和“> $500”。同一服务中的所有价格都必须采用相同的币种。不得为空。必须为正数,但 -1 除外。只有在所有其他字段均未设置的情况下才能设置此字段。

weights[]

Weight

必需。包含上限的订单重量上限列表。通过将价格 amount_micros 设置为 -1,可以将最后一个权重的值设为无穷大。例如,[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] 表示标题“<= 10kg”“<= 50kg”和“> 50kg”。服务中的所有权重都必须使用相同的单位。不得为空。必须为正值(-1 除外)。只有在所有其他字段都未设置时才能设置。

number_of_items[]

string

必需。包含项目数量上限的列表。最后一个值可以是 "infinity"。例如,["10", "50", "infinity"] 表示标题“<= 10 项”“<= 50 项”和“> 50 项”。不得为空。只有在所有其他字段均未设置的情况下才能设置此字段。

postal_code_group_names[]

string

必需。邮政组名称列表。最后一个值可以是 "all other locations"。示例:["zone 1", "zone 2", "all other locations"]。提及的邮政编码组必须与服务的送货国家/地区一致。不得为空。只有在未设置所有其他字段的情况下才能设置此字段。

locations[]

LocationIdSet

必需。位置 ID 集的列表。不得为空。只有在所有其他字段均未设置的情况下才能设置此字段。

首页

商店首页。

字段
name

string

标识符。商店首页的资源名称。格式:accounts/{account}/homepage

claimed

bool

仅限输出。是否声明了首页的所有权。请参阅 https://support.google.com/merchants/answer/176793

uri

string

必需。商店首页的 URI(通常为网址)。

InsertShippingSettingsRequest

InsertShippingSetting 方法的请求消息。

字段
parent

string

必需。要插入此商品的账号。格式:accounts/{account}

shipping_setting

ShippingSettings

必需。新版账号。

ListAccountIssuesRequest

ListAccountIssues 方法的请求消息。

字段
parent

string

必需。拥有此问题集合的父级。格式:accounts/{account}

page_size

int32

可选。要返回的最大问题数。服务返回的值可能小于此值。如果未指定,则最多返回 50 位用户。最大值为 100;高于 100 的值将强制转换为 100

page_token

string

可选。从之前的 ListAccountIssues 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListAccountIssues 的所有其他参数必须与提供页面令牌的调用匹配。

language_code

string

可选。响应中的错误将包含采用给定语言的直观易懂的字段。格式为 BCP-47,例如 en-USsr-Latn。如果未提供任何值,系统将使用 en-US

time_zone

string

可选。用于在人类可读字段中对时间进行本地化的 IANA 时区。例如“America/Los_Angeles”。如果未设置,则使用“America/Los_Angeles”。

ListAccountIssuesResponse

ListAccountIssues 方法的响应消息。

字段
account_issues[]

AccountIssue

指定账号存在的问题。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListAccountsRequest

ListAccounts 方法的请求消息。

字段
page_size

int32

可选。要返回的账号数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 250 个账号。最大值为 500;大于 500 的值将被强制转换为 500。

page_token

string

可选。从之前的 ListAccounts 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListAccounts 的所有其他参数必须与提供页面令牌的调用匹配。

filter

string

可选。仅返回与过滤条件匹配的账号。如需了解详情,请参阅过滤条件语法参考文档

ListAccountsResponse

ListAccounts 方法的响应消息。

字段
accounts[]

Account

ListAccountsRequest匹配的账号。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListOnlineReturnPoliciesRequest

ListOnlineReturnPolicies 方法的请求消息。

字段
parent

string

必需。要列出退货政策的商家账号。格式:accounts/{account}

page_size

int32

可选。要返回的 OnlineReturnPolicy 资源数上限。如果给定商家的退货政策数量少于 pageSize,则该服务返回的数量会少于此值。默认值为 10。最大值为 100;如果指定的值高于上限,则 pageSize 将默认为上限

page_token

string

可选。从之前的 ListOnlineReturnPolicies 调用接收的页面令牌。提供页面令牌以检索后续页面。

进行分页时,提供给 ListOnlineReturnPolicies 的所有其他参数必须与提供页面令牌的调用匹配。在对上一个请求的响应中以 nextPageToken 形式返回的令牌。

ListOnlineReturnPoliciesResponse

ListOnlineReturnPolicies 方法的响应消息。

字段
online_return_policies[]

OnlineReturnPolicy

检索到的退货政策。

next_page_token

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListProgramsRequest

ListPrograms 方法的请求消息。

字段
parent

string

必需。要为其检索所有程序的账号名称。格式:accounts/{account}

page_size

int32

可选。单个响应中可返回的节目数量上限。如果未指定(或 0),则使用默认大小 1000。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

page_token

string

可选。从之前的 ListPrograms 调用接收的续订令牌。提供此令牌以检索下一页。

ListProgramsResponse

ListPrograms 方法的响应消息。

字段
programs[]

Program

指定账号的程序。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListRegionsRequest

ListRegions 方法的请求消息。

字段
parent

string

必需。要为其列出区域的账号。格式:accounts/{account}

page_size

int32

可选。要返回的区域数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个区域。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

page_token

string

可选。从之前的 ListRegions 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListRegions 的所有其他参数必须与提供页面令牌的调用匹配。

ListRegionsResponse

ListRegions 方法的响应消息。

字段
regions[]

Region

指定商家的地区。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSubAccountsRequest

ListSubAccounts 方法的请求消息。

字段
provider

string

必需。家长账号。格式:accounts/{account}

page_size

int32

可选。要返回的账号数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 250 个账号。最大值为 500;大于 500 的值将被强制转换为 500。

page_token

string

可选。从之前的 ListAccounts 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListAccounts 的所有其他参数必须与提供页面令牌的调用匹配。

ListSubAccountsResponse

ListSubAccounts 方法的响应消息。

字段
accounts[]

Account

指定的父级账号是集合商家的账号。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListUsersRequest

ListUsers 方法的请求消息。

字段
parent

string

必需。拥有此用户集合的父级。格式:accounts/{account}

page_size

int32

可选。要返回的用户数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 位用户。最大值为 100;高于 100 的值将强制转换为 100

page_token

string

可选。从之前的 ListUsers 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListUsers 的所有其他参数必须与提供页面令牌的调用匹配。

ListUsersResponse

ListUsers 方法的响应消息。

字段
users[]

User

指定账号中的用户。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

LocationIdSet

位置 ID 集的列表。不得为空。只有在所有其他字段均未设置的情况下才能设置此字段。

字段
location_ids[]

string

必需。地理位置 ID 的非空列表。它们都必须属于同一地理位置类型(例如州)。

MinimumOrderValueTable

自提履单类型的每家商店最低订单金额表。

字段
store_code_set_with_movs[]

StoreCodeSetWithMov

必需。具有相同最低订单金额 (MOV) 的一系列商店代码集。至少需要两个集,并且最后一个集必须为空,表示“MOV for all other stores”(适用于所有其他商店)。每个商店代码在所有组中只能出现一次。同一服务中的所有价格都必须采用相同的币种。

StoreCodeSetWithMov

共享相同最低订单金额的商店代码集的列表。至少需要两组,并且最后一组必须为空,表示“MOV for all other stores”(适用于所有其他商店)。每个商店代码在所有组中只能出现一次。同一服务中的所有价格都必须采用相同的币种。

字段
store_codes[]

string

可选。唯一的商店代码列表或空的综合性商店代码。

value

Price

指定商店的最低订单金额。

OnlineReturnPolicy

在线退货政策对象。此属性目前用于表示广告和非付费商品详情计划的退货政策。

字段
name

string

标识符。OnlineReturnPolicy 资源的名称。格式:accounts/{account}/onlineReturnPolicies/{return_policy}

return_policy_id

string

仅限输出。Google 生成的退货政策 ID。

label

string

此字段表示用户定义的退货政策的唯一标签。请务必注意,对于同一国家/地区,不能在不同的退货政策中使用同一标签。除非商品指定了特定的标签属性,否则系统会自动将政策标记为“默认”。如需为特定商品组分配自定义退货政策,请按照退货政策标签中提供的说明操作。标签最多可包含 50 个字符。

countries[]

string

退货政策适用的目标销售国家/地区。值必须是有效的 2 个字母 ISO 3166 代码。

policy

Policy

退货政策。

restocking_fee

RestockingFee

适用于所有退货原因类别的重新上架费。如果未设置此值,系统会将其视为免费的重新上架费。

return_methods[]

ReturnMethod

客户可以通过哪些退货方式退回商品。除非退货政策类型为 noReturns,否则此值不得为空。

item_conditions[]

ItemCondition

除非退货政策类型为“noReturns”,否则接受退货的商品条件不能为空。

return_shipping_fee

ReturnShippingFee

退货运费。只有当客户需要下载和打印退货单时,才应设置此字段。

return_policy_uri

string

退货政策 URI。Google 可以使用此信息对政策进行合理性检查。此值必须是有效网址。

accept_defective_only

bool

此字段用于指定商家是否仅接受有缺陷的商品的退货,并且此字段为必填字段。

process_refund_days

int32

此字段用于指定商家处理退款所需的天数,该字段为可选字段。

accept_exchange

bool

此字段用于指定商家是否允许客户换货,此字段为必填字段。

ItemCondition

可用的商品状况。

枚举
ITEM_CONDITION_UNSPECIFIED 默认值。此值未使用。
NEW 新建。
USED 已使用。

政策

可用政策。

字段
type

Type

政策类型。

days

int64

商品在送达后的可退货天数,其中一天定义为送达时间戳后的 24 小时。NUMBER_OF_DAYS_AFTER_DELIVERY 返回时必需。

类型

退货政策类型。

枚举
TYPE_UNSPECIFIED 默认值。此值未使用。
NUMBER_OF_DAYS_AFTER_DELIVERY 退货商品送达后的有效天数。
NO_RETURNS 不可退货。
LIFETIME_RETURNS 终身可退货。

RestockingFee

重新上架费。这可以是固定费用或微百分比。

字段

联合字段 type

type 只能是下列其中一项:

fixed_fee

Price

固定的重新上架费。

micro_percent

int32

以百万分之一表示的总价百分比。15,000,000 表示将收取总价的 15%。

ReturnMethod

可用的退货方式。

枚举
RETURN_METHOD_UNSPECIFIED 默认值。此值未使用。
BY_MAIL 通过邮寄方式退回。
IN_STORE 到店退货。
AT_A_KIOSK 在自助服务终端退货。

ReturnShippingFee

退货运费。此属性可以是固定费用,也可以是指示客户支付实际运费的布尔值。

字段
type

Type

退货运费的类型。

fixed_fee

Price

固定的退货运费金额。此值仅适用于类型为 FIXED 时。如果 type 为 FIXED 且未设置此值,我们将将退货运费视为免运费。

类型

退货运费类型。

枚举
TYPE_UNSPECIFIED 默认值。此值未使用。
FIXED 退货运费是固定值。
CUSTOMER_PAYING_ACTUAL_FEE 客户将支付实际的退货运费。

PhoneVerificationState

电话验证状态。

枚举
PHONE_VERIFICATION_STATE_UNSPECIFIED 默认值。此值未使用。
PHONE_VERIFICATION_STATE_VERIFIED 手机已通过验证。
PHONE_VERIFICATION_STATE_UNVERIFIED 该手机未验证

计划

定义指定账号对特定计划的参与情况。

计划提供了一种向商家账号添加功能的机制。一个典型的例子是非付费商品详情计划,该计划让商家商店中的商品能够在 Google 的各个平台上免费展示。

字段
name

string

标识符。节目的资源名称。格式:accounts/{account}/programs/{program}

documentation_uri

string

仅限输出。指向介绍该计划的 Merchant Center 帮助页面的网址。

state

State

仅限输出。账号在计划的参与状态。

active_region_codes[]

string

仅限输出。账号正在积极参与该计划的区域。活跃区域是指已满足影响这些区域的所有计划要求的区域。

地区代码由 CLDR 定义。如果计划仅适用于某个国家/地区,则填写该国家/地区;如果计划在全球范围内适用,则填写 001

unmet_requirements[]

Requirement

仅限输出。账号尚未满足的会影响其参与计划的要求。

要求

定义参与该计划的指定要求。

字段
title

string

仅限输出。要求的名称。

documentation_uri

string

仅限输出。说明相应要求的帮助页面的网址。

affected_region_codes[]

string

仅限输出。目前受此要求不满足影响的地区。

地区代码由 CLDR 定义。可以是本计划专门适用于该国家/地区的国家/地区,也可以是本计划在全球范围内适用的001

账号可能的计划参与状态。

枚举
STATE_UNSPECIFIED 默认值。此值未使用。
NOT_ELIGIBLE 此账号不符合条件,无法参与该计划。
ELIGIBLE 账号符合参与该计划的条件。
ENABLED 该账号已启用该计划。

RateGroup

配送费率组定义。只有最后一个组可以包含空的 applicable_shipping_labels,表示“所有其他内容”。其他 applicable_shipping_labels 不得重叠。

字段
applicable_shipping_labels[]

string

必需。配送标签列表,用于定义此费率组所适用的产品。这是一个析取运算:只要其中一个标签匹配,费率组就会应用。只有服务的最后一个费率组可以为空。

subtables[]

Table

可选。main_table 引用的子表的列表。仅当已设置 main_table 时才能设置此项。

carrier_rates[]

CarrierRate

可选。可通过 main_tablesingle_value 引用的运输公司费率的列表。

single_value

Value

费率组的值(例如固定费率 10 美元)。只有在未设置 main_tablesubtables 时才能设置此项。

main_table

Table

single_value 表达力不足时,用于定义费率组的表。仅当未设置 single_value 时才能设置此项。

name

string

可选。费率组的名称。如果已设置,则必须在配送服务中是唯一的。

区域

表示您可以在 RegionalInventoryShippingSettings 服务中用作目标的地理区域。您可以将地区定义为邮政编码的集合,也可以在某些国家/地区使用预定义的地理定位条件。如需了解详情,请参阅设置地区

字段
name

string

标识符。地区的资源名称。格式:accounts/{account}/regions/{region}

postal_code_area

PostalCodeArea

可选。用于定义地区区域的邮政编码列表。

geotarget_area

GeoTargetArea

可选。用于定义地区区域的地理位置定位目标列表。

regional_inventory_eligible

BoolValue

仅限输出。指示相应地区是否符合在地区商品目录配置中使用的条件。

shipping_eligible

BoolValue

仅限输出。指明地区是否可以在配送服务配置中使用。

display_name

string

可选。地区的显示名称。

GeoTargetArea

用于定义地区区域的地理位置定位目标列表。

字段
geotarget_criteria_ids[]

int64

必需。地理位置 ID 的非空列表。它们必须都属于同一地理位置类型(例如州)。

PostalCodeArea

用于定义地区区域的邮政编码列表。注意:您可以通过账号的 ShippingSettings.postalCodeGroups 资源访问使用邮政编码定义的所有地区。

字段
region_code

string

必需。CLDR 地区代码或邮政编码组所适用的国家/地区。

postal_codes[]

PostalCodeRange

必需。邮政编码范围。

PostalCodeRange

用于定义地区区域的一组邮政编码。

字段
begin

string

必需。邮政编码或格式为前缀* 的模式,表示定义区域范围的下限(包括该下限)。示例值:941089410*9*

end

string

可选。邮政编码或采用 prefix* 格式的模式,表示定义相应区域的范围的上限(包括该上限)。其长度必须与 postalCodeRangeBegin 相同:如果 postalCodeRangeBegin 是邮政编码,则 postalCodeRangeEnd 也必须是邮政编码;如果 postalCodeRangeBegin 是模式,则 postalCodeRangeEnd 也必须是前缀长度相同的模式。可选:如果未设置,则该区域定义为与 postalCodeRangeBegin 匹配的所有邮政编码。

必填

用于说明需要接受的服务条款。

字段
terms_of_service

string

需要接受的termsOfService

tos_file_uri

string

服务条款文件的完整网址。此字段与 TermsOfService.file_uri 相同,仅出于方便起见而添加在此处。

RetrieveForApplicationTermsOfServiceAgreementStateRequest

RetrieveForApplicationTermsOfServiceAgreementState 方法的请求消息。

字段
parent

string

必需。要获取其服务条款协议状态格式的账号:accounts/{account}

RetrieveLatestTermsOfServiceRequest

RetrieveLatestTermsOfService 方法的请求消息。

字段
region_code

string

必需。由 CLDR 定义的地区代码。如果服务条款仅适用于某个国家/地区,则此字段应填写相应国家/地区的代码;如果服务条款适用于全球,则应填写 001。

kind

TermsOfServiceKind

必需。此服务条款版本的适用类型。

添加单元格列表。

字段
cells[]

Value

必需。构成该行的单元格列表。对于二维表格,必须与 columnHeaders 的长度相同;对于一维表格,长度为 1。

服务

配送服务。

字段
delivery_countries[]

string

必需。服务适用的国家/地区的 CLDR 地区代码。

rate_groups[]

RateGroup

可选。配送费率组定义。只有最后一个组可以包含空的 applicable_shipping_labels,表示“所有其他内容”。其他 applicable_shipping_labels 不得重叠。

loyalty_programs[]

LoyaltyProgram

可选。此配送服务仅限于参加的会员回馈活动。

service_name

string

必需。服务的自由形式名称。在目标账号中必须是唯一的。

active

bool

必需。一个布尔值,用于显示配送服务的有效状态。

currency_code

string

此服务适用的币种的 CLDR 代码。必须与费率组中的价格一致。

delivery_time

DeliveryTime

必需。从下单到商品送达所花费的各个方面时间。

shipment_type

ShipmentType

此服务可配送到的地点类型。

minimum_order_value

Price

此服务的最低订单金额。如果设置,则表示客户的支出不得低于此金额。服务中的所有价格都必须采用相同的币种。不能与 minimum_order_value_table 一起设置。

minimum_order_value_table

MinimumOrderValueTable

此表格列出了提货履单类型对应的每家商店的最低订单金额。不能与 minimum_order_value 同时设置。

store_config

StoreConfig

商品发货商店的列表。此属性仅适用于本地配送配送类型。

LoyaltyProgram

商家提供的会员回馈活动

字段
loyalty_program_tiers[]

LoyaltyProgramTiers

可选。此配送服务的会员回馈活动层级。

program_label

string

这是您在 Merchant Center 的会员回馈活动设置中设定的会员回馈活动标签。通过该子属性,Google 可以将您的会员回馈活动映射到符合条件的商品。

LoyaltyProgramTiers

商家会员回馈活动的子集。

字段
tier_label

string

层级标签 [tier_label] 子属性用于区分各个层级的商品级福利。此值也是在 Merchant Center 的会员回馈活动设置中设定的;即使您的会员回馈活动只有一个层级,在更改数据源时也必须提供此子属性。

ShipmentType

配送服务的配送类型。

枚举
SHIPMENT_TYPE_UNSPECIFIED 此服务未指定发货类型。
DELIVERY 此服务会将订单配送到客户选择的地址。
LOCAL_DELIVERY 这项服务会将订单配送到客户选择的地址。订单将从附近的本地商店发货。
COLLECTION_POINT 这项服务会将订单配送到客户选择的地址。订单从取件点发货。

StoreConfig

提供您商品的商店列表。此属性仅适用于本地配送配送类型。

字段
store_codes[]

string

可选。提供本地配送的实体店代码列表。如果为空,则 all_stores 必须为 true。

store_service_type

StoreServiceType

指明此商家列出的所有商店或部分商店是否提供本地配送服务。

cutoff_config

CutoffConfig

与本地送达相关的配置当天结束。

service_radius

Distance

最大配送半径。只有本地配送配送类型才需要此属性。

CutoffConfig

与本地送达相关的配置当天结束。

字段
local_cutoff_time

LocalCutoffTime

当天本地送货结束的时间。

store_close_offset_hours

int64

仅适用于本地送货方式。表示截止时间为商店打烊前的几个小时。它与 local_cutoff_time 相互排斥。

no_delivery_post_cutoff

bool

如果商家将配送服务配置为“n 天送达”,则可以选择不显示“n+1 天送达”。例如,如果配送服务定义了当天送达,并且已超过截止时间,将此字段设置为 true 会导致计算出的配送服务费率返回 NO_DELIVERY_POST_CUTOFF。在同一示例中,将此字段设置为 false 会导致计算出的送货时间为 1 天。此功能仅适用于本地配送。

LocalCutoffTime

当天本地送达服务的结束时间。

字段
hour

int64

当天送达服务的订单必须在截止时间之前下单,才能当天处理。

minute

int64

必须在分钟级本地送达服务的下单截止时间之前下单,才能当天处理。

StoreServiceType

指明商家列出的所有商店或部分商店是否提供本地配送服务。

枚举
STORE_SERVICE_TYPE_UNSPECIFIED 未指定商店服务类型。
ALL_STORES 指明此商家列出的当前和未来的所有商店是否都提供本地送货服务。
SELECTED_STORES 表示只有 store_codes 中列出的商店符合本地配送条件。

ShippingSettings

商家账号的配送设置

字段
name

string

标识符。运费设置的资源名称。格式:accounts/{account}/shippingSetting

services[]

Service

可选。目标账号的服务列表。

warehouses[]

Warehouse

可选。可在 services 中引用的仓库列表。

etag

string

必需。此字段用于避免异步问题。确保在 get call 和 insert call 之间未更改运费设置数据。用户应按以下步骤操作:

  1. 在创建初始运费设置时,将 ETag 字段设置为空字符串。

  2. 初始创建后,调用 get 方法以获取 etag 和当前运费设置数据,然后再调用 insert。

  3. 修改为所需的配送设置信息。

  4. 使用从第 2 步中获取的 etag 调用 insert 方法,并提供所需的配送设置信息。

  5. 如果配送设置数据在第 2 步和第 4 步之间发生了变化。由于每次运费设置数据发生变化时 etag 都会发生变化,因此插入请求将会失败。用户应使用新的 etag 重复第 2-4 步。

single_value 表达力不足时,用于定义费率组的表格。

字段
rows[]

Row

必需。构成表格的行列表。必须与 row_headers 的长度相同。

name

string

表的名称。子表格需要提供,主表格会被忽略。

row_headers

Headers

必需。表格的行标题。

column_headers

Headers

表格的列标题。可选:如果未设置,则表格只有一个维度。

TermsOfService

一个 TermsOfService

字段
name

string

标识符。服务条款版本的资源名称。格式:termsOfService/{version}

region_code

string

CLDR 定义的地区代码。此字段表示服务条款仅适用于特定国家/地区,如果同一 TermsOfService 可在任何国家/地区签署,则填写 001。但请注意,签署适用于全球的服务条款时,我们仍然希望提供特定国家/地区(这应该是商家所在的国家/地区或参与计划的国家/地区)。

kind

TermsOfServiceKind

此服务条款版本的适用类型。

external

bool

此服务条款版本是否为外部版本。外部服务条款版本只能通过外部流程达成一致,而不能由商家直接通过界面或 API 达成一致。

file_uri

string

需要向签署用户显示的服务条款文件的 URI。

TermsOfServiceAgreementState

此资源表示给定账号的协议状态和服务条款类型。状态如下:

  • 如果商家已接受服务条款:系统会填充 accepted,否则将为空
  • 如果商家必须签署服务条款:将填充 required,否则将为空。

请注意,必需接受都可以出现。在这种情况下,accepted 服务条款将在 valid_until 字段中设置失效日期。账号需要在 valid_until 之前接受 required 服务条款,才能继续拥有有效的协议。在接受新服务条款时,我们希望第三方显示与给定服务条款协议相关联的文本(包含文本的文件的网址会添加到下方的“必需”消息中,作为 tos_file_uri)。实际接受服务条款是通过对 TermsOfService 资源调用 accept 方法来完成的。

字段
name

string

标识符。服务条款版本的资源名称。格式:accounts/{account}/termsOfServiceAgreementState/{identifier} 标识符格式为:{TermsOfServiceKind}-{country}例如,标识符可以是:MERCHANT_CENTER-US

region_code

string

地区代码,如 https://cldr.unicode.org/ 中所定义。这是当前状态适用的国家/地区。

terms_of_service_kind

TermsOfServiceKind

与特定版本关联的服务条款类型。

accepted

Accepted

已接受的此类服务条款和关联的 region_code 服务条款

required

Required

所需的服务条款

TermsOfServiceKind

TermsOfService 类型。

枚举
TERMS_OF_SERVICE_KIND_UNSPECIFIED 默认值。此值未使用。
MERCHANT_CENTER Merchant Center 应用。

TransitTable

运送时间表,根据行和列维度显示运送所需的工作日数。您可以设置 min_transit_daysmax_transit_daystransit_time_table,但不能同时设置这两者。

字段
postal_code_group_names[]

string

必需。区域名称列表 Region.name。最后一个值可以是 "all other locations"。示例:["zone 1", "zone 2", "all other locations"]。提及的邮政编码组必须与服务的送货国家/地区一致。

transit_time_labels[]

string

必需。运送时间标签的列表。最后一个值可以是 "all other labels"。示例:["food", "electronics", "all other labels"]

rows[]

TransitTimeRow

必需。如果只有一个 postal_code_group_namestransit_time_labels 维度集,则有多个行,每行包含一个该维度的值。如果有两个维度,则每行对应一个 postal_code_group_names,列(值)对应一个 transit_time_labels

TransitTimeRow

如果只有一个维度集 postal_code_group_namestransit_time_labels,则会有多行,每行都有一个该维度的值。如果有两个维度,则每行对应一个 postal_code_group_names,列(值)对应一个 transit_time_labels

字段
values[]

TransitTimeValue

必需。以工作日计的运送时间范围(最短-最长)。

TransitTimeValue

以工作日计的运送时间范围(最短-最长)。

字段
min_transit_days

int32

最短运送时间范围(以工作日计)。0 表示当天送达,1 表示次日送达。

max_transit_days

int32

必须大于或等于 min_transit_days

UnclaimHomepageRequest

UnclaimHomepage 方法的请求消息。

字段
name

string

必需。要取消声明的首页的名称。格式:accounts/{account}/homepage

UpdateAccountRequest

UpdateAccount 方法的请求消息。

字段
account

Account

必需。新版账号。

update_mask

FieldMask

必需。要更新的字段的列表。

UpdateAutofeedSettingsRequest

UpdateAutofeedSettings 方法的请求消息。

字段
autofeed_settings

AutofeedSettings

必需。新版自动 Feed 设置。

update_mask

FieldMask

必需。要更新的字段的列表。

UpdateBusinessIdentityRequest

UpdateBusinessIdentity 方法的请求消息。

字段
business_identity

BusinessIdentity

必需。新版商家身份。

update_mask

FieldMask

必需。要更新的字段列表。

UpdateBusinessInfoRequest

UpdateBusinessInfo 方法的请求消息。

字段
business_info

BusinessInfo

必需。新版商家信息。

update_mask

FieldMask

必需。要更新的字段的列表。

UpdateEmailPreferencesRequest

UpdateEmailPreferences 方法的请求消息。

字段
email_preferences

EmailPreferences

必需。要更新的电子邮件接收设置。

update_mask

FieldMask

必需。要更新的字段的列表。

UpdateHomepageRequest

UpdateHomepage 方法的请求消息。

字段
homepage

Homepage

必需。新版首页。

update_mask

FieldMask

必需。要更新的字段的列表。

UpdateRegionRequest

UpdateRegion 方法的请求消息。

字段
region

Region

必需。更新后的地区。

update_mask

FieldMask

可选。以英文逗号分隔的字段掩码,用于指明要更新的字段。示例:"displayName,postalCodeArea.regionCode"

UpdateUserRequest

UpdateUser 方法的请求消息。

字段
user

User

必需。用户的新版本。

使用 me 来引用您自己的电子邮件地址,例如 accounts/{account}/users/me

update_mask

FieldMask

必需。要更新的字段的列表。

用户

用户

字段
name

string

标识符。用户的资源名称。格式:accounts/{account}/user/{email}

使用 me 指代您自己的电子邮件地址,例如 accounts/{account}/users/me

state

State

仅限输出。用户的状态。

access_rights[]

AccessRight

可选。用户拥有的访问权限

用户可能的状态。

枚举
STATE_UNSPECIFIED 默认值。此值未使用。
PENDING 用户正在等待确认。在此状态下,用户需要先接受邀请,然后才能执行其他操作。
VERIFIED 用户已通过验证。

费率组的单个值或费率组表中单元格的值。必须设置 no_shippingflat_rateprice_percentagecarrier_rateNamesubtable_name 中的一个。

字段
no_shipping

bool

如果为 true,则表示商品无法配送。设置时必须为 true,只有在所有其他字段都未设置时才能设置。

flat_rate

Price

固定费率。只有在所有其他字段均未设置的情况下才能设置此字段。

price_percentage

string

用十进制数字表示的价格百分比(例如 "5.4")。只有在所有其他字段都未设置时才能设置。

carrier_rate

string

运输公司费率的名称,用于引用同一费率组中定义的运输公司费率。只有在所有其他字段都未设置时才能设置。

subtable

string

子表格的名称。只能在表格单元格中设置(例如,不能针对单个值进行设置),并且只有在所有其他字段都未设置时才能进行设置。

仓库

用于存储和处理商品的履单仓库。下一个代码:7

字段
name

string

必需。仓库的名称。在账号中必须是唯一的。

shipping_address

Address

必需。仓库的送货地址。

cutoff_time

WarehouseCutoffTime

必需。一天中可接受订单并开始处理的最晚时间。较晚的订单将在次日处理。时间取决于仓库的邮政编码。

handling_days

int64

必需。此仓库打包并发货所需的天数。此属性在仓库级别,但可以根据商品的属性在商品级别被替换。

business_day_config

BusinessDayConfig

仓库的工作日。如果未设置,则默认为周一至周五。

WarehouseBasedDeliveryTime

表示应根据所选运输公司的设置,按仓库(发货地点)计算送货时间。设置此字段后,不应在 delivery_time 中设置任何其他与运送时间相关的字段。

字段
carrier

string

必需。运营商,例如 "UPS""Fedex"

carrier_service

string

必需。运营商服务,例如 "ground""2 days"。服务的名称必须在 eddSupportedServices 列表中。

warehouse

string

必需。仓库名称。此值应与 [warehouse][ShippingSetting.warehouses.name] 相匹配

WarehouseCutoffTime

可接受订单并开始处理的每日截止时间。之后的订单将在次日处理。时间取决于仓库的邮政编码。

字段
hour

int32

必需。截止时间(小时),订单必须在此时间之前下单,仓库才能在当天处理。小时数以仓库所在的时区为准。

minute

int32

必需。截止时间的分钟数,订单必须在此之前下单,仓库才能在当天处理。该分钟数根据仓库所在的时区而定。