Geocoder

מחלקה של Geocoder

google.maps.Geocoder סיווג

שירות להמרה בין כתובת לבין LatLng.

ניתן לגשת באמצעות חיוג אל const {Geocoder} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

יצרן
Geocoder	Geocoder() פרמטרים: ללא יצירת מופע חדש של Geocoder ששולח בקשות לקידוד גיאוגרפי לשרתים של Google.

שיטות
geocode	geocode(request[, callback]) פרמטרים:  request:  GeocoderRequest callback:  function(Array<GeocoderResult> optional, GeocoderStatus): void optional הערך המוחזר:  Promise<GeocoderResponse> לבצע קידוד גיאוגרפי של בקשה.

ממשק GeocoderRequest

ממשק google.maps.GeocoderRequest

המפרט של בקשת קידוד גיאוגרפי תישלח אל Geocoder.

תכונות
address optional	סוג:  string optional הכתובת לקואורדינטות. יש לספק אחד, ורק אחד, מתוך address, location ו-placeId.
bounds optional	סוג:  LatLngBounds|LatLngBoundsLiteral optional LatLngBounds שבהם יש לחפש. זה שינוי אופציונלי.
componentRestrictions optional	סוג:  GeocoderComponentRestrictions optional המערכת משתמשת ברכיבים כדי להגביל את התוצאות לאזור מסוים. מסנן מורכב מאחד או יותר מהרכיבים הבאים: route, locality, administrativeArea, postalCode, country. רק התוצאות שתואמות לכל המסננים יוחזרו. ערכי מסננים תומכים באותן שיטות לתיקון איות ולהתאמה חלקית כמו בקשות אחרות של קידוד גיאוגרפי. זה שינוי אופציונלי.
extraComputations optional	הערה: התכונה הזו זמינה רק בערוץ v=beta. סוג:  Array<ExtraGeocodeComputation> optional רשימה של חישובים נוספים שבהם ניתן להשתמש כדי להשלים את הבקשה. הערה: החישובים הנוספים האלה עלולים להחזיר שדות נוספים בתשובה.
fulfillOnZeroResults optional	סוג:  boolean optional יש למלא את ההבטחה בסטטוס ZERO_RESULT בתשובה. מצב כזה יכול להיות רצוי כי גם אם אין תוצאות של קידוד גיאוגרפי, עדיין ייתכן שיוחזרו שדות נוספים של רמות תגובה.
language optional	סוג:  string optional מזהה השפה של השפה שבה התוצאות יוחזרו, כשהדבר אפשרי. כאן אפשר לעיין ברשימת השפות הנתמכות.
location optional	סוג:  LatLng|LatLngLiteral optional LatLng (או LatLngLiteral) לחיפוש. הממיר הגיאוגרפי מבצע קידוד גיאוגרפי הפוך. למידע נוסף, ראו הפוך קידוד גיאוגרפי. יש לספק אחד, ורק אחד, מתוך address, location ו-placeId.
placeId optional	סוג:  string optional מזהה המקום שמשויך למיקום. מזהי המקומות מזהים מקום באופן ייחודי במסד הנתונים של 'מקומות Google' ובמפות Google. למידע נוסף על מזהי מקומות במדריך למפתחים של Places API. הממיר הגיאוגרפי מבצע קידוד גיאוגרפי הפוך. למידע נוסף, ראו המרת קידוד גיאוגרפי הפוך. יש לספק אחד, ורק אחד, מתוך address, location ו-placeId.
region optional	סוג:  string optional קוד המדינה המשמש להטיית החיפוש, שמצוין כתג משנה אזורי / CLDR בן שני תווים (לא מספרי) לפי אזור Unicode. זה שינוי אופציונלי. מידע על האזורים הנתמכים זמין בפרטי הכיסוי של הפלטפורמה של מפות Google.

הממשק של GeocoderComponentRestrictions

ממשק google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions מייצג קבוצה של מסננים שמפנים לאזור ספציפי. הסבר איך זה עובד זמין במאמר סינון רכיבי קידוד גיאוגרפי.

