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" או "מגדל אייפל, פריז". השאילתות חייבות להיות כתובת או שם מקום ספציפיים. אין תמיכה במיקומים כלליים כמו שם של רשת (למשל, "ארומה") או שאילתת חיפוש כמו "מסעדות".

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 רמת סמך גבוהה מציינת שהרזולוציה נכונה ומייצגת ישות גיאוגרפית ספציפית (למשל, מקום ספציפי).