Method: places.get

קבלת הפרטים של מקום על סמך שם המשאב שלו, שהוא מחרוזת בפורמט places/{placeId}.

בקשת HTTP

GET https://places.googleapis.com/v1/{name=places/*}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של מקום, בפורמט places/{placeId}.

פרמטרים של שאילתה

פרמטרים
languageCode

string

אפשרות. פרטי המקום יוצגו בשפה המועדפת, אם היא זמינה.

הרשימה הנוכחית של השפות הנתמכות: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

אפשרות. קוד המדינה/האזור (CLDR) ב-Unicode של המיקום שממנו נשלחה הבקשה. הפרמטר הזה משמש להצגת פרטי המקום, כמו שם מקום ספציפי לאזור, אם הם זמינים. הפרמטר יכול להשפיע על התוצאות בהתאם לדין החל. מידע נוסף זמין בכתובת https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

לידיעתכם, בשלב הזה אין תמיכה בקודי אזור בני 3 ספרות.

sessionToken

string

אפשרות. מחרוזת שמזהה סשן של השלמה אוטומטית למטרות חיוב. חייבת להיות מחרוזת בטוחה מסוג base64 לכתובת URL ולשם הקובץ, עם אורך של 36 תווי ASCII לכל היותר. אחרת, תוחזר שגיאת INVALID_ARGUMENT.

הסשן מתחיל כשהמשתמש מתחיל להקליד שאילתה, ומסתיים כשהוא בוחר מקום ומתבצעת קריאה לפרטי מקום או לאימות כתובת. כל פעילות באתר יכולה לכלול שאילתות מרובות, ואחריהן בקשה אחת לאימות כתובת או 'פרטי מקום'. פרטי הכניסה שמשמשים בכל בקשה בסשן צריכים להשתייך לאותו פרויקט במסוף Google Cloud. לאחר שסשן הסתיים, האסימון כבר לא תקף. האפליקציה צריכה ליצור אסימון חדש לכל סשן. אם הפרמטר sessionToken יושמט, או אם ייעשה שימוש חוזר באסימון סשן, החיוב על הסשן יתבצע כאילו לא סופק אסימון סשן (מחויבת בנפרד על כל בקשה).

מומלץ לפעול לפי ההנחיות הבאות:

  • יש להשתמש באסימוני סשן לכל הקריאות להשלמה אוטומטית של מקומות.
  • יצירת אסימון חדש לכל סשן. מומלץ להשתמש ב-UUID בגרסה 4.
  • מוודאים שפרטי הכניסה שמשמשים לכל הבקשות להשלמה אוטומטית של מקומות, לפרטי מקום ולאימות כתובות בסשן שייכים לאותו פרויקט במסוף Cloud.
  • חשוב להעביר אסימון סשן ייחודי לכל סשן חדש. שימוש באותו אסימון עבור יותר מסשן אחד באתר יגרום לחיוב כל בקשה בנפרד.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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