אינדקס
-
DestinationService(ממשק) -
GeocodeService(ממשק) -
Destination(הודעה) -
Entrance(הודעה) Entrance.Tag(enum)-
GeocodeAddressRequest(הודעה) -
GeocodeAddressRequest.LocationBias(הודעה) -
GeocodeAddressResponse(הודעה) -
GeocodeLocationRequest(הודעה) -
GeocodeLocationResponse(הודעה) -
GeocodePlaceRequest(הודעה) -
GeocodeResult(הודעה) -
GeocodeResult.AddressComponent(הודעה) GeocodeResult.Granularity(enum)-
Landmark(הודעה) Landmark.Tag(enum)-
NavigationPoint(הודעה) NavigationPoint.TravelMode(enum)NavigationPoint.Usage(enum)-
PlaceView(הודעה) PlaceView.StructureType(enum)-
PlusCode(הודעה) -
SearchDestinationsRequest(הודעה) -
SearchDestinationsRequest.AddressQuery(הודעה) -
SearchDestinationsRequest.LocationQuery(הודעה) -
SearchDestinationsRequest.LocationQuery.PlaceFilter(הודעה) SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability(enum)-
SearchDestinationsResponse(הודעה)
DestinationService
שירות לאחזור יעדים.
יעד מספק הקשר היררכי לגבי מקום מסוים, וכך מאפשר לכם, למשל, למצוא בנייני דירות בתוך מתחם דירות גדול יותר, ולהיפך. היא מספקת גם נקודות ניווט שמתאימות לתרחישי שימוש כמו שיתוף נסיעות או משלוחים.
| SearchDestinations |
|---|
|
השיטה הזו מבצעת חיפוש של יעדים ומחזירה רשימה של יעדים.
|
GeocodeService
שירות לביצוע המרת כתובות לקואורדינטות (geocoding).
| GeocodeAddress |
|---|
|
השיטה הזו ממירה כתובת לקואורדינטות, כלומר ממפה כתובת ל-LatLng. היא גם מספקת מידע מובנה על הכתובת.
|
| GeocodeLocation |
|---|
|
השיטה הזו ממירה מיקום לקואורדינטות, כלומר ממפה LatLng לכתובת. היא גם מספקת מידע מובנה על הכתובת.
|
| GeocodePlace |
|---|
|
השיטה הזו מבצעת חיפוש של קואורדינטות באמצעות מזהה מקום.
|
יעד
יעד. הנתונים האלה כוללים את המקום הראשי, מקומות קשורים, כניסות ונקודות ניווט.
| שדות | |
|---|---|
primary |
המקום הראשי שזוהה על ידי |
containing_places[] |
מקומות פחות מדויקים שהמקום הראשי נכלל בהם. לדוגמה, מתחם הדירות שבו נמצא הבניין הזה. |
sub_destinations[] |
יעדי משנה מדויקים יותר של המקום הראשי. לדוגמה, יחידות שנמצאות בבניין. הערה: בהשוואה לSubDestination שמוחזר על ידי Places API, הרשימה הזו של יעדי משנה מקיפה יותר, וכל יעד משנה מכיל יותר מידע. |
landmarks[] |
ציוני דרך שאפשר להשתמש בהם כדי להסביר איפה היעד נמצא או כדי לעזור להגיע אליו. |
entrances[] |
כניסות ליעד הזה. |
navigation_points[] |
נקודות ניווט ליעד הזה. |
כניסה
כניסה היא זוג קואורדינטות יחיד של קו רוחב וקו אורך שמגדיר את המיקום של נקודת כניסה ויציאה למקום.
| שדות | |
|---|---|
location |
המיקום של הכניסה. |
tags[] |
רשימת תגים שמתארים את הכניסה. |
place |
המבנה שבו הכניסה ממוקמת פיזית, בפורמט |
תג
מאפיינים שמתארים כניסה.
| טיפוסים בני מנייה (enum) | |
|---|---|
TAG_UNSPECIFIED |
לא בשימוש. |
PREFERRED |
הכניסה כנראה מספקת גישה פיזית למקום העיקרי ביעד שהוחזר. יכולים להיות למקום כמה כניסות מועדפות. אם אין תג כזה לכניסה, זה אומר שהכניסה נמצאת פיזית באותו בניין כמו המקום הראשי, אבל לא בהכרח מאפשרת גישה למקום. לדוגמה, אם המקום הראשי הוא מסעדה בקניון, הכניסות שיוחזרו עם הערך 'מועדפת' הן כנראה הכניסות שמובילות ישירות למסעדה, ואילו הכניסות האחרות שיוחזרו הן כניסות אחרות לבניין, כמו כניסות למסעדות אחרות בקניון. אם המקום הראשי הוא בניין, הכניסות יהיו אלה שמובילות לחלק הראשי של הבניין. הערה: כניסה מסוג |
GeocodeAddressRequest
הודעת בקשה ל-GeocodeService.GeocodeAddress.
| שדות | |
|---|---|
location_bias |
אופציונלי. האזור לחיפוש. המיקום הזה משמש כהטיה, כלומר המערכת מעדיפה תוצאות שמסביב למיקום הנתון. |
language_code |
אופציונלי. השפה שצריך להחזיר בה את התוצאות. |
region_code |
אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. הפרמטר משפיע על התוצאות בהתאם לדין החל. הפרמטר הזה ישפיע גם על התוצאות מהשירות, אבל לא יגביל אותן באופן מלא. |
שדה איחוד address_input. הכתובת שצריך להמיר לקואורדינטות. הערך address_input יכול להיות רק אחד מהבאים: |
|
address_query |
הכתובת הלא מובנית שצריך להמיר לקואורדינטות. |
address |
הכתובת המובנית שצריך להמיר לקואורדינטות בפורמט של כתובת למשלוח דואר. |
LocationBias
האזור לחיפוש. המיקום הזה משמש כהטיה, כלומר המערכת מעדיפה תוצאות שמסביב למיקום הנתון.
| שדות | |
|---|---|
שדה איחוד type. סוגים של הטיה לפי מיקום. הערך type יכול להיות רק אחד מהבאים: |
|
rectangle |
תיבה מלבנית שמוגדרת על ידי הפינה הצפון-מזרחית והפינה הדרום-מערבית. הערך |
GeocodeAddressResponse
הודעת תגובה אל GeocodeService.GeocodeAddress.
| שדות | |
|---|---|
results[] |
תוצאת ההמרת כתובות לקואורדינטות (geocoding). |
GeocodeLocationRequest
הודעת בקשה ל-GeocodeService.GeocodeLocation.
| שדות | |
|---|---|
language_code |
אופציונלי. השפה שצריך להחזיר בה את התוצאות. |
region_code |
אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. הפרמטר משפיע על התוצאות בהתאם לדין החל. |
types[] |
אופציונלי. קבוצה של תגי סוג להגבלת התוצאות. תוצאות שלא כוללות אף אחד מהסוגים שצוינו יוסרו. רשימה מלאה של הערכים האפשריים מופיעה בטבלה A ובטבלה B בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. |
granularity[] |
אופציונלי. מסנן של ספירות (enum) של רמת פירוט של מיקום אחת או יותר. |
שדה איחוד location_input. המיקום שצריך להמיר לקואורדינטות. הערך location_input יכול להיות רק אחד מהבאים: |
|
location_query |
המיקום בפורמט של מחרוזת 'lat,lng'. לדוגמה, "64.7611872,-18.4705364". |
location |
המיקום בפורמט המובנה. |
GeocodeLocationResponse
הודעת תגובה אל GeocodeService.GeocodeLocation.
| שדות | |
|---|---|
results[] |
תוצאת ההמרת כתובות לקואורדינטות (geocoding). |
plus_code |
ה-Plus Code של המיקום בבקשה. |
GeocodePlaceRequest
הודעת בקשה ל-GeocodeService.GeocodePlace.
| שדות | |
|---|---|
place |
חובה. מזהה המקום שצריך להמיר לקואורדינטות בפורמט places/{place}. |
language_code |
אופציונלי. השפה שצריך להחזיר בה את התוצאות. |
region_code |
אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. הפרמטר משפיע על התוצאות בהתאם לדין החל. |
GeocodeResult
תוצאה של גיאו-קוד מכילה מידע גיאוגרפי על מקום.
| שדות | |
|---|---|
place |
שם המשאב של המקום הזה, בפורמט |
place_id |
המזהה הייחודי של מקום. |
location |
הקואורדינטות של הכתובת הזו. |
granularity |
רמת הפירוט של המיקום. |
viewport |
אזור תצוגה שמתאים להצגת תוצאת הקידוד הגיאוגרפי. |
bounds |
תיבה תוחמת של הכתובת. |
formatted_address |
הכתובת בפורמט של שורה אחת. |
postal_address |
הכתובת בפורמט של כתובת למשלוח דואר. |
address_components[] |
רכיבים שחוזרים על עצמם בכל רמת יישוב. |
postal_code_localities[] |
רשימה מלאה של היישובים שכלולים במיקוד. השדה הזה מאוכלס רק אם התוצאה היא מסוג postal_code (מיקוד). |
types[] |
קבוצה של תגי סוג לתוצאה הזו. לדוגמה, 'פוליטי' ו'אזור אדמיניסטרטיבי'. רשימה מלאה של הערכים האפשריים מופיעה בטבלה A ובטבלה B בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. |
plus_code |
Plus Code של המיקום בגיאו-קידוד הזה. |
AddressComponent
הרכיבים המובנים שמרכיבים את הכתובת המעוצבת, אם המידע הזה זמין.
| שדות | |
|---|---|
long_text |
התיאור המלא של רכיב הכתובת או השם שלו. לדוגמה, רכיב כתובת של המדינה אוסטרליה יכול להיות עם שם ארוך 'אוסטרליה'. |
short_text |
שם טקסטואלי מקוצר של רכיב הכתובת, אם יש כזה. לדוגמה, רכיב כתובת של אוסטרליה יכול להיות עם שם מקוצר של 'AU'. |
types[] |
מערך שמציין את הסוגים של רכיב הכתובת. פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types. |
language_code |
השפה שמשמשת לעיצוב הרכיב הזה, בסימון CLDR. |
רמת פירוט
רמת הפירוט של המיקום.
| טיפוסים בני מנייה (enum) | |
|---|---|
GRANULARITY_UNSPECIFIED |
אין להשתמש בו. |
ROOFTOP |
המיקום הלא משוער של חלקה בפועל שתואם לכתובת שהוזנה. |
RANGE_INTERPOLATED |
הערך הוא אינטרפולציה מטווח של מספרי רחוב. לדוגמה, אם אנחנו יודעים שקטע של Amphitheatre Pkwy מכיל את המספרים 1600 עד 1699, אז יכול להיות שהמספר 1650 ימוקם באמצע בין נקודות הקצה שלו. |
GEOMETRIC_CENTER |
המרכז הגיאומטרי של ישות שיש לנו לגביה נתונים פוליגונליים. |
APPROXIMATE |
כל השאר. |
ציון דרך
ציוני דרך משמשים כדי לציין איפה היעד נמצא או כדי לעזור להגיע ליעד.
| שדות | |
|---|---|
relational_description |
תיאור קריא לאנשים של הקשר בין היעד לבין ציון הדרך. לדוגמה: 'ליד בניין אמפייר סטייט' או 'מול הבית הלבן'. |
tags[] |
תגים שמתארים איך אפשר להשתמש בציון הדרך בהקשר של היעד. |
straight_line_distance_meters |
פלט בלבד. המרחק בקו ישר מציון הדרך הזה ליעד במטרים. |
travel_distance_meters |
פלט בלבד. המרחק בין ציון הדרך הזה ליעד במטרים, בחישוב לפי רשת הכבישים. |
שדה איחוד landmark. ציון הדרך. הערך landmark יכול להיות רק אחד מהבאים: |
|
place |
המקום שמייצג את ציון הדרך הזה. |
תג
רשימה של כל התגים האפשריים שמתארים איך אפשר להשתמש בציון דרך בהקשר של יעד.
אם לכתובת יש גם את התג ADDRESS וגם את התג ARRIVAL, המשמעות היא שציון הדרך בולט באופן מקומי וקרוב ליעד.
| טיפוסים בני מנייה (enum) | |
|---|---|
TAG_UNSPECIFIED |
לא בשימוש. |
ADDRESS |
מקום בולט מקומי שאפשר להשתמש בו כדי לזהות את המיקום הכללי של היעד. בדרך כלל בטווח של כמה מאות מטרים מהיעד. הם דומים לנקודות הציון שמחזירה התכונה Address Descriptors (תיאורי כתובות) של Geocoding API (API לקידוד גאוגרפי): https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors. |
ARRIVAL |
מקום שיכול לעזור להגיע ליעד. התכונה הזו שימושית לניווט כשמתקרבים ליעד. לדוגמה, ציון הדרך יכול להיות מקום שנמצא בצד השני של הרחוב מהיעד. בדרך כלל, ציון דרך עם התג הזה נמצא קרוב יותר ליעד מאשר ציון דרך עם התג ADDRESS. |
PlaceView
מייצג תצוגה של מקום ב-Places API. היא גם מספקת מידע נוסף שספציפי ליעדים, כמו סוג המבנה והפוליגון שמוצג.
במקרים מסוימים, יכול להיות שערך של PlaceView עם אותו מזהה מקום יהיה שונה ממה שמוחזר על ידי Places API בשדות types ו-display_name.
| שדות | |
|---|---|
place |
שם המשאב של המקום הזה, בפורמט |
place_id |
המזהה הייחודי של מקום. |
display_name |
תיאור קריא של המקום. לדוגמה, 'שער ב', 'מקדונלדס' |
primary_type |
סוג המקום העיקרי של המקום הזה. רשימת הערכים האפשריים זמינה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. הערה: השדה הזה לא תמיד מאוכלס. במקרים כאלה, צריך להיות מוכנים להשתמש בשדה |
types[] |
כל סוגי המקומות שמשויכים למקום הזה. רשימת הערכים האפשריים זמינה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. |
formatted_address |
כתובת בשורה אחת. |
postal_address |
כתובת מובנית. |
structure_type |
סוג המבנה שמתאים למקום הזה. |
location |
המיקום של המקום הזה. במקומות שבהם מוצגים פוליגונים, אפשר להשתמש בהם כדי להציב סמן במפה. |
display_polygon |
המתאר של המקום בצורת מצולע בפורמט GeoJSON, בפורמט RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6. הערה: פורמט RFC 7946 תומך ב-MultiPolygons, כך שאובייקט |
StructureType
סוג המבנה שהמקום הזה מייצג.
| טיפוסים בני מנייה (enum) | |
|---|---|
STRUCTURE_TYPE_UNSPECIFIED |
לא בשימוש. |
POINT |
מיקום נקודתי. |
SECTION |
חלק ממבנה. |
BUILDING |
בניין. |
GROUNDS |
אזור גדול שבדרך כלל מכיל כמה בניינים, כמו קמפוס אוניברסיטאי, מתחם דירות או קניון. |
PlusCode
Plus Code (http://plus.codes) הוא הפניה למיקום בשני פורמטים: קוד גלובלי שמגדיר מלבן בגודל 14 מ'×14 מ' (1/8, 000 של מעלה) או קטן יותר, וקוד מורכב שמחליף את הקידומת בהפניה למיקום.
| שדות | |
|---|---|
global_code |
הקוד הגלובלי (המלא) של המקום, כמו 9FWM33GV+HQ, שמייצג אזור של 1/8000 על 1/8000 מעלות (~14 על 14 מטרים). |
compound_code |
קוד מורכב של מקום, כמו '33GV+HQ, Ramberg, Norway', שמכיל את הסיומת של הקוד הגלובלי ומחליף את הקידומת בשם מפורמט של ישות הפניה. |
SearchDestinationsRequest
בקשת הודעה עבור DestinationService.SearchDestinations.
| שדות | |
|---|---|
travel_modes[] |
אופציונלי. אמצעי התחבורה שרוצים לסנן את נקודות הניווט לפי. הפעולה הזו משפיעה על השדה |
language_code |
אופציונלי. השפה שצריך להחזיר בה את התוצאות. |
region_code |
אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. הפרמטר משפיע על התוצאות בהתאם לדין החל. הפרמטר הזה ישפיע גם על התוצאות מהשירות, אבל לא יגביל אותן באופן מלא. |
שדה איחוד היעדים מבוססים על השאילתה הראשית שצוינה. הערה: המערכת תומכת רק במקומות ובכתובות שיכולים להיות יעד לניווט. לדוגמה, אפשר להשתמש במקום שמייצג בית או מתחם דירות כשאילתה ראשית, אבל אי אפשר להשתמש במקומות שמייצגים רשות מוניציפאלית או אזור מנהלי כשאילתה ראשית. הערך |
|
place |
שם המשאב של המקום, בפורמט |
address_query |
כתובת רחוב. |
location_query |
מיקום מדויק. |
AddressQuery
כתובת הרחוב שרוצים לחפש. צריך לציין את הכתובות בהתאם לפורמט שבו משתמשים בשירות הדואר הלאומי של המדינה הרלוונטית.
| שדות | |
|---|---|
שדה איחוד kind. שאילתת הכתובת. הערך kind יכול להיות רק אחד מהבאים: |
|
address |
כתובת רחוב בפורמט של כתובת למשלוח דואר. |
address_query |
כתובת רחוב בפורמט של שורה אחת. |
LocationQuery
שאילתת מיקום לזיהוי יעד ראשי בקרבת מקום.
הערה: אם שאילתת המיקום היא בתוך בניין שמכיל שטחי משנה, יכול להיות שהמקום הראשי שיוחזר הוא שטח משנה. במקרים כאלה, השדה containing_places יכלול את הבניין.
| שדות | |
|---|---|
place_filter |
אופציונלי. מסננים להחלה על מועמדים ליעד. |
שדה איחוד kind. שאילתת המיקום. הערך kind יכול להיות רק אחד מהבאים: |
|
location |
מיקום מדויק של קו רוחב וקו אורך. |
PlaceFilter
מסננים להחלה על מועמדים ליעד.
| שדות | |
|---|---|
structure_type |
אופציונלי. אם מציינים את סוג המבנה הזה, מובטח שלכל היעדים יהיה מקום ראשי עם סוג המבנה הזה. התוצאה יכולה להיות סינון של חלק מהיעדים, או שינוי רמת הפירוט של היעדים שמוחזרים. לדוגמה, אם מציינים את שימוש נוסף בשדה הזה הוא כדי לחלץ בקלות רבה יותר מצולעים של בניינים. לדוגמה, אם מציינים את |
addressability |
אופציונלי. אם מציינים את הפרמטר הזה, הפונקציה מחזירה רק יעדים שעומדים בקריטריונים המתאימים של יכולת הכתובת. |
אפשרות פנייה
הגדרת אפשרויות לסינון לפי יכולת פנייה. יכול להיות שבעתיד נוסיף ערכים חדשים.
| טיפוסים בני מנייה (enum) | |
|---|---|
ADDRESSABILITY_UNSPECIFIED |
אם לא מציינים ברירת מחדל, השירות יבחר ברירת מחדל הגיונית. |
ANY |
היכולת להציג מודעות לאנשים מסוימים היא לא קריטריון לסינון. היעדים מוחזרים ללא קשר ליכולת ההגעה שלהם. |
PRIMARY |
לכל היעדים שיוחזרו יהיה מקום ראשי עם כתובת או שם ברמת הרחוב. |
WEAK |
לכל היעדים שיוחזרו יהיה מקום ראשי או יעד משנה עם כתובת או שם ברמת הרחוב. |
SearchDestinationsResponse
הודעת תגובה ל-DestinationService.SearchDestinations.
| שדות | |
|---|---|
destinations[] |
רשימת יעדים. השירות מחזיר תוצאה אחת אם אפשר לזהות באופן חד-משמעי יעד ראשי מתוך השאילתה הראשית. אחרת, השירות עשוי להחזיר כמה תוצאות כדי להבחין בין האפשרויות או אפס תוצאות. |