ממשק 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 או אם משתמשים מחדש בטוקן סשן, הסשן יחויב כאילו לא סופק טוקן סשן (כל בקשה תחויב בנפרד). מומלץ לפעול לפי ההנחיות הבאות:
|
AutocompleteSessionToken class
google.maps.places.AutocompleteSessionToken
class
מייצג אסימון סשן שמשמש למעקב אחרי סשן של השלמה אוטומטית.
אפשר להתקשר אל const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
יצרן | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() פרמטרים: אין
יוצר מופע חדש של AutocompleteSessionToken . |
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. |
מאפיינים | |
---|---|
placePrediction |
סוג:
PlacePrediction optional מכיל את השם של התוצאה שהוחזרה, בפורמט שקריא לבני אדם. בתוצאות של מוסדות, בדרך כלל מדובר בשם העסק ובכתובת שלו. |
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 | |
---|---|
toPlace |
toPlace() פרמטרים: אין
ערך מוחזר:
Place מחזירה ייצוג של Place של PlacePrediction הזה. כדי לקבל את כל פרטי המקום, צריך לבצע שיחה נוספת אל Place.fetchFields . |
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 . |