Method: places.searchText

חיפוש מקום על סמך שאילתת טקסט.

בקשת HTTP

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

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

גוף הבקשה

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

ייצוג JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
שדות
textQuery

string

חובה. שאילתת הטקסט לחיפוש באמצעות טקסט.
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 ספרות.
rankPreference

enum (RankPreference)

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

string

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

boolean

משמש להגבלת החיפוש למקומות שפתוחים כרגע. ברירת המחדל היא False.
minRating

number

כך אפשר לסנן תוצאות שדירוג המשתמשים הממוצע שלהן נמוך ממש מהמגבלה הזו. ערך חוקי חייב להיות ערך צף בין 0 ל-5 (כולל) בקצב של 0.5, כלומר [0, 0.5, 1.0, ... , 5.0] כולל. דירוג הקלט יעוגל כלפי מעלה ל-0.5(תקרה). לדוגמה, דירוג של 0.6 יבטל את כל התוצאות עם דירוג נמוך מ-1.0.
maxResultCount
(deprecated)

integer

הוצא משימוש: יש להשתמש במקום זאת ב-pageSize.

המספר המקסימלי של תוצאות שניתן להחזיר לכל דף. אם מספר התוצאות הזמינות גדול מ-maxResultCount, מוחזר nextPageToken שאותו ניתן להעביר אל pageToken כדי לקבל את דף התוצאות הבא בבקשות הבאות. אם לא מזינים 0 או לא מזינים ערך, המערכת משתמשת בברירת המחדל של 20. הערך המקסימלי הוא 20. ערכים מעל 20 יכוונו ל-20. ערכים שליליים יחזירו שגיאת INVALID_ARGUMENT.

אם ציינת את maxResultCount וגם את pageSize, המערכת תתעלם מ-maxResultCount.
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של תוצאות שניתן להחזיר לכל דף. אם מספר התוצאות הזמינות גדול מ-pageSize, מוחזר nextPageToken שאותו ניתן להעביר אל pageToken כדי לקבל את דף התוצאות הבא בבקשות הבאות. אם לא מזינים 0 או לא מזינים ערך, המערכת משתמשת בברירת המחדל של 20. הערך המקסימלי הוא 20. ערכים מעל 20 יוגדרו כ-20. ערכים שליליים יחזירו שגיאת INVALID_ARGUMENT.

אם ציינת את maxResultCount וגם את pageSize, המערכת תתעלם מ-maxResultCount.
pageToken

string

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

במהלך העימוד, כל הפרמטרים מלבד pageToken, pageSize ו-maxResultCount שסופקו ל-TextSearch חייבים להתאים לקריאה הראשונית שסיפקה את אסימון הדף. אחרת, תוחזר שגיאת INVALID_ARGUMENT.
priceLevels[]

enum (PriceLevel)

משמש להגבלת החיפוש למקומות שמסומנים כרמות מחיר מסוימות. המשתמשים יכולים לבחור כל שילוב של רמות מחירים. ברירת המחדל היא בחירה של כל רמות המחירים.
strictTypeFiltering

boolean

משמש להגדרת סינון סוגים מחמיר עבור includedType. אם היא מוגדרת כ-True, יוחזרו רק תוצאות מאותו סוג. ברירת המחדל היא False.
locationBias

object (LocationBias)

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

object (LocationRestriction)

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

object (EVOptions)

זה שינוי אופציונלי. הגדרת האפשרויות של הרכב החשמלי (EV) הניתנות לחיפוש עבור בקשה של חיפוש מקום.

גוף התשובה

פרוטו של תגובה ל- places.searchText.

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

ייצוג JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
שדות
places[]

object (Place)

רשימה של מקומות שעומדים בקריטריונים לחיפוש טקסט של המשתמש.
contextualContents[]

object (ContextualContent)

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

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

string

אסימון שיכול להישלח בתור pageToken כדי לאחזר את הדף הבא. אם השדה הזה יושמט או שהוא ריק, לא יהיו דפים עוקבים.

RankPreference

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