תכונות
administrativeArea optional	סוג:  string optional התאמה לכל administrative_area levels. זה שינוי אופציונלי.
country optional	סוג:  string optional תואם לשם מדינה או לקוד מדינה בן שתי אותיות לפי תקן ISO 3166-1. זה שינוי אופציונלי.
locality optional	סוג:  string optional תואם לסוגים locality ו-sublocality. זה שינוי אופציונלי.
postalCode optional	סוג:  string optional תואם ל-postal_code ול-postal_code_prefix. זה שינוי אופציונלי.
route optional	סוג:  string optional תואם לשם הארוך או הקצר של route. זה שינוי אופציונלי.

קבועים של ExtraGeocodeComputation

google.maps.ExtraGeocodeComputation קבועים

הערה: התכונה הזו זמינה רק בערוץ v=beta.

חישובים נוספים שצריך לבצע בזמן מילוי בקשה לקידוד גיאוגרפי.

ניתן לגשת באמצעות חיוג אל const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

קבועים
ADDRESS_DESCRIPTORS	יוצרים תיאור כתובת.

קבועים של GeocoderStatus

google.maps.GeocoderStatus קבועים

הסטטוס שהוחזר על ידי Geocoder במהלך שיחה אל geocode(). צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'OK' או google.maps.GeocoderStatus.OK.

ניתן לגשת באמצעות חיוג אל const {GeocoderStatus} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

קבועים
ERROR	הייתה בעיה ביצירת קשר עם שרתי Google.
INVALID_REQUEST	הערך של GeocoderRequest לא חוקי.
OK	התשובה מכילה GeocoderResponse חוקי.
OVER_QUERY_LIMIT	דף האינטרנט חרג ממגבלת הבקשות בפרק זמן קצר מדי.
REQUEST_DENIED	דף האינטרנט אינו מורשה להשתמש בממיר הגיאוגרפי.
UNKNOWN_ERROR	לא ניתן היה לעבד בקשה לקידוד גיאוגרפי עקב שגיאה בחיבור לשרת. ניסיון חוזר של הבקשה עשוי להתבצע בהצלחה.
ZERO_RESULTS	לא נמצאה תוצאה עבור GeocoderRequest.

ממשק GeocoderResponse

ממשק google.maps.GeocoderResponse

תגובת מקודד גיאוגרפי שמוחזרת על ידי Geocoder שמכילה את הרשימה של GeocoderResult.

תכונות
results	סוג:  Array<GeocoderResult> הרשימה של GeocoderResult.
address_descriptor optional	הערה: התכונה הזו זמינה רק בערוץ v=beta. סוג:  AddressDescriptor optional תיאור יחסי של מיקום. כולל קבוצה מדורגת של ציוני דרך בקרבת מקום והאזורים שכוללים את מיקום היעד. השדה הזה מאוכלס רק לבקשות לקבלת קידוד גיאוגרפי הפוך ורק כאשר האפשרות ExtraGeocodeComputation.ADDRESS_DESCRIPTORS מופעלת.
plus_code optional	סוג:  PlacePlusCode optional ה-OLC המשויך למיקום.

ממשק GeocoderResult

ממשק google.maps.GeocoderResult

תוצאת קואורדינטות אחת אוחזרה משרת הקואורדינטות. בקשה לקידוד גיאוגרפי עשויה להחזיר מספר אובייקטי תוצאה. חשוב לשים לב שהתוצאה הזו היא "כמו JSON", אבל זה לא קובץ JSON בלבד כי הוא כולל באופן עקיף אובייקט LatLng.

