Package google.maps.geocode.v4beta

אינדקס

GeocodeService

שירות לביצוע המרה של כתובות לקואורדינטות (geocoding).

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
GeocodeLocation

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.location
GeocodePlace

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

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

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.place

GeocodeAddressRequest

הודעת בקשה ל-GeocodeService.GeocodeAddress.

שדות
location_bias

GeocodeAddressRequest.LocationBias

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

language_code

string

אופציונלי. השפה שבה התוצאות צריכות להיות מוצגות.

region_code

string

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

שדה איחוד address_input. הכתובת להמרה לקואורדינטות. הערך address_input יכול להיות רק אחד מהבאים:
address_query

string

הכתובת הלא מובנית להמרה לקואורדינטות.

address

PostalAddress

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

LocationBias

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

שדות
שדה איחוד type. סוגים של הטיה לפי מיקום. הערך type יכול להיות רק אחד מהבאים:
rectangle

Viewport

תיבת מלבן שמוגדרת על ידי הפינה הצפון-מזרחית והפינה הדרום-מערבית. הערך rectangle.high() צריך להיות הנקודה הצפון-מזרחית של אזור התצוגה המלבני. הערך rectangle.low() צריך להיות הנקודה הדרום-מערבית של אזור התצוגה המלבני. הערך בשדה rectangle.low().latitude() לא יכול להיות גדול מ-rectangle.high().latitude(). התוצאה תהיה טווח ריק של קווי רוחב. הרוחב של אזור התצוגה המלבני לא יכול להיות גדול מ-180 מעלות.

GeocodeAddressResponse

הודעת תגובה לגבי GeocodeService.GeocodeAddress.

שדות
results[]

GeocodeResult

תוצאת הגיאו-קידוד.

GeocodeLocationRequest

הודעת בקשה ל-GeocodeService.GeocodeLocation.

שדות
language_code

string

אופציונלי. השפה שבה התוצאות צריכות להיות מוצגות.

region_code

string

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

types[]

string

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

רשימה מלאה של הערכים האפשריים מופיעה בטבלה א' ובטבלה ב' בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.

granularity[]

GeocodeResult.Granularity

אופציונלי. מסנן של ספירה אחת או יותר של רמת פירוט של מיקום.

שדה איחוד location_input. המיקום להמרה לקואורדינטות. הערך location_input יכול להיות רק אחד מהבאים:
location_query

string

המיקום בפורמט של מחרוזת 'lat,lng'. לדוגמה, "64.7611872,-18.4705364".

location

LatLng

המיקום בפורמט המובנה.

GeocodeLocationResponse

הודעת תגובה לגבי GeocodeService.GeocodeLocation.

שדות
results[]

GeocodeResult

תוצאת הגיאו-קידוד.

plus_code

PlusCode

ה-Plus Code של המיקום בבקשה.

GeocodePlaceRequest

הודעת בקשה ל-GeocodeService.GeocodePlace.

שדות
place

string

חובה. מזהה מקום לגיאו-קידוד בפורמט places/{place}.

language_code

string

אופציונלי. השפה שבה התוצאות צריכות להיות מוצגות.

region_code

string

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

GeocodeResult

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

שדות
place

string

מזהה המקום שמוגדר במלואו של התוצאה הזו. בפורמט ‎ "//places.googleapis.com/places/{placeID}"‎. פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/places/web-service/place-id.

place_id

string

מזהה המקום של התוצאה הזו.

location

LatLng

הקואורדינטות של הכתובת.

granularity

GeocodeResult.Granularity

רמת הפירוט של המיקום.

viewport

Viewport

אזור תצוגה שמתאים להצגת תוצאת הקידוד הגיאוגרפי.

bounds

Viewport

תיבה תוחמת של הכתובת.

formatted_address

string

הכתובת בפורמט של שורה אחת.

postal_address

PostalAddress

הכתובת בפורמט של כתובת למשלוח דואר.

address_components[]

GeocodeResult.AddressComponent

רכיבים שחוזרים על עצמם לכל רמת מקומיות.

postal_code_localities[]

LocalizedText

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

השדה הזה מאוכלס רק אם התוצאה היא מסוג postal_code.

types[]

string

קבוצה של תגי סוג לתוצאה הזו. לדוגמה, 'פוליטי' ו-'administrative_area'.

רשימה מלאה של הערכים האפשריים מופיעה בטבלה א' ובטבלה ב' בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.

plus_code

PlusCode

‫Plus Code של המיקום בגיאוקוד הזה.

AddressComponent

הרכיבים המובְנים שמרכיבים את הכתובת בפורמט המתאים, אם המידע הזה זמין.

שדות
long_text

string

התיאור המלא של רכיב הכתובת או השם שלו. לדוגמה, רכיב כתובת של המדינה אוסטרליה יכול להיות עם שם ארוך 'אוסטרליה'.

short_text

string

שם טקסטואלי מקוצר של רכיב הכתובת, אם יש כזה. לדוגמה, רכיב כתובת של אוסטרליה יכול להיות עם שם מקוצר של 'AU'.

types[]

string

מערך שמציין את הסוגים של רכיב הכתובת.

פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types.

language_code

string

השפה שמשמשת לעיצוב הרכיבים האלה, בסימון CLDR.

רמת פירוט

רמת הפירוט של המיקום.

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

PlusCode

‫Plus Code‏ (http://plus.codes) הוא הפניה למיקום בשני פורמטים: קוד גלובלי שמגדיר מלבן בגודל 14 מ'‎ x 14 מ'‎ (1/8, 000 של מעלה) או קטן יותר, וקוד מורכב שמחליף את הקידומת בהפניה למיקום.

שדות
global_code

string

הקוד הגלובלי (המלא) של המקום, כמו '9FWM33GV+HQ', שמייצג אזור של 1/8000 על 1/8000 מעלות (~14 על 14 מטרים).

compound_code

string

קוד מורכב של מקום, כמו "33GV+HQ, Ramberg, Norway", שמכיל את הסיומת של הקוד הגלובלי ומחליף את הקידומת בשם מפורמט של ישות הפניה.