Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: locations.verify
Stay organized with collections
Save and categorize content based on your preferences.
Starts the verification process for a location.
HTTP request
POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the location to verify.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"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.
} |
| Fields |
method |
enum (VerificationMethod)
Required. Verification method.
|
languageCode |
string
Optional. The BCP 47 language code representing the language that is to be used for the verification process.
|
context |
object (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.
|
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: |
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.
|
mailerContact |
string
Optional. The input for ADDRESS method. Contact name the mail should be sent to.
|
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.
|
token |
object (VerificationToken)
Optional. The input for VETTED_PARTNER method available to select partners. The input is not needed for a vetted account. Token that is associated to the location. Token that is associated to the location.
|
Response body
Response message for Verifications.VerifyLocation.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"verification": {
object (Verification)
}
} |
| Fields |
verification |
object (Verification)
The created verification request.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
VerificationToken
Token generated by a vetted partner.
| JSON representation |
{
"tokenString": string
} |
| Fields |
tokenString |
string
The token string.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\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. |"]]