The Q&A API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

Package google.mybusiness.verifications.v1

Index

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

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Completes a PENDING verification.

It is only necessary for non AUTO verification methods. AUTO verification request is instantly VERIFIED upon creation.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Reports all eligible verification options for a location in a specific language.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

GenerateVerificationToken

rpc GenerateVerificationToken(GenerateVerificationTokenRequest) returns (GenerateVerificationTokenResponse)

Generates a token for the provided location data as a vetted partner.

Throws PERMISSION_DENIED if the caller is not a vetted partner account. Throws FAILED_PRECONDITION if the caller's VettedStatus is INVALID.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

List verifications of a location, ordered by create time.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Starts the verification process for a location.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

VoiceOfMerchant

This service allows 3P users to request details on voice of merchant state.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Gets the VoiceOfMerchant state.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

CompleteVerificationRequest

Request message for Verifications.CompleteVerificationAction.

Fields
name

string

Required. Resource name of the verification to complete.

pin

string

Required. PIN code received by the merchant to complete the verification.

CompleteVerificationResponse

Response message for Verifications.CompleteVerificationAction.

Fields
verification

Verification

The completed verification.

ComplyWithGuidelines

Indicates that the location fails to comply with our guidelines. To fix this issue, consult the Help Center Article.

FetchVerificationOptionsRequest

Request message for Verifications.FetchVerificationOptions.

Fields
location

string

Required. The location to verify.

language_code

string

Required. The BCP 47 language code representing the language that is to be used for the verification process. Available options vary by language.

context

ServiceBusinessContext

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[]

VerificationOption

The available verification options.

GenerateVerificationTokenRequest

Request message for Verifications.GenerateVerificationToken.

Fields
location

Location

Required. The target location.

GenerateVerificationTokenResponse

Response message for Verifications.GenerateVerificationToken.

Fields
token

VerificationToken

The generated token to verify the location.

GetVoiceOfMerchantStateRequest

Request message for VoiceOfMerchant.GetVoiceOfMerchantState.

Fields
name

string

Required. Resource name of the location.

ListVerificationsRequest

Request message for Verifications.ListVerifications.

Fields
parent

string

Required. Resource name of the location that verification requests belong to.

page_size

int32

How many verification to include per page. Minimum is 1, and the default and maximum page size is 100.

page_token

string

If specified, returns the next page of verifications.

ListVerificationsResponse

Response message for Verifications.ListVerifications.

Fields
verifications[]

Verification

List of the verifications.

next_page_token

string

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.

Location

A subset of location info. See the help center article for a detailed description of these fields, or the category endpoint for a list of valid business categories.

Fields
name

string

Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, Address, Categories). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").

primary_phone

string

Optional. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.

address

PostalAddress

Required. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five address_lines values in the address.

primary_category_id

string

Required. Id of the category that best describes the core business this location engages in.

website_uri

string

Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.

ResolveOwnershipConflict

Indicates that the location duplicates another location that is in good standing.

ServiceBusinessContext

Additional data for service business verification.

Fields
address

PostalAddress

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

string

Resource name of the verification.

method

VerificationMethod

The method of the verification.

state

State

The state of the verification.

create_time

Timestamp

The timestamp when the verification is requested.

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 Used for vetted partners. 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

VerificationMethod

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

string

Set only if the method is PHONE_CALL or SMS. Phone number that the PIN will be sent to.

address_data

AddressVerificationData

Set only if the method is MAIL.

email_data

EmailVerificationData

Set only if the method is EMAIL.

AddressVerificationData

Display data for verifications through postcard.

Fields
business

string

Merchant's business name.

address

PostalAddress

Address that a postcard can be sent to.

expected_delivery_days_region

int32

Expected number of days it takes to deliver a postcard to the address's region.

EmailVerificationData

Display data for verifications through email.

Fields
domain

string

Domain name in the email address. e.g. "gmail.com" in foo@gmail.com

user

string

User name in the email address. e.g. "foo" in foo@gmail.com

is_user_name_editable

bool

Whether client is allowed to provide a different user name.

VerificationToken

Token generated by a vetted partner.

Fields
token_string

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

bool

Indicates whether a verification process has already started, and can be completed by the location.

VerifyLocationRequest

Request message for Verifications.VerifyLocation.

Fields
name

string

Required. Resource name of the location to verify.

method

VerificationMethod

Required. Verification method.

language_code

string

Optional. The BCP 47 language code representing the language that is to be used for the verification process.

context

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:
email_address

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 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

string

Optional. The input for ADDRESS method. Contact name the mail should be sent to.

phone_number

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

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.

VerifyLocationResponse

Response message for Verifications.VerifyLocation.

Fields
verification

Verification

The created verification request.

VoiceOfMerchantState

Response message for VoiceOfMerchant.GetVoiceOfMerchantState.

Fields
has_voice_of_merchant

bool

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

bool

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

WaitForVoiceOfMerchant

Wait to gain Voice of Merchant. The location is under review for quality purposes.

verify

Verify

Start or continue the verification process.

resolve_ownership_conflict

ResolveOwnershipConflict

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

ComplyWithGuidelines

The location fails to comply with our guidelines and requires additional steps for reinstatement. To fix this issue, consult the Help Center Article.

WaitForVoiceOfMerchant

Indicates that the location will gain voice of merchant after passing review.