Method: accounts.locations.fetchVerificationOptions

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

HTTP 请求

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions

网址采用 gRPC 转码语法。

路径参数

参数
name

string

要验证的营业地点的资源名称。

请求正文

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

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

string

BCP 47 语言代码，表示验证流程要使用的语言。可用选项因语言而异。
context

object (ServiceBusinessContext)

用于验证服务类商家的额外背景信息。对于业务类型为 CUSTOMER_LOCATION_ONLY 的营业地点，这是必填项。如果针对其他业务类型的位置设置 INVALID_ARGUMENT，则会抛出 INVALID_ARGUMENT。

响应正文

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

Verifications.FetchVerificationOptions 的响应消息。

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

object (VerificationOption)

可用的验证选项。

授权范围

需要以下 OAuth 范围之一：

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

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

VerificationOption

验证选项表示如何验证营业地点（通过验证方法指明）和验证将发送到哪里（通过显示数据指明）。

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

  // Union field DisplayData can be only one of the following:
  "phoneData": {
    object (PhoneVerificationData)
  },
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  }
  // End of list of possible types for union field DisplayData.
}
字段
verificationMethod

enum (VerificationMethod)

用于验证营业地点的方法。
联合字段 DisplayData。其中一个显示数据。数据必须与方法匹配。如果相应的方法没有任何显示数据，则为空。DisplayData 只能是下列其中一项：
phoneData

object (PhoneVerificationData)

仅当方法为 PHONE_CALL 或 SMS 时才设置。
addressData

object (AddressVerificationData)

仅当方法是 mail 时才设置。
emailData

object (EmailVerificationData)

仅当方法是 EMAIL 时才设置。

PhoneVerificationData

显示用于通过电话进行验证的数据，例如电话、短信

JSON 表示法 
{
  "phoneNumber": string
}
字段
phoneNumber

string

接收 PIN 码的电话号码。

AddressVerificationData

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

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

string

商家的商家名称。
address

object (PostalAddress)

可以接收明信片的地址。

EmailVerificationData

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

JSON 表示法 
{
  "domainName": string,
  "userName": string,
  "isUserNameEditable": boolean
}
字段
domainName

string

电子邮件地址中的域名。例如"gmail.com"网址：foo@gmail.com
userName

string

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

boolean

是否允许客户端提供不同的用户名。