Package google.maps.geocode.v4alpha

شاخصه

DestinationService

سرویسی برای بازیابی مقصدها.

مقصد بافت سلسله‌مراتبی درباره مکان ارائه می‌دهد که به شما امکان می‌دهد، برای مثال، ساختمان‌های آپارتمانی را در مجتمع آپارتمانی بزرگ‌تر پیدا کنید و برعکس. همچنین نقاط پیمایشی را ارائه می‌دهد که برای موارد استفاده‌ای مثل هم‌سفری یا تحویل مناسب است.

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

این روش جستجوی مقصد را انجام می‌دهد و فهرستی از مقصدها را برمی‌گرداند.

دامنه‌های مجوز

به یکی از دامنه‌های OAuth زیر نیاز دارد:

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

GeocodeService

سرویسی برای انجام زمین‌کدیابی.

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

مقصد

مقصد. این شامل مکان اصلی، مکان‌های مرتبط، ورودی‌ها، و نقاط ناوبری می‌شود.

فیلدها
primary

PlaceView

مکان اصلی که با primary_query در درخواست شناسایی شده است.
containing_places[]

PlaceView

مکان‌های با دقت کمتر که مکان اصلی در آن‌ها قرار دارد. برای مثال، مجتمع آپارتمانی که این ساختمان در آن قرار دارد.
sub_destinations[]

PlaceView

زیرمقصدهای دقیق‌تر مکان اصلی. برای مثال، واحدهای موجود در یک ساختمان.

توجه: درمقایسه با SubDestination که توسط Places API برگردانده می‌شود، این فهرست از زیرمقصدها جامع‌تر است و هر زیرمقصد حاوی اطلاعات بیشتری است.
landmarks[]

Landmark

نشانگرهای مکانی که می‌توانند برای اطلاع‌رسانی درباره مکان مقصد یا کمک به رسیدن به آن استفاده شوند.
entrances[]

Entrance

ورودی‌های این مقصد.
navigation_points[]

NavigationPoint

نقاط ناوبری برای این مقصد.
parking_options

Destination.ParkingOptions

گزینه‌های پارکینگ برای این مقصد.
arrival_summary

Destination.ArrivalSummary

خلاصه تولیدشده با هوش مصنوعی از تجربه ورود به مقصد.

ArrivalSummary

خلاصه تولیدشده با هوش مصنوعی از تجربه ورود به مقصد.

فیلدها
text

LocalizedText

خلاصه تجربه ورود به مقصد.
flag_content_url

string

پیوندی که کاربران می‌توانند ازطریق آن مشکلات خلاصه را پرچم‌گذاری کنند.
disclosure_text

LocalizedText

فقط خروجی. حاوی نوشتار شفاف‌سازی برای خلاصه ورود است.

ParkingOptions

اطلاعات مربوط به گزینه‌های پارکینگ برای مقصد.

فیلدها
availability

Destination.ParkingOptions.Availability

دردسترس بودن پارکینگ برای این مقصد.
parking_facilities[]

Destination.ParkingOptions.ParkingFacility

تسهیلات پارکینگ برای این مقصد.
onsite_parking

bool

پارکینگ درمحل در مقصد وجود دارد.
free_parking_lot

bool

پارکینگ سرباز رایگان ارائه می‌دهد.
paid_parking_lot

bool

پارکینگ سرباز پولی ارائه می‌دهد.
free_street_parking

bool

پارکینگ رایگان کنار خیابان ارائه می‌دهد.
paid_street_parking

bool

پارکینگ پولی کنار خیابان ارائه می‌دهد.
valet_parking

bool

سرویس پارکینگ با پیشکار ارائه می‌دهد.
free_garage_parking

bool

پارکینگ رایگان در گاراژ ارائه می‌دهد.
paid_garage_parking

bool

پارکینگ پولی در گاراژ ارائه می‌دهد.

دردسترس بودن

معیاری انبوهشی از میزان دشواری پیدا کردن پارکینگ هنگام بازدید از این مکان.

