Package google.mybusiness.verifications.v1

索引

• Verifications（界面）
• VoiceOfMerchant（界面）
• CompleteVerificationRequest（消息）
• CompleteVerificationResponse（消息）
• ComplyWithGuidelines（消息）
• ComplyWithGuidelines.RecommendationReason（枚举）
• FetchVerificationOptionsRequest（消息）
• FetchVerificationOptionsResponse（消息）
• GetVoiceOfMerchantStateRequest（消息）
• ListVerificationsRequest（消息）
• ListVerificationsResponse（消息）
• ResolveOwnershipConflict（消息）
• ServiceBusinessContext（消息）
• Verification（消息）
• Verification.State（枚举）
• VerificationMethod（枚举）
• VerificationOption（消息）
• VerificationOption.AddressVerificationData（消息）
• VerificationOption.EmailVerificationData（消息）
• VerificationToken（消息）
• Verify（消息）
• VerifyLocationRequest（消息）
• VerifyLocationResponse（消息）
• VoiceOfMerchantState（消息）
• WaitForVoiceOfMerchant（消息）

验证

借助此 API，您可以管理 Google 上的营业地点验证。您可以用它管理 [Verification] [google.mybusiness.v1.Verification] 资源。

每个 [Location] [google.mybusiness.businessinformation.locations.v1.Location] 都有一组名为 locations/*/verifications/* 的 [Verification] [google.mybusiness.verifications] 资源。

CompleteVerification
rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse) 完成 PENDING 验证。 只有非 AUTO 验证方法才需要此参数。AUTO验证请求在创建后会立即处于 VERIFIED 状态。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

FetchVerificationOptions
rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse) 针对某个营业地点使用特定语言报告所有符合条件的验证选项。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

ListVerifications
rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse) 列出营业地点的验证，按创建时间排序。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

VerifyLocation
rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse) 启动营业地点的验证流程。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

VoiceOfMerchant

此服务允许第三方用户请求获取商家状态的详细信息。

GetVoiceOfMerchantState
rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState) 获取 VoiceOfMerchant 状态。 授权范围 需要以下 OAuth 作用域： https://www.googleapis.com/auth/business.manage 有关详情，请参阅 OAuth 2.0 概览。

CompleteVerificationRequest

Verifications.CompleteVerificationAction 的请求消息。

字段
name	string 必需。要完成的验证的资源名称。
pin	string 必需。商家收到的 PIN 码，用于完成验证。

CompleteVerificationResponse

Verifications.CompleteVerificationAction 的响应消息。

字段
verification	Verification 验证已完成。

ComplyWithGuidelines

表示营业地点不符合我们的指南。

字段
recommendation_reason	RecommendationReason 建议相应营业地点符合相关准则的原因。

RecommendationReason

指明营业地点为何被建议遵循 ComplyWithGuidelines。

枚举
RECOMMENDATION_REASON_UNSPECIFIED	未指定。
BUSINESS_LOCATION_SUSPENDED	此营业地点已暂停。如需解决此问题，请参阅帮助中心文章。
BUSINESS_LOCATION_DISABLED	营业地点已被停用。如需解决此问题，请参阅帮助中心文章。

FetchVerificationOptionsRequest

Verifications.FetchVerificationOptions 的请求消息。

字段
location	string 必需。要验证的营业地点。
language_code	string 必需。BCP 47 语言代码，表示验证流程将采用的语言。可用选项因语言而异。
context	ServiceBusinessContext 可选。用于验证服务类商家的额外背景信息。只能应用于业务类型为 CUSTOMER_LOCATION_ONLY 的营业地点。指定准确的地址可以启用更多选项。如果针对其他商家类型的营业地点设置 INVALID_STRING，则系统会抛出该错误。

FetchVerificationOptionsResponse

Verifications.FetchVerificationOptions 的响应消息。

字段
options[]	VerificationOption 可用的验证选项。

GetVoiceOfMerchantStateRequest

VoiceOfMerchant.GetVoiceOfMerchantState 的请求消息。

字段
name	string 必需。营业地点的资源名称。

ListVerificationsRequest

Verifications.ListVerifications 的请求消息。

字段
parent	string 必需。验证请求所属营业地点的资源名称。
page_size	int32 每页要包含的验证次数。最小值为 1，默认页面大小和最大页面大小为 100。
page_token	string 如果指定，则返回下一页验证。

ListVerificationsResponse

Verifications.ListVerifications 的响应消息。

字段
verifications[]	Verification 验证列表。
next_page_token	string 如果验证次数超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用中获取下一页验证。如果没有其他属性，此字段将不会在响应中显示。

ResolveOwnershipConflict

此类型没有任何字段。

表示营业地点与另一个信誉良好的营业地点重复。

ServiceBusinessContext

用于服务商家验证的其他数据。

字段
address	PostalAddress 营业地点的验证地址。用于启用更多验证选项或寄送明信片。

验证

验证表示尝试对营业地点进行验证。

字段
name	string 验证的资源名称。
method	VerificationMethod 验证方法。
state	State 验证的状态。
create_time	Timestamp 请求验证时的时间戳。
announcement	string 可选。仅当方法为 VETTED_PARTNER 时，才可设置响应通知。

状态

所有可能的验证状态。

枚举
STATE_UNSPECIFIED	默认值，会导致错误。
PENDING	正在等待验证。
COMPLETED	验证已完成。
FAILED	验证失败。

VerificationMethod

指定 Google 用于验证营业地点的流程。

枚举
VERIFICATION_METHOD_UNSPECIFIED	默认值，会导致错误。
ADDRESS	将带有验证 PIN 码的明信片寄送到特定的邮寄地址。PIN 码用于完成 Google 验证。
EMAIL	向特定电子邮件地址发送一封包含验证 PIN 码的电子邮件。PIN 码用于完成 Google 验证。
PHONE_CALL	通过特定电话号码拨打电话，并提供验证 PIN 码。PIN 码用于完成 Google 验证。
SMS	向特定电话号码发送一条包含验证 PIN 的短信。PIN 码用于完成 Google 验证。
AUTO	无需用户额外操作即可验证营业地点。此选项可能只适用于部分地点。
VETTED_PARTNER	此选项可能只适用于部分地点。

VerificationOption

验证选项表示营业地点的验证方式（通过验证方法指明）和接收验证地点（通过显示数据指明）。

字段
verification_method	VerificationMethod 用于验证营业地点的方法。
联合字段 DisplayData。其中一个显示数据。数据必须与方法匹配。如果相应方法没有任何显示数据，则为空。DisplayData 只能是下列其中一项：
phone_number	string 仅当方法是 PHONE_CALL 或 SMS 时设置。用于接收 PIN 码的电话号码。
address_data	AddressVerificationData 仅当方法是 mail 时才设置。
email_data	EmailVerificationData 仅当方法为 EMAIL 时设置。
announcement	string 仅当方法为 VETTED_PARTNER 时设置。

AddressVerificationData

显示通过明信片验证的数据。

字段
business	string 商家的商家名称。
address	PostalAddress 明信片的邮寄地址。
expected_delivery_days_region	int32 预计将明信片寄送到地址所属地区所需的天数。

EmailVerificationData

显示通过电子邮件进行验证的数据。

字段
domain	string 电子邮件地址中的域名。例如 [e-mail] 中的“gmail.com”[e-mail]
user	string 电子邮件地址中的用户名。例如 [e-mail] 中的“foo”
is_user_name_editable	bool 是否允许客户提供不同的用户名。

VerificationToken

令牌由经过审核的合作伙伴生成。

字段
token_string	string 令牌字符串。

验证

指明营业地点需要验证。包含当前对营业地点执行的验证操作的相关信息。

字段
has_pending_verification	bool 指明验证流程是否已开始且可由营业地点完成。

VerifyLocationRequest

Verifications.VerifyLocation 的请求消息。

字段
name	string 必需。要验证的营业地点的资源名称。
method	VerificationMethod 必需。验证方法。
language_code	string 可选。BCP 47 语言代码，表示验证流程将采用的语言。
context	ServiceBusinessContext 可选。用于验证服务类商家的额外背景信息。只有商家类型为 CUSTOMER_LOCATION_ONLY 的营业地点才需要填写此字段。进行 ADDRESS 验证时，该地址将用于寄送明信片。对于其他方法，它应该与传递给 GetVerificationOptions 的方法相同。如果针对其他类型的营业地点设置了 INVALID_STRING，则系统会抛出该错误。
联合字段 RequestData。除显示数据之外，特定方法的用户输入数据。数据必须与请求的方法匹配。如果不需要任何数据，请将其留空。RequestData 只能是下列其中一项：
email_address	string 可选。EMAIL 方法的输入。PIN 码应发送到的电子邮件地址。 仅当电子邮件地址是由 FetchVerificationOptions 提供的地址之一时，我们才会接受它。如果 [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] 将 is_user_name_editor 设为 true，则客户端可以指定其他用户名（本地部分），但必须与域名匹配。
mailer_contact	string 可选。ADDRESS 方法的输入。接收邮件的联系人姓名。
phone_number	string 可选。PHONE_CALL/SMS 方法的输入。应拨打或接收短信的电话号码。必须是符合条件的选项中的电话号码之一。
token	VerificationToken 可选。可供选定partners.使用的 VETTED_PARTNER 方法的输入信息。已通过审核的帐号不需要输入信息。与营业地点关联的令牌。与营业地点关联的令牌。

VerifyLocationResponse

Verifications.VerifyLocation 的响应消息。

字段
verification	Verification 已创建验证请求。

VoiceOfMerchantState

VoiceOfMerchant.GetVoiceOfMerchantState 的响应消息。

字段
has_voice_of_merchant	bool 指明营业地点是否信誉良好且可以控制 Google 上的商家。通过审核阶段后，对营业地点所做的任何修改都将传播到 Google 地图。
has_business_authority	bool 指明营业地点是否拥有 Google 上的商家授权（所有权）。如果为 true，则其他营业地点无法取代并成为 Google 地图上的主要商家信息。但是，除非获得商家的声音（即 has_voice_of_merchant 为 true），否则修改不会生效。
联合字段 gain_voice_of_merchant_action。建议营业地点采取操作，以控制 Google 上的商家。gain_voice_of_merchant_action 只能是下列其中一项：
wait_for_voice_of_merchant	WaitForVoiceOfMerchant 请等待获取 Voice of Merchant。此营业地点正在接受质量审核。
verify	Verify 开始或继续验证流程。
resolve_ownership_conflict	ResolveOwnershipConflict 此营业地点与另一个信誉良好的营业地点重复。如果您有权访问信誉良好的营业地点，请使用该营业地点的 ID 执行操作。否则，请向当前所有者申请权限。
comply_with_guidelines	ComplyWithGuidelines 营业地点不符合我们的准则，需要执行额外步骤才能恢复。如需解决此问题，请参阅帮助中心文章。

WaitForVoiceOfMerchant

此类型没有任何字段。

表示营业地点在通过审核后将获得商家发声。