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

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

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

جستجوی مقاصد
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} .

برچسب بزنید

ویژگی هایی که یک ورودی را توصیف می کند.

Enums
TAG_UNSPECIFIED	استفاده نشده است.
PREFERRED	ورودی احتمالاً دسترسی فیزیکی به مکان اصلی در مقصد بازگشتی را فراهم می کند. یک مکان می تواند چندین ورودی ترجیحی داشته باشد. اگر ورودی این برچسب را نداشته باشد، به این معنی است که ورودی از نظر فیزیکی روی همان ساختمانی است که مکان اصلی است، اما لزوماً دسترسی به مکان را فراهم نمی کند. برای مثال، اگر مکان اصلی یک رستوران در یک مرکز خرید استریپ باشد، ورودی‌های «ترجیح» ورودی‌هایی هستند که احتمالاً به خود رستوران منتهی می‌شوند، در حالی که ورودی‌های برگشتی دیگر ورودی‌های دیگری برای ساختمان هستند، مانند ورودی‌های رستوران‌های دیگر در مرکز خرید استریپ. اگر مکان اصلی خود یک ساختمان باشد، ورودی های PREFERRED ورودی هایی هستند که به بخش "اصلی" ساختمان منتهی می شوند. برای مثال، در یک مرکز خرید، ورودی‌های PREFERRED ورودی‌هایی هستند که امکان دسترسی به فضای سرسرا اصلی را فراهم می‌کنند، اما اگر ورودی فقط دسترسی به فروشگاهی در کنار ساختمان را فراهم کند، ورودی PREFERRED نخواهد بود. توجه: یک ورودی PREFERRED ممکن است دسترسی به مکان اصلی را فراهم نکند و یک ورودی غیر PREFERRED ممکن است دسترسی به مکان اصلی را فراهم کند.

نقطه عطف

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

فیلدها
tags[]	Landmark.Tag برچسب هایی که نحوه استفاده از نقطه عطف را در زمینه مقصد توصیف می کنند.
landmark میدان اتحادیه نقطه عطف. landmark فقط می تواند یکی از موارد زیر باشد:
place	PlaceView مکانی که نشان دهنده این نقطه عطف است.

برچسب بزنید

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

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

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

NavigationPoint

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

فیلدها
display_name	LocalizedText نام نمایشی این نقطه ناوبری. به عنوان مثال، "خیابان پنجم" یا "دروازه B".
location	LatLng نقطه ای در کنار بخش جاده که در آن ناوبری باید به پایان برسد. این نقطه عمداً کمی از خط مرکزی جاده منحرف شده است تا به وضوح کنار جاده که مکان در آن قرار دارد مشخص شود.
travel_modes[]	NavigationPoint.TravelMode حالت های سفر که برای این نقطه ناوبری مناسب است.
usages[]	NavigationPoint.Usage کاربردهای پشتیبانی شده توسط این نقطه ناوبری.

حالت سفر

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

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

استفاده

کاربردهای پشتیبانی شده توسط این نقطه ناوبری.

Enums
USAGE_UNSPECIFIED	استفاده نشده است.
UNKNOWN	نوع استفاده نامشخص اکثر نقاط ناوبری UNKNOWN خواهند بود و لزوماً به این معنی نیست که استفاده از آنها به هیچ وجه محدود شده است. این پیمایش ممکن است همچنان برای دریافت و/یا خروج مناسب باشد.
DROPOFF	مناسب برای پیاده کردن مسافر به عنوان مثال، یک مکان تخلیه اشتراکی.
PICKUP	مناسب برای سوار کردن مسافر به عنوان مثال، یک مکان سواری به اشتراک گذاشته شده است.

PlaceView

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

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

فیلدها
place	string نام منبع این مکان، در قالب places/{placeId} .
display_name	LocalizedText شرح مکان قابل خواندن توسط انسان به عنوان مثال، "Gate B"، "McDonalds"
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

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

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

جستجوی مقصدها درخواست

درخواست پیام برای 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 مکان دقیق LatLng.

Search Destinations Response

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

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