Method: resolveNames

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

בקשת HTTP

POST https://mapstools.googleapis.com/v1alpha: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.

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  }
}
שדות
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" }.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

LocationQuery

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

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

string

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

LocationBias

האזור שבו רוצים להטות את תוצאות הרזולוציה.

ייצוג ב-JSON 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
שדות
שדה איחוד type. סוג ההטיה למיקום. הערך type יכול להיות רק אחד מהבאים:
viewport

object (Viewport)

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

אזור התצוגה

אזור תצוגה של קווי אורך ורוחב, שמיוצג כשני קצוות מנוגדים של אלכסון low ו-high. אזור התצוגה נחשב לאזור סגור, כלומר הוא כולל את הגבול שלו. הגבולות של קו הרוחב צריכים להיות בין 90- ל-90 מעלות כולל, והגבולות של קו האורך צריכים להיות בין 180- ל-180 מעלות כולל. דוגמאות לכיסויים כאלה:

  • אם low = high, אזור התצוגה מורכב מהנקודה היחידה הזו.

  • אם low.longitude > high.longitude, טווח קווי האורך הפוך (אזור התצוגה חוצה את קו האורך 180 מעלות).

  • אם low.longitude = ‎-180 מעלות ו-high.longitude = ‎180 מעלות, אז אזור התצוגה כולל את כל קווי האורך.

  • אם low.longitude = 180 מעלות ו-high.longitude = ‎-180 מעלות, טווח קווי האורך ריק.

  • אם low.latitude > high.latitude, טווח קווי הרוחב ריק.

צריך למלא את שני השדות low ו-high, והתיבה שמיוצגת לא יכולה להיות ריקה (כפי שמצוין בהגדרות שלמעלה). אם אזור התצוגה יהיה ריק, תופיע שגיאה.

לדוגמה, אזור התצוגה הזה כולל את כל העיר ניו יורק:

‪{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

ייצוג ב-JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
שדות
low

object (LatLng)

חובה. הנקודה הנמוכה של אזור התצוגה.
high

object (LatLng)

חובה. הנקודה הגבוהה ביותר באזור התצוגה.

LatLng

אובייקט שמייצג זוג של קווי אורך ורוחב. הערך הזה מבוטא כזוג מספרים עשרוניים שמייצגים מעלות של קו רוחב ומעלות של קו אורך. אלא אם צוין אחרת, האובייקט הזה צריך להיות תואם ל תקן WGS84. הערכים צריכים להיות בטווחים מנורמלים.

ייצוג ב-JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הערך חייב להיות בטווח [‎-90.0, ‎+90.0].
longitude

number

קו האורך במעלות. הערך חייב להיות בטווח [‎-180.0, ‎+180.0].

תוצאה

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

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

object (Entity)

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

enum (Confidence)

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

רמת מהימנות

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

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