Method: accounts.locations.findMatches
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
חיפוש של כל המיקומים האפשריים שתואמים למיקום שצוין. הפעולה הזו תקפה רק אם המיקום לא מאומת.
בקשת HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים |
name |
string
שם המשאב של המיקום כדי לחפש התאמות.
|
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
{
"languageCode": string,
"numResults": integer,
"maxCacheDuration": string
} |
שדות |
languageCode |
string
השפה המועדפת למיקום התואם (בפורמט BCP-47).
|
numResults |
integer
מספר ההתאמות שיש להחזיר. ערך ברירת המחדל הוא 3, והערך המקסימלי הוא 10. חשוב לזכור שזמן האחזור יכול להתארך אם תישלח בקשה נוספת. אין חלוקה לדפים.
|
maxCacheDuration |
string (Duration format)
הוצא משימוש. המערכת מתעלמת מהשדה הזה בכל הבקשות. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s '. לדוגמה: "3.5s" .
|
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
הודעת תגובה לגבי Locations.FindMatchingLocations (מיקומים).
ייצוג JSON |
{
"matchedLocations": [
{
object (MatchedLocation )
}
],
"matchTime": string
} |
שדות |
matchedLocations[] |
object (MatchedLocation )
אוסף של מיקומים שעשויים להיות התאמות פוטנציאליות למיקום שצוין, בחלוקה לפי סדר מהטוב ביותר לנמוך ביותר. אם קיימת התאמה מדויקת, היא תופיע במיקום הראשון.
|
matchTime |
string (Timestamp format)
מתי בוצע אלגוריתם ההתאמה האחרון עבור המיקום הזה. חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z" .
|
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
MatchedLocation
מייצג התאמה אפשרית למיקום.
ייצוג JSON |
{
"location": {
object (Location )
},
"isExactMatch": boolean
} |
שדות |
location |
object (Location )
המיקום המאוכלס בדלילות שאפשר להתאים לו. שדות שלא מאוכלסים כוללים, בין היתר: שם (לא ניתן לאחזר את המיקום התואם דרך locations.get או locations.batchGet ); storeCode ; פרטים על אזור הכיסוי של serviceArea ; labels ; adWordsLocationExtensions ; photos
|
isExactMatch |
boolean
האם זו התאמה מדויקת?
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון 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? |"]]