Method: resolveNames

הפונקציה פותרת רשימה של שמות מקומות (או כתובות) לישויות גיאוספציאליות ספציפיות (למשל מקומות) במפות Google.

בקשת HTTP

POST https://mapstools.googleapis.com/v1:resolveNames

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
שדות
queries[]

object (LocationQuery)

חובה. רשימה של שאילתות מיקום שצריך לפתור. אפשר לציין עד 20 שאילתות.

locationBias

object (LocationBias)

אופציונלי. אזור אופציונלי להטיית תוצאות ההחלטה. אם מציינים אזור, תוצאות ההחלטה יושפעו יותר מהישויות שקרובות לאזור הזה. אם כוללים את התווים locationBias או regionCode, לרוב מקבלים תוצאות טובות יותר כי מרחב החיפוש מצטמצם.

אם מציינים גם את locationBias וגם את regionCode, ל-locationBias יש עדיפות על פני regionCode.

regionCode

string

אופציונלי. קוד אזור אופציונלי להטיית תוצאות ההמרה. אם מציינים אזור, התוצאות של ההחלטה יתמקדו בישויות שנמצאות באזור שצוין או בקרבתו. הערך צריך להיות קוד אזור ממאגר ה-CLDR. לדוגמה, 'US' או 'CA'. אם כוללים את התווים locationBias או regionCode, לרוב מקבלים תוצאות טובות יותר כי מרחב החיפוש מצטמצם.

אם מציינים גם את locationBias וגם את regionCode, ל-locationBias יש עדיפות על פני regionCode.

גוף התשובה

הודעת התגובה ל-v1.resolveNames.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
שדות
results[]

object (Result)

פלט בלבד. רשימת הישויות שנפתרו משאילתות המיקום. מובטח שהמיפוי יהיה 1:1 עם האינדקסים של בקשת queries. מחרוזת ריקה באינדקס i מציינת שהפענוח נכשל עבור השאילתה הזו. אם הפענוח נכשל, צריך לבדוק את השדה failedRequests כדי לראות את סטטוס השגיאה.

failedRequests

map (key: integer, value: object (Status))

פלט בלבד. מפה שמציגה כשלים חלקיים. המפתח הוא האינדקס של הבקשה שנכשלה בשדה queries. הערך הוא סטטוס השגיאה שמפרט למה הפענוח נכשל.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

saveToMapsUrl

string

פלט בלבד. קישור לשמירת כל הישויות שנפתרו בהצלחה במפות Google.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

שאילתת מיקום מייצגת ישות מיקום ספציפית שאפשר לפתור באמצעות מפות Google. בשלב הזה, אפשר להשתמש רק בשמות של מקומות ובכתובות כשאילתות המיקום.

ייצוג ב-JSON
{
  "text": string
}
שדות
text

string

חובה. שאילתת הטקסט שצריך לפתור כדי להגיע לישות גיאוספציפית ספציפית במפות Google, כמו מקום או כתובת. ככל שהשאילתה תהיה ספציפית יותר, כך הפתרון יהיה מדויק יותר. לדוגמה, 'סן פרנסיסקו', 'Googleplex, Mountain View, CA',‏ '1600 Amphitheatre Parkway, Mountain View, CA' או 'מגדל אייפל, פריז'. השאילתות צריכות להיות כתובת ספציפית או שם של מקום. אין תמיכה במיקומים כלליים כמו שם של רשת (למשל, Starbucks) או שאילתת חיפוש כמו 'מסעדות'.

LocationBias

האזור שצריך להטות את תוצאות ההחלטה אליו.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "viewport": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
שדות
סוג ההטיה לפי מיקום. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
viewport

object (Viewport)

אזור תצוגה שמוגדר על ידי תיבה תוחמת.

סוף השדות הבלעדיים.

תוצאה

ישויות יחידות שנפתרו משאילתת מיקום נתונה, יחד עם רמת הסמך של הפתרון.

ייצוג ב-JSON
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
שדות
entity

object (Entity)

פלט בלבד. הישות שזוהתה מתוך שאילתת המיקום.

confidence

enum (Confidence)

פלט בלבד. רמת המהימנות של הפתרון.

רמת מהימנות

רמת המהימנות של הפתרון.

טיפוסים בני מנייה (enum)
CONFIDENCE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
MEDIUM רמת מהימנות בינונית מציינת שהפתרון כנראה נכון, אבל יכול להיות שיש מועמדים אחרים.
HIGH רמת סמך גבוהה מציינת שהרזולוציה נכונה ומייצגת ישות גיאוספציפית ספציפית (למשל, מקום ספציפי).