Index
Verifications
(interface)VoiceOfMerchant
(interface)CompleteVerificationRequest
(message)CompleteVerificationResponse
(message)ComplyWithGuidelines
(message)ComplyWithGuidelines.RecommendationReason
(enum)FetchVerificationOptionsRequest
(message)FetchVerificationOptionsResponse
(message)GetVoiceOfMerchantStateRequest
(message)ListVerificationsRequest
(message)ListVerificationsResponse
(message)ResolveOwnershipConflict
(message)ServiceBusinessContext
(message)Verification
(message)Verification.State
(enum)VerificationMethod
(enum)VerificationOption
(message)VerificationOption.AddressVerificationData
(message)VerificationOption.EmailVerificationData
(message)VerificationToken
(message)Verify
(message)VerifyLocationRequest
(message)VerifyLocationResponse
(message)VoiceOfMerchantState
(message)WaitForVoiceOfMerchant
(message)
Verifications
This API allows management of Location verifications on Google. It lets you manage [Verification] [google.mybusiness.v1.Verification] resources.
Each [Location] [google.mybusiness.businessinformation.locations.v1.Location] has a collection of [Verification] [google.mybusiness.verifications] resources, named locations/*/verifications/*
.
CompleteVerification |
---|
Completes a It is only necessary for non
|
FetchVerificationOptions |
---|
Reports all eligible verification options for a location in a specific language.
|
ListVerifications |
---|
List verifications of a location, ordered by create time.
|
VerifyLocation |
---|
Starts the verification process for a location.
|
VoiceOfMerchant
This service allows 3P users to request details on voice of merchant state.
GetVoiceOfMerchantState |
---|
Gets the VoiceOfMerchant state.
|
CompleteVerificationRequest
Request message for Verifications.CompleteVerificationAction.
Fields | |
---|---|
name |
Required. Resource name of the verification to complete. |
pin |
Required. PIN code received by the merchant to complete the verification. |
CompleteVerificationResponse
Response message for Verifications.CompleteVerificationAction.
Fields | |
---|---|
verification |
The completed verification. |
ComplyWithGuidelines
Indicates that the location fails to comply with our guidelines.
Fields | |
---|---|
recommendation_reason |
The reason why the location is being recommended to comply with guidelines. |
RecommendationReason
Indicates why the location was recommended to ComplyWithGuidelines.
Enums | |
---|---|
RECOMMENDATION_REASON_UNSPECIFIED |
Not specified. |
BUSINESS_LOCATION_SUSPENDED |
The business location is suspended. To fix this issue, consult the Help Center article. |
BUSINESS_LOCATION_DISABLED |
The business location is disabled. To fix this issue, consult the Help Center article. |
FetchVerificationOptionsRequest
Request message for Verifications.FetchVerificationOptions.
Fields | |
---|---|
location |
Required. The location to verify. |
language_code |
Required. The BCP 47 language code representing the language that is to be used for the verification process. Available options vary by language. |
context |
Optional. Extra context information for the verification of service businesses. Can only be applied to the locations whose business type is CUSTOMER_LOCATION_ONLY. Specifying an accurate address could enable more options. INVALID_ARGUMENT will be thrown if it is set for other business types of locations. |
FetchVerificationOptionsResponse
Response message for Verifications.FetchVerificationOptions.
Fields | |
---|---|
options[] |
The available verification options. |
GetVoiceOfMerchantStateRequest
Request message for VoiceOfMerchant.GetVoiceOfMerchantState.
Fields | |
---|---|
name |
Required. Resource name of the location. |
ListVerificationsRequest
Request message for Verifications.ListVerifications.
Fields | |
---|---|
parent |
Required. Resource name of the location that verification requests belong to. |
page_size |
How many verification to include per page. Minimum is 1, and the default and maximum page size is 100. |
page_token |
If specified, returns the next page of verifications. |
ListVerificationsResponse
Response message for Verifications.ListVerifications.
Fields | |
---|---|
verifications[] |
List of the verifications. |
next_page_token |
If the number of verifications exceeded the requested page size, this field will be populated with a token to fetch the next page of verification on a subsequent call. If there are no more attributes, this field will not be present in the response. |
ResolveOwnershipConflict
This type has no fields.
Indicates that the location duplicates another location that is in good standing.
ServiceBusinessContext
Additional data for service business verification.
Fields | |
---|---|
address |
The verification address of the location. It is used to either enable more verification options or send a postcard. |
Verification
A verification represents a verification attempt on a location.
Fields | |
---|---|
name |
Resource name of the verification. |
method |
The method of the verification. |
state |
The state of the verification. |
create_time |
The timestamp when the verification is requested. |
announcement |
Optional. Response announcement set only if the method is VETTED_PARTNER. |
State
All possible verification states.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value, will result in errors. |
PENDING |
The verification is pending. |
COMPLETED |
The verification is completed. |
FAILED |
The verification is failed. |
VerificationMethod
Specifies the processes used by Google to verify a location.
Enums | |
---|---|
VERIFICATION_METHOD_UNSPECIFIED |
Default value, will result in errors. |
ADDRESS |
Send a postcard with a verification PIN to a specific mailing address. The PIN is used to complete verification with Google. |
EMAIL |
Send an email with a verification PIN to a specific email address. The PIN is used to complete verification with Google. |
PHONE_CALL |
Make a phone call with a verification PIN to a specific phone number. The PIN is used to complete verification with Google. |
SMS |
Send an SMS with a verification PIN to a specific phone number. The PIN is used to complete verification with Google. |
AUTO |
Verify the location without additional user action. This option may not be available for all locations. |
VETTED_PARTNER |
This option may not be available for all locations. |
VerificationOption
The verification option represents how to verify the location (indicated by verification method) and where the verification will be sent to (indicated by display data).
Fields | |
---|---|
verification_method |
Method to verify the location. |
Union field DisplayData . One of the display data. The data must match the method. Empty if the corresponding method doesn't have any display data. DisplayData can be only one of the following: |
|
phone_number |
Set only if the method is PHONE_CALL or SMS. Phone number that the PIN will be sent to. |
address_data |
Set only if the method is MAIL. |
email_data |
Set only if the method is EMAIL. |
announcement |
Set only if the method is VETTED_PARTNER. |
AddressVerificationData
Display data for verifications through postcard.
Fields | |
---|---|
business |
Merchant's business name. |
address |
Address that a postcard can be sent to. |
expected_delivery_days_region |
Expected number of days it takes to deliver a postcard to the address's region. |
EmailVerificationData
Display data for verifications through email.
Fields | |
---|---|
domain |
Domain name in the email address. e.g. "gmail.com" in foo@gmail.com |
user |
User name in the email address. e.g. "foo" in foo@gmail.com |
is_user_name_editable |
Whether client is allowed to provide a different user name. |
VerificationToken
Token generated by a vetted partner.
Fields | |
---|---|
token_string |
The token string. |
Verify
Indicates that the location requires verification. Contains information about the current verification actions performed on the location.
Fields | |
---|---|
has_pending_verification |
Indicates whether a verification process has already started, and can be completed by the location. |
VerifyLocationRequest
Request message for Verifications.VerifyLocation.
Fields | |
---|---|
name |
Required. Resource name of the location to verify. |
method |
Required. Verification method. |
language_code |
Optional. The BCP 47 language code representing the language that is to be used for the verification process. |
context |
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: |
|
email_address |
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 FetchVerificationOptions. If the [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] has is_user_name_editable set to true, the client may specify a different user name (local-part) but must match the domain name. |
mailer_contact |
Optional. The input for ADDRESS method. Contact name the mail should be sent to. |
phone_number |
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 |
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. |
VerifyLocationResponse
Response message for Verifications.VerifyLocation.
Fields | |
---|---|
verification |
The created verification request. |
VoiceOfMerchantState
Response message for VoiceOfMerchant.GetVoiceOfMerchantState.
Fields | |
---|---|
has_voice_of_merchant |
Indicates whether the location is in good standing and has control over the business on Google. Any edits made to the location will propagate to Maps after passing the review phase. |
has_business_authority |
Indicates whether the location has the authority (ownership) over the business on Google. If true, another location cannot take over and become the dominant listing on Maps. However, edits will not become live unless Voice of Merchant is gained (i.e. has_voice_of_merchant is true). |
Union field gain_voice_of_merchant_action . Action recommended to the location to gain control over the business on Google. gain_voice_of_merchant_action can be only one of the following: |
|
wait_for_voice_of_merchant |
Wait to gain Voice of Merchant. The location is under review for quality purposes. |
verify |
Start or continue the verification process. |
resolve_ownership_conflict |
This location duplicates another location that is in good standing. If you have access to the location in good standing, use that location's id to perform operations. Otherwise, request access from the current owner. |
comply_with_guidelines |
The location fails to comply with our guidelines and requires additional steps for reinstatement. To fix this issue, consult the Help Center Article. |
WaitForVoiceOfMerchant
This type has no fields.
Indicates that the location will gain voice of merchant after passing review.