Sign up for email announcements to stay updated on the latest information about the GMB API.

Method: accounts.listRecommendGoogleLocations

List all the GoogleLocations that have been recommended to the specified GMB account. Recommendations are provided for personal accounts and location groups only, requests for all other account types will result in an error. The recommendations for location groups are based on the locations in that group.

The recommendations for personal accounts are based on all of the locations that the user has access to on Google My Business (which includes locations they can access through location groups), and is a superset of all recommendations generated for the user.

HTTP request

GET https://mybusiness.googleapis.com/v4/{name=accounts/*}:recommendGoogleLocations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

name of the account resource to fetch recommended Google locations for.

Query parameters

Parameters
pageSize

number

How many locations to fetch per page. Default is 25, minimum is 1, and maximum page size is 100.

pageToken

string

If specified, the next page of locations is retrieved.

Request body

The request body must be empty.

Response body

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

Response message for GoogleLocations.ListRecommendedGoogleLocations.

It also contains some locations that have been claimed by other GMB users since the last time they were recommended to this GMB account.

JSON representation 
{
  "googleLocations": [
    {
      object(GoogleLocation)
    }
  ],
  "totalSize": number,
  "nextPageToken": string
}
Fields
googleLocations[]

object(GoogleLocation)

The locations recommended to a GMB account. Each of these represents a GoogleLocation that is present on Maps. The locations are sorted in decreasing order of relevance to the GMB account.

totalSize

number

The total number of recommended locations for this GMB account, irrespective of pagination.

nextPageToken

string

During pagination, if there are more locations available to be fetched in the next page, this field is populated with a token to fetch the next page of locations in a subsequent call. If there are no more locations to be fetched, this field is not present in the response.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.