תכונות
address_components	סוג:  Array<GeocoderAddressComponent> מערך של GeocoderAddressComponents
formatted_address	סוג:  string מחרוזת שמכילה את הכתובת של המיקום הזה, שאנשים יכולים לקרוא.
geometry	סוג:  GeocoderGeometry אובייקט GeocoderGeometry
place_id	סוג:  string מזהה המקום שמשויך למיקום. מזהי המקומות מזהים מקום באופן ייחודי במסד הנתונים של 'מקומות Google' ובמפות Google. למידע נוסף על מזהי מקומות במדריך למפתחים של Places API.
types	סוג:  Array<string> מערך של מחרוזות שמציינות את סוג הרכיב המוחזר בקידוד גיאוגרפי. לרשימה של מחרוזות אפשריות, יש לעיין בקטע סוגי רכיבי הכתובת במדריך למפתחים.
address_descriptor optional	הערה: התכונה הזו זמינה רק בערוץ v=beta. סוג:  AddressDescriptor optional תיאור יחסי של המיקום שמשויך לקואורדינטות האלה. כולל קבוצה מדורגת של ציוני דרך בקרבת מקום והאזורים שכוללים את מיקום היעד. השדה הזה יאוכלס רק עבור בקשות לחיפוש קידוד גיאוגרפי להעברה ומזהה מקום, ורק כאשר ExtraGeocodeComputation.ADDRESS_DESCRIPTORS מופעל, ורק למקומות מסוימים שהותאמו לשוק המקומי.
partial_match optional	סוג:  boolean optional האם המקודד הגיאוגרפי לא החזיר התאמה מדויקת עבור הבקשה המקורית, על אף שהוא הצליח להתאים לחלק מהכתובת המבוקשת. אם ההתאמה המדויקת תהיה התאמה, הערך יהיה undefined.
plus_code optional	סוג:  PlacePlusCode optional ה-OLC המשויך למיקום.
postcode_localities optional	סוג:  Array<string> optional מערך של מחרוזות שמציינות את כל המיקומים שנכללים במיקוד. השדה הזה מוצג רק כשהתוצאה היא מיקוד שמכיל מספר רשויות מקומיות.

ממשק AddressDescriptor

ממשק google.maps.AddressDescriptor

הערה: התכונה הזו זמינה רק בערוץ v=beta.

תיאור יחסי של מיקום. כולל קבוצה מדורגת של ציוני דרך בקרבת מקום והאזורים שכוללים את מיקום היעד.

תכונות
areas	סוג:  Array<Area> רשימה מדורגת של אזורים מכילים או אזורים סמוכים. האזורים השימושיים (הזיהוי והמדויקים ביותר) מדורגים ראשונים.
landmarks	סוג:  Array<Landmark> רשימה מדורגת של ציוני דרך בקרבת מקום. ציוני הדרך השימושיים ביותר (הזוהו ובקרבת מקום) מדורגים ראשונים.

ממשק GeocoderAddressComponent

ממשק google.maps.GeocoderAddressComponent

רכיב כתובת יחיד בתוך GeocoderResult. כתובת מלאה יכולה לכלול כמה רכיבי כתובת.

תכונות
long_name	סוג:  string הטקסט המלא של רכיב הכתובת
short_name	סוג:  string הטקסט המקוצר והקצר של רכיב הכתובת הנתון
types	סוג:  Array<string> מערך של מחרוזות שמציינות את הסוג של רכיב הכתובת הזה. כאן מופיעה רשימה של סוגים חוקיים

ממשק GeocoderGeometry

ממשק google.maps.GeocoderGeometry

מידע גיאומטרי על GeocoderResult הזה

תכונות
location	סוג:  LatLng קווי האורך והרוחב של התוצאה הזו
location_type	סוג:  GeocoderLocationType סוג המיקום שהוחזר בlocation
viewport	סוג:  LatLngBounds הגבולות של אזור התצוגה המומלץ להצגת GeocoderResult זה
bounds optional	סוג:  LatLngBounds optional הגבולות המדויקים של GeocoderResult זה, אם רלוונטי

קבועים של GeocoderLocationType

google.maps.GeocoderLocationType קבועים

מתאר את סוג המיקום שהוחזר מקואורדינטות. צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'ROOFTOP' או google.maps.GeocoderLocationType.ROOFTOP.

ניתן לגשת באמצעות חיוג אל const {GeocoderLocationType} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

קבועים
APPROXIMATE	התוצאה שהוחזרה היא אומדן.
GEOMETRIC_CENTER	התוצאה שמוחזרת היא המרכז הגאומטרי של תוצאה כמו קו (למשל רחוב) או פוליגון (אזור).
RANGE_INTERPOLATED	התוצאה שמוחזרת משקפת אומדן (בדרך כלל על כביש) שעבר אינטרפולציה בין שתי נקודות מדויקות (כגון צמתים). בדרך כלל, תוצאות אינטרפולציה מוחזרות כאשר אין קודים גיאוגרפיים על הגגות עבור כתובת רחוב.
ROOFTOP	התוצאה שמוחזרת משקפת קואורדינטות מדויקות.

