Places Autocomplete Service

המחלקה AutocompleteService

google.maps.places.AutocompleteService סיווג

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

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

ממשק AutocompletionRequest

ממשק google.maps.places.AutocompletionRequest

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

תכונות
input	סוג:  string המשתמש הזין מחרוזת קלט.
bounds optional	הוצאה משימוש: bounds הוצא משימוש החל ממאי 2023. במקומו צריך להשתמש ב-AutocompletionRequest.locationBias וב-AutocompletionRequest.locationRestriction. סוג:  LatLngBounds|LatLngBoundsLiteral optional גבולות להטיית חיזוי. התחזיות יתבססו על bounds הנתון, אבל לא רק. המערכת תתעלם גם מ-location וגם מ-radius אם המדיניות bounds מוגדרת.
componentRestrictions optional	סוג:  ComponentRestrictions optional ההגבלות על הרכיבים. הגבלות על רכיבים משמשות להגבלת החיזויים רק לאלו שבתוך רכיב ההורה. למשל, המדינה.
language optional	סוג:  string optional מזהה השפה של השפה שבה יוצגו התוצאות, אם זה אפשרי. יכול להיות שתוצאות בשפה שנבחרה יקבלו דירוג גבוה יותר, אבל ההצעות לא מוגבלות לשפה הזו. כאן אפשר לעיין ברשימת השפות הנתמכות.
location optional	הוצאה משימוש: location הוצא משימוש החל ממאי 2023. במקומו צריך להשתמש ב-AutocompletionRequest.locationBias וב-AutocompletionRequest.locationRestriction. סוג:  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	הוצאה משימוש: radius הוצא משימוש החל ממאי 2023. במקומו צריך להשתמש ב-AutocompletionRequest.locationBias וב-AutocompletionRequest.locationRestriction. סוג:  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	סוג:  Array<AutocompletePrediction> הרשימה של AutocompletePrediction.

ממשק QueryAutocompletionRequest

ממשק google.maps.places.QueryAutocompletionRequest

בקשת השלמה אוטומטית של Query שתישלח אל QueryAutocompleteService.

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

המחלקה AutocompleteSessionToken

google.maps.places.AutocompleteSessionToken סיווג

אסימון סשן משמש למעקב אחר השלמה אוטומטית של סשן, שיכול להיות סדרה של קריאות AutocompleteService.getPlacePredictions ואחריהן קריאה אחת ל-PlacesService.getDetails.

ניתן לגשת באמצעות חיוג אל const {AutocompleteSessionToken} = await google.maps.importLibrary("places"). ראה ספריות ב-Maps JavaScript API.

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

ממשק 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	סוג:  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 optional	סוג:  number optional המרחק במטרים של המקום מתוך AutocompletionRequest.origin.

ממשק QueryAutocompletePrediction

ממשק google.maps.places.QueryAutocompletePrediction

מייצג חיזוי יחיד בהשלמה אוטומטית של שאילתה.

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