Geocoder

המחלקה Geocoder

class google.maps.Geocoder
library "geocoding"

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

const {Geocoder} = await google.maps.importLibrary("geocoding");

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

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

ממשק GeocoderRequest

ממשק google.maps.GeocoderRequest

המפרט של בקשת המרת כתובות לקואורדינטות (geocoding) שתישלח אל Geocoder.

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

הממשק GeocoderComponentRestrictions

ממשק google.maps.GeocoderComponentRestrictions

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

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

קבועים של ExtraGeocodeComputation

constants google.maps.ExtraGeocodeComputation
ספרייה "geocoding"

הערה: זמין רק ב-ערוץ בטא.

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג ExtraGeocodeComputationString.

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");

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

ערכי GeocoderStatus קבועים

constants google.maps.GeocoderStatus
ספרייה "geocoding"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג GeocoderStatusString.

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");

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

ממשק GeocoderResponse

ממשק google.maps.GeocoderResponse

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

מאפיינים
results	סוג: Array<GeocoderResult> רשימת GeocoderResult.
address_descriptor אופציונלי	הערה: זמין רק ב-ערוץ בטא. סוג: AddressDescriptor optional תיאור יחסי של מיקום. כולל קבוצה מדורגת של ציוני דרך בקרבת מקום והאזורים שבהם נמצא מיקום היעד הגיאוגרפי. השדה הזה מאוכלס רק בבקשות להמרת קואורדינטות לכתובות (reverse geocoding) ורק כש-ExtraGeocodeComputation.ADDRESS_DESCRIPTORS מופעל.
plus_code אופציונלי	סוג: PlacePlusCode optional ה-Plus Code שמשויך למיקום.

ממשק GeocoderResult

ממשק google.maps.GeocoderResult

תוצאה אחת של המרת כתובות לקואורדינטות (geocoding) שאוחזרה משרת המרת הכתובות לקואורדינטות. בקשה להמרת כתובת לקואורדינטות עשויה להחזיר כמה אובייקטים של תוצאות. שימו לב שלמרות שהתוצאה הזו היא "דמוית 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 אופציונלי	הערה: זמין רק ב-ערוץ בטא. סוג: AddressDescriptor optional תיאור יחסי של המיקום שמשויך לקואורדינטות האלה. כולל קבוצה מדורגת של ציוני דרך בקרבת מקום והאזורים שבהם נמצא מיקום היעד הגיאוגרפי. השדה הזה יאוכלס רק בבקשות להמרת כתובות לקואורדינטות (geocoding) ובבקשות לחיפוש מזהה מקום, רק כש-ExtraGeocodeComputation.ADDRESS_DESCRIPTORS מופעל ורק במקומות מסוימים שמותאמים לשוק המקומי.
partial_match אופציונלי	סוג: boolean optional אם הכלי להמרת כתובות לקואורדינטות לא החזיר התאמה מדויקת לבקשה המקורית, אבל הצליח להתאים חלק מהכתובת המבוקשת. אם יש התאמה מדויקת, הערך יהיה undefined.
plus_code אופציונלי	סוג: PlacePlusCode optional ה-Plus Code שמשויך למיקום.
postcode_localities אופציונלי	סוג: Array<string> optional מערך של מחרוזות שמציינות את כל היישובים שכלולים במיקוד. השדה הזה מופיע רק כשהתוצאה היא מיקוד שמכיל כמה יישובים.

ממשק AddressDescriptor

ממשק google.maps.AddressDescriptor

הערה: זמין רק ב-ערוץ בטא.

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

מאפיינים
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 אופציונלי	סוג: LatLngBounds optional הגבולות המדויקים של GeocoderResult, אם רלוונטי

קבועים של GeocoderLocationType

constants google.maps.GeocoderLocationType
ספרייה "geocoding"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג GeocoderLocationTypeString.

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");

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

ממשק Landmark

ממשק google.maps.Landmark

הערה: זמין רק ב-ערוץ בטא.

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

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

ממשק Area

ממשק google.maps.Area

הערה: זמין רק ב-ערוץ בטא.

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

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

קבועי הכלה

constants google.maps.Containment
ספרייה "geocoding"

הערה: זמין רק ב-ערוץ בטא.

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג ContainmentString.

const {Containment} = await google.maps.importLibrary("geocoding");

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

קבועים של SpatialRelationship

constants google.maps.SpatialRelationship
ספרייה "geocoding"

הערה: זמין רק ב-ערוץ בטא.

ערך enum שמייצג את הקשר במרחב בין נקודת הציון לבין היעד.

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג SpatialRelationshipString.

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");

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