- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权作用域
- VerificationOptionVerificationOption
- PhoneVerificationData
- AddressVerificationData
- EmailVerificationData
针对某个营业地点使用特定语言报告所有符合条件的验证选项。
HTTP 请求
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
要验证的营业地点的资源名称。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 | |
---|---|
{
"languageCode": string,
"context": {
object ( |
字段 | |
---|---|
languageCode |
BCP 47 语言代码,表示验证流程将采用的语言。可用选项因语言而异。 |
context |
用于验证服务类商家的额外背景信息。对于商家类型为 CUSTOMER_LOCATION_ONLY 的营业地点,则为必填。如果针对其他商家类型的营业地点设置 INVALID_STRING,则系统会抛出该错误。 |
响应正文
如果成功,响应正文将包含结构如下的数据:
Verifications.FetchVerificationOptions 的响应消息。
JSON 表示法 | |
---|---|
{
"options": [
{
object ( |
字段 | |
---|---|
options[] |
可用的验证选项。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
有关详情,请参阅 OAuth 2.0 概览。
VerificationOption
验证选项表示营业地点的验证方式(通过验证方法指明)和接收验证地点(通过显示数据指明)。
JSON 表示法 | |
---|---|
{ "verificationMethod": enum ( |
字段 | ||
---|---|---|
verificationMethod |
用于验证营业地点的方法。 |
|
联合字段 DisplayData 。其中一个显示数据。数据必须与方法匹配。如果相应方法没有任何显示数据,则为空。DisplayData 只能是下列其中一项: |
||
phoneData |
仅当方法是 PHONE_CALL 或 SMS 时设置。 |
|
addressData |
仅当方法是 mail 时才设置。 |
|
emailData |
仅当方法为 EMAIL 时设置。 |
PhoneVerificationData
显示通过电话进行验证的数据,例如电话、短信。
JSON 表示法 | |
---|---|
{ "phoneNumber": string } |
字段 | |
---|---|
phoneNumber |
用于接收 PIN 码的电话号码。 |
AddressVerificationData
显示通过明信片验证的数据。
JSON 表示法 | |
---|---|
{
"businessName": string,
"address": {
object ( |
字段 | |
---|---|
businessName |
商家的商家名称。 |
address |
明信片的邮寄地址。 |
EmailVerificationData
显示通过电子邮件进行验证的数据。
JSON 表示法 | |
---|---|
{ "domainName": string, "userName": string, "isUserNameEditable": boolean } |
字段 | |
---|---|
domainName |
电子邮件地址中的域名。例如 foo@gmail.com 中的“gmail.com”foo@gmail.com |
userName |
电子邮件地址中的用户名。例如 foo@gmail.com 中的“foo” |
isUserNameEditable |
是否允许客户提供不同的用户名。 |