Places Autocomplete Service

הכיתה AutocompleteService

google.maps.places.AutocompleteService class

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

אפשר לגשת אליו באמצעות חיוג למספר const {AutocompleteService} = await google.maps.importLibrary("places"). ספריות ב-Maps JavaScript API
AutocompleteService
AutocompleteService()
פרמטרים:  ללא
יצירת מכונה חדשה של AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
פרמטרים: 
  • request:  AutocompletionRequest הבקשה להשלמה אוטומטית.
  • callback:  function(Array<AutocompletePrediction> optional, PlacesServiceStatus): void optional פונקציית קריאה חוזרת (callback) שמקבלת מערך של אובייקטים מסוג AutocompletePrediction וערכו של PlacesServiceStatus כארגומנטים.
ערך המוחזר:  Promise<AutocompleteResponse>
אחזור של חיזויים להשלמה אוטומטית של מקומות על סמך בקשת ההשלמה האוטומטית שסופקה.
getQueryPredictions
getQueryPredictions(request, callback)
פרמטרים: 
  • request:  QueryAutocompletionRequest הבקשה להשלמה אוטומטית של השאילתה.
  • callback:  function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void פונקציית קריאה חוזרת (callback) שמקבלת מערך של אובייקטים מסוג QueryAutocompletePrediction וערכים של PlacesServiceStatus כארגומנטים.
ערך המוחזר:  None
אחזור של חיזויים להשלמה אוטומטית של שאילתות על סמך הבקשה להשלמה האוטומטית של השאילתה שסופקה.

הממשק AutocompletionRequest

ממשק google.maps.places.AutocompletionRequest

