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.

Method: locations.getVoiceOfMerchantState

Gets the VoiceOfMerchant state.

HTTP request

GET https://mybusinessverifications.googleapis.com/v1/{name=locations/*}/VoiceOfMerchantState

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the location.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for VoiceOfMerchant.GetVoiceOfMerchantState.

JSON representation
{
  "hasVoiceOfMerchant": boolean,

  // Union field gain_voice_of_merchant_action can be only one of the following:
  "wait": {
    object (Wait)
  },
  "verify": {
    object (Verify)
  },
  "resolveInProduct": {
    object (ResolveInProduct)
  }
  // End of list of possible types for union field gain_voice_of_merchant_action.
}
Fields
hasVoiceOfMerchant

boolean

The merchant already has control over the business on Google.

Union field gain_voice_of_merchant_action. Action recommended to the merchant to gain control over the business on Google. gain_voice_of_merchant_action can be only one of the following:
wait

object (Wait)

Wait to gain control over the business on Google.

verify

object (Verify)

Start or continue the verification process.

resolveInProduct

object (ResolveInProduct)

Please use in-product capabilities to gain control.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

Wait

Contains information about Wait action.

Verify

Contains information about Verify action.

JSON representation
{
  "hasPendingVerification": boolean
}
Fields
hasPendingVerification

boolean

A verification process has already started, and can be completed by the merchant.

ResolveInProduct

Contains information about ResolveInProduct action.