Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: chains.search
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThis document outlines the process for searching a chain using its name via the \u003ccode\u003echains:search\u003c/code\u003e endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe search functionality supports exact, partial, fuzzy, and related queries and allows specifying the maximum number of results.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses provide a list of chains matching the query, ranked by relevance, along with their respective details as defined by the \u003ccode\u003eChain\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: chains.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchChainsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nSearches the chain based on chain name.\n\n### HTTP request\n\n`GET https://mybusinessbusinessinformation.googleapis.com/v1/chains:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chainName` | `string` Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: \"walmart\", \"wal-mart\", \"walmmmart\", \"沃尔玛\" |\n| `pageSize` | `integer` The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for Locations.SearchChains.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------|\n| ``` { \"chains\": [ { object (/my-business/reference/businessinformation/rest/v1/chains#Chain) } ] } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chains[]` | `object (`[Chain](/my-business/reference/businessinformation/rest/v1/chains#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. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]