Package google.maps.geocode.v4alpha

אינדקס

• DestinationService (ממשק)
• Destination (הודעה)
• Entrance (הודעה)
• Entrance.Tag (enum)
• Landmark (הודעה)
• Landmark.Tag (enum)
• NavigationPoint (הודעה)
• NavigationPoint.TravelMode (enum)
• NavigationPoint.Usage (enum)
• PlaceView (הודעה)
• PlaceView.StructureType (enum)
• SearchDestinationsRequest (הודעה)
• SearchDestinationsRequest.AddressQuery (הודעה)
• SearchDestinationsRequest.LocationQuery (הודעה)
• SearchDestinationsResponse (הודעה)

DestinationService

שירות לאחזור יעדים.

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

SearchDestinations
rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse) השיטה הזו מבצעת חיפוש של יעד ומחזירה רשימה של יעדים. היקפי הרשאה נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/maps-platform.geocode

יעד

יעד. המידע הזה כולל את המקום הראשי, מקומות קשורים, כניסות ונקודות ניווט.

שדות
primary	PlaceView המקום הראשי שזוהה על ידי primary_query בבקשה.
containing_places[]	PlaceView מקומות פחות מדויקים שהמקום הראשי נכלל בהם. לדוגמה, מתחם הדירות שבו נמצא הבניין הזה.
sub_destinations[]	PlaceView יעדי משנה מדויקים יותר של המקום הראשי. לדוגמה, יחידות שכלולות בבניין. הערה: בהשוואה לSubDestination שמוחזר על ידי Places API, הרשימה הזו של יעדי משנה מקיפה יותר, וכל יעד משנה מכיל יותר מידע.
landmarks[]	Landmark ציוני דרך שאפשר להשתמש בהם כדי לציין איפה היעד נמצא או כדי לעזור להגיע אליו.
entrances[]	Entrance כניסות ליעד הזה.
navigation_points[]	NavigationPoint נקודות ניווט ליעד הזה.

כניסה

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

שדות
location	LatLng המיקום של הכניסה.
tags[]	Entrance.Tag רשימת תגים שמתארים את הכניסה.
place	string המבנה שבו הכניסה ממוקמת פיזית, בפורמט places/{place_id}.

תיוג

מאפיינים שמתארים כניסה.

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

ציון דרך

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

שדות
tags[]	Landmark.Tag תגים שמתארים איך אפשר להשתמש בציון הדרך בהקשר של היעד.
שדה איחוד landmark. ציון הדרך. הערך landmark יכול להיות רק אחד מהבאים:
place	PlaceView המקום שמייצג את ציון הדרך הזה.

תיוג

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

אם לכתובת יש גם את התג ADDRESS וגם את התג ARRIVAL, המשמעות היא שציון הדרך בולט בסביבה וגם קרוב ליעד.

טיפוסים בני מנייה (enum)
TAG_UNSPECIFIED	לא בשימוש.
ADDRESS	מקום בולט באזור שאפשר להשתמש בו כדי לזהות את המיקום הכללי של היעד. בדרך כלל בטווח של כמה מאות מטרים מהיעד. הם דומים לנקודות הציון שמחזירה התכונה Address Descriptors (תיאורי כתובות) של Geocoding API: ‏ https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL	מקום שיכול לעזור להגיע ליעד. התכונה הזו שימושית לניווט כשמתקרבים ליעד. לדוגמה, ציון הדרך יכול להיות מקום שנמצא בצד השני של הרחוב מהיעד. בדרך כלל, נקודת ציון עם התג הזה קרובה יותר ליעד מאשר נקודות ציון עם התג ADDRESS.

NavigationPoint

נקודת ניווט היא מיקום ליד כביש שבו הניווט יכול להסתיים.

שדות
display_name	LocalizedText השם המוצג של נקודת הניווט הזו. לדוגמה, 'שדרת 5' או 'שער ב'.
location	LatLng נקודה ליד מקטע הכביש שבו הניווט צריך להסתיים. הנקודה מוסטת בכוונה מעט מקו האמצע של הכביש כדי לסמן בבירור את הצד של הכביש שבו המקום ממוקם.
travel_modes[]	NavigationPoint.TravelMode מצבי נסיעה שמתאימים לנקודת הניווט הזו.
usages[]	NavigationPoint.Usage סוגי השימוש שנתמכים בנקודת הניווט הזו.

TravelMode

מצבי נסיעה שמתאימים לנקודת הניווט הזו.

טיפוסים בני מנייה (enum)
TRAVEL_MODE_UNSPECIFIED	לא בשימוש.
DRIVE	מתאים לנהיגה.
WALK	מתאים להליכה.

שימוש

סוגי השימוש שנתמכים בנקודת הניווט הזו.

טיפוסים בני מנייה (enum)
USAGE_UNSPECIFIED	לא בשימוש.
UNKNOWN	סוג השימוש לא ידוע. רוב נקודות הניווט יהיו UNKNOWN, וזה לא בהכרח אומר שהשימוש בהן מוגבל בצורה כלשהי. יכול להיות שהניווט הזה עדיין מתאים לאיסוף ו/או להורדה.
DROPOFF	מתאים להורדת נוסע. לדוגמה, מיקום להורדת נוסעים בנסיעה שיתופית.
PICKUP	מתאים לאיסוף נוסעים. לדוגמה, מיקום איסוף של נסיעה שיתופית.