ممکن است در آینده مقادیر جدیدی اضافه شود.

شمارشی‌ها
AVAILABILITY_UNSPECIFIED دردسترس بودن پارکینگ دردسترس نیست.
PLENTY جای پارک زیادی دردسترس است.
SOMEWHAT_DIFFICULT پیدا کردن جای پارک تاحدی سخت است.
DIFFICULT پیدا کردن جای پارک بسیار سخت است.

ParkingFacility

یک گزینه پارکینگ مجزا و مشخص (مثلاً یک پارکینگ یا گاراژ خاص) که با مقصد مرتبط است. این پیام اطلاعات دقیقی درباره یک پارکینگ خاص ارائه می‌دهد، درحالی‌که پیام اصلی ParkingOptions خلاصه‌ای تجمیعی از همه پارکینگ‌های دردسترس ارائه می‌دهد.

فیلدها
place

PlaceView

نمایش مکان این پارکینگ خاص.
onsite

bool

اینکه این پارکینگ در محل مقصد اصلی واقع شده است یا نه. اگر این فیلد تنظیم نشده باشد، وضعیت در محل نامشخص است.
popular

bool

اینکه آیا این پارکینگ انتخاب پرطرفداری برای بازدیدکنندگانی است که به مقصد اصلی سفر می‌کنند یا نه. اگر این فیلد تنظیم نشده باشد، وضعیت محبوبیت نامشخص است.
straight_line_distance_meters

double

فاصله خط مستقیم برحسب متر از مقصد اصلی تا این پارکینگ.

ورودی

ورودی یک جفت مختصات عرض جغرافیایی/طول جغرافیایی است که مکان نقطه ورود و خروج را برای یک مکان تعریف می‌کند.

فیلدها
display_name

LocalizedText

نام قابل‌خواندن برای انسان، مثلاً «دروازه ب»، «ورودی جنوبی»، «ورودی خیابان پنجم».
location

LatLng

مکان ورودی.
tags[]

Entrance.Tag

فهرستی از برچسب‌ها که ورودی را توصیف می‌کند.
place

string

ساختاری که این ورودی به‌طور فیزیکی در آن قرار دارد، در قالب places/{place_id}.
street_view_thumbnail

StreetViewThumbnail

تصویر ریزعکس «نمای خیابان» که ورودی را نشان می‌دهد. تصویر را می‌توان از Street View Static API درخواست کرد. https://developers.google.com/maps/documentation/streetview/request-streetview را ببینید.
street_view_annotation

ImageAnnotation

حاشیه‌نویسی ورودی در street_view_thumbnail در بالا برگردانده شد.

برچسب

مشخصاتی که ورودی را توصیف می‌کند.

شمارشی‌ها
TAG_UNSPECIFIED استفاده‌نشده.
PREFERRED

ورودی احتمالاً دسترسی فیزیکی به مکان اصلی در مقصد برگردانده‌شده را فراهم می‌کند. یک مکان می‌تواند چندین ورودی ترجیحی داشته باشد. اگر ورودی این برچسب را نداشته باشد، به این معنی است که ورودی ازنظر فیزیکی در همان ساختمان مکان اصلی قرار دارد، اما لزوماً دسترسی به مکان را فراهم نمی‌کند.

برای مثال، اگر مکان اصلی رستورانی در یک مرکز خرید خطی باشد، ورودی‌های «ترجیحی» ورودی‌هایی خواهند بود که احتمالاً به خود رستوران منتهی می‌شوند، درحالی‌که سایر ورودی‌های برگردانده‌شده ورودی‌های دیگر ساختمان خواهند بود، مانند ورودی‌های رستوران‌های دیگر در مرکز خرید خطی.

اگر مکان اصلی خود ساختمان باشد، ورودی‌های PREFERRED ورودی‌هایی خواهند بود که به بخش «اصلی» ساختمان منتهی می‌شوند. برای مثال، در مرکز خرید، ورودی‌های PREFERRED ورودی‌هایی هستند که امکان دسترسی به محوطه سرسرای اصلی را فراهم می‌کنند، اما اگر ورودی فقط امکان دسترسی به فروشگاهی در کنار ساختمان را فراهم کند، ورودی PREFERRED نخواهد بود.