בקשה להשלמה אוטומטית שתשלח אל AutocompleteService.getPlacePredictions.
input
סוג:  string
מחרוזת הקלט שהמשתמש הזין.
bounds optional
גבולות להטיה של תחזיות. התחזיות יהיו מוטה לכיוון bounds שצוין, אבל לא מוגבלות אליו. אם bounds מוגדר, המערכת תתעלם גם מ-location וגם מ-radius.
componentRestrictions optional
סוג:  ComponentRestrictions optional
ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת התחזיות רק לאלה שנמצאות ברכיב ההורה. למשל, המדינה.
language optional
סוג:  string optional
מזהה שפה של השפה שבה צריך להציג את התוצאות, אם אפשר. יכול להיות שתוצאות בשפה שנבחרה יקבלו דירוג גבוה יותר, אבל ההצעות לא מוגבלות לשפה הזו. כאן אפשר לעיין ברשימת השפות הנתמכות.
location optional
סוג:  LatLng optional
מיקום להטיה של חיזויים. התחזיות יהיו מוטה לכיוון הערכים של location ו-radius. לחלופין, אפשר להשתמש ב-bounds.
locationBias optional
סוג:  LocationBias optional
גבול או רמז רופפים לשימוש בחיפוש מקומות.
locationRestriction optional
סוג:  LocationRestriction optional
גבולות כדי להגביל את תוצאות החיפוש.
offset optional
סוג:  number optional
מיקום התווים במונח הקלט שבו השירות משתמש בטקסט לצורך חיזויים (המיקום של הסמן בשדה הקלט).
origin optional
סוג:  LatLng|LatLngLiteral optional
המיקום שממנו מחושב הערך של AutocompletePrediction.distance_meters.
radius optional
סוג:  number optional
הרדיוס של האזור שמשמש להטיה של התחזיות. הערך של radius מצוין במטרים, ותמיד צריך לצרף לו את המאפיין location. לחלופין, אפשר להשתמש ב-bounds.
region optional
סוג:  string optional
קוד אזור שמשמש לעיצוב התוצאות ולסינון התוצאות. היא לא מגבילה את ההצעות למדינה הזו. קוד האזור יכול להכיל ערך בן שני תווים של דומיין ברמה עליונה עם קוד מדינה (ccTLD). רוב הקודים של הדומיינים ברמה הלאומית זהים לקודי ISO 3166-1, מלבד כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של בריטניה הוא 'uk' (.co.uk), ואילו הקוד שלה ב-ISO 3166-1 הוא 'gb' (טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד').
sessionToken optional
סוג:  AutocompleteSessionToken optional
הפניה ייחודית שמשמשת לאריזת בקשות בודדות בסשנים.
types optional
סוג:  Array<string> optional
סוגי התחזיות שיוחזרו. ב מדריך למפתחים מפורטת רשימת הסוגים הנתמכים. אם לא מציינים סוגי פריטים, כל הסוגים יוחזרו.

הממשק AutocompleteResponse

ממשק google.maps.places.AutocompleteResponse

תגובה של השלמה אוטומטית שמוחזרת מהקריאה ל-AutocompleteService.getPlacePredictions ומכילה רשימה של AutocompletePrediction.
predictions
רשימת ה-AutocompletePrediction.

הממשק QueryAutocompletionRequest

ממשק google.maps.places.QueryAutocompletionRequest

בקשה של QueryAutocompletion שנשלחת אל QueryAutocompleteService.
input
סוג:  string
מחרוזת הקלט שהמשתמש הזין.
bounds optional
גבולות להטיה של תחזיות. התחזיות יהיו מוטה לכיוון bounds שצוין, אבל לא מוגבלות אליו. אם bounds מוגדר, המערכת תתעלם גם מ-location וגם מ-radius.
location optional
סוג:  LatLng optional
מיקום להטיה של חיזויים. התחזיות יהיו מוטה לכיוון הערכים של location ו-radius. לחלופין, אפשר להשתמש ב-bounds.
offset optional
סוג:  number optional
מיקום התווים במונח הקלט שבו השירות משתמש בטקסט לצורך חיזויים (המיקום של הסמן בשדה הקלט).
radius optional
סוג:  number optional
הרדיוס של האזור שמשמש להטיה של התחזיות. הערך של radius מצוין במטרים, ותמיד צריך לצרף לו את המאפיין location. לחלופין, אפשר להשתמש ב-bounds.

הממשק ComponentRestrictions

ממשק google.maps.places.ComponentRestrictions

הגדרת ההגבלות על הרכיבים שאפשר להשתמש בהם עם שירות ההשלמה האוטומטית.
country optional
סוג:  string|Array<string> optional
הגבלת התחזיות למדינה שצוינה (קוד מדינה לפי תקן ISO 3166-1 Alpha-2, ללא קשר לאותיות רישיות). לדוגמה, 'us', 'br' או 'au'. אפשר לספק קוד אחד או מערך של עד חמש מחרוזות של קודי מדינות.

ממשק AutocompletePrediction

ממשק google.maps.places.AutocompletePrediction

מייצג חיזוי אחד להשלמה אוטומטית.
description
סוג:  string
זוהי הגרסה ללא הפורמט של השאילתה שהוצעה על ידי שירות המקומות.
matched_substrings
קבוצה של מחרוזות משנה בתיאור המקום שתואמות לרכיבים בקלט של המשתמש, מתאימה לשימוש בהדגשת המחרוזות המשנה האלה. כל מחרוזת משנה מזוהה על ידי אופסט (הזחה) ואורך, שמבוטאים בתווים של Unicode.
place_id
סוג:  string
מזהה מקום שאפשר להשתמש בו כדי לאחזר פרטים על המקום הזה באמצעות שירות פרטי המקום (ראו PlacesService.getDetails).
structured_formatting
מידע מובנה על תיאור המקום, שמחולק לטקסט ראשי וטקסט משני, כולל מערך של מחרוזות משנה תואמות מהקלט של ההשלמה האוטומטית, שמזוהות לפי אופסט ואורך, ומבוטאות בתווים של Unicode.
terms
מידע על מונחים ספציפיים בתיאור שלמעלה, מהספציפי ביותר לפחות ספציפי. לדוגמה, 'Taco Bell',‏ 'Willitis' ו-'CA'.
types
סוג:  Array<string>
מערך של סוגים שהחיזוי שייך אליהם, לדוגמה 'establishment' או 'geocode'.
distance_meters optional
סוג:  number optional
המרחק במטרים של המקום מה-AutocompletionRequest.origin.

הממשק QueryAutocompletePrediction

ממשק google.maps.places.QueryAutocompletePrediction

מייצג חיזוי אחד של השלמה אוטומטית של שאילתות.
description
סוג:  string
זוהי הגרסה ללא הפורמט של השאילתה שהוצעה על ידי שירות המקומות.
matched_substrings
קבוצה של מחרוזות משנה בתיאור המקום שתואמות לרכיבים בקלט של המשתמש, מתאימה לשימוש בהדגשת המחרוזות המשנה האלה. כל מחרוזת משנה מזוהה על ידי אופסט (הזחה) ואורך, שמבוטאים בתווים של Unicode.
terms
מידע על מונחים ספציפיים בתיאור שלמעלה. מונחים קטגוריאליים מופיעים קודם (לדוגמה, 'מסעדה'). מונחי הכתובות מופיעים מהספציפיים ביותר ועד הכי פחות ספציפיים. לדוגמה, 'תל אביב' ו-'IL'.
place_id optional
סוג:  string optional
האפשרות הזו זמינה רק אם התחזית היא מקום. מזהה מקום שאפשר להשתמש בו כדי לאחזר פרטים על המקום הזה באמצעות שירות פרטי המקום (ראו PlacesService.getDetails).

ממשק PredictionTerm

ממשק google.maps.places.PredictionTerm

מייצג מונח חיזוי.
offset
סוג:  number
הזזת האופרטור, בתווים של Unicode, מתחילת המונח הזה בתיאור המקום.
value
סוג:  string
הערך של המונח הזה, לדוגמה, 'Taco Bell'.

הממשק PredictionSubstring

ממשק google.maps.places.PredictionSubstring

מייצג מחרוזת משנה של חיזוי.
length
סוג:  number
האורך של מחרוזת המשנה.
offset
סוג:  number
ההיסט לתחילת המחרוזת המשנה במחרוזת התיאור.

הממשק StructuredFormatting

ממשק google.maps.places.StructuredFormatting

מכיל מידע מובנה על תיאור המקום, שמחולק לטקסט ראשי וטקסט משני, כולל מערך של מחרוזות משנה תואמות מהקלט של ההשלמה האוטומטית, שזוהו לפי אופסט ואורך, שמוצגים בתווים של Unicode.
main_text
סוג:  string
זהו החלק העיקרי בטקסט של התיאור ללא עיצוב של המקום שהוצעה על ידי שירות Places. בדרך כלל השם של המקום.
main_text_matched_substrings
קבוצה של מחרוזות משנה בטקסט הראשי שתואמות לרכיבים בהזנת המשתמש, שמתאימה לשימוש בהדגשת מחרוזות המשנה האלה. כל מחרוזת משנה מזוהה על ידי אופסט (הזחה) ואורך, שמבוטאים בתווים של Unicode.
secondary_text
סוג:  string
זהו חלק הטקסט המשני בתיאור הלא מעוצב של המקום שהוצעה על ידי שירות Places. בדרך כלל המיקום של המקום.