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: accounts.locations.findMatches
Stay organized with collections
Save and categorize content based on your preferences.
Finds all of the possible locations that are a match to the specified location. This operation is only valid if the location is unverified.
HTTP request
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The resource name of the location to find matches for.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"languageCode": string,
"numResults": integer,
"maxCacheDuration": string
} |
| Fields |
languageCode |
string
The preferred language for the matching location (in BCP-47 format).
|
numResults |
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.
|
maxCacheDuration |
string (Duration format)
Deprecated. This field is ignored for all requests. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
|
Response body
If successful, the response body contains data with the following structure:
Response message for Locations.FindMatchingLocations.
| JSON representation |
{
"matchedLocations": [
{
object (MatchedLocation)
}
],
"matchTime": string
} |
| Fields |
matchedLocations[] |
object (MatchedLocation)
A collection of locations that are potential matches to the specified location, listed in order from best to least match. If there is an exact match, it will be in the first position.
|
matchTime |
string (Timestamp format)
When the matching algorithm was last executed for this location. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
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.
MatchedLocation
Represents a possible match to a location.
| JSON representation |
{
"location": {
object (Location)
},
"isExactMatch": boolean
} |
| Fields |
location |
object (Location)
The sparsely populated location that is a potential match. Unpopulated fields include, but may not be limited to: name (the matched location cannot be retrieved via locations.get nor locations.batchGet); storeCode; serviceArea coverage area details; labels; adWordsLocationExtensions; photos
|
isExactMatch |
boolean
Is this an exact match?
|
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\u003eFinds potential location matches for unverified locations, ranked by match quality.\u003c/p\u003e\n"],["\u003cp\u003eSends an HTTP POST request to \u003ccode\u003ehttps://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches\u003c/code\u003e, specifying the location and optional language, result count.\u003c/p\u003e\n"],["\u003cp\u003eReceives a response with a list of matched locations and a timestamp indicating when the matching algorithm was last run.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003ehttps://www.googleapis.com/auth/plus.business.manage\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eEach matched location includes basic information and a flag indicating whether it's an exact match.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.locations.findMatches\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FindMatchingLocationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [MatchedLocation](#MatchedLocation)\n - [JSON representation](#MatchedLocation.SCHEMA_REPRESENTATION)\n\nFinds all of the possible locations that are a match to the specified location. This operation is only valid if the location is unverified.\n\n### HTTP request\n\n`POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------|\n| `name` | `string` The resource name of the location to find matches for. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------|---|\n| ``` { \"languageCode\": string, \"numResults\": integer, \"maxCacheDuration\": string } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `languageCode` | `string` The preferred language for the matching location (in BCP-47 format). |\n| `numResults` | `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. |\n| `maxCacheDuration` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` Deprecated. This field is ignored for all requests. A duration in seconds with up to nine fractional digits, terminated by '`s`'. Example: `\"3.5s\"`. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Locations.FindMatchingLocations.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"matchedLocations\": [ { object (/my-business/reference/rest/v4/accounts.locations/findMatches#MatchedLocation) } ], \"matchTime\": string } ``` |\n\n| Fields ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matchedLocations[]` | `object (`[MatchedLocation](/my-business/reference/rest/v4/accounts.locations/findMatches#MatchedLocation)`)` A collection of locations that are potential matches to the specified location, listed in order from best to least match. If there is an exact match, it will be in the first position. |\n| `matchTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` When the matching algorithm was last executed for this location. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\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).\n\nMatchedLocation\n---------------\n\nRepresents a possible match to a location.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"location\": { object (/my-business/reference/rest/v4/accounts.locations#Location) }, \"isExactMatch\": boolean } ``` |\n\n| Fields ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location` | `object (`[Location](/my-business/reference/rest/v4/accounts.locations#Location)`)` The sparsely populated location that is a potential match. Unpopulated fields include, but may not be limited to: name (the matched location cannot be retrieved via `locations.get` nor `locations.batchGet`); `storeCode`; `serviceArea` coverage area details; `labels`; `adWordsLocationExtensions`; `photos` |\n| `isExactMatch` | `boolean` Is this an exact match? |"]]