Geocoder

הכיתה Geocoder

google.maps.Geocoder class

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

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

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

Methods
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) שרוצים לחפש. הכלי להמרת כתובות לקואורדינטות מבצע המרת קואורדינטות לכתובות (reverse geocoding). מידע נוסף זמין במאמר גיאוקוד הפוכה. צריך לספק רק אחד מבין address,‏ location ו-placeId.
placeId optional	סוג:  string optional מזהה המקום שמשויך למיקום. המזהה הייחודי של מקום במסד הנתונים של 'מקומות Google' ובמפות Google. מידע נוסף על מזהי מקומות זמין במדריך למפתחים של Places API. הכלי להמרת כתובות לקואורדינטות מבצע המרת קואורדינטות לכתובות (reverse geocoding). מידע נוסף זמין במאמר גיאוקוד הפוך. צריך לספק רק אחד מבין address,‏ location ו-placeId.
region optional	סוג:  string optional קוד המדינה שמשמש להטיה של החיפוש, שצוין בתג משנה של אזור Unicode (לא מספרי) בן שני תווים או במזהה CLDR. זה שינוי אופציונלי. כאן אפשר למצוא את רשימת האזורים הנתמכים בפלטפורמה של מפות 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	קובץ ה-cookie GeocoderRequest היה לא חוקי.
OK	התשובה מכילה GeocoderResponse תקין.
OVER_QUERY_LIMIT	דף האינטרנט חרג ממגבלת הבקשות בפרק זמן קצר מדי.
REQUEST_DENIED	אין לדף האינטרנט הרשאה להשתמש במקודד הגיאוגרפיה.
UNKNOWN_ERROR	לא ניתן היה לעבד בקשה להמרת כתובת לקואורדינטות (geocoding) בגלל שגיאה בשרת. יכול להיות שהבקשה תצליח אם תנסה שוב.
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 ה-Plus Code שמשויך למיקום.

הממשק GeocoderResult

ממשק google.maps.GeocoderResult

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

מאפיינים
address_components	סוג:  Array<GeocoderAddressComponent> מערך של GeocoderAddressComponent
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 ה-Plus Code שמשויך למיקום.
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> מערך של מחרוזות שמציין את הסוג של רכיב הכתובת הזה. כאן אפשר למצוא רשימה של סוגי MIME חוקיים.

הממשק 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	התוצאה שמוחזרת משקפת כתובת גיאוגרפית מדויקת.

ממשק Landmark

ממשק 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 מרחק הנסיעה לאורך רשת הכבישים בין מיקום היעד לנקודת הציון. השדה הזה יכול להיות ריק אם ציון הדרך לא מחובר לחלק מרשת הכבישים שאליו היעד הקרוב ביותר, או אם מיקום היעד לא נחשב בפועל לרשת הכבישים.

ממשק Area

ממשק google.maps.Area

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

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

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

קבועים של אחסון

google.maps.Containment קבועים

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

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

אפשר לגשת אליו באמצעות חיוג למספר 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	לאתר המפורסם יש גיאומטריה מרחבית והיעד נמצא בתוך גבולותיו.