ממשק הציון

ממשק google.maps.Landmark

הערה: התכונה הזו זמינה רק בערוץ v=beta.

מקום שמייצג נקודת התייחסות לכתובת.

תכונות
display_name	סוג:  string השם של ציון הדרך.
display_name_language_code	סוג:  string השפה שבה כתוב השם של ציון הדרך.
place_id	סוג:  string מזהה המקום של המוסד הבסיסי שמשמש כציון הדרך. אפשר להשתמש בו כדי לזהות מידע נוסף על ציון הדרך באמצעות 'פרטי מקום' או 'חיפוש מזהה מקום'.
spatial_relationship	סוג:  SpatialRelationship מגדיר את הקשר המרחבי בין מיקום היעד לציון הדרך.
straight_line_distance_meters	סוג:  number מרחק הקו הישר בין מיקום היעד לציון הדרך.
types	סוג:  Array<string> ערך אחד או יותר מציינים את סוג התוצאה שהוחזרה. פרטים נוספים זמינים במאמר סוגים .
travel_distance_meters optional	סוג:  number optional מרחק הנסיעה לאורך רשת הכבישים בין מיקום היעד לציון הדרך. ניתן לבטל את הערך הזה אם ציון הדרך מנותק מהחלק של רשת הכבישים שאליו היעד קרוב ביותר או אם מיקום היעד לא נחשב בפועל ברשת הכבישים.

ממשק zone

ממשק google.maps.Area

הערה: התכונה הזו זמינה רק בערוץ v=beta.

מקום שהוא אזור קטן, כמו שכונה, אזור משנה או מתחם גדול שמכיל את המיקום הגיאוגרפי לטירגוט.

תכונות
containment	סוג:  Containment מגדיר את הקשר המרחבי בין מיקום היעד והאזור.
display_name	סוג:  string שם האזור.
display_name_language_code	סוג:  string השפה שבה כתוב שם האזור.
place_id	סוג:  string מזהה המקום של האזור הבסיסי. אפשר להשתמש במידע הזה כדי לפתור מידע נוסף על האזור באמצעות 'פרטי מקום' או 'חיפוש מזהה מקום'.

קבועים של מאגר

google.maps.Containment קבועים

הערה: התכונה הזו זמינה רק בערוץ v=beta.

טיפוסים בני מנייה (enum) שמייצג את הקשר המרחבי בין האזור לבין מיקום היעד.

ניתן לגשת באמצעות חיוג אל const {Containment} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

קבועים
NEAR	המיקום הגיאוגרפי לטירגוט נמצא מחוץ לאזור האזור, אבל בקרבת מקום.
OUTSKIRTS	מיקום היעד נמצא בתוך אזור האזור, סמוך לקצה.
WITHIN	מיקום היעד נמצא בתוך האזור, קרוב למרכז.

קבועים של SpatialRelationship

google.maps.SpatialRelationship קבועים

הערה: התכונה הזו זמינה רק בערוץ v=beta.

'טיפוסים בני מנייה (enum)' שמייצג את הקשר במרחב בין ציון הדרך ליעד.

ניתן לגשת באמצעות חיוג אל const {SpatialRelationship} = await google.maps.importLibrary("geocoding"). ראה ספריות ב-Maps JavaScript API.

קבועים
ACROSS_THE_ROAD	היעד נמצא מול ציון הדרך בצד השני של הכביש.
AROUND_THE_CORNER	לא באותו מסלול כמו ציון הדרך, אלא במרחק פנייה אחת.
BEHIND	קרוב למבנה של ציון הדרך, אבל רחוק מנקודת הגישה.
BESIDE	היעד נמצא ממש בסמוך לציון הדרך.
DOWN_THE_ROAD	באותו מסלול כמו ציון הדרך, אבל לא לצידו או לצידו.
NEAR	זהו קשר ברירת המחדל במקרים שבהם לא חל מידע ספציפי יותר בהמשך.
WITHIN	לציון הדרך יש גיאומטריה מרחבית והיעד נמצא בגבולותיו.