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 פונקציית קריאה חוזרת שמקבלת מערך של אובייקטים מסוג AutocompletePrediction וערך מסוג PlacesServiceStatus כארגומנט.
ערך מוחזר:  Promise<AutocompleteResponse>
מאחזר חיזויים להשלמה אוטומטית של מקומות על סמך בקשת ההשלמה האוטומטית שסופקה.
getQueryPredictions
getQueryPredictions(request, callback)
פרמטרים: 
ערך מוחזר:  אין
מאחזר חיזויים להשלמה אוטומטית של שאילתות על סמך בקשת ההשלמה האוטומטית של השאילתה שסופקה.

ממשק 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 (דומיין ברמה העליונה) באורך שני תווים. רוב קודי ה-ccTLD זהים לקודי ISO 3166-1, אבל יש כמה יוצאים מן הכלל. לדוגמה, דומיין ccTLD של בריטניה הוא 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 interface

google.maps.places.QueryAutocompletionRequest ממשק

בקשת השלמה אוטומטית של שאילתה שתישלח אל 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 interface

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 interface

google.maps.places.QueryAutocompletePrediction ממשק

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

‫PredictionTerm interface

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
זהו החלק העיקרי בטקסט של תיאור המקום שלא עבר עיצוב, כפי שהוצע על ידי שירות המקומות. בדרך כלל שם המקום.
main_text_matched_substrings
קבוצה של מחרוזות משנה בטקסט הראשי שתואמות לרכיבים בקלט של המשתמש, שמתאימות לשימוש בהדגשת מחרוזות המשנה האלה. כל מחרוזת משנה מזוהה על ידי היסט ואורך, שמוצגים בתווי Unicode.
secondary_text
סוג:  string
זהו חלק הטקסט המשני בתיאור הלא מעוצב של המקום שהוצע על ידי שירות המקומות. בדרך כלל המיקום של המקום.