טיפוסים בני מנייה (enums)
RANK_PREFERENCE_UNSPECIFIED עבור שאילתה קטגורית כמו "מסעדות בתל אביב", RELEVANCE היא ברירת המחדל. לגבי שאילתות שאינן קטגוריות, כמו "Mountain View, CA", מומלץ לא להגדיר את RankPreference (העדפות).
DISTANCE מדרג את התוצאות לפי מרחק.
RELEVANCE מדרג את התוצאות לפי רלוונטיות. סדר המיון נקבע לפי ערימת דירוג רגילה.

LocationBias

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

ייצוג JSON 
{

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

שדה איחוד type.

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

object (Viewport)

תיבה מלבנית שהוגדרה לפי פינה צפון-מזרחית ודרום-מערבית. rectangle.high() חייב להיות הנקודה הצפון-מזרחית של אזור התצוגה של המלבן. rectangle.low() חייב להיות הנקודה הדרום-מערבית של אזור התצוגה של המלבן. rectangle.low().latitude() לא יכול להיות גדול מ-rectangle.high().latitude(). התוצאה היא טווח קווי רוחב ריק. אזור התצוגה של מלבן לא יכול להיות רחב יותר מ-180 מעלות.
circle

object (Circle)

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

LocationRestriction

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

ייצוג JSON 
{

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

שדה איחוד type.

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

object (Viewport)

תיבה מלבנית שהוגדרה לפי פינה צפון-מזרחית ודרום-מערבית. rectangle.high() חייב להיות הנקודה הצפון-מזרחית של אזור התצוגה של המלבן. rectangle.low() חייב להיות הנקודה הדרום-מערבית של אזור התצוגה של המלבן. rectangle.low().latitude() לא יכול להיות גדול מ-rectangle.high().latitude(). התוצאה היא טווח קווי רוחב ריק. אזור התצוגה של מלבן לא יכול להיות רחב יותר מ-180 מעלות.

EVOptions

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

ייצוג JSON 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
שדות
minimumChargingRateKw

number

זה שינוי אופציונלי. קצב הטעינה המינימלי הנדרש בקילוואט. מקום שקצב הטעינה שלו נמוך מהתעריף שצוין יסונן.
connectorTypes[]

enum (EVConnectorType)

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

ContextualContent

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

תוכן שהוא בהקשר לשאילתת המקום.

ייצוג JSON 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
שדות
reviews[]

object (Review)

רשימת ביקורות על המקום הזה, ממשיכות לשאילתת המקום.
photos[]

object (Photo)

מידע (כולל התייחסויות) על תמונות של המקום הזה, שמופיעות בהמשך לשאילתת המקום.
justifications[]

object (Justification)

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

הצדקות למקום.

הצדקה

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

הצדקות למקום. נימוקים מספקים מענה לשאלה מדוע מקום מסוים יכול לעניין את משתמש הקצה.

ייצוג JSON 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
שדות

שדה איחוד justification.

justification יכול להיות רק אחד מהבאים:
reviewJustification

object (ReviewJustification)

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

ReviewJustification

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

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

ייצוג JSON 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
שדות
highlightedText

object (HighlightedText)
review

object (Review)

הביקורת שממנה נוצר הטקסט המודגש.

HighlightedText

הטקסט שמודגש על ידי ההצדקה. זו רק קבוצת משנה של הבדיקה. המילה המדויקת שיש להדגיש מסומנת על ידי highlightedTextRange. יכולות להיות כמה מילים בטקסט שמודגש.

ייצוג JSON 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
שדות
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

רשימת הטווחים של הטקסט המודגש.

HighlightedTextRange

הטווח של הטקסט המודגש.

ייצוג JSON 
{
  "startIndex": integer,
  "endIndex": integer
}
שדות
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. הצדקות לגבי BusinessAvailabilityAttributes. כאן מוצגים כמה מאפיינים של עסק שעשויים לעניין את משתמש הקצה.

ייצוג JSON 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
שדות
takeout

boolean

אם יש אפשרות לאיסוף עצמי.
delivery

boolean

אם המקום מציע משלוחים.
dineIn

boolean

אם אפשר לאכול במקום.