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 概览

AccountTaxService

管理账号级税费设置数据。

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

  • AccountTax
GetAccountTax

rpc GetAccountTax(GetAccountTaxRequest) returns (AccountTax)

返回与 GetAccountTaxRequest 的条件匹配的税费规则

授权范围

需要以下 OAuth 范围:

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

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

ListAccountTax

rpc ListAccountTax(ListAccountTaxRequest) returns (ListAccountTaxResponse)

仅列出您的 Merchant Center 账号中子账号的税费设置。此方法只能在多客户账号中调用,否则将返回错误。

授权范围

需要以下 OAuth 范围:

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

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

UpdateAccountTax

rpc UpdateAccountTax(UpdateAccountTaxRequest) returns (AccountTax)

更新帐号的税费设置。

授权范围

需要以下 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 会导致其所有子帐号被删除。执行此方法需要管理员访问权限。

授权范围

需要以下 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 概览

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

用于支持 Business Information 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 的子帐号。

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

对于更新而言,指定“UNCONFIRMED”的选择启用状态值无效。

使用 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

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 此问题是改进建议。

AccountTax

商家账号的税费设置。所有方法都需要管理员角色。

字段
name

string

标识符。税费设置的名称。格式:“{account_tax.name=accounts/{account}}”

account

int64

仅限输出。这些帐号税费设置所属的帐号的 ID。

tax_rules[]

TaxRule

税务规则。"定义每个地区的税务规则。如果某个地区没有规则,就不会显示税费。”

地址

仓库的送货地址。

字段
street_address

string

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

city

string

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

administrative_area

string

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

postal_code

string

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

region_code

string

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

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

可选。商家的客户服务。

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

CreateAndConfigureAccountRequest

CreateAndConfigureAccount 方法的请求消息。

字段
account

Account

必需。要创建的账号。

users[]

CreateUserRequest

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

service[]

AddAccountService

可选。如果已指定,将在创建过程中创建要创建的帐号和提供方帐号之间的帐号服务。

accept_terms_of_service

AcceptTermsOfService

可选。在创建账号后立即接受的服务条款 (ToS)。

AcceptTermsOfService

对服务条款资源的引用。

字段
name

string

必需。服务条款版本的资源名称。

region_code

string

必需。由 CLDR 定义的地区代码。如果服务条款是专门针对某个国家/地区适用的,则此处填写的国家/地区;或者如果服务条款适用于全球,则为 001

AddAccountService

关于在创建账号期间添加账号服务的其他说明。

字段
联合字段 service_type。目前仅支持多客户父级账号类型。service_type 只能是下列其中一项:
account_aggregation

Empty

该提供商是帐号的集合商家。

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

必需。时区标识符,例如“欧洲/苏黎世”。

DeleteAccountRequest

DeleteAccount 方法的请求消息。

字段
name

string

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

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 表示次日发货。

max_handling_days

int32

订单发货前所需的最长工作日天数。0 表示当天发货,1 表示次日发货。必须大于或等于 min_handling_days

transit_time_table

TransitTable

运送时间表,运输途中花费的时间(基于行和列维度)。可以设置 min_transit_daysmax_transit_daystransit_time_table,但不能同时设置两者。

handling_business_day_config

BusinessDayConfig

可以处理订单的工作日。如果未提供,将假定为星期一至星期五的工作日。

transit_business_day_config

BusinessDayConfig

可以运送订单的工作日。如果未提供,将假定为星期一至星期五的工作日。

DisableProgramRequest

CloseProgram 方法的请求消息。

字段
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}

GetAccountTaxRequest

请求获取税费设置

字段
name

string

必需。要从中检索税费设置的名称

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}

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

必需。包含订单价格上限的列表。将 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

必需。包含订单权重上限的列表。通过将 price 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

TimeZone

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

ListAccountIssuesResponse

ListAccountIssues 方法的响应消息。

字段
account_issues[]

AccountIssue

指定帐号中的问题。

next_page_token

string

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

ListAccountTaxRequest

请求仅针对提出请求的商家列出所有子账号税费设置。此方法只能针对多客户账号调用,否则会返回错误。

字段
parent

string

必需。拥有这笔账号税费的父级账号。格式:accounts/{account}

page_size

int32

响应中要返回的税费设置数量上限,用于分页。

page_token

string

上一个请求返回的令牌。

ListAccountTaxResponse

响应账号税费列表请求。此方法只能在多客户账号中调用,否则会返回错误。

