Method: places.searchNearby

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

בקשת HTTP

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

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
שדות
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 ספרות.
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)

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

גוף התשובה

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

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

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

object (Place)

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

object (RoutingSummary)

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

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 דירוג התוצאות לפי פופולריות.