Method: googleLocations.search

  • Search for Google Locations that match a specified request, using either a location object or a string query.

  • Responses include a list of potential Google Location matches, ranked by accuracy.

  • Specify the number of matches to return, with a default of 3 and a maximum of 10.

  • Requires the https://www.googleapis.com/auth/business.manage OAuth scope for authorization.

  • The API utilizes gRPC Transcoding and provides JSON structured request and response bodies.

Search all of the possible locations that are a match to the specified request.

HTTP request

POST https://mybusinessbusinessinformation.googleapis.com/v1/googleLocations:search

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageSize": integer,

  // Union field search_query can be only one of the following:
  "location": {
    object (Location)
  },
  "query": string
  // End of list of possible types for union field search_query.
}
Fields
pageSize

integer

The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.
Union field search_query. Search query. This can be provided either as a location object or as a string query. search_query can be only one of the following:
location

object (Location)

Location to search for. If provided, will find locations which match the provided location details.
query

string

Text query to search for. The search results from a query string will be less accurate than if providing an exact location, but can provide more inexact matches.

Response body

Response message for GoogleLocations.SearchGoogleLocations.

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

JSON representation 
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
Fields
googleLocations[]

object (GoogleLocation)

A collection of GoogleLocations that are potential matches to the specified request, listed in order from most to least accuracy.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.