The Business Profile Performance API is now launched! Migration work is required.
Review the deprecation schedule and instructions to migrate over to new v1 APIs from older deprecated v4 API.
Help us improve the food menu experience by filling in this survey to better understand what place, menu, and dish attributes you can provide about the merchants you support

Method: chains.search

Stay organized with collections Save and categorize content based on your preferences.

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

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

Response message for Locations.SearchChains.

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.