AutocompleteSuggestion class
google.maps.places.AutocompleteSuggestion
class
תוצאה של הצעה להשלמה אוטומטית.
אפשר להתקשר אל const {AutocompleteSuggestion} = await google.maps.importLibrary("places") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Static Methods | |
|---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest)פרמטרים:
ערך מוחזר:
Promise<{suggestions:Array<AutocompleteSuggestion>}>מאחזר רשימה של AutocompleteSuggestions. אם מצוין AutocompleteRequest.sessionToken בבקשה, אז אסימון הסשן הזה ייכלל באופן אוטומטי כשקוראים ל-Place.fetchFields בפעם הראשונה, בכל Place שמוחזר על ידי PlacePrediction.toPlace ב-PlacePredictions שמתקבלים. |
מאפיינים | |
|---|---|
placePrediction |
סוג:
PlacePrediction optionalמכיל את השם של התוצאה שהוחזרה, בפורמט שקריא לבני אדם. בתוצאות של מוסדות, בדרך כלל מדובר בשם העסק ובכתובת שלו. אם סופק AutocompleteRequest.sessionToken ב-AutocompleteRequest ששימש לאחזור ה-AutocompleteSuggestion הזה, אותו טוקן ייכלל באופן אוטומטי כשקוראים ל-Place.fetchFields בפעם הראשונה ב-Place שמוחזר על ידי קריאה ל-PlacePrediction.toPlace. |
ממשק AutocompleteRequest
google.maps.places.AutocompleteRequest
ממשק
ממשק בקשות עבור AutocompleteSuggestion.fetchAutocompleteSuggestions.
מאפיינים | |
|---|---|
input |
סוג:
stringמחרוזת הטקסט שבה יתבצע החיפוש. |
includedPrimaryTypes optional |
סוג:
Array<string> optionalסוג המקום הראשי שכלול (לדוגמה, 'מסעדה' או 'תחנת דלק'). מקום יוחזר רק אם הסוג הראשי שלו כלול ברשימה הזו. אפשר לציין עד 5 ערכים. אם לא מציינים סוגים, כל סוגי המקומות מוחזרים. |
includedRegionCodes optional |
סוג:
Array<string> optionalכולל רק תוצאות באזורים שצוינו, שמוגדרים כעד 15 קודי אזור בני שני תווים של CLDR. קבוצה ריקה לא תגביל את התוצאות. אם גם locationRestriction וגם includedRegionCodes מוגדרים, התוצאות ימוקמו באזור החיתוך. |
inputOffset optional |
סוג:
number optionalהיסט של תו Unicode מבוסס-אפס של input שמציין את מיקום הסמן ב-input. יכול להיות שמיקום הסמן ישפיע על התחזיות שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא האורך של input. |
language optional |
סוג:
string optionalהשפה שבה יוחזרו התוצאות. כברירת מחדל, ייעשה שימוש בהעדפת השפה של הדפדפן. יכול להיות שהתוצאות יהיו בשילוב של שפות אם השפה שבה משתמשים ב- input שונה מ-language, או אם אין תרגום של המקום שמוחזר מהשפה המקומית ל-language. |
locationBias optional |
סוג:
LocationBias optionalהטיית התוצאות למיקום שצוין. צריך להגדיר רק אחד מהמאפיינים locationBias או locationRestriction. אם אף אחת מההגדרות לא מוגדרת, התוצאות יהיו מוטות לפי כתובת ה-IP, כלומר כתובת ה-IP תמופה למיקום לא מדויק ותשמש כאות הטיה. |
locationRestriction optional |
סוג:
LocationRestriction optionalהגבלת התוצאות למיקום ספציפי. צריך להגדיר רק אחד מהמאפיינים locationBias או locationRestriction. אם אף אחת מההגדרות לא מוגדרת, התוצאות יהיו מוטות לפי כתובת ה-IP, כלומר כתובת ה-IP תמופה למיקום לא מדויק ותשמש כאות הטיה. |
origin optional |
סוג:
LatLng|LatLngLiteral optionalנקודת המוצא שממנה יחושב המרחק הגיאודזי ליעד (הערך שמוחזר הוא PlacePrediction.distanceMeters). אם הערך הזה לא מצוין, המרחק הגיאודזי לא יוחזר. |
region optional |
סוג:
string optionalקוד האזור, שמוגדר כקוד אזור בן שני תווים במאגר CLDR. ההגדרה הזו משפיעה על הפורמט של הכתובות, על דירוג התוצאות ועל התוצאות שמוחזרות. ההגדרה הזו לא מגבילה את התוצאות לאזור שצוין. |
sessionToken optional |
סוג:
AutocompleteSessionToken optionalטוקן שמזהה סשן של השלמה אוטומטית למטרות חיוב. יוצרים טוקן חדש של סשן באמצעות AutocompleteSessionToken. הסשן מתחיל כשהמשתמש מתחיל להקליד שאילתה, ומסתיים כשהוא בוחר מקום ומתקשר אליו Place.fetchFields. כל סשן יכול לכלול כמה שאילתות, ואחריהן קריאה אחת ל-fetchFields. האישורים שמשמשים לכל בקשה בסשן חייבים להיות שייכים לאותו פרויקט במסוף Google Cloud. אחרי שהסשן מסתיים, האסימון כבר לא תקף. האפליקציה צריכה ליצור אסימון חדש לכל סשן. אם לא מציינים את הפרמטר sessionToken או אם משתמשים מחדש בטוקן סשן, הסשן יחויב כאילו לא סופק טוקן סשן (כל בקשה תחויב בנפרד). כשמספקים אסימון סשן בבקשה אל AutocompleteSuggestion.fetchAutocompleteSuggestions, אותו אסימון ייכלל אוטומטית בקריאה הראשונה אל fetchFields ב-Place שמוחזר על ידי קריאה אל PlacePrediction.toPlace באחד מ-AutocompleteSuggestions שמתקבלים. מומלץ לפעול לפי ההנחיות הבאות:
|
AutocompleteSessionToken class
google.maps.places.AutocompleteSessionToken
class
מייצג אסימון סשן שמשמש למעקב אחרי סשן של השלמה אוטומטית.
אפשר להתקשר אל const {AutocompleteSessionToken} = await google.maps.importLibrary("places") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
יצרן | |
|---|---|
AutocompleteSessionToken |
AutocompleteSessionToken()פרמטרים: אין
יוצר מופע חדש של AutocompleteSessionToken. |
PlacePrediction class
google.maps.places.PlacePrediction
class
תוצאות חיזוי להשלמה אוטומטית של מקום.
אפשר להתקשר אל const {PlacePrediction} = await google.maps.importLibrary("places") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
מאפיינים | |
|---|---|
distanceMeters |
סוג:
number optionalאורך הקו הגיאודזי במטרים מ- origin אם מצוין origin. |
mainText |
סוג:
FormattableText optionalמייצג את שם המקום. |
placeId |
סוג:
stringהמזהה הייחודי של המקום המוצע. אפשר להשתמש במזהה הזה בממשקי API אחרים שמקבלים מזהי מקומות. |
secondaryText |
סוג:
FormattableText optionalמייצג מאפיינים נוספים שמסייעים להבחין בין מקומות (כמו עיר או אזור) כדי לזהות את המקום בצורה מדויקת יותר. |
text |
סוג:
FormattableTextמכיל את השם של התוצאה שהוחזרה, בפורמט שקריא לבני אדם. בתוצאות של מוסדות, בדרך כלל מדובר בשם העסק ובכתובת שלו. text מומלץ למפתחים שרוצים להציג רכיב אחד של ממשק משתמש. מפתחים שרוצים להציג שני רכיבים נפרדים בממשק המשתמש, אבל קשורים זה לזה, יכולים להשתמש במקום זאת ב-PlacePrediction.mainText וב-PlacePrediction.secondaryText. |
types |
סוג:
Array<string>רשימה של סוגים שרלוונטיים למקום הזה מתוך טבלה א' או טבלה ב' בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. |
Methods | |
|---|---|
|
fetchAddressValidation(request)פרמטרים:
ערך מוחזר:
Promise<AddressValidation>שולחת בקשה לאימות כתובת שמשויכת לסשן ההשלמה האוטומטית הזה (מאכלסת את הבקשה באופן פנימי באסימון של סשן ההשלמה האוטומטית). לא נכלל באופן אוטומטי מידע על מקום מה-PlacePrediction – זוהי שיטה נוחה שעוזרת בניהול סשן של השלמה אוטומטית. |
toPlace |
toPlace()פרמטרים: אין
ערך מוחזר:
Placeמחזירה ייצוג Place של PlacePrediction. כדי לקבל את כל פרטי המקום, צריך לבצע שיחה נוספת אל Place.fetchFields. אם סופק AutocompleteRequest.sessionToken ב-AutocompleteRequest ששימש לאחזור PlacePrediction הזה, אותו טוקן ייכלל באופן אוטומטי כשקוראים ל-fetchFields. לחלופין, כשמשתמשים ב- PlaceAutocompleteElement, השיחה הראשונה אל Place.fetchFields ב-Place שמוחזר על ידי PlacePrediction.toPlace תכלול באופן אוטומטי את אסימון הסשן. |
StringRange class
google.maps.places.StringRange
class
מזהה מחרוזת משנה בטקסט נתון.
אפשר להתקשר אל const {StringRange} = await google.maps.importLibrary("places") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
מאפיינים | |
|---|---|
endOffset |
סוג:
numberההיסט של תו ה-Unicode האחרון במחרוזת המשנה (לא כולל), שמתחיל מאפס. |
startOffset |
סוג:
numberההיסט מבוסס-אפס של תו ה-Unicode הראשון במחרוזת המשנה (כולל). |
המחלקות FormattableText
google.maps.places.FormattableText
class
טקסט שמייצג חיזוי של מקום. אפשר להשתמש בטקסט כמו שהוא או לעצב אותו.
אפשר להתקשר אל const {FormattableText} = await google.maps.importLibrary("places") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
מאפיינים | |
|---|---|
matches |
סוג:
Array<StringRange>רשימה של טווחי מחרוזות שמזהים את המקום שבו בקשת הקלט תאמה ב- FormattableText.text. אפשר להשתמש בטווחים כדי לעצב חלקים ספציפיים של text. יכול להיות שמחרוזות המשנה לא יהיו זהות ל-AutocompleteRequest.input אם ההתאמה נקבעה לפי קריטריונים אחרים מלבד התאמה של מחרוזות (לדוגמה, תיקוני איות או תעתיקים). הערכים האלה הם היסטים של תווי Unicode של FormattableText.text. הטווחים מובטחים להיות מסודרים בסדר עולה של ערכי ההיסט. |
text |
סוג:
stringטקסט שאפשר להשתמש בו כמו שהוא או לעצב אותו באמצעות FormattableText.matches. |