توجه: ورودی PREFERRED ممکن است دسترسی به مکان اصلی را فراهم نکند و ورودی غیرPREFERRED ممکن است دسترسی به مکان اصلی را فراهم کند.

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() باشد. این کار منجر به محدوده عرض جغرافیایی خالی می‌شود. عرض نمای مستطیلی نمی‌تواند بیشتر از ۱۸۰ درجه باشد.

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/{placeId}. می‌تواند برای جستجوی «مکان» استفاده شود.
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

مجموعه‌ای از برچسب‌های نوع برای این نتیجه. برای مثال، «political» و «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

آرایه‌ای که نوع(انواع) مؤلفه نشانی را نشان می‌دهد.

این مقادیر از جدول انواع نشانی و انواع مؤلفه نشانی که Places API از آن استفاده می‌کند گرفته شده است: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
language_code

string

زبانی که برای قالب‌بندی این مؤلفه استفاده می‌شود، در نماد CLDR.

دقت

جزئیات مکان.

شمارشی‌ها
GRANULARITY_UNSPECIFIED استفاده نکنید.
ROOFTOP مکان غیردرون‌یابی‌شده قطعه زمین واقعی مربوط به نشانی مطابقت‌داده‌شده.
RANGE_INTERPOLATED از گستره‌ای از شماره‌های خیابان درون‌یابی شده است. برای مثال، اگر بدانیم که بخشی از Amphitheatre Pkwy شامل شماره‌های ۱۶۰۰ تا ۱۶۹۹ است، شماره ۱۶۵۰ ممکن است در نیمه راه بین نقاط پایانی آن قرار گیرد.
GEOMETRIC_CENTER مرکز هندسی عارضه‌ای که برای آن داده‌های چندضلعی داریم.
APPROXIMATE سایر چیزها.

ImageAnnotation

حاشیه‌نویسی روی ریزعکس تصویر، مثل چندضلعی‌ای که ورودی را مشخص می‌کند.

فیلدها
coordinates[]

ImageAnnotation.Coordinate

فهرستی از مختصات که چندضلعی را روی تصویر تشکیل می‌دهند. مختصات‌ها به‌صورت پادساعت‌گرد مرتب شده‌اند.

مختصات

مختصات پیکسل نقطه‌ای روی تصویر. مبدأ (0,0) گوشه بالا سمت چپ پیکسل بالا سمت چپ تصویر است، که محور x به سمت راست و محور y به سمت پایین اشاره می‌کند.

فیلدها
x_px

float

مختصات X.
y_px

float

مختصات Y.

نشانگر مکانی

از نشانگرهای مکانی برای اطلاع‌رسانی درباره محل مقصد یا کمک به رسیدن به مقصد استفاده می‌شود.

فیلدها
relational_description

LocalizedText

شرحی قابل‌خواندن برای انسان درباره اینکه مقصد چه ارتباطی با نشانگر مکانی دارد. برای مثال: «نزدیک امپایر استیت» یا «روبه‌روی کاخ سفید».
tags[]

Landmark.Tag

برچسب‌هایی که نحوه استفاده از مکان دیدنی را در بافت مقصد توصیف می‌کنند.
straight_line_distance_meters

double

فقط خروجی. فاصله مستقیم از این مکان دیدنی تا مقصد به متر.
travel_distance_meters

double

فقط خروجی. فاصله پیاده‌روی از این مکان دیدنی تا مقصد به متر.
فیلد اتحادیه landmark. نشانگر مکانی. landmark فقط می‌تواند یکی از موارد زیر باشد:
place

PlaceView

مکانی که این نقطه عطف را نشان می‌دهد.

برچسب

فهرست همه برچسب‌های ممکن که نحوه استفاده از مکان دیدنی را در بافت مقصد توصیف می‌کند.