字段
account_taxes[]

AccountTax

账号税费设置页面

next_page_token

string

用于检索账号税费设置的下一页的令牌。

ListAccountsRequest

ListAccounts 方法的请求消息。

字段
page_size

int32

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

page_token

string

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

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

filter

string

可选。可选过滤条件,用于仅返回与过滤条件匹配的账号。

以下是有效过滤条件的一些示例:

  • accountName = "*store*" AND relationship(providerId = 123)
  • relationship(providerId = 123 AND service(type = "ACCOUNT_AGGREGATION"))
  • (accountName = "storeA") OR (accountName = "storeB")
  • relationship(service( handshakeState = "APPROVED" AND type = "ACCOUNT_MANAGEMENT"))
  • relationship(callerHasAccessToProvider() AND externalAccountId = "extAcctId" AND accountIdAlias = "alias")
  • (relationship(service(type = "ACCOUNT_MANAGEMENT") AND service(handshakeState = "PENDING"))) OR (accountName = "store" AND relationship(...))

帐号级别的过滤条件具有以下语义:

  • accountName这是指帐号的 accountName 字段。
  • relationship(...)这表示帐号与其他帐号的关系。在 函数中,可以进一步指定此关系。

关系级别的过滤条件具有以下语义:

  • providerId:指作为关系的其他成员的账号的数字 ID。例如,如果过滤器应限定为与帐号 accounts/name/123 有关系的帐号,则 providerId 应作为 providerId = 123 进行过滤。
  • callerHasAccessToProvider()这会将生成的账号限制为与其他账号有关联的账号,而调用用户还可以访问该关系的另一个成员(或提供商)。
  • externalAccountId:指为关系配置的外部账号 ID。
  • accountIdAlias 是指为关系配置的账号 ID 别名。
  • service(...):指作为关系的一部分提供的服务。注意:两个帐号之间的关系可包含多个服务。

服务级别的过滤条件具有以下语义:

  • handshakeState这是指服务的握手状态。建立服务后,有时需要先获得关系的另一方或双方批准。因此,服务可以处于 PENDINGAPPROVED 状态。
  • type指服务的类型。可能的值包括:
    • ACCOUNT_MANAGEMENT:帐号由提供方管理。
    • ACCOUNT_AGGREGATION该提供商是帐号的集合商家。

过滤器遵循 AIP 过滤器规范及其 EBNF 正式语法的子集。此过滤器的语法更严格和更具体

filter
    : accountFilterDisj
    | accountFilterConj
    ;
accountFilterDisj
    : "(" accountFilterConj " OR " accountFilterConj ")"
    ;
accountFilterConj
    : accountFilter {" AND " accountFilter}
    ;
accountFilter
    : accountNameFilter | relationshipFn
    ;
accountNameFilter
    : "accountName" comparator value
    ;
relationshipFn
    : "relationship(" relationshipConj ")"
    ;
relationshipConj
    : relationshipFilter {" AND " relationshipFilter}
    ;
relationshipFilter
    : "providerId = " numValue
    | "callerHasAccessToProvider()"
    | "externalAccountId" comparator value
    | "accountIdAlias" comparator value
    | serviceFn
    ;
serviceFn
    : "service(" serviceConj ")"
    ;
serviceConj
    : serviceFilter {" AND " serviceFilter}
    ;
serviceFilter
    : handshakeStateFilter
    | typeFilter
    ;
handshakeStateFilter
    : "handshakeState = " value
    ;
typeFilter
    : "type = " value
    ;
comparator
    : " = " | " != "
    ;

此外,以下规则也适用:

  • 每个关联字段只能出现一次(例如,在帐号一级只能对 accountName 进行过滤一次,或者只能在每个关系级别对 providerId 进行过滤一次)。
  • 对于字符串字段(例如 accountNameaccountIdAlias),可以通过将查询包含在 * 中来表示 CONTAINS 运算符。例如,accountName = "*foo*" 将返回 accountName 包含 foo 的所有帐号。从正向角度来看,可以使用 != 表示 NOT_CONTAINS 运算符。例如,accountName != "*foo*" 将返回 accountName 中不包含 foo 的所有帐号。注意:您可以使用 *** 搜索 accountName 中包含星号字符 * 的帐号。
  • 多余空格都会被忽略。
  • 除纯数字值以外的所有值都必须用双引号括起来。
  • 如果使用析取,则每一侧的连词都必须使用圆括号,即使连词只有一个表达式也是如此。除了函数调用(例如 relationshipservice)之外,不允许使用括号。这是为了明确表明连接结合在逻辑上优于析取。

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”。每个商店代码在所有集合中都只能出现一次。一项服务中的所有价格都必须采用相同的币种。

