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.
Searches the chain based on chain name.
HTTP request
GET https://mybusiness.googleapis.com/v4/chains:search
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
chainDisplayName |
string
Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
|
resultCount |
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 chainDisplayName in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
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 details how to search for a business chain using the \u003ccode\u003esearch\u003c/code\u003e endpoint and the \u003ccode\u003echainDisplayName\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and the response will include a list of chains matching the query, ranked by relevance.\u003c/p\u003e\n"],["\u003cp\u003eThe maximum number of results returned can be controlled using the \u003ccode\u003eresultCount\u003c/code\u003e query parameter, with a default of 10 and a maximum of 500.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using either the \u003ccode\u003ehttps://www.googleapis.com/auth/plus.business.manage\u003c/code\u003e or \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://mybusiness.googleapis.com/v4/chains:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chainDisplayName` | `string` Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: \"walmart\", \"wal-mart\", \"walmmmart\", \"沃尔玛\" |\n| `resultCount` | `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\nIf successful, the response body contains data with the following structure:\nResponse message for Locations.SearchChains.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------|---|\n| ``` { \"chains\": [ { object (/my-business/reference/rest/v4/chains#Chain) } ] } ``` |\n\n| Fields ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `chains[]` | `object (`[Chain](/my-business/reference/rest/v4/chains#Chain)`)` Chains that match the queried chainDisplayName 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 one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\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)."]]