اگر نشانی‌ای هر دو برچسب ADDRESS و ARRIVAL را داشته باشد، یعنی آن نشانگر مکانی هم در محل برجسته است و هم به مقصد نزدیک است.

شمارشی‌ها
TAG_UNSPECIFIED استفاده‌نشده.
ADDRESS مکانی که در منطقه شناخته‌شده است و می‌توان از آن برای شناسایی مکان کلی مقصد استفاده کرد. معمولاً در چند صد متری مقصد. این‌ها شبیه به نشان‌های بازگردانده‌شده توسط ویژگی «توصیف‌کننده‌های نشانی» در Geocoding API هستند: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL مکانی که می‌تواند برای کمک به رسیدن به مقصد استفاده شود. وقتی به مقصد نزدیک هستید، برای ناوبری مفید است. برای مثال، این مکان شاخص ممکن است مکانی باشد که در آن‌سوی خیابان مقصد قرار دارد. نشانگر مکانی با این برچسب معمولاً نسبت‌به نشانگرهای مکانی با برچسب ADDRESS به مقصد نزدیک‌تر است.

نقطه ناوبری مکانی در کنار جاده است که ناوبری می‌تواند در آنجا پایان یابد.

فیلدها
navigation_point_token

string

فقط خروجی. نشانه‌ای که می‌تواند برای شناسایی این نقطه پیمایش استفاده شود.
display_name

LocalizedText

نام نمایشی این نقطه ناوبری. برای مثال، «خیابان پنجم» یا «دروازه ب».
location

LatLng

نقطه‌ای در کنار بخش جاده که ناوبری باید در آنجا پایان یابد. این نقطه به‌طور عمدی کمی از خط مرکزی جاده فاصله دارد تا طرفی از جاده را که مکان در آن قرار دارد به‌وضوح مشخص کند.
travel_modes[]

NavigationPoint.TravelMode

حالت‌های سفر که برای این نقطه ناوبری مناسب است.
usages[]

NavigationPoint.Usage

فهرست‌های usages که این نقطه پیمایش از آن‌ها پشتیبانی می‌کند. اگر خالی باشد، لزوماً به این معنی نیست که استفاده از آن به هر نحوی محدود شده است. از همه نقاط ناوبری می‌توان برای ناوبری عمومی استفاده کرد.
street_view_thumbnail

StreetViewThumbnail

تصویر ریزعکس «نمای خیابان» که نقطه پیمایش را نشان می‌دهد، درصورت دردسترس بودن. تصویر را می‌توان از Street View Static API درخواست کرد. https://developers.google.com/maps/documentation/streetview/request-streetview را ببینید.
entrance_annotation

ImageAnnotation

حاشیه‌نویسی ورودی مرتبط با این نقطه پیمایش در street_view_thumbnail که در بالا برگردانده شده است، درصورت وجود.
altitude_meters

float

ارتفاع نقطه ناوبری به متر نسبت به بیضی‌گون WGS-84.

TravelMode

حالت‌های سفر که برای این نقطه ناوبری مناسب است.

شمارشی‌ها
TRAVEL_MODE_UNSPECIFIED استفاده‌نشده.
DRIVE مناسب برای رانندگی.
WALK مناسب برای پیاده‌روی.

کاربرد

کاربردهایی که این نقطه ناوبری از آن‌ها پشتیبانی می‌کند. ممکن است در آینده مقادیر جدیدی اضافه شود.

شمارشی‌ها
USAGE_UNSPECIFIED استفاده‌نشده.
UNKNOWN نشان می‌دهد که نوع استفاده نامشخص است.
DROPOFF برای پیاده کردن مسافر مناسب است. برای مثال، مکان پیاده شدن مسافر در سفر اشتراکی.
PICKUP مناسب برای سوار کردن مسافر. برای مثال، مکان سوار شدن خودرو اشتراکی.
PARKING مناسب برای پارک کردن. برای مثال، در پارکینگ.

PlaceView