PlaceView

מייצג תצוגה של מקום ב-Places API. בנוסף, הוא מספק מידע נוסף שספציפי ליעדים, כמו סוג המבנה והמצולע שמוצג.

במקרים מסוימים, יכול להיות שערך של PlaceView עם אותו מזהה מקום יהיה שונה ממה שמוחזר על ידי Places API בשדות types ו-display_name.

שדות
place	string שם המשאב של המקום הזה, בפורמט places/{placeId}.
display_name	LocalizedText תיאור קריא של המקום. לדוגמה, 'שער ב', 'מקדונלדס'
primary_type	string סוג המקום העיקרי של המקום הזה. רשימת הערכים האפשריים זמינה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types. הערה: השדה הזה לא תמיד מאוכלס. במקרים כאלה, צריך להיות מוכנים להשתמש בשדה types.
types[]	string כל סוגי המקומות שמשויכים למקום הזה. רשימת הערכים האפשריים זמינה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.
formatted_address	string כתובת בשורה אחת.
postal_address	PostalAddress כתובת מובנית.
structure_type	PlaceView.StructureType סוג המבנה שמתאים למקום הזה.
location	LatLng המיקום של המקום הזה. במקומות עם מצולעים של תצוגה, זה יכול לייצג נקודה טובה להצבת סמן במפה.
display_polygon	Struct המתאר של המקום בצורת מצולע בפורמט GeoJSON, בפורמט RFC 7946: ‏ https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6. הערה: פורמט RFC 7946 תומך ב-MultiPolygons, כך שאובייקט display_polygon אחד יכול לייצג כמה מצולעים.

StructureType

סוג המבנה שהמקום הזה מייצג.

טיפוסים בני מנייה (enum)
STRUCTURE_TYPE_UNSPECIFIED	לא בשימוש.
POINT	מיקום נקודתי.
SECTION	חלק ממבנה.
BUILDING	בניין.
GROUNDS	אזור גדול שבדרך כלל מכיל כמה בניינים, כמו קמפוס אוניברסיטאי, מתחם דירות או קניון.

SearchDestinationsRequest

בקשת הודעה עבור DestinationService.SearchDestinations.

שדות
travel_modes[]	NavigationPoint.TravelMode אופציונלי. אמצעי התחבורה לסינון נקודות הניווט. הפעולה הזו משפיעה על השדה navigation_points שמוחזר בתגובה. אם המערך ריק, אפשר להחזיר נקודות ניווט של כל אמצעי התחבורה.
language_code	string אופציונלי. השפה שבה התוצאות צריכות להיות מוצגות.
region_code	string אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך של שני תווים של ccTLD (דומיין ברמה העליונה). הפרמטר משפיע על התוצאות בהתאם לדין החל. הפרמטר הזה גם משפיע על התוצאות מהשירות, אבל לא מגביל אותן באופן מלא.
שדה איחוד primary_query. שליחת שאילתה ליעד הראשי. יכול להיות שמדובר במקום, בכתובת מלאה או במיקום LatLng. לא ניתן להפוך ליעד חלק מהמקומות והכתובות שיש לגביהם מידע מינימלי. היעדים מבוססים על השאילתה הראשית שצוינה. הערה: יש תמיכה רק במקומות ובכתובות שיכולים להיות יעד לניווט. לדוגמה, אפשר להשתמש במקום שמייצג בית או מתחם דירות כשאילתת החיפוש הראשית, אבל אי אפשר להשתמש במקומות שמייצגים יישוב או אזור אדמיניסטרטיבי כשאילתת החיפוש הראשית. הערך primary_query יכול להיות רק אחד מהבאים:
place	string שם המשאב של המקום, בפורמט places/{place_id}.
address_query	SearchDestinationsRequest.AddressQuery כתובת רחוב.
location_query	SearchDestinationsRequest.LocationQuery מיקום מדויק.

AddressQuery

כתובת הרחוב שרוצים לחפש. צריך לציין את הכתובות בהתאם לפורמט שבו משתמשים בשירות הדואר הלאומי של המדינה הרלוונטית.

שדות
שדה איחוד kind. שאילתת הכתובת. הערך kind יכול להיות רק אחד מהבאים:
address	PostalAddress כתובת רחוב בפורמט של כתובת למשלוח דואר.
address_query	string כתובת רחוב בפורמט של שורה אחת.

LocationQuery

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

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

שדות
שדה איחוד kind. שאילתת המיקום. הערך kind יכול להיות רק אחד מהבאים:
location	LatLng מיקום מדויק של קו רוחב וקו אורך.

SearchDestinationsResponse

הודעת תגובה ל-DestinationService.SearchDestinations.

שדות
destinations[]	Destination רשימה של יעדים. השירות מחזיר תוצאה אחת אם אפשר לזהות באופן חד-משמעי יעד ראשי מתוך השאילתה הראשית. אחרת, השירות עשוי להחזיר כמה תוצאות כדי להסביר את ההבדל בין האפשרויות, או לא להחזיר תוצאות בכלל.