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