Method: places.searchNearby

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

בקשת HTTP

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

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

גוף הבקשה

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

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

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

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

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

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

string

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

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

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

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

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

string

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

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

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

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

string

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

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

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

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

integer

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

object (LocationRestriction)

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

enum (RankPreference)

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

גוף התשובה

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

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

ייצוג JSON 
{
  "places": [
    {
      object (Place)
    }
  ]
}
שדות
places[]

object (Place)

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

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

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

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