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

האם זו התאמה מדויקת?