הפונקציה מחפשת את כל המיקומים האפשריים שתואמים למיקום שצוין. הפעולה הזו תקפה רק אם המיקום לא מאומת.
בקשת HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
שם המשאב של המיקום שצריך לחפש עבורו התאמות. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "languageCode": string, "numResults": integer, "maxCacheDuration": string } |
שדות | |
---|---|
languageCode |
השפה המועדפת למיקום התואם (בפורמט BCP-47). |
numResults |
מספר ההתאמות שיש להחזיר. ערך ברירת המחדל הוא 3, ומקסימום 10. הערה: זמן האחזור עשוי להתארך אם תבקשו יותר. אין עימוד. |
maxCacheDuration |
הוּצא משימוש. המערכת מתעלמת מהשדה הזה בכל הבקשות. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הודעת תגובה עבור Locations.FindMatchingLocations.
ייצוג JSON | |
---|---|
{
"matchedLocations": [
{
object ( |
שדות | |
---|---|
matchedLocations[] |
אוסף של מיקומים שהם התאמות פוטנציאליות למיקום שצוין, המפורטים לפי סדר ההתאמה הטובה ביותר עד הנמוכה ביותר. אם יש התאמה מדויקת, היא תוצג במיקום הראשון. |
matchTime |
המועד שבו בוצע לאחרונה אלגוריתם ההתאמה במיקום הזה. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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 |
האם זו התאמה מדויקת? |