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 )
},
// Union field RequestData can be only one of the following:
"emailAddress": string,
"mailerContact": string,
"phoneNumber": string,
"token": {
object (VerificationToken )
}
// End of list of possible types for union field RequestData .
} |
字段 |
method |
enum (VerificationMethod )
必需。验证方法。
|
languageCode |
string
可选。BCP 47 语言代码,表示验证流程要使用的语言。
|
context |
object (ServiceBusinessContext )
可选。用于验证服务类商家的额外背景信息。只有业务类型为 CUSTOMER_LOCATION_ONLY 的营业地点才需要使用此属性。对于 ADDRESS 验证,该地址将用于寄送明信片。对于其他方法,它应该与传递给 GetVerificationOptions 的方法相同。如果针对其他类型的营业地点设置了 INVALID_ARGUMENT,则会抛出 INVALID_ARGUMENT。
|
联合字段 RequestData 。除显示数据外,针对特定方法的用户输入数据。数据必须与请求的方法匹配。如果不需要数据,请将其留空。RequestData 只能是下列其中一项: |
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 方法的输入可供选择合作伙伴。对于经过审核的账号,您无需输入这些信息。与营业地点相关联的令牌。与营业地点相关联的令牌。
|
响应正文
Verifications.VerifyLocation 的响应消息。
如果成功,响应正文将包含结构如下的数据:
字段 |
verification |
object (Verification )
已创建的验证请求。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/business.manage
如需了解详情,请参阅 OAuth 2.0 概览。
VerificationToken
JSON 表示法 |
{
"tokenString": string
} |
字段 |
tokenString |
string
令牌字符串。
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eInitiates the verification process for a specified location using various methods like email, phone, address, or a vetted partner token.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the location's resource name and selecting the desired verification method.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, you can specify language, service business context, and user input data depending on the chosen method.\u003c/p\u003e\n"],["\u003cp\u003eA successful verification request returns a Verification object representing the initiated process.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This documentation details how to initiate a location verification process via a POST request to `https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify`. The request requires a location's resource `name` as a path parameter. The request body uses JSON and specifies the verification `method`, optional `languageCode` and `context` and the `RequestData` which could include an `emailAddress`, `mailerContact`, `phoneNumber`, or a `token`. A successful request returns a `verification` object in the JSON response body. An `Authorization scope` is required.\n"],null,["# Method: locations.verify\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.VerifyLocationResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [VerificationToken](#VerificationToken)\n - [JSON representation](#VerificationToken.SCHEMA_REPRESENTATION)\n\nStarts the verification process for a location.\n\n### HTTP request\n\n`POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the location to verify. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"method\": enum (/my-business/reference/verifications/rest/v1/VerificationMethod), \"languageCode\": string, \"context\": { object (/my-business/reference/verifications/rest/v1/ServiceBusinessContext) }, // Union field `RequestData` can be only one of the following: \"emailAddress\": string, \"mailerContact\": string, \"phoneNumber\": string, \"token\": { object (/my-business/reference/verifications/rest/v1/locations/verify#VerificationToken) } // End of list of possible types for union field `RequestData`. } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `method` | `enum (`[VerificationMethod](/my-business/reference/verifications/rest/v1/VerificationMethod)`)` Required. Verification method. |\n| `languageCode` | `string` Optional. The BCP 47 language code representing the language that is to be used for the verification process. |\n| `context` | `object (`[ServiceBusinessContext](/my-business/reference/verifications/rest/v1/ServiceBusinessContext)`)` Optional. Extra context information for the verification of service businesses. It is only required for the locations whose business type is CUSTOMER_LOCATION_ONLY. For ADDRESS verification, the address will be used to send out postcard. For other methods, it should be the same as the one that is passed to GetVerificationOptions. INVALID_ARGUMENT will be thrown if it is set for other types of business locations. |\n| Union field `RequestData`. User input data for specific method in addition to the display data. The data must match the requested method. Leave it empty if no data is needed. `RequestData` can be only one of the following: ||\n| `emailAddress` | `string` Optional. The input for EMAIL method. Email address where the PIN should be sent to. An email address is accepted only if it is one of the addresses provided by locations.fetchVerificationOptions. If the \\[EmailVerificationData\\] \\[google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData\\] has isUserNameEditable set to true, the client may specify a different user name (local-part) but must match the domain name. |\n| `mailerContact` | `string` Optional. The input for ADDRESS method. Contact name the mail should be sent to. |\n| `phoneNumber` | `string` Optional. The input for PHONE_CALL/SMS method The phone number that should be called or be sent SMS to. It must be one of the phone numbers in the eligible options. |\n| `token` | `object (`[VerificationToken](/my-business/reference/verifications/rest/v1/locations/verify#VerificationToken)`)` Optional. The input for VETTED_PARTNER method available to select [partners.](https://support.google.com/business/answer/7674102) The input is not needed for a vetted account. Token that is associated to the location. Token that is associated to the location. |\n\n### Response body\n\nResponse message for Verifications.VerifyLocation.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"verification\": { object (/my-business/reference/verifications/rest/v1/Verification) } } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------|\n| `verification` | `object (`[Verification](/my-business/reference/verifications/rest/v1/Verification)`)` The created verification request. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nVerificationToken\n-----------------\n\nToken generated by a vetted [partner](https://support.google.com/business/answer/7674102).\n\n| JSON representation |\n|-----------------------------------|\n| ``` { \"tokenString\": string } ``` |\n\n| Fields ||\n|---------------|----------------------------|\n| `tokenString` | `string` The token string. |"]]