Places Autocomplete Service (deprecated)

הכיתה AutocompleteService

class google.maps.places.AutocompleteService
library "places"

הוצאה משימוש: החל מ-1 במרץ 2025, השירות google.maps.places.AutocompleteService לא זמין ללקוחות חדשים. יש להשתמש בעמודות AutocompleteSuggestion במקומן. בשלב הזה, לא מתוכנן להפסיק את השירות google.maps.places.AutocompleteService, אבל מומלץ להשתמש ב-AutocompleteSuggestion במקום ב-google.maps.places.AutocompleteService. אנחנו נמשיך לתקן באגים ב-google.maps.places.AutocompleteService במקרה של רגרסיות משמעותיות, אבל לא נטפל בבאגים קיימים ב-google.maps.places.AutocompleteService. נודיע לכם לפחות 12 חודשים לפני שנפסיק את התמיכה. פרטים נוספים זמינים בכתובת https://developers.google.com/maps/legacy, והמדריך להעברת נתונים זמין בכתובת https://developers.google.com/maps/documentation/javascript/places-migration-overview.

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

const {AutocompleteService} = await google.maps.importLibrary("places");

יצרן
AutocompleteService	AutocompleteService() פרמטרים: אין יוצרת מופע חדש של AutocompleteService.

Methods
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 כארגומנט. הערך המוחזר: אין אחזור של הצעות להשלמת החיפוש על סמך בקשה להשלמה אוטומטית של שאילתות.

הממשק AutocompletionRequest

ממשק google.maps.places.AutocompletionRequest

בקשת השלמה אוטומטית שתישלח אל AutocompleteService.getPlacePredictions.

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

הממשק AutocompleteResponse

ממשק google.maps.places.AutocompleteResponse

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

מאפיינים
predictions	סוג: Array<AutocompletePrediction> רשימת AutocompletePrediction.

ממשק QueryAutocompletionRequest

ממשק google.maps.places.QueryAutocompletionRequest

בקשת QueryAutocompletion שתישלח אל QueryAutocompleteService.

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

ממשק ComponentRestrictions

ממשק google.maps.places.ComponentRestrictions

מגדירה את ההגבלות על הרכיבים שאפשר להשתמש בהם עם שירות ההשלמה האוטומטית.

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

ממשק AutocompletePrediction

ממשק google.maps.places.AutocompletePrediction

מייצג הצעה אחת להשלמת החיפוש.

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

ממשק QueryAutocompletePrediction

ממשק google.maps.places.QueryAutocompletePrediction

מייצג הצעות להשלמת החיפוש של שאילתה יחידה.

מאפיינים
description	סוג: string זו הגרסה הלא מעוצבת של השאילתה שהוצעה על ידי שירות Places.
matched_substrings	סוג: Array<PredictionSubstring> קבוצה של מחרוזות משנה בתיאור המקום שתואמות לרכיבים בקלט של המשתמש, ומתאימות לשימוש בהדגשה של מחרוזות המשנה האלה. כל מחרוזת משנה מזוהה באמצעות היסט ואורך, שמבוטאים בתווי Unicode.
terms	סוג: Array<PredictionTerm> מידע על מונחים ספציפיים בתיאור שלמעלה. מונחים קטגוריים מופיעים קודם (לדוגמה, "מסעדה"). המונחים של הכתובת מופיעים מהספציפי ביותר לפחות ספציפי. לדוגמה, "תל אביב" ו "מרכז".
place_id אופציונלי	סוג: 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	סוג: Array<PredictionSubstring> קבוצה של מחרוזות משנה בטקסט הראשי שתואמות לרכיבים בקלט של המשתמש, ומתאימות לשימוש בהדגשה של מחרוזות המשנה האלה. כל מחרוזת משנה מזוהה באמצעות היסט ואורך, שמבוטאים בתווי Unicode.
secondary_text	סוג: string זהו החלק המשני של הטקסט בתיאור הלא מעוצב של המקום שהוצע על ידי שירות Places. בדרך כלל המיקום של המקום.