شاخصه
-
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.AddressComponent(پیام) -
PlaceView.StructureType(enum) -
PlusCode(پیام) -
SearchDestinationsRequest(پیام) -
SearchDestinationsRequest.AddressQuery(پیام) -
SearchDestinationsRequest.LocationQuery(پیام) -
SearchDestinationsRequest.LocationQuery.PlaceFilter(پیام) -
SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability(enum) -
SearchDestinationsResponse(پیام)
DestinationService
سرویسی برای بازیابی مقصدها.
مقصد بافت سلسلهمراتبی درباره مکان ارائه میدهد که به شما امکان میدهد، برای مثال، ساختمانهای آپارتمانی را در مجتمع آپارتمانی بزرگتر پیدا کنید و برعکس. همچنین نقاط پیمایشی را ارائه میدهد که برای موارد استفادهای مثل همسفری یا تحویل مناسب است.
| SearchDestinations |
|---|
|
این روش جستجوی مقصد را انجام میدهد و فهرستی از مقصدها را برمیگرداند.
|
GeocodeService
سرویسی برای انجام زمینکدیابی.
| GeocodeAddress |
|---|
|
این روش زمینکدیابی نشانی را انجام میدهد که نشانی را به LatLng نگاشت میکند. همچنین اطلاعات ساختاریافتهای درباره نشانی ارائه میدهد.
|
| GeocodeLocation |
|---|
|
این روش زمینکدیابی مکان را انجام میدهد که LatLng را به نشانی نگاشت میکند. همچنین اطلاعات ساختاریافتهای درباره نشانی ارائه میدهد.
|
| GeocodePlace |
|---|
|
این روش جستجوی زمینکدیاب را بااستفاده از شناسه مکان انجام میدهد.
|
مقصد
مقصد. این شامل مکان اصلی، مکانهای مرتبط، ورودیها، و نقاط ناوبری میشود.
| فیلدها | |
|---|---|
primary |
مکان اصلی که با |
containing_places[] |
مکانهای با دقت کمتر که مکان اصلی در آنها قرار دارد. برای مثال، مجتمع آپارتمانی که این ساختمان در آن قرار دارد. |
sub_destinations[] |
زیرمقصدهای دقیقتر مکان اصلی. برای مثال، واحدهای موجود در یک ساختمان. توجه: درمقایسه با SubDestination که توسط Places API برگردانده میشود، این فهرست از مقصدهای فرعی جامعتر است و هر مقصد فرعی حاوی اطلاعات بیشتری است. |
landmarks[] |
نشانگرهای مکانی که میتوانند برای اطلاعرسانی درباره مکان مقصد یا کمک به رسیدن به آن استفاده شوند. |
entrances[] |
ورودیهای این مقصد. |
navigation_points[] |
نقاط ناوبری برای این مقصد. |
ورودی
ورودی یک جفت مختصات عرض جغرافیایی/طول جغرافیایی است که مکان نقطه ورود و خروج را برای یک مکان تعریف میکند.
| فیلدها | |
|---|---|
display_name |
نام قابلخواندن برای انسان، مثلاً «دروازه ب»، «ورودی جنوبی»، «ورودی خیابان پنجم». |
location |
مکان ورودی. |
tags[] |
فهرستی از برچسبها که ورودی را توصیف میکند. |
place |
ساختاری که این ورودی بهطور فیزیکی در آن قرار دارد، در قالب |
برچسب
مشخصاتی که ورودی را توصیف میکند.
| شمارشیها | |
|---|---|
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[] |
نتیجه زمینکدیابی. |
GeocodeLocationRequest
پیام درخواست برای GeocodeService.GeocodeLocation.
| فیلدها | |
|---|---|
language_code |
اختیاری. زبان نتایجی که باید برگردانده شود. |
region_code |
اختیاری. کد منطقه. کد منطقه، که بهعنوان مقدار دو نویسهای ccTLD («دامنه سطح بالا») مشخص شده است. این پارامتر براساس قانون ذیربط بر نتایج تأثیر میگذارد. |
types[] |
اختیاری. مجموعهای از برچسبهای نوع برای محدود کردن نتایج. نتایجی که هیچکدام از انواع مشخصشده را نداشته باشند برداشته میشوند. برای مشاهده فهرست کامل مقادیر ممکن، به «جدول الف» و «جدول ب» در https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید. |
granularity[] |
اختیاری. فیلتری از یک یا چند شمارش دانهبندی مکان. |
فیلد اتحادیه location_input. مکان برای زمینکدیابی. location_input فقط میتواند یکی از موارد زیر باشد: |
|
location_query |
مکان در قالب رشته «lat,lng». برای مثال، «64.7611872,-18.4705364». |
location |
مکان در قالب ساختیافته. |
GeocodeLocationResponse
پیام پاسخ برای GeocodeService.GeocodeLocation.
| فیلدها | |
|---|---|
results[] |
نتیجه زمینکدیابی. |
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[] |
مجموعهای از برچسبهای نوع برای این نتیجه. برای مثال، «political» و «administrative_area». برای مشاهده فهرست کامل مقادیر ممکن، به «جدول الف» و «جدول ب» در https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید. |
plus_code |
Plus Code مکان در این زمینکد. |
AddressComponent
مؤلفههای ساختاریافتهای که نشانی قالببندیشده را تشکیل میدهند، درصورت دردسترس بودن این اطلاعات.
| فیلدها | |
|---|---|
long_text |
شرح نوشتاری کامل یا نام مؤلفه نشانی. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام طولانی «استرالیا» را داشته باشد. |
short_text |
نام متنی اختصاری برای مؤلفه نشانی، درصورت وجود. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام کوتاه «AU» داشته باشد. |
types[] |
آرایهای که نوع(انواع) مؤلفه نشانی را نشان میدهد. این مقادیر از جدول انواع نشانی و انواع مؤلفه نشانی که Places API از آن استفاده میکند گرفته شده است: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types |
language_code |
زبانی که برای قالببندی این مؤلفه استفاده میشود، در نماد CLDR. |
دقت
جزئیات مکان.
| شمارشیها | |
|---|---|
GRANULARITY_UNSPECIFIED |
استفاده نکنید. |
ROOFTOP |
مکان غیردرونیابیشده قطعه زمین واقعی مربوط به نشانی مطابقتدادهشده. |
RANGE_INTERPOLATED |
از گسترهای از شمارههای خیابان درونیابی شده است. برای مثال، اگر بدانیم که بخشی از Amphitheatre Pkwy شامل شمارههای ۱۶۰۰ تا ۱۶۹۹ است، شماره ۱۶۵۰ ممکن است در نیمه راه بین نقاط پایانی آن قرار گیرد. |
GEOMETRIC_CENTER |
مرکز هندسی عارضهای که برای آن دادههای چندضلعی داریم. |
APPROXIMATE |
سایر چیزها. |
نشانگر مکانی
از نشانگرهای مکانی برای اطلاعرسانی درباره مکان مقصد یا کمک به رسیدن به مقصد استفاده میشود.
| فیلدها | |
|---|---|
relational_description |
شرحی قابلخواندن برای انسان درباره اینکه مقصد چه ارتباطی با نشانگر مکانی دارد. برای مثال: «نزدیک امپایر استیت» یا «روبهروی کاخ سفید». |
tags[] |
برچسبهایی که نحوه استفاده از مکان دیدنی را در بافت مقصد توصیف میکنند. |
straight_line_distance_meters |
فقط خروجی. فاصله مستقیم از این مکان دیدنی تا مقصد به متر. |
travel_distance_meters |
فقط خروجی. فاصله پیادهروی از این مکان دیدنی تا مقصد به متر. |
فیلد اتحادیه landmark. نشانگر مکانی. landmark فقط میتواند یکی از موارد زیر باشد: |
|
place |
مکانی که این نقطه عطف را نشان میدهد. |
برچسب
فهرست همه برچسبهای ممکن که نحوه استفاده از مکان دیدنی را در بافت مقصد توصیف میکند.
اگر نشانیای هر دو برچسب ADDRESS و ARRIVAL را داشته باشد، یعنی آن نشانگر مکانی هم در محل برجسته است و هم به مقصد نزدیک است.
| شمارشیها | |
|---|---|
TAG_UNSPECIFIED |
استفادهنشده. |
ADDRESS |
مکانی که در منطقه شناختهشده است و میتوان از آن برای شناسایی مکان کلی مقصد استفاده کرد. معمولاً در فاصله چند صد متری مقصد. اینها شبیه به نشانهای بازگرداندهشده توسط ویژگی «توصیفکنندههای نشانی» در Geocoding API هستند: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors. |
ARRIVAL |
مکانی که میتواند برای کمک به رسیدن به مقصد استفاده شود. وقتی به مقصد نزدیک هستید، برای ناوبری مفید است. برای مثال، این مکان شاخص ممکن است مکانی باشد که در آنسوی خیابان مقصد قرار دارد. نشانگر مکانی با این برچسب معمولاً نسبتبه نشانگرهای مکانی با برچسب ADDRESS به مقصد نزدیکتر است. |
PlaceView
نمای Place را در 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 پشتیبانی میکند، بنابراین یک شیء |
address_components[] |
مؤلفههای تکراری برای هر سطح محلی. |
AddressComponent
مؤلفههای ساختاریافتهای که نشانی قالببندیشده را تشکیل میدهند، درصورت دردسترس بودن این اطلاعات.
| فیلدها | |
|---|---|
long_text |
شرح نوشتاری کامل یا نام مؤلفه نشانی. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام طولانی «استرالیا» را داشته باشد. |
short_text |
نام متنی اختصاری برای مؤلفه نشانی، درصورت وجود. برای مثال، مؤلفه نشانی برای کشور استرالیا ممکن است نام کوتاه «AU» داشته باشد. |
types[] |
آرایهای که نوع(انواع) مؤلفه نشانی را نشان میدهد. این مقادیر از جدول انواع نشانی و انواع مؤلفه نشانی که Places API از آن استفاده میکند گرفته شده است: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types |
language_code |
زبانی که برای قالببندی این مؤلفه استفاده میشود، در نماد CLDR. |
StructureType
نوع ساختاری که این مکان نشان میدهد.
| شمارشیها | |
|---|---|
STRUCTURE_TYPE_UNSPECIFIED |
استفادهنشده. |
POINT |
مکان نقطهای. |
SECTION |
زیربخشی از ساختمان. |
BUILDING |
ساختمان. |
GROUNDS |
منطقهای بزرگ که معمولاً شامل چندین ساختمان است، مانند پردیس دانشگاه، مجتمع آپارتمانی، یا مرکز خرید. |
PlusCode
Plus code (http://plus.codes) مرجع مکان با دو قالب است: کد جهانی که مستطیل ۱۴ متر در ۱۴ متر (۱/۸۰۰۰ درجه) یا کوچکتر را تعریف میکند، و کد ترکیبی که پیشوند را با مکان مرجع جایگزین میکند.
| فیلدها | |
|---|---|
global_code |
کد جهانی (کامل) مکان، مثل «9FWM33GV+HQ»، که نشاندهنده منطقهای با ابعاد ۱/۸۰۰۰ در ۱/۸۰۰۰ درجه (تقریباً ۱۴ در ۱۴ متر) است. |
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 |
اختیاری. اگر مشخص شده باشد، فقط مقصدهایی را برمیگرداند که با معیارهای آدرسپذیری مربوطه مطابقت داشته باشند. |
آدرسپذیری
گزینههای فیلتر کردن آدرسپذیری را تعریف میکند. ممکن است در آینده مقادیر جدیدی اضافه شود.
| شمارشیها | |
|---|---|
ADDRESSABILITY_UNSPECIFIED |
اگر مشخص نشده باشد، سرویس یک پیشفرض معقول را انتخاب خواهد کرد. |
ANY |
آدرسپذیری جزو معیارهای فیلتر کردن نیست. مقصدها صرفنظر از آدرسپذیر بودنشان برگردانده میشوند. |
PRIMARY |
همه مقصدهای برگرداندهشده دارای مکانی اصلی با نام یا نشانی در سطح خیابان خواهند بود. |
WEAK |
همه مقصدهای برگرداندهشده یا مکان اصلی خواهند داشت یا مقصد فرعی با نام یا نشانی سطح خیابان. |
SearchDestinationsResponse
پیام پاسخ برای DestinationService.SearchDestinations.
| فیلدها | |
|---|---|
destinations[] |
فهرستی از مقاصد. اگر مقصد اصلی را بتوان بهطور واضح از پُرسمان اصلی شناسایی کرد، این سرویس یک نتیجه برمیگرداند. درغیراینصورت، ممکن است سرویس چندین نتیجه برای ابهامزدایی یا صفر نتیجه برگرداند. |