Method: chains.search

  • This document outlines the process for searching a chain using its name via the chains:search endpoint.

  • The search functionality supports exact, partial, fuzzy, and related queries and allows specifying the maximum number of results.

  • Successful responses provide a list of chains matching the query, ranked by relevance, along with their respective details as defined by the Chain object.

  • Authorization is required using the https://www.googleapis.com/auth/business.manage OAuth scope.

Searches the chain based on chain name.

HTTP request

GET https://mybusinessbusinessinformation.googleapis.com/v1/chains:search

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
chainName

string

Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
pageSize

integer

The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.

Request body

The request body must be empty.

Response body

Response message for Locations.SearchChains.

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

JSON representation 
{
  "chains": [
    {
      object (Chain)
    }
  ]
}
Fields
chains[]

object (Chain)

Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.