نمای Place را در Places API نشان می‌دهد. همچنین اطلاعات بیشتری را که مختص مقصدها است، مانند نوع ساختار و چندضلعی نمایش، ارائه می‌دهد.

در برخی موارد، PlaceView با همان شناسه مکان ممکن است با آنچه توسط Places API برای فیلدهای types و display_name برگردانده می‌شود متفاوت باشد.

فیلدها
place

string

نام منبع این «مکان»، در قالب places/{placeId}. می‌تواند برای جستجوی «مکان» استفاده شود.
place_id

string

شناسه یکتای مکان.
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 می‌تواند چند چندضلعی را نشان دهد.
address_components[]

PlaceView.AddressComponent

مؤلفه‌های تکراری برای هر سطح محلی.

AddressComponent

مؤلفه‌های ساختاریافته‌ای که نشانی قالب‌بندی‌شده را تشکیل می‌دهند، درصورت دردسترس بودن این اطلاعات.

فیلدها
long_text

string

شرح نوشتاری کامل یا نام مؤلفه نشانی. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام طولانی «استرالیا» را داشته باشد.
short_text

string

نام متنی اختصاری برای مؤلفه نشانی، درصورت وجود. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام کوتاه «AU» داشته باشد.
types[]

string

آرایه‌ای که نوع(انواع) مؤلفه نشانی را نشان می‌دهد.

این مقادیر از جدول انواع نشانی و انواع مؤلفه نشانی که Places API از آن استفاده می‌کند گرفته شده است: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
language_code

string

زبانی که برای قالب‌بندی این مؤلفه استفاده می‌شود، در نماد CLDR.

StructureType

نوع ساختاری که این مکان نشان می‌دهد.

شمارشی‌ها
STRUCTURE_TYPE_UNSPECIFIED استفاده‌نشده.
POINT مکان نقطه‌ای.
SECTION زیربخشی از ساختمان.
BUILDING ساختمان.
GROUNDS منطقه‌ای بزرگ که معمولاً شامل چندین ساختمان است، مانند پردیس دانشگاه، مجتمع آپارتمانی، یا مرکز خرید.

PlusCode

