Method: locations.verify

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

HTTP 请求

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

请求正文

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  },
  "trustedPartnerToken": string
  // End of mutually exclusive fields.
}
字段
method

enum (VerificationMethod)

必需。验证方式。

languageCode

string

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

context

object (ServiceBusinessContext)

可选。Extra context information for the verification of service businesses. 仅当营业地点的业务类型为 CUSTOMER_LOCATION_ONLY 时,才需要提供此字段。对于地址验证,该地址将用于寄送明信片。对于其他方法,该值应与传递给 GetVerificationOptions 的值相同。如果为其他类型的营业地点设置此值,系统会抛出 INVALID_ARGUMENT 错误。

除显示数据外,特定方法的用户输入数据。数据必须与请求的方法匹配。如果不需要任何数据,请将其留空。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
emailAddress

string

可选。EMAIL 方法的输入。PIN 码应发送到的邮箱。

只有当电子邮件地址是 locations.fetchVerificationOptions 提供的地址之一时,系统才会接受该地址。如果 [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] 的 isUserNameEditable 设置为 true,则客户端可以指定其他用户名(本地部分),但必须与域名匹配。

mailerContact

string

可选。ADDRESS 方法的输入。邮件应发送到的联系人姓名。

phoneNumber

string

可选。PHONE_CALL/SMS 方法的输入。应拨打或发送短信的电话号码。它必须是符合条件的选项中的一个电话号码。

token

object (VerificationToken)

可选。VETTED_PARTNER 方法的输入内容,仅面向部分合作伙伴提供。对于经过审核的账号,无需输入。与营业地点相关联的令牌。与营业地点相关联的令牌。

trustedPartnerToken

string

TRUSTED_PARTNER 方法的输入:与营业地点关联的验证令牌。

互斥字段结束。

响应正文

Verifications.VerifyLocation 的响应消息。

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

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

object (Verification)

已创建的验证请求。

授权范围

需要以下 OAuth 范围:

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

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

VerificationToken

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

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

string

令牌字符串。