Method: searchText

חיפוש מקומות באמצעות שאילתת טקסט.

בקשת HTTP

POST https://mapstools.googleapis.com/v1alpha:searchText

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
שדות
textQuery

string

חובה. שאילתת הטקסט.
languageCode

string

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

לדוגמה, "en" לאנגלית.

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

string

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

לדוגמה, "US" לארצות הברית.

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

שימו לב שכרגע אין תמיכה בקודי אזור בני 3 ספרות.
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של מקומות שיוחזרו, עד 10. יכול להיות שהשירות יחזיר פחות מהערך הזה. ערך ברירת המחדל הוא 5.

בקשה של יותר מ-5 מקומות תפעיל את רמת Pro ותגרום לעלות חיוב גבוהה יותר ולזמן אחזור ארוך יותר.
includeExtendedDetails

boolean

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

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

משאירים את הערך false (ברירת המחדל) לחיפושים רגילים (למשל, סוגי מטבחים, סוגי חנויות), חיפושי מיקום/כתובת, פרטים ליצירת קשר, שעות פעילות ומטא-נתונים/שירותים רגילים.

הפעלת השדה הזה תפעיל את רמת Pro ותגרום לעלות חיוב גבוהה יותר ולזמן אחזור ארוך יותר.
locationBias

object (LocationBias)

אזור אופציונלי להטיית תוצאות החיפוש. אם מיקום מפורש נמצא ב-textQuery, הוא ישמש להטיית תוצאות החיפוש במקום השדה הזה.

גוף התשובה

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/maps-platform.mapstools