Places Autocomplete Service

שיעור השלמה בשירות

כיתה google.maps.places.AutocompleteService

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

כדי לקבל גישה, צריך להתקשר ל-const {AutocompleteService} = await google.maps.importLibrary("places"). כדאי לעיין בספריות בממשק ה-API של מפות Google JavaScript.

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

ממשק השלמה אוטומטית

ממשק google.maps.places.AutocompletionRequest

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

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

ממשק השלמה אוטומטית

ממשק google.maps.places.AutocompleteResponse

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

נכסים
predictions	סוג:  Array<AutocompletePrediction> הרשימה של AutocompletePrediction.

ממשק QueryAutocomplete

ממשק google.maps.places.QueryAutocompletionRequest

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

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

שיעור השלמה אוטומטית לסשן משנה

כיתה google.maps.places.AutocompleteSessionToken

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

כדי לקבל גישה, צריך להתקשר ל-const {AutocompleteSessionToken} = await google.maps.importLibrary("places"). כדאי לעיין בספריות בממשק ה-API של מפות Google JavaScript.

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

הממשק של ComponentRestrictions

ממשק google.maps.places.ComponentRestrictions

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

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

הממשק חיזוי השלמה אוטומטית

ממשק google.maps.places.AutocompletePrediction

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

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

הממשק חיזוי השלמה אוטומטית של שאילתות

ממשק google.maps.places.QueryAutocompletePrediction

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

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

ממשק תקופת החיזוי

ממשק google.maps.places.PredictionTerm

מייצג מונח חיזוי.

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

ממשק חיזוי ממשק

ממשק google.maps.places.PredictionSubstring

מחרוזת המשנה שמייצגת את החיזוי.

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

ממשק בפורמט מובנה

ממשק google.maps.places.StructuredFormatting

מכיל מידע מובנה לגבי התיאור של המקום, מחולק לטקסט ראשי ולטקסט משני, כולל מערך של מחרוזות משנה תואמות מקלט ההשלמה האוטומטית, שמזוהה על ידי היסט ואורך, ומודגש בתווי Unicode.

נכסים
main_text	סוג:  string זהו חלק הטקסט העיקרי של התיאור שאינו מעוצב של המקום שהוצע על ידי שירות 'מקומות'. בדרך כלל השם של המקום.
main_text_matched_substrings	סוג:  Array<PredictionSubstring> קבוצה של מחרוזות משנה בטקסט הראשי שמתאימות לאלמנטים בקלט של המשתמש, מתאימות לשימוש לצורך הדגשה של מחרוזות משנה אלה. כל מחרוזת משנה מזוהה באמצעות היסט ואורך שמבוטאים בתווי Unicode.
secondary_text	סוג:  string זהו חלק הטקסט המשני של התיאור הלא מעוצב של המקום שהוצע על ידי שירות 'מקומות'. בדרך כלל המיקום של המקום.