‫Plus code (http://plus.codes) مرجع مکان با دو قالب است: کد جهانی که مستطیل ۱۴ متر در ۱۴ متر (۱/۸۰۰۰ درجه) یا کوچک‌تر را تعریف می‌کند، و کد ترکیبی که پیشوند را با مکان مرجع جایگزین می‌کند.

فیلدها
global_code

string

کد جهانی (کامل) مکان، مثل «9FWM33GV+HQ»، که نشان‌دهنده منطقه‌ای با ابعاد ۱/۸۰۰۰ در ۱/۸۰۰۰ درجه (تقریباً ۱۴ در ۱۴ متر) است.
compound_code

string

کد ترکیبی مکان، مانند «33GV+HQ, Ramberg, Norway»، که حاوی پسوند کد جهانی است و پیشوند را با نام قالب‌بندی‌شده نهاد مرجع جایگزین می‌کند.

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 شامل ساختمان خواهد بود.

فیلدها
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

اختیاری. فیلترهایی که باید برای مقصدهای احتمالی اعمال شود.
فیلد اتحادیه kind. پُرسمان مکان. kind فقط می‌تواند یکی از موارد زیر باشد:
location

LatLng

مکان دقیق طول و عرض جغرافیایی.

PlaceFilter

فیلترهایی که باید برای مقصدهای احتمالی اعمال شود.

فیلدها
structure_type

PlaceView.StructureType

اختیاری. اگر مشخص شده باشد، تضمین می‌شود که همه مقصدها مکانی اصلی با این نوع ساختار داشته باشند. این امر می‌تواند منجر به فیلتر شدن برخی‌از مقصدها یا درشت‌تر/دقیق‌تر شدن مقصدهای برگردانده‌شده شود.

برای مثال، اگر GROUNDS مشخص شده باشد، همه مقصدهای برگردانده‌شده دارای مکان اصلی با نوع ساختار GROUNDS خواهند بود. این امر می‌تواند منجر به فیلتر کردن برخی‌از مقصدهایی شود که بخشی از محوطه نیستند، یا منجر به درشت‌نمایی مقصدهای برگردانده‌شده به سطح محوطه شود.

استفاده دیگر از این فیلد، استخراج آسان‌تر چندضلعی‌های نمایش ساختمان است. برای مثال، اگر BUILDING مشخص شده باشد، چندضلعی نمایشی مکان اصلی برای ساختمان واقع در مکان مشخص‌شده خواهد بود.
addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

اختیاری. اگر مشخص شده باشد، فقط مقصدهایی را برمی‌گرداند که با معیارهای آدرس‌پذیری مربوطه مطابقت داشته باشند.

آدرس‌پذیری

گزینه‌های فیلتر کردن آدرس‌پذیری را تعریف می‌کند. ممکن است در آینده مقادیر جدیدی اضافه شود.

شمارشی‌ها
ADDRESSABILITY_UNSPECIFIED اگر مشخص نشده باشد، سرویس یک پیش‌فرض معقول را انتخاب خواهد کرد.
ANY آدرس‌پذیری جزو معیارهای فیلتر کردن نیست. مقصدها صرف‌نظر از آدرس‌پذیر بودنشان برگردانده می‌شوند.
PRIMARY همه مقصدهای برگردانده‌شده دارای مکانی اصلی با نام یا نشانی در سطح خیابان خواهند بود.
WEAK همه مقصدهای برگردانده‌شده یا مکان اصلی خواهند داشت یا مقصد فرعی با نام یا نشانی سطح خیابان.

SearchDestinationsResponse

پیام پاسخ برای DestinationService.SearchDestinations.

فیلدها
destinations[]

Destination

فهرستی از مقاصد.

اگر مقصد اصلی را بتوان به‌طور واضح از پُرسمان اصلی شناسایی کرد، این سرویس یک نتیجه برمی‌گرداند. درغیراین‌صورت، ممکن است سرویس چندین نتیجه برای ابهام‌زدایی یا صفر نتیجه برگرداند.

StreetViewThumbnail

پارامترهای نمایش ریزعکس «نمای خیابان Google». از این پارامترها می‌توان برای درخواست تصویر نمای خیابان از Street View Static API استفاده کرد. https://developers.google.com/maps/documentation/streetview/request-streetview را ببینید.

فیلدها
pano

string

شناسه تمام‌نمای خاص.
width_px

int32

عرض تصویر ریزعکس خروجی به پیکسل. توجه: هنگام درخواست حاشیه‌نویسی در کنار ریزعکس، این مقادیر ارتفاع و عرض باید در درخواست Street View API استفاده شوند تا اطمینان حاصل شود که مختصات حاشیه‌نویسی به‌درستی با تصویر هم‌تراز شده‌اند.
height_px

int32

ارتفاع تصویر ریزعکس خروجی به پیکسل. توجه: هنگام درخواست حاشیه‌نویسی در کنار ریزعکس، این مقادیر ارتفاع و عرض باید در درخواست Street View API استفاده شوند تا اطمینان حاصل شود که مختصات حاشیه‌نویسی به‌درستی با تصویر هم‌تراز شده‌اند.
heading_degree

float

جهت افقی دوربین برحسب درجه. محدوده [۰، ۳۶۰). عدد ۰ نشان‌دهنده شمال و عدد ۹۰ نشان‌دهنده شرق است.
pitch_degree

float

جهت عمودی دوربین به درجه. محدوده [۹۰-، ۹۰]. ‫۰ افق است، ‎+۹۰ مستقیماً بالا است، ‎-۹۰ مستقیماً پایین است.
fov_degree

float

میدان دید افقی برحسب درجه. محدوده (0، 180]. سطح بزرگ‌نمایی را کنترل می‌کند. میدان دید کوچک‌تر به‌معنای بزرگ‌نمایی بیشتر است.