StoreCodeSetWithMov

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

字段
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 时,此值才适用。如果类型为 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

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

Row

添加单元格列表。

字段
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,则计算的配送时间为一天。这仅适用于本地配送。

LocalCutoffTime

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

字段
hour

int64

您必须在 之前按小时处理本地配送订单,才能在当天处理。

minute

int64

本地币种为分钟外卖订单的下单截止时间为“当天”。

StoreServiceType

指明商家列出的所有商店或选定的商店是否提供本地送货服务。

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

ShippingSettings

商家账号的 [配送设置]((https://support.google.com/merchants/answer/6069284)

字段
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

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

TaxRule

主要类型会议

微百分比 : 100% = 1 000 000 和 1% = 10 000 不能为负数。

有关税务关系和相关参数的信息,适用于配送到某位税务管理员所涵盖地区的订单。当商家在税务管理员所管理的区域开展业务时,系统会创建 Nexus 设备(Nexus 配置仅支持美国各州)。如果商家在美国有实体存在,则商家需要向与送货目的地相关联的所有税务机关支付税费。下一个 ID :8

字段
region_code

string

此规则适用的地区代码

shipping_taxed

bool

如果设置,则在配送到此管理员所在的区域时,将对运费收税(与商品费率相同)。只能针对没有类别的美国州进行设置。

effective_time_period

Interval

必需。此规则生效的时间段。如果有效的时间中缺少持续时间,则该持续时间为将来开放。此时间段的开始时间含边界值,结束时间不含边界值。

联合字段 location。通过邮政编码范围或条件 ID 描述地理位置。location 只能是下列其中一项:
location_id

int64

此规则适用的地区的 admin_id 或 criteria_id。

post_code_range

TaxPostalCodeRange

此规则适用的邮政编码范围。

联合字段 rate_calculation。使用什么方法计算配送到此管理员所在区域的税率?只能针对美国各州进行设置。rate_calculation 只能是下列其中一项:
use_google_rate

bool

运费取决于送货地点:如果商家在美国相应州有实体存在,则负责对送货区域有管辖权的权威机构进行费率加总。

self_specified_rate_micros

int64

以微单位指定的固定费率,其中 100% = 1_000_000。适用于基于来源的州。

TaxPostalCodeRange

用于定义区域的邮政编码范围。

字段
start

string

必需。邮政编码范围的起点,也是范围内的最小值。

end

string

邮政编码范围的末尾。如果未指定,则与 start 相同。

TermsOfService

一个 TermsOfService

字段
name

string

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

region_code

string

CLDR 定义的地区代码。可以是服务条款专门针对该国家/地区适用的国家/地区,也可以是001(如果在任何国家/地区可签署相同的TermsOfService)。但请注意,签署适用于全球的服务条款时,我们仍然希望提供特定国家/地区(这应该是商家所在的国家/地区或参与计划的国家/地区)。

kind

TermsOfServiceKind

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

external

bool

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

file_uri

string

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

TermsOfServiceAgreementState

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

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

请注意,可以同时提供 requiredaccepted 这两个字段。在这种情况下,系统会在 valid_until 字段中设置 accepted 服务条款的到期日期。您必须在 valid_until之前接受《required》服务条款,此账号才会继续签署有效的协议。在接受新的服务条款时,我们希望第三方显示与指定服务条款协议相关的文本(包含该文本的文件的网址会在下面的“必需消息”中添加为 tos_file_uri)。对 TermsOfService 资源调用 accept 即可实际接受服务条款。

字段
name

string

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

region_code

string

https://cldr.unicode.org/ 定义的地区代码。这是指当前州所适用的国家/地区。

terms_of_service_kind

TermsOfServiceKind

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

accepted

Accepted

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

required

Required

所需的服务条款

TermsOfServiceKind

服务条款种类。

枚举
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

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

UpdateAccountTaxRequest

请求更新税费设置

字段
account_tax

AccountTax

必需。要更新的税费设置

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/{user}

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

必需。截止时间的截止时间,以便仓库在当天处理订单。该分钟数根据仓库所在的时区而定。