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