Method: locations.fetchVerificationOptions

报告某个营业地点使用特定语言的所有符合条件的验证选项。

HTTP 请求

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

网址采用 gRPC 转码语法。

路径参数

参数
location

string

必需。要验证的营业地点。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
字段
languageCode

string

必需。BCP 47 语言代码,表示验证流程中要使用的语言。可用选项因语言而异。

context

object (ServiceBusinessContext)

可选。Extra context information for the verification of service businesses. 只能应用于业务类型为 CUSTOMER_LOCATION_ONLY 的营业地点。指定准确的地址可能会提供更多选项。如果为其他营业类型的营业地点设置此值,系统会抛出 INVALID_ARGUMENT 错误。

响应正文

Verifications.FetchVerificationOptions 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
字段
options[]

object (VerificationOption)

可用的验证选项。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/business.manage

如需了解详情,请参阅 OAuth 2.0 Overview。

VerificationOption

验证选项表示如何验证营业地点(由验证方法指示)以及验证信息将发送到何处(由显示数据指示)。

JSON 表示法
{
  "verificationMethod": enum (VerificationMethod),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of mutually exclusive fields.
}
字段
verificationMethod

enum (VerificationMethod)

验证营业地点的方法。

其中一个显示数据。数据必须与方法匹配。如果相应方法没有任何显示数据,则为空。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
phoneNumber

string

仅在方法为 PHONE_CALL 或 SMS 时设置。PIN 码将发送到的电话号码。

addressData

object (AddressVerificationData)

仅在验证方法为 MAIL 时设置。

emailData

object (EmailVerificationData)

仅在方法为 EMAIL 时设置。

announcement

string

仅在方法为 VETTED_PARTNER 时设置。

互斥字段结束。

AddressVerificationData

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

JSON 表示法
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
字段
business

string

商家的企业名称。

address

object (PostalAddress)

可接收明信片的地址。

expectedDeliveryDaysRegion

integer

将明信片寄送到该地址所在区域预计需要的天数。

EmailVerificationData

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

JSON 表示法
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
字段
domain

string

邮箱中的域名。例如,foo@gmail.com 中的“gmail.com”

user

string

电子邮件地址中的用户名,例如 foo@gmail.com 中的“foo”

isUserNameEditable

boolean

是否允许客户端提供其他用户名。