- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- RankPreference
- LocationBias
- LocationRestriction
- EVOptions
- ContextualContent
- הצדקה
- ReviewJustification
- HighlightedText
- HighlightedTextRange
- BusinessAvailabilityAttributesJustification
חיפוש מקום על סמך שאילתת טקסט.
בקשת HTTP
POST https://places.googleapis.com/v1/places:searchText
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
שדות | |
---|---|
textQuery |
חובה. שאילתת הטקסט לחיפוש באמצעות טקסט. |
languageCode |
פרטי המקום יוצגו בשפה המועדפת, אם היא זמינה. אם קוד השפה לא צוין או לא מזוהה, ייתכן שיוחזרו פרטי מקום של שפה כלשהי, עם עדיפות לאנגלית אם קיימים פרטים כאלה. הרשימה הנוכחית של השפות הנתמכות: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
קוד המדינה/האזור (CLDR) ב-Unicode של המיקום שממנו נשלחה הבקשה. הפרמטר הזה משמש להצגת פרטי המקום, כמו שם מקום ספציפי לאזור, אם הם זמינים. הפרמטר יכול להשפיע על התוצאות בהתאם לדין החל. מידע נוסף זמין בכתובת https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. לידיעתכם, בשלב הזה אין תמיכה בקודי אזור בני 3 ספרות. |
rankPreference |
איך התוצאות יקבלו דירוג בתשובה. |
includedType |
סוג המקום המבוקש. הרשימה המלאה של הסוגים הנתמכים: https://developers.google.com/maps/documentation/places/web-service/place-types. תמיכה בסוג כלול אחד בלבד. |
openNow |
משמש להגבלת החיפוש למקומות שפתוחים כרגע. ברירת המחדל היא False. |
minRating |
כך אפשר לסנן תוצאות שדירוג המשתמשים הממוצע שלהן נמוך ממש מהמגבלה הזו. ערך חוקי חייב להיות ערך צף בין 0 ל-5 (כולל) בקצב של 0.5, כלומר [0, 0.5, 1.0, ... , 5.0] כולל. דירוג הקלט יעוגל כלפי מעלה ל-0.5(תקרה). לדוגמה, דירוג של 0.6 יבטל את כל התוצאות עם דירוג נמוך מ-1.0. |
maxResultCount |
הוצא משימוש: יש להשתמש במקום זאת ב- המספר המקסימלי של תוצאות שניתן להחזיר לכל דף. אם מספר התוצאות הזמינות גדול מ- אם ציינת את |
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של תוצאות שניתן להחזיר לכל דף. אם מספר התוצאות הזמינות גדול מ- אם ציינת את |
pageToken |
זה שינוי אופציונלי. אסימון דף שהתקבל משיחת TextSearch קודמת. ספקו אותו כדי לאחזר את הדף הבא. במהלך העימוד, כל הפרמטרים מלבד |
priceLevels[] |
משמש להגבלת החיפוש למקומות שמסומנים כרמות מחיר מסוימות. המשתמשים יכולים לבחור כל שילוב של רמות מחירים. ברירת המחדל היא בחירה של כל רמות המחירים. |
strictTypeFiltering |
משמש להגדרת סינון סוגים מחמיר עבור includedType. אם היא מוגדרת כ-True, יוחזרו רק תוצאות מאותו סוג. ברירת המחדל היא False. |
locationBias |
האזור לחיפוש. המיקום הזה משמש כהטיה, כלומר יכול להיות שיוחזרו תוצאות לגבי המיקום הנתון. לא ניתן להגדיר יחד עם הגבלת מיקום. |
locationRestriction |
האזור לחיפוש. המיקום הזה משמש כהגבלה, כלומר לא יוחזרו תוצאות מחוץ למיקום הנתון. לא ניתן להגדיר יחד עם Bias. |
evOptions |
זה שינוי אופציונלי. הגדרת האפשרויות של הרכב החשמלי (EV) הניתנות לחיפוש עבור בקשה של חיפוש מקום. |
גוף התשובה
פרוטו של תגובה ל- places.searchText.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "places": [ { object ( |
שדות | |
---|---|
places[] |
רשימה של מקומות שעומדים בקריטריונים לחיפוש טקסט של המשתמש. |
contextualContents[] |
ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. רשימת תכנים הקשריים שבהם כל רשומה משויכת למקום המתאים באותו אינדקס בשדה 'מקומות'. יש עדיפות לתוכן שרלוונטי ל- |
nextPageToken |
אסימון שיכול להישלח בתור |
RankPreference
איך התוצאות יקבלו דירוג בתשובה.
טיפוסים בני מנייה (enums) | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
עבור שאילתה קטגורית כמו "מסעדות בתל אביב", RELEVANCE היא ברירת המחדל. לגבי שאילתות שאינן קטגוריות, כמו "Mountain View, CA", מומלץ לא להגדיר את RankPreference (העדפות). |
DISTANCE |
מדרג את התוצאות לפי מרחק. |
RELEVANCE |
מדרג את התוצאות לפי רלוונטיות. סדר המיון נקבע לפי ערימת דירוג רגילה. |
LocationBias
האזור לחיפוש. המיקום הזה משמש כהטיה, כלומר יכול להיות שיוחזרו תוצאות לגבי המיקום הנתון.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
rectangle |
תיבה מלבנית שהוגדרה לפי פינה צפון-מזרחית ודרום-מערבית. |
circle |
מעגל שמוגדר לפי נקודת מרכז ורדיוס. |
LocationRestriction
האזור לחיפוש. המיקום הזה משמש כהגבלה, כלומר לא יוחזרו תוצאות מחוץ למיקום הנתון.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד
|
|
rectangle |
תיבה מלבנית שהוגדרה לפי פינה צפון-מזרחית ודרום-מערבית. |
EVOptions
אפשרויות חיפוש של רכב חשמלי בבקשה לחיפוש מקום.
ייצוג JSON |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
שדות | |
---|---|
minimumChargingRateKw |
זה שינוי אופציונלי. קצב הטעינה המינימלי הנדרש בקילוואט. מקום שקצב הטעינה שלו נמוך מהתעריף שצוין יסונן. |
connectorTypes[] |
זה שינוי אופציונלי. רשימת הסוגים המועדפים של מחברים של רכב חשמלי. מקום שלא תומך באף אחד מסוגי המחברים שצוינו יסונן. |
ContextualContent
ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.
תוכן שהוא בהקשר לשאילתת המקום.
ייצוג JSON |
---|
{ "reviews": [ { object ( |
שדות | |
---|---|
reviews[] |
רשימת ביקורות על המקום הזה, ממשיכות לשאילתת המקום. |
photos[] |
מידע (כולל התייחסויות) על תמונות של המקום הזה, שמופיעות בהמשך לשאילתת המקום. |
justifications[] |
ניסיוני: פרטים נוספים זמינים בכתובת 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 |
שדות | |
---|---|
שדה איחוד
|
|
reviewJustification |
ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. |
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 |
הביקורת שממנה נוצר הטקסט המודגש. |
HighlightedText
הטקסט שמודגש על ידי ההצדקה. זו רק קבוצת משנה של הבדיקה. המילה המדויקת שיש להדגיש מסומנת על ידי highlightedTextRange. יכולות להיות כמה מילים בטקסט שמודגש.
ייצוג JSON |
---|
{
"text": string,
"highlightedTextRanges": [
{
object ( |
שדות | |
---|---|
text |
|
highlightedTextRanges[] |
רשימת הטווחים של הטקסט המודגש. |
HighlightedTextRange
הטווח של הטקסט המודגש.
ייצוג JSON |
---|
{ "startIndex": integer, "endIndex": integer } |
שדות | |
---|---|
startIndex |
|
endIndex |
|
BusinessAvailabilityAttributesJustification
ניסיוני: פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. הצדקות לגבי BusinessAvailabilityAttributes. כאן מוצגים כמה מאפיינים של עסק שעשויים לעניין את משתמש הקצה.
ייצוג JSON |
---|
{ "takeout": boolean, "delivery": boolean, "dineIn": boolean } |
שדות | |
---|---|
takeout |
אם יש אפשרות לאיסוף עצמי. |
delivery |
אם המקום מציע משלוחים. |
dineIn |
אם אפשר לאכול במקום. |