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