Update your Google Business Profile API integration before critical endpoints are disabled. Review the deprecation schedule and instructions to avoid disruptions starting in April 2022.

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,
  "hasBusinessAuthority": boolean,

  // Union field gain_voice_of_merchant_action can be only one of the following:
  "waitForVoiceOfMerchant": {
    object (WaitForVoiceOfMerchant)
  },
  "verify": {
    object (Verify)
  },
  "resolveOwnershipConflict": {
    object (ResolveOwnershipConflict)
  },
  "complyWithGuidelines": {
    object (ComplyWithGuidelines)
  }
  // End of list of possible types for union field gain_voice_of_merchant_action.
}
Fields
hasVoiceOfMerchant

boolean

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.

hasBusinessAuthority

boolean

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. hasVoiceOfMerchant 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:
waitForVoiceOfMerchant

object (WaitForVoiceOfMerchant)

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

verify

object (Verify)

Start or continue the verification process.

resolveOwnershipConflict

object (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.

complyWithGuidelines

object (ComplyWithGuidelines)

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

WaitForVoiceOfMerchant

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

Verify

Indicates that the location requires verification. Contains information about the current verification actions performed on the location.

JSON representation
{
  "hasPendingVerification": boolean
}
Fields
hasPendingVerification

boolean

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

ResolveOwnershipConflict

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

ComplyWithGuidelines

Indicates that the location fails to comply with our guidelines.

JSON representation
{
  "recommendationReason": enum (RecommendationReason)
}
Fields
recommendationReason

enum (RecommendationReason)

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.