Method: accounts.locations.verify

为营业地点启动验证流程。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

请求正文

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

JSON 表示法
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
字段
method

enum (VerificationMethod)

验证方法。

languageCode

string

BCP 47 语言代码,表示验证流程要使用的语言。

context

object (ServiceBusinessContext)

用于验证服务商家的额外背景信息。对于业务类型为 CUSTOMER_LOCATION_ONLY 的地点,此属性为必填项。对于 ADDRESS 验证,该地址将用于寄送明信片。对于其他方法,它应该与传递给 locations.fetchVerificationOptions 的方法相同。如果为其他类型的商家营业地点设置此值,系统会抛出 INVALID_ARGUMENT。

联合字段 RequestData。除了显示数据之外,还包含特定方法的用户输入数据。数据必须与请求的方法匹配。如果不需要数据,请将其留空。RequestData 只能是下列其中一项:
emailInput

object (EmailInput)

EMAIL 方法的输入。

addressInput

object (AddressInput)

ADDRESS 方法的输入。

phoneInput

object (PhoneInput)

PHONE_CALL/SMS 方法的输入

响应正文

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

Verifications.VerifyLocation 的响应消息。

JSON 表示法
{
  "verification": {
    object (Verification)
  }
}
字段
verification

object (Verification)

已创建的验证请求。

授权范围

需要以下 OAuth 范围之一:

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

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

EmailInput

输入用于电子邮件验证的信息。

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

string

应将 PIN 码发送到的电子邮件地址。

只有在电子邮件地址是 locations.fetchVerificationOptions 提供的地址之一时,我们才会接受该地址。如果 EmailVerificationData 将 isUserNameEditable 设置为 true,客户端可以指定其他用户名(本地部分),但必须与域名匹配。

AddressInput

输入地址验证信息。

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

string

应将邮件发送给的联系人姓名。

PhoneInput

PHONE_CALL/短信验证的输入。

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

string

应拨打或发送短信的电话号码。该电话号码必须是符合条件的选项中的电话号码之一。