Method: searchAlongRoute

جستجوی مکان‌ها درطول مسیر سفر.

درخواست HTTP

POST https://mapstools.googleapis.com/v1alpha:searchAlongRoute

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
فیلدها
textQuery

string

الزامی. پُرسمان جستجوی زبان طبیعی (برای مثال، «شارژرهای خودرو برقی»، «قهوه»).
languageCode

string

اختیاری. زبان خلاصه و جزئیات مکان. به‌طور پیش‌فرض روی «en-US» تنظیم شده است.
regionCode

string

اختیاری. کد کشور/منطقه (CLDR) مکان (مثلاً «US»).
routingPreference

enum (RoutingPreference)

اختیاری. اولویت اختیاری مسیریابی که نحوه استفاده از داده‌های ترافیک را مشخص می‌کند. پیش‌فرض TRAFFIC_UNAWARE است.
includeExtendedDetails

boolean

اختیاری. شامل جزئیات گسترده مکان در پاسخ می‌شود.

وقتی درخواست کاربر به اطلاعات آماری کیفی غنی، پویایی‌های هم‌زمان، یا مشخصه‌های نهاد تخصصی نیاز دارد، این فیلد را روی true تنظیم کنید: - مرورهای کیفی، احساسات مشتری، و بازخورد. - پیشنهادهای ویژه خاص مانند گزینه‌های منو، غذاها، غذاهای ویژه، نوشیدنی‌ها، یا نکات برجسته کسب‌وکار. - جو کیفی، دکوراسیون داخلی، زیبایی‌شناسی، محیط، یا حال‌وهوا. - داده‌های هم‌زمان و مشخصات تسهیلات تخصصی، خط‌مشی‌ها/نکات بازدیدکننده، زمان‌های انتظار.

false (پیش‌فرض) را برای جستجوهای اکتشافی استاندارد (مثلاً غذاها، انواع فروشگاه)، جستجوهای مکان/نشانی، اطلاعات تماس، ساعت کاری، و فراداده/امکانات رفاهی استاندارد بگذارید.

فعال کردن این فیلد ممکن است باعث تأخیر بیشتر شود.
travelMode

enum (RouteTravelMode)

اختیاری. حالت سفر مورداستفاده برای محاسبه مسیر و مسیرهای انحرافی را مشخص می‌کند. پیش‌فرض‌ها به DRIVE. ‫WALK و BICYCLE فقط با routeEndpoints پشتیبانی می‌شوند. ‫TRANSIT پشتیبانی نمی‌شود.
مشخصات مسیر: یا مسیر موجود، یا توکن مسیر، یا نقاط پایانی مبدأ/مقصد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
encodedPolyline

string

رشته چندخطی کدبندی‌شده‌ای که نشان‌دهنده مسیر است. https://developers.google.com/maps/documentation/utilities/polylinealgorithm را ببینید
retrievalToken

string

یک کد بازیابی که از تماس قبلی v1alpha.computeRoutes برگردانده شده و نشان‌دهنده مسیر است.
routeEndpoints

object (RouteEndpoints)

نقاط پایانی صریح مسیر (مبدأ و مقصد).
پایان فیلدهای متقابلاً انحصاری.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از SearchAlongRouteResponse است.

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

به گستره OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/maps-platform.mapstools