Method: places.searchNearby

חיפוש מקומות ליד מיקומים.

בקשת HTTP

POST https://places.googleapis.com/v1/places:searchNearby

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  },
  "includeFutureOpeningBusinesses": boolean
}
שדות
languageCode

string

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

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

string

קוד המדינה או האזור של Unicode ‏ (CLDR) של המיקום שממנו מגיעה הבקשה. הפרמטר הזה משמש להצגת פרטי המקום, כמו שם המקום הספציפי לאזור, אם הוא זמין. הפרמטר יכול להשפיע על התוצאות בהתאם לדין החל.

מידע נוסף זמין בכתובת https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

שימו לב: בשלב הזה אין תמיכה בקודים אזוריים בני 3 ספרות.
includedTypes[]

string

סוג המקום הכלול (לדוגמה, 'מסעדה' או 'תחנת דלק') מתוך https://developers.google.com/maps/documentation/places/web-service/place-types.

אפשר לציין עד 50 סוגים מטבלה א'.

אם יש סוגים סותרים, כלומר סוג שמופיע גם ב-includedTypes וגם ב-excludedTypes, מוחזרת שגיאה מסוג INVALID_ARGUMENT.

אם מציינים סוג מקום עם כמה הגבלות על סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. לדוגמה, אם נגדיר {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, המקומות שיוחזרו יספקו שירותים שקשורים ל'מסעדה', אבל לא יפעלו בעיקר כ'מסעדות'.
excludedTypes[]

string

סוג המקום (לדוגמה, 'מסעדה' או 'תחנת דלק') שמופיע בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.

אפשר לציין עד 50 סוגים מטבלה א'.

אם הלקוח מספק גם includedTypes (למשל, מסעדה) וגם excludedTypes (למשל, בית קפה), התשובה צריכה לכלול מקומות שהם מסעדה אבל לא בית קפה. התשובה כוללת מקומות שתואמים לפחות לאחד מהערכים של includedTypes ולא לאף אחד מהערכים של excludedTypes.

אם יש סוגים סותרים, כלומר סוג שמופיע גם ב-includedTypes וגם ב-excludedTypes, מוחזרת שגיאה מסוג INVALID_ARGUMENT.

אם מציינים סוג מקום עם כמה הגבלות על סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. לדוגמה, אם נגדיר {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, המקומות שיוחזרו יספקו שירותים שקשורים ל'מסעדה', אבל לא יפעלו בעיקר כ'מסעדות'.
includedPrimaryTypes[]

string

סוג המקום הראשי שכלול (לדוגמה, 'מסעדה' או 'תחנת דלק') מתוך https://developers.google.com/maps/documentation/places/web-service/place-types. לכל מקום יכול להיות רק סוג ראשי אחד מתוך הטבלה של הסוגים הנתמכים.

אפשר לציין עד 50 סוגים מטבלה א'.

אם יש סוגים ראשיים סותרים, כלומר סוג שמופיע גם ב-includedPrimaryTypes וגם ב-excludedPrimaryTypes, מוחזרת שגיאה מסוג INVALID_ARGUMENT.

אם מציינים סוג מקום עם כמה הגבלות על סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. לדוגמה, אם נגדיר {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, המקומות שיוחזרו יספקו שירותים שקשורים ל'מסעדה', אבל לא יפעלו בעיקר כ'מסעדות'.
excludedPrimaryTypes[]

string

סוג המקום הראשי שמוחרג (לדוגמה, 'מסעדה' או 'תחנת דלק') מתוך https://developers.google.com/maps/documentation/places/web-service/place-types.

אפשר לציין עד 50 סוגים מטבלה א'.

אם יש סוגים ראשיים סותרים, כלומר סוג שמופיע גם ב-includedPrimaryTypes וגם ב-excludedPrimaryTypes, מוחזרת שגיאה מסוג INVALID_ARGUMENT.

אם מציינים סוג מקום עם כמה הגבלות על סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. לדוגמה, אם נגדיר {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, המקומות שיוחזרו יספקו שירותים שקשורים ל'מסעדה', אבל לא יפעלו בעיקר כ'מסעדות'.
maxResultCount

integer

המספר המקסימלי של התוצאות שיוחזרו. הערך חייב להיות בין 1 ל-20 (ברירת מחדל), כולל. אם המספר לא מוגדר, המערכת חוזרת למגבלה העליונה. אם המספר מוגדר כשלילי או חורג מהמגבלה העליונה, מוחזרת שגיאת INVALID_ARGUMENT.
locationRestriction

object (LocationRestriction)

חובה. האזור לחיפוש.
rankPreference

enum (RankPreference)

איך התוצאות ידורגו בתשובה.
routingParameters

object (RoutingParameters)

אופציונלי. פרמטרים שמשפיעים על הניתוב לתוצאות החיפוש.
includeFutureOpeningBusinesses

boolean

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

גוף התשובה

קובץ proto של התגובה לחיפוש בקרבת מקום.

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

ייצוג ב-JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
שדות
places[]

object (Place)

רשימה של מקומות שעומדים בדרישות המשתמש, כמו סוגי מקומות, מספר מקומות והגבלות מיקום ספציפיות.
routingSummaries[]

object (RoutingSummary)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform

LocationRestriction

האזור לחיפוש.

ייצוג ב-JSON 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
שדות

שדה איחוד type.

הערך type יכול להיות רק אחד מהבאים:
circle

object (Circle)

מעגל שמוגדר על ידי נקודת מרכז ורדיוס.

RankPreference

איך התוצאות ידורגו בתשובה.

טיפוסים בני מנייה (enum)
RANK_PREFERENCE_UNSPECIFIED לא הוגדר ערך ל-RankPreference. המערכת תשתמש בדירוג לפי פופולריות כברירת מחדל.
DISTANCE מדרג את התוצאות לפי מרחק.
POPULARITY התוצאות מדורגות לפי פופולריות.