Method: computeRoutes

با توجه به مجموعه ای از ایستگاه های پایانه و میانی، مسیر اصلی را به همراه مسیرهای جایگزین اختیاری برمی گرداند.

توجه: این روش مستلزم آن است که یک ماسک فیلد پاسخ را در ورودی مشخص کنید. می‌توانید ماسک فیلد پاسخ را با استفاده از پارامتر URL $fields یا fields ، یا با استفاده از هدر HTTP/gRPC X-Goog-FieldMask ارائه دهید (به پارامترها و سرصفحه‌های URL موجود مراجعه کنید). مقدار یک لیست از مسیرهای فیلد جدا شده با کاما است. به مستندات دقیق در مورد نحوه ساخت مسیرهای فیلد مراجعه کنید.

برای مثال در این روش:

  • ماسک فیلد تمام فیلدهای موجود (برای بازرسی دستی): X-Goog-FieldMask: *
  • ماسک میدانی از مدت زمان، فاصله و چند خط سطح مسیر (نمونه ای از تنظیمات تولید): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google از استفاده از ماسک فیلد پاسخ ( * ) یا مشخص کردن ماسک فیلد در سطح بالا ( routes ) جلوگیری می کند، زیرا:

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

درخواست HTTP

POST https://routes.googleapis.com/directions/v2:computeRoutes

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

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

نمایندگی JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
فیلدها
origin

object ( Waypoint )

مورد نیاز. نقطه راه مبدأ

destination

object ( Waypoint )

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

intermediates[]

object ( Waypoint )

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

travel Mode

enum ( RouteTravelMode )

اختیاری. نحوه حمل و نقل را مشخص می کند.

routing Preference

enum ( RoutingPreference )

اختیاری. نحوه محاسبه مسیر را مشخص می کند. سرور سعی می کند از اولویت مسیریابی انتخاب شده برای محاسبه مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تاخیر طولانی مدت شود، یک خطا برگردانده می شود. شما می توانید این گزینه را فقط زمانی مشخص کنید که travelMode DRIVE یا TWO_WHEELER باشد، در غیر این صورت درخواست با شکست مواجه می شود.

polyline Quality

enum ( PolylineQuality )

اختیاری. ترجیح شما را برای کیفیت پلی لاین مشخص می کند.

polyline Encoding

enum ( PolylineEncoding )

اختیاری. رمزگذاری ترجیحی برای چند خط را مشخص می کند.

departure Time

string ( Timestamp format)

اختیاری. زمان حرکت اگر این مقدار را تنظیم نکنید، این مقدار به طور پیش‌فرض روی زمانی است که درخواست را انجام داده‌اید. توجه: زمانی که RouteTravelMode روی TRANSIT تنظیم شده باشد، می‌توانید departureTime در گذشته مشخص کنید. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

arrival Time

string ( Timestamp format)

اختیاری. زمان رسیدن. توجه: فقط زمانی می توان تنظیم کرد که RouteTravelMode روی TRANSIT تنظیم شده باشد. شما می توانید departureTime یا arrivalTime را مشخص کنید، اما نه هر دو را. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

compute Alternative Routes

boolean

اختیاری. تعیین می کند که آیا مسیرهای جایگزین علاوه بر مسیر محاسبه شود یا خیر. هیچ مسیر جایگزینی برای درخواست هایی که دارای ایستگاه های بین راهی هستند بازگردانده نمی شود.

route Modifiers

object ( RouteModifiers )

اختیاری. مجموعه ای از شرایط برای برآورده شدن که بر نحوه محاسبه مسیرها تأثیر می گذارد.

language Code

string

اختیاری. کد زبان BCP-47، مانند "en-US" یا "sr-Latn". برای اطلاعات بیشتر، به شناسه محلی یونیکد مراجعه کنید. برای لیست زبان های پشتیبانی شده به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمی کنید، زبان نمایش از محل درخواست مسیر استنباط می شود.

region Code

string

اختیاری. کد منطقه که به عنوان یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") مشخص شده است. برای اطلاعات بیشتر به دامنه های سطح بالای کد کشور مراجعه کنید.

units

enum ( Units )

اختیاری. واحدهای اندازه گیری فیلدهای نمایش را مشخص می کند. این فیلدها شامل فیلد instruction در NavigationInstruction است. واحدهای اندازه گیری مورد استفاده برای مسیر، پا، فاصله گام، و مدت زمان تحت تأثیر این مقدار قرار نمی گیرند. اگر این مقدار را ارائه نکنید، واحدهای نمایش از محل مبدا اول استنتاج می شوند.

optimize Waypoint Order

boolean

اختیاری. اگر روی true تنظیم شود، سرویس تلاش می کند تا هزینه کلی مسیر را با مرتب کردن مجدد ایستگاه های بین راهی مشخص شده به حداقل برساند. در صورتی که هر یک از ایستگاه های بین راهی یک ایستگاه via راهی باشد، درخواست با شکست مواجه می شود. از ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index برای پیدا کردن سفارش جدید استفاده کنید. اگر ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index در هدر X-Goog-FieldMask درخواست نشود، درخواست با شکست مواجه می شود. اگر optimizeWaypointOrder روی false تنظیم شود، ComputeRoutesResponse.optimized_intermediate_waypoint_index خالی خواهد بود.

requested Reference Routes[]

enum ( ReferenceRoute )

اختیاری. مشخص می کند چه مسیرهای مرجعی علاوه بر مسیر پیش فرض به عنوان بخشی از درخواست محاسبه شود. مسیر مرجع مسیری با هدف محاسبه مسیر متفاوت از مسیر پیش‌فرض است. برای مثال یک محاسبه مسیر مرجع FUEL_EFFICIENT پارامترهای مختلفی را در نظر می گیرد که یک مسیر کارآمد سوخت بهینه ایجاد می کند. هنگام استفاده از این ویژگی، به دنبال routeLabels در مسیرهای حاصل بگردید.

extra Computations[]

enum ( ExtraComputation )

اختیاری. فهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ بازگرداند. این فیلدهای اضافی نیز باید در فیلد ماسک برای بازگشت در پاسخ مشخص شوند.

traffic Model

enum ( TrafficModel )

اختیاری. مفروضاتی را برای محاسبه زمان در ترافیک مشخص می کند. این تنظیم بر مقدار بازگشتی در قسمت مدت زمان در Route و RouteLeg تأثیر می‌گذارد که شامل زمان پیش‌بینی‌شده در ترافیک بر اساس میانگین‌های تاریخی است. TrafficModel فقط برای درخواست‌هایی در دسترس است که RoutingPreference روی TRAFFIC_AWARE_OPTIMAL و RouteTravelMode را روی DRIVE تنظیم کرده‌اند. اگر ترافیک درخواست شده باشد و TrafficModel مشخص نشده باشد به BEST_GUESS پیش‌فرض می‌شود.

transit Preferences

object ( TransitPreferences )

اختیاری. تنظیمات برگزیده را مشخص می کند که بر مسیر برگشتی برای مسیرهای TRANSIT تأثیر می گذارد. توجه: زمانی که RouteTravelMode روی TRANSIT تنظیم شده باشد، می توانید یک transitPreferences مشخص کنید.

بدن پاسخگو

v2.compute پیام پاسخ را مسیریابی می کند.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
فیلدها
routes[]

object ( Route )

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

fallback Info

object ( FallbackInfo )

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

geocoding Results

object ( GeocodingResults )

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

کیفیت پلی لاین

مجموعه ای از مقادیر که کیفیت چند خط را مشخص می کند.

Enums
POLYLINE_QUALITY_UNSPECIFIED هیچ اولویت کیفیت چند خطی مشخص نشده است. به طور پیش‌فرض به OVERVIEW .
HIGH_QUALITY یک خط چند خطی با کیفیت بالا را مشخص می کند - که با استفاده از نقاط بیشتری نسبت به OVERVIEW ساخته شده است، به قیمت افزایش اندازه پاسخ. زمانی که به دقت بیشتری نیاز دارید از این مقدار استفاده کنید.
OVERVIEW یک چند خط نمای کلی را مشخص می کند - که با استفاده از تعداد کمی از نقاط تشکیل شده است. هنگام نمایش یک نمای کلی از مسیر از این مقدار استفاده کنید. استفاده از این گزینه در مقایسه با استفاده از گزینه HIGH_QUALITY تاخیر درخواست کمتری دارد.

PolylineEncoding

نوع ترجیحی چند خطی که باید برگردانده شود را مشخص می کند.

Enums
POLYLINE_ENCODING_UNSPECIFIED هیچ نوع اولویت چند خطی مشخص نشده است. پیش‌فرض ENCODED_POLYLINE است.
ENCODED_POLYLINE چند خطی را مشخص می کند که با استفاده از الگوریتم کدگذاری چند خطی کدگذاری شده است.
GEO_JSON_LINESTRING با استفاده از قالب GeoJSON LineString یک چند خط را مشخص می کند

ReferenceRoute

یک مسیر مرجع پشتیبانی شده در ComputeRoutesRequest.

Enums
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار با شکست مواجه می شوند.
FUEL_EFFICIENT مسیر مصرف سوخت
SHORTER_DISTANCE

مسیری با مسافت سفر کمتر. این یک ویژگی آزمایشی است.

برای درخواست‌های DRIVE ، این ویژگی مسافت کوتاه‌تر را به راحتی رانندگی اولویت می‌دهد. برای مثال، ممکن است جاده‌های محلی را به جای بزرگراه‌ها ترجیح دهد، از جاده‌های خاکی استفاده کند، پارکینگ‌ها را قطع کند، و غیره.

برای درخواست‌های BICYCLE و TWO_WHEELER ، این ویژگی مسیرهایی مشابه مسیرهایی را برمی‌گرداند که زمانی که requestedReferenceRoutes مشخص نکنید، بازمی‌گردد.

این ویژگی با هیچ حالت سفر دیگری، از طریق ایستگاه های بین راهی، یا optimizeWaypointOrder سازگار نیست. چنین درخواست هایی با شکست مواجه خواهند شد. با این حال، می توانید از آن با هر routingPreference استفاده کنید.

محاسبات اضافی

محاسبات اضافی برای انجام در هنگام تکمیل درخواست.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار با شکست مواجه خواهند شد.
TOLLS اطلاعات عوارض برای مسیر(های)
FUEL_CONSUMPTION مصرف سوخت تخمینی برای مسیر(های)
TRAFFIC_ON_POLYLINE چند خط آگاه از ترافیک برای مسیر(های)
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions به عنوان یک رشته متن فرمت شده HTML ارائه شده است. این محتوا باید همانطور که هست خوانده شود. این محتوا فقط برای نمایش است. به صورت برنامه نویسی آن را تجزیه نکنید.
FLYOVER_INFO_ON_POLYLINE اطلاعات پرواز برای مسیر(های) برای بازگرداندن این اطلاعات، فیلد ماسک routes.polyline_details.flyover_info باید مشخص شود. این داده ها در حال حاضر فقط برای متروهای خاصی در هند پر می شود. این ویژگی آزمایشی است و SKU/هزینه ممکن است تغییر کند.
NARROW_ROAD_INFO_ON_POLYLINE اطلاعات جاده باریک برای مسیر(ها). برای بازگرداندن این اطلاعات، فیلد ماسک routes.polyline_details.narrow_road_info باید مشخص شود. این داده ها در حال حاضر فقط برای متروهای خاصی در هند پر می شود. این ویژگی آزمایشی است و SKU/هزینه ممکن است تغییر کند.

مسیر

شامل یک مسیر است که شامل یک سری از بخش های جاده متصل است که به ایستگاه های ابتدایی، انتهایی و میانی می پیوندند.

نمایندگی JSON
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string,
  "polylineDetails": {
    object (PolylineDetails)
  }
}
فیلدها
route Labels[]

enum ( RouteLabel )

برچسب‌هایی برای Route که برای شناسایی ویژگی‌های خاص مسیر برای مقایسه با دیگران مفید هستند.

legs[]

object ( RouteLeg )

مجموعه ای از پاها (بخش های مسیر بین ایستگاه های بین راه) که مسیر را تشکیل می دهند. هر پا مربوط به سفر بین دو Waypoints غیر via است. به عنوان مثال، مسیری که هیچ ایستگاه بین راهی ندارد، تنها یک پا دارد. مسیری که شامل یک ایستگاه بین راهی غیر via ، دو پا دارد. مسیری که شامل یک مسیر via ایستگاه بین راهی است، یک پا دارد. ترتیب پاها با ترتیب ایستگاه های بین راه از origin تا intermediates تا destination مطابقت دارد.

distance Meters

integer

مسافت طی مسیر، بر حسب متر.

duration

string ( Duration format)

مدت زمان لازم برای پیمایش مسیر. اگر routingPreference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار همان staticDuration است. اگر routingPreference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

static Duration

string ( Duration format)

مدت زمان سفر در مسیر بدون در نظر گرفتن شرایط ترافیکی.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

polyline

object ( Polyline )

چند خط کلی مسیر. این چند خط، چند خط ترکیبی همه legs است.

description

string

شرح مسیر.

warnings[]

string

مجموعه ای از هشدارها برای نشان دادن هنگام نمایش مسیر.

viewport

object ( Viewport )

کادر محدودکننده نما در چند خط.

travel Advisory

object ( RouteTravelAdvisory )

اطلاعات تکمیلی در مورد مسیر.

optimized Intermediate Waypoint Index[]

integer

اگر optimizeWaypointOrder روی true تنظیم کنید، این فیلد شامل ترتیب بهینه شده نقاط بین راهی است. در غیر این صورت این قسمت خالی است. برای مثال، اگر ورودی Origin را بدهید: LA; ایستگاه های بین راهی: دالاس، بانگور، فینیکس؛ مقصد: نیویورک؛ و ترتیب میانی بهینه شده Phoenix، Dallas، Bangor است، سپس این فیلد حاوی مقادیر [2، 0، 1] است. شاخص با 0 برای اولین نقطه میانی ارائه شده در ورودی شروع می شود.

localized Values

object ( RouteLocalizedValues )

نمایش متنی ویژگی های Route .

route Token

string

یک نشانه مات که می تواند به Navigation SDK منتقل شود تا مسیر را در حین ناوبری بازسازی کند و در صورت تغییر مسیر، به هدف اصلی هنگام ایجاد مسیر احترام بگذارد. با این نشانه به عنوان یک لکه مات رفتار کنید. مقدار آن را در بین درخواست‌ها مقایسه نکنید زیرا ممکن است ارزش آن تغییر کند حتی اگر سرویس دقیقاً همان مسیر را برگرداند.

توجه: Route.route_token فقط برای درخواست‌هایی در دسترس است که ComputeRoutesRequest.routing_preference روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کرده‌اند. Route.route_token برای درخواست هایی که دارای ایستگاه های بین راه هستند پشتیبانی نمی شود.

polyline Details

object ( PolylineDetails )

حاوی اطلاعاتی درباره جزئیات در امتداد چند خط است.

RouteLabel

برچسب‌هایی برای Route که برای شناسایی ویژگی‌های خاص مسیر برای مقایسه با دیگران مفید هستند.

Enums
ROUTE_LABEL_UNSPECIFIED پیش فرض - استفاده نشده است.
DEFAULT_ROUTE مسیر پیش‌فرض "بهترین" برای محاسبه مسیر برگردانده شد.
DEFAULT_ROUTE_ALTERNATE جایگزینی برای مسیر پیش‌فرض "بهترین" زمانی که computeAlternativeRoutes مشخص شده باشد، مسیرهایی مانند این برگردانده می شوند.
FUEL_EFFICIENT مسیر مصرف سوخت مسیرهایی که با این مقدار برچسب گذاری شده اند برای پارامترهای Eco مانند مصرف سوخت بهینه شده اند.
SHORTER_DISTANCE مسافت سفر کوتاه تر. این یک ویژگی آزمایشی است.

RouteLeg

شامل یک بخش بین ایستگاه های غیر via .

نمایندگی JSON
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
فیلدها
distance Meters

integer

مسافت طی مسیر، بر حسب متر.

duration

string ( Duration format)

مدت زمان لازم برای حرکت در پا. اگر route_preference روی TRAFFIC_UNAWARE تنظیم شود، این مقدار همان staticDuration است. اگر route_preference یا TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL باشد، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

static Duration

string ( Duration format)

مدت زمان سفر از طریق پا، بدون در نظر گرفتن شرایط ترافیک محاسبه شده است.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

polyline

object ( Polyline )

چند خط کلی برای این پا که شامل چند خط هر step است.

start Location

object ( Location )

محل شروع این پا. این مکان ممکن است با origin ارائه شده متفاوت باشد. به عنوان مثال، زمانی که origin ارائه شده نزدیک جاده نباشد، این نقطه ای از جاده است.

end Location

object ( Location )

محل انتهایی این پا. این مکان ممکن است با destination ارائه شده متفاوت باشد. به عنوان مثال، زمانی که destination ارائه شده نزدیک جاده ای نباشد، این نقطه ای در جاده است.

steps[]

object ( RouteLegStep )

مجموعه‌ای از مراحل که بخش‌های درون این پا را نشان می‌دهد. هر مرحله نشان دهنده یک دستورالعمل ناوبری است.

travel Advisory

object ( RouteLegTravelAdvisory )

حاوی اطلاعات اضافی است که کاربر باید از آنها مطلع شود، مانند محدودیت های احتمالی منطقه ترافیک، در یک مسیر.

localized Values

object ( RouteLegLocalizedValues )

نمایش متنی ویژگی های RouteLeg .

steps Overview

object ( StepsOverview )

اطلاعات کلی در مورد مراحل این RouteLeg . این قسمت فقط برای مسیرهای TRANSIT پر شده است.

پلی لاین

یک چند خط کدگذاری شده را در بر می گیرد.

نمایندگی JSON
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
فیلدها
فیلد اتحادیه polyline_type . نوع پلی لاین را کپسوله می کند. پیش‌فرض encoded_polyline است. polyline_type می تواند تنها یکی از موارد زیر باشد:
encoded Polyline

string

رمزگذاری رشته چند خط با استفاده از الگوریتم کدگذاری چند خطی

geo Json Linestring

object ( Struct format)

با استفاده از قالب GeoJSON LineString یک چند خط را مشخص می کند.

RouteLegStep

شامل بخشی از RouteLeg است. یک مرحله مربوط به یک دستورالعمل ناوبری است. پایه های مسیر از پله ها تشکیل شده است.

نمایندگی JSON
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
فیلدها
distance Meters

integer

مسافت طی این مرحله، بر حسب متر است. در برخی شرایط، این فیلد ممکن است ارزشی نداشته باشد.

static Duration

string ( Duration format)

مدت زمان سفر در این مرحله بدون در نظر گرفتن شرایط ترافیکی. در برخی شرایط، این فیلد ممکن است ارزشی نداشته باشد.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

polyline

object ( Polyline )

چند خط مرتبط با این مرحله.

start Location

object ( Location )

محل شروع این مرحله.

end Location

object ( Location )

محل پایان این مرحله.

navigation Instruction

object ( NavigationInstruction )

دستورالعمل های ناوبری.

travel Advisory

object ( RouteLegStepTravelAdvisory )

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

localized Values

object ( RouteLegStepLocalizedValues )

نمایش متنی خصوصیات RouteLegStep .

transit Details

object ( RouteLegStepTransitDetails )

جزئیات مربوط به این مرحله اگر حالت سفر TRANSIT باشد.

travel Mode

enum ( RouteTravelMode )

حالت سفر استفاده شده برای این مرحله.

مانور

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

Enums
MANEUVER_UNSPECIFIED استفاده نشده است.
TURN_SLIGHT_LEFT کمی به سمت چپ بپیچید.
TURN_SHARP_LEFT به شدت به سمت چپ بپیچید.
UTURN_LEFT یک چرخش به چپ انجام دهید.
TURN_LEFT به چپ بپیچید.
TURN_SLIGHT_RIGHT کمی به سمت راست بپیچید.
TURN_SHARP_RIGHT به شدت به سمت راست بپیچید.
UTURN_RIGHT یک دور به راست بپیچید.
TURN_RIGHT به راست بپیچید.
STRAIGHT مستقیم برو
RAMP_LEFT از سطح شیب دار سمت چپ بروید.
RAMP_RIGHT از رمپ سمت راست بروید.
MERGE ادغام در ترافیک
FORK_LEFT چنگال چپ را بردارید.
FORK_RIGHT چنگال مناسب را بردارید.
FERRY سوار کشتی شوید.
FERRY_TRAIN سوار قطار منتهی به کشتی شوید.
ROUNDABOUT_LEFT در دوربرگردان به چپ بپیچید.
ROUNDABOUT_RIGHT در دوربرگردان به راست بپیچید.
DEPART مانور اولیه
NAME_CHANGE برای نشان دادن تغییر نام خیابان استفاده می شود.

RouteLegStepTravelAdvisory

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

نمایندگی JSON
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
speed Reading Intervals[]

object ( SpeedReadingInterval )

توجه: این فیلد در حال حاضر پر نشده است.

RouteLegStepLocalizedValues

نمایش متنی از ویژگی های خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

مسافت سفر به صورت متنی نشان داده شده است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

RouteLegStepTransitDetails

اطلاعات اضافی برای RouteLegStep مربوط به مسیرهای TRANSIT .

نمایندگی JSON
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
فیلدها
stop Details

object ( TransitStopDetails )

اطلاعات در مورد ورود و خروج توقف برای مرحله.

localized Values

object ( TransitDetailsLocalizedValues )

نمایش متنی خصوصیات RouteLegStepTransitDetails .

headsign

string

جهت حرکت در این خط را همانطور که روی وسیله نقلیه یا در ایستگاه خروج مشخص شده است مشخص می کند. جهت اغلب ایستگاه پایانه است.

headway

string ( Duration format)

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

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

transit Line

object ( TransitLine )

اطلاعات مربوط به خط ترانزیت مورد استفاده در این مرحله.

stop Count

integer

تعداد توقف ها از مبدأ تا توقف ورود. این شمارش شامل توقف ورود است، اما توقف خروج را شامل نمی شود. به عنوان مثال، اگر مسیر شما از ایستگاه A حرکت کند، از ایستگاه های B و C عبور کند و به ایستگاه D برسد،

stopCount

برمی گرداند 3.

trip Short Text

string

متنی که در جدول ها و تابلوهای علامت برای شناسایی یک سفر ترانزیت به مسافران ظاهر می شود. متن باید به طور منحصر به فرد یک سفر در یک روز خدمات را مشخص کند. به عنوان مثال، "538" tripShortText قطار Amtrak است که سن خوزه، کالیفرنیا را در ساعت 15:10 روزهای هفته به سمت ساکرامنتو، کالیفرنیا ترک می کند.

TransitStopDetails

جزئیات در مورد توقف های حمل و نقل برای RouteLegStep .

نمایندگی JSON
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
فیلدها
arrival Stop

object ( TransitStop )

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

arrival Time

string ( Timestamp format)

زمان تخمینی رسیدن به مرحله.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

departure Stop

object ( TransitStop )

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

departure Time

string ( Timestamp format)

زمان تخمینی حرکت برای مرحله.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

TransitStop

اطلاعات در مورد ایستگاه حمل و نقل

نمایندگی JSON
{
  "name": string,
  "location": {
    object (Location)
  }
}
فیلدها
name

string

نام ایستگاه حمل و نقل.

location

object ( Location )

محل توقف با مختصات طول و عرض جغرافیایی بیان می شود.

TransitDetailsLocalizedValues

توضیحات محلی مقادیر برای RouteTransitDetails .

نمایندگی JSON
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
فیلدها
arrival Time

object ( LocalizedTime )

زمان در نمایش متن قالب بندی شده با منطقه زمانی مربوطه.

departure Time

object ( LocalizedTime )

زمان در نمایش متن قالب بندی شده با منطقه زمانی مربوطه.

LocalizedTime

توصیف موضعی زمان

نمایندگی JSON
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
فیلدها
time

object ( LocalizedText )

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

time Zone

string

شامل منطقه زمانی است. مقدار، نام منطقه زمانی است که در پایگاه داده منطقه زمانی IANA تعریف شده است، به عنوان مثال "America/New_York".

ترانزیت لاین

حاوی اطلاعاتی در مورد خط حمل و نقل مورد استفاده در این مرحله است.

نمایندگی JSON
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
فیلدها
agencies[]

object ( TransitAgency )

آژانس حمل و نقل (یا آژانس هایی) که این خط ترانزیت را اداره می کند.

name

string

نام کامل این خط ترانزیت، به عنوان مثال، "8 Avenue Local".

uri

string

URI این خط ترانزیت که توسط آژانس حمل و نقل ارائه شده است.

color

string

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

icon Uri

string

URI برای نماد مرتبط با این خط.

name Short

string

نام کوتاه این خط ترانزیت. این نام معمولاً یک شماره خط است، مانند "M7" یا "355".

text Color

string

رنگی که معمولاً در متن روی تابلوهای این خط استفاده می شود. در هگزادسیمال نشان داده شده است.

vehicle

object ( TransitVehicle )

نوع وسیله نقلیه ای که در این خط ترانزیتی تردد می کند.

آژانس ترانزیت

آژانس ترانزیت که یک خط ترانزیت را اداره می کند.

نمایندگی JSON
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
فیلدها
name

string

نام این آژانس حمل و نقل.

phone Number

string

شماره تلفن قالب‌بندی شده آژانس حمل و نقل.

uri

string

URI آژانس حمل و نقل.

وسیله نقلیه ترانزیت

اطلاعات در مورد وسیله نقلیه مورد استفاده در مسیرهای حمل و نقل.

نمایندگی JSON
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
فیلدها
name

object ( LocalizedText )

نام این وسیله نقلیه با حروف بزرگ نوشته شده است.

type

enum ( TransitVehicleType )

نوع وسیله نقلیه مورد استفاده.

icon Uri

string

URI برای نماد مرتبط با این نوع خودرو.

local Icon Uri

string

URI برای نماد مرتبط با این نوع وسیله نقلیه، بر اساس علائم حمل و نقل محلی.

Transit VehicleType

نوع وسایل نقلیه برای مسیرهای ترانزیتی.

Enums
TRANSIT_VEHICLE_TYPE_UNSPECIFIED استفاده نشده
BUS اتوبوس
CABLE_CAR وسیله نقلیه ای که روی کابل، معمولاً روی زمین کار می کند. تله کابین های هوایی ممکن است از نوع GONDOLA_LIFT باشند.
COMMUTER_TRAIN راه آهن شهری.
FERRY فری
FUNICULAR وسیله نقلیه ای که توسط کابل از شیب تند بالا کشیده می شود. یک فونیکولار معمولاً از دو اتومبیل تشکیل شده است که هر اتومبیل به عنوان وزنه تعادل برای دیگری عمل می کند.
GONDOLA_LIFT یک تله کابین هوایی.
HEAVY_RAIL ریل سنگین
HIGH_SPEED_TRAIN قطار پر سرعت.
INTERCITY_BUS اتوبوس بین شهری.
LONG_DISTANCE_TRAIN قطار راه دور.
METRO_RAIL حمل و نقل ریلی سبک.
MONORAIL مونوریل.
OTHER همه وسایل نقلیه دیگر
RAIL راه آهن.
SHARE_TAXI تاکسی اشتراکی نوعی اتوبوس با قابلیت جابجایی و جابجایی مسافران در هر نقطه از مسیر است.
SUBWAY راه آهن زیرزمینی.
TRAM ریل نوری روی زمین.
TROLLEYBUS ترولی بوس.

RouteLegTravelAdvisory

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

نمایندگی JSON
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
toll Info

object ( TollInfo )

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

speed Reading Intervals[]

object ( SpeedReadingInterval )

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

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

RouteLegLocalizedValues

نمایش متنی از ویژگی های خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

مسافت سفر به صورت متنی نشان داده شده است.

duration

object ( LocalizedText )

مدت زمان، به صورت متن نمایش داده شده و به منطقه پرس و جو بومی سازی شده است. شرایط ترافیکی را در نظر می گیرد. توجه: اگر اطلاعات ترافیک را درخواست نکرده اید، این مقدار همان مقدار staticDuration است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

StepsOverview

اطلاعات کلی درباره لیستی از RouteLegStep را ارائه می دهد.

نمایندگی JSON
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
فیلدها
multi Modal Segments[]

object ( MultiModalSegment )

اطلاعات خلاصه شده در مورد بخش های مختلف چند وجهی RouteLeg.steps . اگر RouteLeg شامل بخش‌های چند وجهی در مراحل نباشد، این فیلد پر نمی‌شود.

MultiModalSegment

اطلاعات خلاصه ای را در مورد بخش های مختلف چند وجهی RouteLeg.steps ارائه می دهد. یک بخش چند وجهی به عنوان یک یا چند RouteLegStep به هم پیوسته تعریف می‌شود که RouteTravelMode یکسان دارند. اگر RouteLeg شامل بخش‌های چند وجهی در مراحل نباشد، این فیلد پر نمی‌شود.

نمایندگی JSON
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
فیلدها
navigation Instruction

object ( NavigationInstruction )

راهنمای ناوبری برای بخش چند وجهی.

travel Mode

enum ( RouteTravelMode )

حالت سفر بخش چند وجهی.

step Start Index

integer

شاخص RouteLegStep مربوطه که شروع یک بخش چند وجهی است.

step End Index

integer

شاخص RouteLegStep مربوطه که انتهای یک بخش چند وجهی است.

درگاه دید

یک نمای طول و عرض جغرافیایی که به صورت دو نقطه low و high به صورت مورب در مقابل هم نمایش داده می شود. یک viewport یک منطقه بسته در نظر گرفته می شود، یعنی شامل مرز آن می شود. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. موارد مختلف عبارتند از:

  • اگر low = high ، نمای از همان نقطه واحد تشکیل شده است.

  • اگر low.longitude > high.longitude , محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).

  • اگر low.longitude = -180 درجه و high.longitude = 180 درجه باشد، درگاه دید شامل تمام طول‌های جغرافیایی می‌شود.

  • اگر low.longitude = 180 درجه و high.longitude = -180 درجه باشد، محدوده طول جغرافیایی خالی است.

  • اگر low.latitude > high.latitude ، محدوده عرض جغرافیایی خالی است.

هر دو low و high باید پر شوند و کادر نمایش داده شده نمی تواند خالی باشد (همانطور که در تعاریف بالا مشخص شده است). یک نمای خالی منجر به خطا می شود.

به عنوان مثال، این نما به طور کامل شهر نیویورک را در بر می گیرد:

{ "low": { "Latitude": 40.477398, "Litude": -74.259087 }, "high": { "Latitude": 40.91618, "Latitude": -73.70018 } }

نمایندگی JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
فیلدها
low

object ( LatLng )

مورد نیاز. نقطه پایین دید.

high

object ( LatLng )

مورد نیاز. نقطه اوج دید.

RouteLocalizedValues

نمایش متنی از ویژگی های خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

مسافت سفر به صورت متنی نشان داده شده است.

duration

object ( LocalizedText )

مدت زمان، به صورت متن نمایش داده شده و به منطقه پرس و جو بومی سازی شده است. شرایط ترافیکی را در نظر می گیرد. توجه: اگر اطلاعات ترافیک را درخواست نکرده‌اید، این مقدار همان مقدار staticDuration است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

transit Fare

object ( LocalizedText )

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

جزئیات Polyline

جزئیات مربوط به یک شاخص داده شده یا بخش پیوسته از یک چند خط. با توجه به چند خطی با نقاط P_0، P_1، ...، P_N (شاخص مبتنی بر صفر)، PolylineDetails یک بازه و ابرداده مرتبط را تعریف می کند.

نمایندگی JSON
{
  "flyoverInfo": [
    {
      object (FlyoverInfo)
    }
  ],
  "narrowRoadInfo": [
    {
      object (NarrowRoadInfo)
    }
  ]
}
فیلدها
flyover Info[]

object ( FlyoverInfo )

جزئیات پرواز در امتداد چند خط.

narrow Road Info[]

object ( NarrowRoadInfo )

جزئیات جاده باریک در امتداد چند خط.

FlyoverInfo

اطلاعات مربوط به پل هوایی را در امتداد چند خط در خود محصور می کند.

نمایندگی JSON
{
  "flyoverPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
flyover Presence

enum ( RoadFeatureState )

فقط خروجی نشان می دهد که آیا یک پل هوایی برای یک کشش معین از چند خط وجود دارد یا خیر.

polyline Point Index

object ( PolylinePointIndex )

مکان اطلاعات مربوط به پل هوایی در امتداد چند خط.

RoadFeatureState

حالت های ویژگی های جاده را در امتداد یک خط چند خطی در بر می گیرد.

Enums
ROAD_FEATURE_STATE_UNSPECIFIED وضعیت ویژگی جاده محاسبه نشده است (مقدار پیش فرض).
EXISTS ویژگی جاده وجود دارد.
DOES_NOT_EXIST ویژگی جاده وجود ندارد.

PolylinePointIndex

نمایه های شروع و پایان را برای جزئیات چند خطی در بر می گیرد. برای نمونه هایی که داده ها با یک نقطه منطبق است، startIndex و endIndex برابر خواهند بود.

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer
}
فیلدها
start Index

integer

شاخص شروع این جزئیات در چند خط.

end Index

integer

شاخص انتهایی این جزئیات در چند خط.

NarrowRoadInfo

اطلاعات مربوط به جاده های باریک در امتداد چند خط را در بر می گیرد.

نمایندگی JSON
{
  "narrowRoadPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
narrow Road Presence

enum ( RoadFeatureState )

فقط خروجی نشان می دهد که آیا یک جاده باریک برای یک کشش معین از چند خط وجود دارد یا خیر.

polyline Point Index

object ( PolylinePointIndex )

مکان اطلاعات مربوط به جاده باریک در امتداد چند خط.

نتایج جغرافیایی

شامل GeocodedWaypoints برای مبدا، مقصد و ایستگاه های بین راهی. فقط برای نقاط راه آدرس پر شده است.

نمایندگی JSON
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
فیلدها
origin

object ( GeocodedWaypoint )

نقطه بین مسیرهای جغرافیایی کدگذاری شده مبدا.

destination

object ( GeocodedWaypoint )

نقطه گذر جغرافیایی مقصد.

intermediates[]

object ( GeocodedWaypoint )

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

GeocedWaypoint

جزئیات در مورد مکان های استفاده شده به عنوان ایستگاه های بین راه. فقط برای نقاط راه آدرس پر شده است. شامل جزئیاتی در مورد نتایج کدگذاری جغرافیایی به منظور تعیین اینکه آدرس به چه مکانی کدگذاری شده است.

نمایندگی JSON
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
فیلدها
geocoder Status

object ( Status )

کد وضعیت حاصل از عملیات کدگذاری جغرافیایی را نشان می دهد.

type[]

string

نوع (های) نتیجه، به صورت تگ های صفر یا بیشتر. انواع پشتیبانی شده: انواع آدرس و انواع اجزای آدرس .

partial Match

boolean

نشان می دهد که geocoder مطابقت دقیقی با درخواست اصلی برنگردانده است، اگرچه می تواند بخشی از آدرس درخواستی را مطابقت دهد. ممکن است بخواهید درخواست اصلی برای غلط املایی و/یا آدرس ناقص را بررسی کنید.

place Id

string

شناسه مکان برای این نتیجه.

intermediate Waypoint Request Index

integer

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

،

با توجه به مجموعه ای از ایستگاه های پایانه و میانی، مسیر اصلی را به همراه مسیرهای جایگزین اختیاری برمی گرداند.

توجه: این روش مستلزم آن است که یک ماسک فیلد پاسخ را در ورودی مشخص کنید. می‌توانید ماسک فیلد پاسخ را با استفاده از پارامتر URL $fields یا fields ، یا با استفاده از هدر HTTP/gRPC X-Goog-FieldMask ارائه دهید (به پارامترها و سرصفحه‌های URL موجود مراجعه کنید). مقدار یک لیست از مسیرهای فیلد جدا شده با کاما است. به مستندات دقیق در مورد نحوه ساخت مسیرهای فیلد مراجعه کنید.

برای مثال در این روش:

  • ماسک فیلد تمام فیلدهای موجود (برای بازرسی دستی): X-Goog-FieldMask: *
  • ماسک میدانی از مدت زمان، فاصله و چند خط سطح مسیر (نمونه ای از تنظیمات تولید): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google از استفاده از ماسک فیلد پاسخ ( * ) یا مشخص کردن ماسک فیلد در سطح بالا ( routes ) جلوگیری می کند، زیرا:

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

درخواست HTTP

POST https://routes.googleapis.com/directions/v2:computeRoutes

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

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

نمایندگی JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
فیلدها
origin

object ( Waypoint )

مورد نیاز. نقطه راه مبدأ

destination

object ( Waypoint )

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

intermediates[]

object ( Waypoint )

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

travel Mode

enum ( RouteTravelMode )

اختیاری. نحوه حمل و نقل را مشخص می کند.

routing Preference

enum ( RoutingPreference )

اختیاری. نحوه محاسبه مسیر را مشخص می کند. سرور سعی می کند از اولویت مسیریابی انتخاب شده برای محاسبه مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تاخیر طولانی مدت شود، یک خطا برگردانده می شود. شما می توانید این گزینه را فقط زمانی مشخص کنید که travelMode DRIVE یا TWO_WHEELER باشد، در غیر این صورت درخواست با شکست مواجه می شود.

polyline Quality

enum ( PolylineQuality )

اختیاری. ترجیح شما را برای کیفیت پلی لاین مشخص می کند.

polyline Encoding

enum ( PolylineEncoding )

اختیاری. رمزگذاری ترجیحی برای چند خط را مشخص می کند.

departure Time

string ( Timestamp format)

اختیاری. زمان حرکت اگر این مقدار را تنظیم نکنید، این مقدار به طور پیش‌فرض روی زمانی است که درخواست را انجام داده‌اید. توجه: زمانی که RouteTravelMode روی TRANSIT تنظیم شده باشد، می‌توانید departureTime در گذشته مشخص کنید. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

arrival Time

string ( Timestamp format)

اختیاری. زمان رسیدن. توجه: فقط زمانی می توان تنظیم کرد که RouteTravelMode روی TRANSIT تنظیم شده باشد. شما می توانید departureTime یا arrivalTime را مشخص کنید، اما نه هر دو را. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

compute Alternative Routes

boolean

اختیاری. تعیین می کند که آیا مسیرهای جایگزین علاوه بر مسیر محاسبه شود یا خیر. هیچ مسیر جایگزینی برای درخواست هایی که دارای ایستگاه های بین راهی هستند بازگردانده نمی شود.

route Modifiers

object ( RouteModifiers )

اختیاری. مجموعه ای از شرایط برای برآورده شدن که بر نحوه محاسبه مسیرها تأثیر می گذارد.

language Code

string

اختیاری. کد زبان BCP-47، مانند "en-US" یا "sr-Latn". برای اطلاعات بیشتر، به شناسه محلی یونیکد مراجعه کنید. برای لیست زبان های پشتیبانی شده به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمی کنید، زبان نمایش از محل درخواست مسیر استنباط می شود.

region Code

string

اختیاری. کد منطقه که به عنوان یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") مشخص شده است. برای اطلاعات بیشتر به دامنه های سطح بالای کد کشور مراجعه کنید.

units

enum ( Units )

اختیاری. واحدهای اندازه گیری فیلدهای نمایش را مشخص می کند. این فیلدها شامل فیلد instruction در NavigationInstruction است. واحدهای اندازه گیری مورد استفاده برای مسیر، پا، فاصله گام، و مدت زمان تحت تأثیر این مقدار قرار نمی گیرند. اگر این مقدار را ارائه نکنید، واحدهای نمایش از محل مبدا اول استنتاج می شوند.

optimize Waypoint Order

boolean

اختیاری. اگر روی true تنظیم شود، سرویس تلاش می کند تا هزینه کلی مسیر را با مرتب کردن مجدد ایستگاه های بین راهی مشخص شده به حداقل برساند. در صورتی که هر یک از ایستگاه های بین راهی یک ایستگاه via راهی باشد، درخواست با شکست مواجه می شود. از ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index برای پیدا کردن سفارش جدید استفاده کنید. اگر ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index در هدر X-Goog-FieldMask درخواست نشود، درخواست با شکست مواجه می شود. اگر optimizeWaypointOrder روی false تنظیم شود، ComputeRoutesResponse.optimized_intermediate_waypoint_index خالی خواهد بود.

requested Reference Routes[]

enum ( ReferenceRoute )

اختیاری. مشخص می کند چه مسیرهای مرجعی علاوه بر مسیر پیش فرض به عنوان بخشی از درخواست محاسبه شود. مسیر مرجع مسیری با هدف محاسبه مسیر متفاوت از مسیر پیش‌فرض است. به عنوان مثال ، یک محاسبه مسیر مرجع FUEL_EFFICIENT پارامترهای مختلفی را در نظر می گیرد که می تواند یک مسیر بهینه سوخت را تولید کند. هنگام استفاده از این ویژگی ، به دنبال routeLabels در مسیرهای حاصل باشید.

extra Computations[]

enum ( ExtraComputation )

اختیاری. لیستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است زمینه های اضافی را در پاسخ بازگرداند. این زمینه های اضافی نیز باید در ماسک میدانی مشخص شود که در پاسخ برگردانده شود.

traffic Model

enum ( TrafficModel )

اختیاری. فرضیات استفاده شده در هنگام محاسبه زمان در ترافیک را مشخص می کند. این تنظیم بر مقدار برگشتی در زمینه مدت زمان در Route و RouteLeg که حاوی زمان پیش بینی شده در ترافیک بر اساس میانگین های تاریخی است ، تأثیر می گذارد. TrafficModel فقط برای درخواست هایی که RoutingPreference DRIVE TRAFFIC_AWARE_OPTIMAL و RouteTravelMode تنظیم کرده اند در دسترس است. در صورت درخواست ترافیک به بهترین وجه به BEST_GUESS و TrafficModel مشخص نشده است.

transit Preferences

object ( TransitPreferences )

اختیاری. ترجیحاتی را که در مسیر بازگشت برای مسیرهای TRANSIT تأثیر می گذارد ، مشخص می کند. توجه: هنگامی که RouteTravelMode روی TRANSIT تنظیم شده است ، فقط می توانید transitPreferences مشخص کنید.

بدن پاسخگو

v2.computeroutes پیام پاسخ.

در صورت موفقیت ، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
فیلدها
routes[]

object ( Route )

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

fallback Info

object ( FallbackInfo )

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

geocoding Results

object ( GeocodingResults )

حاوی اطلاعات پاسخ GeoCoding برای نقاط راه مشخص شده به عنوان آدرس است.

چند خطی

مجموعه ای از مقادیر که کیفیت پلی خط را مشخص می کند.

Enums
POLYLINE_QUALITY_UNSPECIFIED هیچ اولویت کیفیت پلی خط مشخص نشده است. پیش فرض برای OVERVIEW .
HIGH_QUALITY یک پلی خط با کیفیت بالا را مشخص می کند - که با استفاده از امتیازات بیشتر از OVERVIEW ، با هزینه افزایش اندازه پاسخ تشکیل شده است. در صورت نیاز به دقت بیشتری از این مقدار استفاده کنید.
OVERVIEW یک مرور اجمالی را مشخص می کند - که با استفاده از تعداد کمی از امتیازات تشکیل شده است. هنگام نمایش یک نمای کلی از مسیر از این مقدار استفاده کنید. استفاده از این گزینه در مقایسه با استفاده از گزینه HIGH_QUALITY تأخیر درخواست کمتری دارد.

پرکندرد

نوع ترجیحی پلی خط را که باید برگردانده شود مشخص می کند.

Enums
POLYLINE_ENCODING_UNSPECIFIED هیچ نوع ترجیح نوع پلی خط مشخص نشده است. پیش فرض به ENCODED_POLYLINE .
ENCODED_POLYLINE با استفاده از الگوریتم رمزگذاری پلی خط ، یک پلی خط رمزگذاری شده را مشخص می کند.
GEO_JSON_LINESTRING با استفاده از قالب Geojson Linestring ، یک پلی خط را مشخص می کند

ارجاع

یک مسیر مرجع پشتیبانی شده در ComputerOutesRequest.

Enums
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار شکست می خورند.
FUEL_EFFICIENT مسیر کارآمد سوخت.
SHORTER_DISTANCE

مسیر با فاصله سفر کوتاه تر. این یک ویژگی آزمایشی است.

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

برای درخواست های BICYCLE و TWO_WHEELER ، این ویژگی مسیرهایی را شبیه به موارد برگشتی باز می گرداند که شما requestedReferenceRoutes مشخص نمی کنید.

این ویژگی با سایر حالت های مسافرتی ، از طریق نقاط راه میانی یا optimizeWaypointOrder سازگار نیست. چنین درخواست هایی با شکست روبرو می شوند. با این حال ، می توانید از آن با هر routingPreference استفاده کنید.

خارج

محاسبات اضافی برای انجام ضمن تکمیل درخواست.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار شکست خواهد خورد.
TOLLS اطلاعات عوارض برای مسیر (ها).
FUEL_CONSUMPTION تخمین مصرف سوخت برای مسیر (ها).
TRAFFIC_ON_POLYLINE Polylines آگاهی از ترافیک برای مسیر (ها).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions به عنوان یک رشته متن HTML فرمت شده ارائه شده است. این محتوا به معنای خوانده شده است. این محتوا فقط برای نمایش است. آن را به صورت برنامه ای تجزیه نکنید.
FLYOVER_INFO_ON_POLYLINE اطلاعات پرواز برای مسیر (ها). برای بازگشت این اطلاعات باید routes.polyline_details.flyover_info FieldMask مشخص شود. این داده ها فقط در حال حاضر برای متروهای خاص در هند جمع می شوند. این ویژگی آزمایشی است و Sku/Charge در معرض تغییر است.
NARROW_ROAD_INFO_ON_POLYLINE اطلاعات جاده ای باریک برای مسیر (ها). routes.polyline_details.narrow_road_info fieldmask باید برای بازگشت این اطلاعات مشخص شود. این داده ها فقط در حال حاضر برای متروهای خاص در هند جمع می شوند. این ویژگی آزمایشی است و Sku/Charge در معرض تغییر است.

مسیر

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

نمایندگی JSON
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string,
  "polylineDetails": {
    object (PolylineDetails)
  }
}
فیلدها
route Labels[]

enum ( RouteLabel )

برچسب هایی برای Route که برای شناسایی خصوصیات خاص مسیر برای مقایسه در برابر دیگران مفید هستند.

legs[]

object ( RouteLeg )

مجموعه ای از پاها (بخش های مسیر بین ایستگاه های راه) که مسیر را تشکیل می دهند. هر پا با سفر بین دو غیر via Waypoints مطابقت دارد. به عنوان مثال ، مسیری که دارای نقطه راه میانی نیست ، فقط یک پا دارد. مسیری که شامل یک غیر via ایستگاه واسطه است ، دارای دو پا است. مسیری که شامل یکی via ایستگاه میانی است ، دارای یک پا است. ترتیب پاها با ترتیب ایستگاه های راه از origin تا intermediates تا destination مطابقت دارد.

distance Meters

integer

فاصله سفر مسیر ، در متر.

duration

string ( Duration format)

مدت زمان لازم برای حرکت در مسیر. اگر routingPreference را به TRAFFIC_UNAWARE تنظیم کنید ، این مقدار همان staticDuration است. اگر routingPreference را به صورت TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید ، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

static Duration

string ( Duration format)

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

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

polyline

object ( Polyline )

پلی خط مسیر کلی. این پلی خط پلی خط ترکیبی از همه legs است.

description

string

توضیحی از مسیر.

warnings[]

string

مجموعه ای از هشدارها برای نشان دادن هنگام نمایش مسیر.

viewport

object ( Viewport )

جعبه محدودیت نمای Polyline.

travel Advisory

object ( RouteTravelAdvisory )

اطلاعات اضافی در مورد مسیر.

optimized Intermediate Waypoint Index[]

integer

اگر optimizeWaypointOrder به True تنظیم کنید ، این قسمت حاوی ترتیب بهینه شده از ایستگاه های میانی است. در غیر این صورت ، این قسمت خالی است. به عنوان مثال ، اگر ورودی مبدا ارائه می دهید: LA ؛ ایستگاه های واسطه ای: دالاس ، بنگور ، ققنوس ؛ مقصد: نیویورک ؛ و سفارش بهینه میانی بهینه ، ققنوس ، دالاس ، بنگور است ، سپس این قسمت حاوی مقادیر [2 ، 0 ، 1] است. شاخص با 0 برای اولین نقطه میانی واسطه ارائه شده در ورودی شروع می شود.

localized Values

object ( RouteLocalizedValues )

بازنمایی متن از خواص Route .

route Token

string

یک نشانه مات که می تواند برای بازسازی مسیر در حین ناوبری به SDK ناوبری منتقل شود ، و در صورت تجدید نظر ، هنگام ایجاد مسیر ، به قصد اصلی احترام می گذارد. این نشانه را به عنوان حباب مات درمان کنید. ارزش آن را در بین درخواست ها مقایسه نکنید زیرا ممکن است ارزش آن تغییر کند حتی اگر سرویس دقیقاً همان مسیر را برگرداند.

توجه: Route.route_token فقط برای درخواست هایی که ComputeRoutesRequest.routing_preference تنظیم کرده اند در دسترس است. routing_preference به TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL . Route.route_token برای درخواست هایی که از طریق ایستگاه های راه وجود دارد پشتیبانی نمی شود.

polyline Details

object ( PolylineDetails )

حاوی اطلاعاتی در مورد جزئیات در امتداد پلی خط است.

روته

برچسب هایی برای Route که برای شناسایی خصوصیات خاص مسیر برای مقایسه در برابر دیگران مفید هستند.

Enums
ROUTE_LABEL_UNSPECIFIED پیش فرض - استفاده نشده است.
DEFAULT_ROUTE مسیر پیش فرض "بهترین" برای محاسبه مسیر بازگشت.
DEFAULT_ROUTE_ALTERNATE جایگزینی برای مسیر پیش فرض "بهترین". مسیرهایی مانند این با مشخص شدن computeAlternativeRoutes بازگردانده می شوند.
FUEL_EFFICIENT مسیر کارآمد سوخت. مسیرهای برچسب دار با این مقدار تعیین می شوند که برای پارامترهای سازگار با محیط زیست مانند مصرف سوخت بهینه سازی می شوند.
SHORTER_DISTANCE مسیر مسافت کوتاه تر سفر. این یک ویژگی آزمایشی است.

مسیر

حاوی یک بخش بین غیر via ایستگاه های راه است.

نمایندگی JSON
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
فیلدها
distance Meters

integer

فاصله سفر پای مسیر ، در متر.

duration

string ( Duration format)

مدت زمان لازم برای حرکت در پا. اگر route_preference روی TRAFFIC_UNAWARE تنظیم شود ، این مقدار همان staticDuration است. اگر route_preference یا TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL باشد ، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

static Duration

string ( Duration format)

مدت زمان سفر از طریق پا ، بدون در نظر گرفتن شرایط ترافیکی محاسبه می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

polyline

object ( Polyline )

پلی خط کلی برای این پا که شامل پلی خط هر step است.

start Location

object ( Location )

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

end Location

object ( Location )

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

steps[]

object ( RouteLegStep )

مجموعه ای از مراحل حاکی از بخش های موجود در این پا. هر مرحله یک دستورالعمل ناوبری را نشان می دهد.

travel Advisory

object ( RouteLegTravelAdvisory )

حاوی اطلاعات اضافی است که کاربر باید از آن مطلع شود ، مانند محدودیت های ممکن در منطقه ترافیک ، در یک مسیر مسیر.

localized Values

object ( RouteLegLocalizedValues )

بازنمایی متن از خصوصیات RouteLeg .

steps Overview

object ( StepsOverview )

اطلاعات اجمالی در مورد مراحل موجود در این RouteLeg . این قسمت فقط برای مسیرهای حمل و نقل جمع شده است.

پلی لاین

یک پلی خط رمزگذاری شده را محصور می کند.

نمایندگی JSON
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
فیلدها
Union Field polyline_type . نوع پلی خط را محصور می کند. پیش فرض به encoded_polyline. polyline_type فقط می تواند یکی از موارد زیر باشد:
encoded Polyline

string

رمزگذاری رشته پلی خط با استفاده از الگوریتم رمزگذاری پلی خط

geo Json Linestring

object ( Struct format)

با استفاده از قالب Geojson Linestring ، یک پلی خط را مشخص می کند.

مسیر

حاوی بخشی از یک RouteLeg است. یک قدم با یک دستورالعمل ناوبری واحد مطابقت دارد. پاهای مسیر از مراحل تشکیل شده است.

نمایندگی JSON
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
فیلدها
distance Meters

integer

فاصله سفر این مرحله ، در متر. در برخی شرایط ، این زمینه ممکن است ارزشی نداشته باشد.

static Duration

string ( Duration format)

مدت زمان سفر در این مرحله بدون توجه به شرایط ترافیکی. در برخی شرایط ، این زمینه ممکن است ارزشی نداشته باشد.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

polyline

object ( Polyline )

پلی خط مرتبط با این مرحله.

start Location

object ( Location )

محل شروع این مرحله.

end Location

object ( Location )

محل پایان این مرحله.

navigation Instruction

object ( NavigationInstruction )

دستورالعمل های ناوبری.

travel Advisory

object ( RouteLegStepTravelAdvisory )

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

localized Values

object ( RouteLegStepLocalizedValues )

بازنمایی متن از خواص RouteLegStep .

transit Details

object ( RouteLegStepTransitDetails )

در صورت TRANSIT حالت سفر ، جزئیات مربوط به این مرحله است.

travel Mode

enum ( RouteTravelMode )

حالت سفر مورد استفاده برای این مرحله.

مانور

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

Enums
MANEUVER_UNSPECIFIED استفاده نشده است.
TURN_SLIGHT_LEFT کمی به سمت چپ بپیچید.
TURN_SHARP_LEFT به شدت به سمت چپ بپیچید.
UTURN_LEFT یک چرخش U سمت چپ درست کنید.
TURN_LEFT به چپ بپیچید.
TURN_SLIGHT_RIGHT کمی به سمت راست بپیچید.
TURN_SHARP_RIGHT به شدت به سمت راست بپیچید.
UTURN_RIGHT یک چرخش راست درست کنید.
TURN_RIGHT به راست بپیچید.
STRAIGHT مستقیم برو
RAMP_LEFT رمپ سمت چپ را بگیرید.
RAMP_RIGHT رمپ درست را بگیرید.
MERGE ادغام در ترافیک.
FORK_LEFT چنگال سمت چپ را بگیرید.
FORK_RIGHT چنگال سمت راست را بگیرید.
FERRY کشتی را بگیرید.
FERRY_TRAIN قطار منتهی به کشتی را طی کنید.
ROUNDABOUT_LEFT در سمت چپ به سمت چپ بپیچید.
ROUNDABOUT_RIGHT به سمت راست در دور دور بپیچید.
DEPART مانور اولیه.
NAME_CHANGE برای نشان دادن تغییر نام خیابان استفاده می شود.

مسیریابی

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

نمایندگی JSON
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
speed Reading Intervals[]

object ( SpeedReadingInterval )

توجه: این قسمت در حال حاضر پر جمعیت نیست.

RoutelegsteplocalizedValues

بازنمایی متن از خصوصیات خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

فاصله سفر به شکل متن نشان داده شده است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیکی ، که به شکل متن نشان داده شده است.

stelegsteptransitdetails

اطلاعات اضافی برای RouteLegStep مربوط به مسیرهای TRANSIT .

نمایندگی JSON
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
فیلدها
stop Details

object ( TransitStopDetails )

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

localized Values

object ( TransitDetailsLocalizedValues )

بازنمایی متن از خصوصیات RouteLegStepTransitDetails .

headsign

string

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

headway

string ( Duration format)

زمان مورد انتظار را به عنوان مدت زمان بین عزیمت از همان توقف در این زمان مشخص می کند. به عنوان مثال ، با ارزش ثانیه ای از 600 ، انتظار دارید که اگر اتوبوس خود را از دست بدهید ، ده دقیقه منتظر بمانید.

مدت زمان در ثانیه با حداکثر نه رقم کسری ، که با " s " پایان می یابد. مثال: "3.5s" .

transit Line

object ( TransitLine )

اطلاعات مربوط به خط ترانزیت مورد استفاده در این مرحله.

stop Count

integer

تعداد توقف از عزیمت به توقف ورود. این شمارش شامل توقف ورود است ، اما توقف عزیمت را مستثنی می کند. به عنوان مثال ، اگر مسیر شما از توقف A خارج می شود ، از توقف B و C عبور می کند و به Stop D می رسد ،

stopCount

بازگشت 3.

trip Short Text

string

متنی که در برنامه ها ظاهر می شود و تابلوها را امضا می کند تا یک سفر ترانزیت به مسافران را شناسایی کند. متن باید به طور منحصر به فرد سفر را در یک روز خدمات مشخص کند. به عنوان مثال ، "538" tripShortText از قطار Amtrak است که سان خوزه ، کالیفرنیا را در ساعت 15:10 در روزهای هفته به ساکرامنتو ، کالیفرنیا ترک می کند.

ترانزیت

جزئیات مربوط به ترانزیت برای RouteLegStep متوقف می شود.

نمایندگی JSON
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
فیلدها
arrival Stop

object ( TransitStop )

اطلاعات مربوط به توقف ورود برای مرحله.

arrival Time

string ( Timestamp format)

زمان تخمینی ورود برای مرحله.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

departure Stop

object ( TransitStop )

اطلاعات مربوط به خروج برای مرحله متوقف می شود.

departure Time

string ( Timestamp format)

زمان تخمینی عزیمت برای مرحله.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

ایستگاه حمل و نقل

اطلاعات مربوط به توقف حمل و نقل.

نمایندگی JSON
{
  "name": string,
  "location": {
    object (Location)
  }
}
فیلدها
name

string

نام ترانزیت توقف.

location

object ( Location )

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

TransitDetailSlocalizedValues

توضیحات بومی شده از مقادیر برای RouteTransitDetails .

نمایندگی JSON
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
فیلدها
arrival Time

object ( LocalizedTime )

زمان در نمایش متن فرمت شده خود با یک منطقه زمانی مربوطه.

departure Time

object ( LocalizedTime )

زمان در نمایش متن فرمت شده خود با یک منطقه زمانی مربوطه.

زمان محلی

توضیحات بومی شده زمان.

نمایندگی JSON
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
فیلدها
time

object ( LocalizedText )

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

time Zone

string

شامل منطقه زمانی است. مقدار نام منطقه زمانی است که در پایگاه داده منطقه زمانی IANA تعریف شده است ، به عنوان مثال "America/New_york".

خط حمل و نقل

حاوی اطلاعاتی در مورد خط ترانزیت مورد استفاده در این مرحله است.

نمایندگی JSON
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
فیلدها
agencies[]

object ( TransitAgency )

آژانس ترانزیت (یا آژانس ها) که این خط ترانزیت را اداره می کند.

name

string

به عنوان مثال ، نام کامل این خط ترانزیت ، "8 خیابان محلی".

uri

string

URI برای این خط ترانزیت همانطور که توسط آژانس ترانزیت ارائه شده است.

color

string

رنگی که معمولاً در این علائم در علائم استفاده می شود. در hexadecimal نماینده است.

icon Uri

string

URI برای نماد مرتبط با این خط.

name Short

string

نام کوتاه این خط ترانزیت. این نام معمولاً یک شماره خط مانند "M7" یا "355" خواهد بود.

text Color

string

رنگی که معمولاً در متن روی علائم برای این خط استفاده می شود. در hexadecimal نماینده است.

vehicle

object ( TransitVehicle )

نوع وسیله نقلیه ای که در این خط ترانزیت کار می کند.

ترانسیت

یک آژانس حمل و نقل که یک خط ترانزیت را اداره می کند.

نمایندگی JSON
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
فیلدها
name

string

نام این آژانس ترانزیت.

phone Number

string

شماره تلفن با فرمت اختصاصی آژانس ترانزیت.

uri

string

URI آژانس ترانزیت.

حمل و نقل

اطلاعات مربوط به وسیله نقلیه مورد استفاده در مسیرهای ترانزیت.

نمایندگی JSON
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
فیلدها
name

object ( LocalizedText )

نام این وسیله نقلیه ، سرمایه گذاری شده است.

type

enum ( TransitVehicleType )

نوع وسیله نقلیه مورد استفاده

icon Uri

string

URI برای یک نماد مرتبط با این نوع وسیله نقلیه.

local Icon Uri

string

URI برای نماد مرتبط با این نوع وسیله نقلیه ، بر اساس علائم حمل و نقل محلی.

نوع حمل و نقل

نوع وسایل نقلیه برای مسیرهای حمل و نقل.

Enums
TRANSIT_VEHICLE_TYPE_UNSPECIFIED استفاده نشده
BUS اتوبوس
CABLE_CAR وسیله نقلیه ای که معمولاً روی کابل کار می کند ، معمولاً روی زمین. کابل های هوایی ممکن است از نوع GONDOLA_LIFT باشد.
COMMUTER_TRAIN راه آهن شهری.
FERRY فری
FUNICULAR وسیله نقلیه ای که توسط یک کابل شیب شیب دار کشیده می شود. یک قارچ به طور معمول از دو اتومبیل تشکیل شده است که هر ماشین به عنوان ضد وزن برای دیگری عمل می کند.
GONDOLA_LIFT یک کابل هوایی.
HEAVY_RAIL راه آهن سنگین
HIGH_SPEED_TRAIN قطار پر سرعت.
INTERCITY_BUS اتوبوس بین شهری.
LONG_DISTANCE_TRAIN قطار از راه دور.
METRO_RAIL ترانزیت راه آهن سبک.
MONORAIL مونوریل.
OTHER همه وسایل نقلیه دیگر.
RAIL راه آهن.
SHARE_TAXI Taxi Share نوعی اتوبوس است که توانایی رها کردن و انتخاب مسافر در هر نقطه از مسیر خود را دارد.
SUBWAY راه آهن سبک زیرزمینی.
TRAM بالاتر از راه آهن سبک زمین.
TROLLEYBUS چرخ دستی.

مربوط به مسیر

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

نمایندگی JSON
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
toll Info

object ( TollInfo )

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

speed Reading Intervals[]

object ( SpeedReadingInterval )

فواصل خواندن سرعت در مورد تراکم ترافیک. در صورت استفاده از TRAFFIC_AWARE و TRAFFIC_AWARE_OPTIMAL ترجیحات مسیریابی قابل اجرا است. فواصل کل خطی از RouteLeg را بدون همپوشانی پوشش می دهد. نقطه شروع یک بازه مشخص همان نقطه پایان فاصله قبل است.

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

روتگلوکالیزه مقالاتی

بازنمایی متن از خصوصیات خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

فاصله سفر به شکل متن نشان داده شده است.

duration

object ( LocalizedText )

مدت زمان ، به شکل متن نشان داده شده و در منطقه پرس و جو بومی سازی شده است. شرایط ترافیکی را در نظر می گیرد. توجه: اگر اطلاعات ترافیکی را درخواست نکردید ، این مقدار همان مقدار StaticDuration است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیکی ، که به شکل متن نشان داده شده است.

پله پله

اطلاعات کلی را در مورد لیستی از RouteLegStep ارائه می دهد.

نمایندگی JSON
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
فیلدها
multi Modal Segments[]

object ( MultiModalSegment )

اطلاعات خلاصه شده در مورد بخش های مختلف چند منظوره از RouteLeg.steps . این قسمت در صورتی جمع نمی شود اگر RouteLeg حاوی هیچ بخش چند منظوره در مراحل باشد.

بخش چندگانه

اطلاعات خلاصه شده در مورد بخش های مختلف چند منظوره RouteLeg.steps را ارائه می دهد. یک بخش چند حالته به عنوان یک یا چند RouteLegStep متناقض که دارای همان RouteTravelMode هستند تعریف شده است. این قسمت در صورتی جمع نمی شود اگر RouteLeg حاوی هیچ بخش چند منظوره در مراحل باشد.

نمایندگی JSON
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
فیلدها
navigation Instruction

object ( NavigationInstruction )

NavigationInstruction برای بخش چند مدلی.

travel Mode

enum ( RouteTravelMode )

حالت سفر بخش چند مدلی.

step Start Index

integer

شاخص مربوطه RouteLegStep که شروع یک بخش چند منظوره است.

step End Index

integer

شاخص مربوطه RouteLegStep که پایان یک بخش چند منظوره است.

درگاه دید

نمای عرضه طول و عرض جغرافیایی ، که به عنوان دو مورب مخالف نقاط low و high نشان داده شده است. منظره یک منطقه بسته در نظر گرفته می شود ، یعنی مرز آن را شامل می شود. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. موارد مختلف شامل:

  • اگر low = high ، نمای از همان نقطه واحد تشکیل شده است.

  • اگر low.longitude > high.longitude , محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).

  • اگر low.longitude = -180 درجه و high.longitude = 180 درجه باشد، درگاه دید شامل تمام طول‌های جغرافیایی می‌شود.

  • اگر low.longitude = 180 درجه و high.longitude = -180 درجه باشد، محدوده طول جغرافیایی خالی است.

  • اگر low.latitude > high.latitude ، محدوده عرض جغرافیایی خالی است.

هر دو low و high باید جمع شوند ، و جعبه نماینده نمی تواند خالی باشد (همانطور که توسط تعاریف فوق مشخص شده است). نمای خالی منجر به خطایی خواهد شد.

به عنوان مثال ، این منظره به طور کامل شهر نیویورک را محصور می کند:

{"کم": {"عرض جغرافیایی": 40.477398 ، "طول جغرافیایی": -74.259087} ، "بالا": {"عرض جغرافیایی": 40.91618 ، "طول": -73.70018}}}

نمایندگی JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
فیلدها
low

object ( LatLng )

مورد نیاز. نقطه پایین منظره.

high

object ( LatLng )

مورد نیاز. نقطه مرتفع منظره.

مقادیر روتایی

بازنمایی متن از خصوصیات خاص.

نمایندگی JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

فاصله سفر به شکل متن نشان داده شده است.

duration

object ( LocalizedText )

مدت زمان ، به شکل متن نشان داده شده و در منطقه پرس و جو بومی سازی شده است. شرایط ترافیکی را در نظر می گیرد. توجه: اگر اطلاعات ترافیکی را درخواست نکردید ، این مقدار همان مقدار staticDuration است.

static Duration

object ( LocalizedText )

مدت زمان بدون در نظر گرفتن شرایط ترافیکی ، که به شکل متن نشان داده شده است.

transit Fare

object ( LocalizedText )

کرایه ترانزیت به شکل متن نشان داده شده است.

گلدان های فلزی

جزئیات مربوط به یک شاخص معین یا بخش متناوب یک پلی خط. با توجه به یک پلی خط با امتیاز P_0 ، P_1 ، ... ، P_N (شاخص مبتنی بر صفر) ، PolylineDetails یک فاصله و ابرداده مرتبط را تعریف می کند.

نمایندگی JSON
{
  "flyoverInfo": [
    {
      object (FlyoverInfo)
    }
  ],
  "narrowRoadInfo": [
    {
      object (NarrowRoadInfo)
    }
  ]
}
فیلدها
flyover Info[]

object ( FlyoverInfo )

جزئیات پرواز در امتداد پلی خط.

narrow Road Info[]

object ( NarrowRoadInfo )

جزئیات جاده باریک در امتداد پلی خط.

مگس

اطلاعات مربوط به مگس ها را در امتداد پلی خط محاصره می کند.

نمایندگی JSON
{
  "flyoverPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
flyover Presence

enum ( RoadFeatureState )

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

polyline Point Index

object ( PolylinePointIndex )

محل اطلاعات مربوط به پرواز در امتداد پلی خط.

ترشی

حالت های ویژگی های جاده را در امتداد بخش پلی خط محاصره می کند.

Enums
ROAD_FEATURE_STATE_UNSPECIFIED حالت ویژگی جاده محاسبه نشده است (مقدار پیش فرض).
EXISTS ویژگی جاده وجود دارد.
DOES_NOT_EXIST ویژگی جاده وجود ندارد.

PolylinePointIndex

شاخص های شروع و پایان را برای جزئیات چند خطی محصور می کند. برای مواردی که داده ها با یک نقطه واحد مطابقت دارند ، startIndex و endIndex برابر خواهند بود.

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer
}
فیلدها
start Index

integer

شاخص شروع این جزئیات در Polyline.

end Index

integer

شاخص پایان این جزئیات در پلی خط.

باریکه

اطلاعات مربوط به جاده های باریک را در امتداد پلی خط محاصره می کند.

نمایندگی JSON
{
  "narrowRoadPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
narrow Road Presence

enum ( RoadFeatureState )

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

polyline Point Index

object ( PolylinePointIndex )

محل اطلاعات مربوط به جاده باریک در امتداد پلی خط.

جغرافیایی

حاوی GeocodedWaypoints برای مبدا ، مقصد و ایستگاه های راه متوسط ​​است. فقط برای آدرس های خطاب آدرس جمع شده است.

نمایندگی JSON
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
فیلدها
origin

object ( GeocodedWaypoint )

نقطه راه GeoCoded Origin.

destination

object ( GeocodedWaypoint )

مقصد Geocoded Waypoint.

intermediates[]

object ( GeocodedWaypoint )

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

نقطه جغرافیایی

جزئیات مربوط به مکان های مورد استفاده به عنوان ایستگاه های راه. فقط برای آدرس های خطاب آدرس جمع شده است. شامل جزئیات مربوط به نتایج جغرافیایی به منظور تعیین اینکه آدرس به آن منتقل شده است.

نمایندگی JSON
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
فیلدها
geocoder Status

object ( Status )

کد وضعیت ناشی از عملیات جغرافیایی را نشان می دهد.

type[]

string

نوع (های) نتیجه ، در قالب برچسب های صفر یا بیشتر. انواع پشتیبانی شده: انواع آدرس و انواع مؤلفه آدرس .

partial Match

boolean

نشان می دهد که GeoCoder مسابقه دقیقی را برای درخواست اصلی برنگردد ، اگرچه توانست با بخشی از آدرس درخواست شده مطابقت داشته باشد. شما ممکن است بخواهید درخواست اصلی برای غلط های غلط و/یا یک آدرس ناقص را بررسی کنید.

place Id

string

شناسه مکان برای این نتیجه.

intermediate Waypoint Request Index

integer

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

،

با توجه به مجموعه ای از ایستگاه های راه ترمینال و میانی ، مسیر اصلی را به همراه مسیرهای متناوب اختیاری برمی گرداند.

توجه: این روش مستلزم آن است که ماسک زمینه پاسخ را در ورودی مشخص کنید. می توانید با استفاده از پارامتر url $fields یا fields یا با استفاده از هدر HTTP/GRPC X-Goog-FieldMask ، ماسک زمینه پاسخ را ارائه دهید (به پارامترها و هدر های URL موجود مراجعه کنید). مقدار یک لیست جدا از کاما از مسیرهای میدانی است. مستندات مفصل در مورد نحوه ساخت مسیرهای میدانی را مشاهده کنید.

به عنوان مثال ، در این روش:

  • ماسک میدانی از همه زمینه های موجود (برای بازرسی دستی): X-Goog-FieldMask: *
  • ماسک میدانی از مدت زمان مسیر ، فاصله و پلی خط (نمونه ای از تولید): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google از استفاده از ماسک زمینه پاسخ Wildcard ( * ) یا مشخص کردن ماسک میدانی در سطح بالا ( routes ) دلسرد می شود ، زیرا:

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

درخواست HTTP

POST https://routes.googleapis.com/directions/v2:computeRoutes

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست شامل داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
فیلدها
origin

object ( Waypoint )

مورد نیاز. نقطه راه اصلی.

destination

object ( Waypoint )

مورد نیاز. ایستگاه مقصد.

intermediates[]

object ( Waypoint )

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

travel Mode

enum ( RouteTravelMode )

اختیاری. نحوه حمل و نقل را مشخص می کند.

routing Preference

enum ( RoutingPreference )

اختیاری. نحوه محاسبه مسیر را مشخص می کند. سرور سعی در استفاده از اولویت مسیریابی انتخاب شده برای محاسبه مسیر دارد. اگر ترجیح مسیریابی منجر به خطا یا تأخیر طولانی مدت شود ، خطایی بازگردانده می شود. شما می توانید این گزینه را فقط در مواردی که travelMode DRIVE یا TWO_WHEELER است ، مشخص کنید ، در غیر این صورت درخواست از بین می رود.

polyline Quality

enum ( PolylineQuality )

اختیاری. ترجیح شما را برای کیفیت پلی خط مشخص می کند.

polyline Encoding

enum ( PolylineEncoding )

اختیاری. رمزگذاری ترجیحی را برای پلی خط مشخص می کند.

departure Time

string ( Timestamp format)

اختیاری. زمان عزیمت اگر این مقدار را تنظیم نکردید ، این مقدار به زمانی که درخواست را انجام داده اید پیش فرض می شود. توجه: هنگامی که RouteTravelMode روی TRANSIT تنظیم شده است ، می توانید در گذشته یک departureTime مشخص کنید. سفرهای ترانزیت در گذشته یا 100 روز در آینده تا 7 روز در دسترس است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

arrival Time

string ( Timestamp format)

اختیاری. زمان ورود توجه: فقط در صورت تنظیم RouteTravelMode در TRANSIT قابل تنظیم است. شما می توانید departureTime یا arrivalTime مشخص کنید ، اما هر دو نیست. سفرهای ترانزیت در گذشته یا 100 روز در آینده تا 7 روز در دسترس است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

compute Alternative Routes

boolean

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

route Modifiers

object ( RouteModifiers )

اختیاری. مجموعه ای از شرایط برای برآورده کردن بر نحوه محاسبه مسیرها.

language Code

string

اختیاری. کد زبان BCP-47 ، مانند "en-us" یا "sr-latn". برای اطلاعات بیشتر ، به شناسه محلی Unicode مراجعه کنید. پشتیبانی از زبان را برای لیست زبانهای پشتیبانی شده مشاهده کنید. وقتی این مقدار را ارائه نمی دهید ، زبان نمایش از محل درخواست مسیر استنباط می شود.

region Code

string

اختیاری. کد منطقه ، به عنوان یک مقدار CCTLD ("دامنه سطح بالا") مقدار دو شخصیت مشخص شده است. برای اطلاعات بیشتر به دامنه های سطح بالای کد کشور مراجعه کنید.

units

enum ( Units )

اختیاری. واحدهای اندازه گیری را برای قسمتهای نمایشگر مشخص می کند. این زمینه ها شامل زمینه instruction در NavigationInstruction است. واحدهای اندازه گیری مورد استفاده برای مسیر ، پا ، فاصله مرحله و مدت زمان تحت تأثیر این مقدار قرار نمی گیرند. اگر این مقدار را ارائه ندهید ، واحدهای نمایشگر از محل اولین منشاء استنباط می شوند.

optimize Waypoint Order

boolean

اختیاری. در صورت تنظیم صحیح ، این سرویس سعی می کند با سفارش مجدد ایستگاه های واسطه ای مشخص شده ، هزینه کلی مسیر را به حداقل برساند. اگر هر یک از نقاط راه میانی via ایستگاه راه باشد ، درخواست از بین می رود. برای یافتن سفارش جدید از ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index استفاده کنید. اگر ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index در عنوان X-Goog-FieldMask درخواست نشده است ، درخواست از بین می رود. اگر optimizeWaypointOrder روی FALSE تنظیم شده باشد ، ComputeRoutesResponse.optimized_intermediate_waypoint_index خالی خواهد بود.

requested Reference Routes[]

enum ( ReferenceRoute )

اختیاری. علاوه بر مسیر پیش فرض ، چه مسیرهای مرجع را برای محاسبه به عنوان بخشی از درخواست مشخص می کند. یک مسیر مرجع مسیری با هدف محاسبه مسیر متفاوت از مسیر پیش فرض است. به عنوان مثال ، یک محاسبه مسیر مرجع FUEL_EFFICIENT پارامترهای مختلفی را در نظر می گیرد که می تواند یک مسیر بهینه سوخت را تولید کند. هنگام استفاده از این ویژگی ، به دنبال routeLabels در مسیرهای حاصل باشید.

extra Computations[]

enum ( ExtraComputation )

اختیاری. لیستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است زمینه های اضافی را در پاسخ بازگرداند. این زمینه های اضافی نیز باید در ماسک میدانی مشخص شود که در پاسخ برگردانده شود.

traffic Model

enum ( TrafficModel )

اختیاری. فرضیات استفاده شده در هنگام محاسبه زمان در ترافیک را مشخص می کند. این تنظیم بر مقدار برگشتی در زمینه مدت زمان در Route و RouteLeg که حاوی زمان پیش بینی شده در ترافیک بر اساس میانگین های تاریخی است ، تأثیر می گذارد. TrafficModel فقط برای درخواست هایی که RoutingPreference DRIVE TRAFFIC_AWARE_OPTIMAL و RouteTravelMode تنظیم کرده اند در دسترس است. در صورت درخواست ترافیک به بهترین وجه به BEST_GUESS و TrafficModel مشخص نشده است.

transit Preferences

object ( TransitPreferences )

اختیاری. ترجیحاتی را که در مسیر بازگشت برای مسیرهای TRANSIT تأثیر می گذارد ، مشخص می کند. توجه: هنگامی که RouteTravelMode روی TRANSIT تنظیم شده است ، فقط می توانید transitPreferences مشخص کنید.

بدن پاسخگو

v2.computeroutes پیام پاسخ.

در صورت موفقیت ، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
فیلدها
routes[]

object ( Route )

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

fallback Info

object ( FallbackInfo )

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

geocoding Results

object ( GeocodingResults )

حاوی اطلاعات پاسخ GeoCoding برای نقاط راه مشخص شده به عنوان آدرس است.

چند خطی

مجموعه ای از مقادیر که کیفیت پلی خط را مشخص می کند.

Enums
POLYLINE_QUALITY_UNSPECIFIED هیچ اولویت کیفیت پلی خط مشخص نشده است. پیش فرض برای OVERVIEW .
HIGH_QUALITY یک پلی خط با کیفیت بالا را مشخص می کند - که با استفاده از امتیازات بیشتر از OVERVIEW ، با هزینه افزایش اندازه پاسخ تشکیل شده است. در صورت نیاز به دقت بیشتری از این مقدار استفاده کنید.
OVERVIEW یک مرور اجمالی را مشخص می کند - که با استفاده از تعداد کمی از امتیازات تشکیل شده است. هنگام نمایش یک نمای کلی از مسیر از این مقدار استفاده کنید. استفاده از این گزینه در مقایسه با استفاده از گزینه HIGH_QUALITY تأخیر درخواست کمتری دارد.

پرکندرد

نوع ترجیحی پلی خط را که باید برگردانده شود مشخص می کند.

Enums
POLYLINE_ENCODING_UNSPECIFIED هیچ نوع ترجیح نوع پلی خط مشخص نشده است. پیش فرض به ENCODED_POLYLINE .
ENCODED_POLYLINE با استفاده از الگوریتم رمزگذاری پلی خط ، یک پلی خط رمزگذاری شده را مشخص می کند.
GEO_JSON_LINESTRING با استفاده از قالب Geojson Linestring ، یک پلی خط را مشخص می کند

ارجاع

یک مسیر مرجع پشتیبانی شده در ComputerOutesRequest.

Enums
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار شکست می خورند.
FUEL_EFFICIENT مسیر کارآمد سوخت.
SHORTER_DISTANCE

مسیر با فاصله سفر کوتاه تر. این یک ویژگی آزمایشی است.

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

برای درخواست های BICYCLE و TWO_WHEELER ، این ویژگی مسیرهایی را شبیه به موارد برگشتی باز می گرداند که شما requestedReferenceRoutes مشخص نمی کنید.

این ویژگی با سایر حالت های مسافرتی ، از طریق نقاط راه میانی یا optimizeWaypointOrder سازگار نیست. چنین درخواست هایی با شکست روبرو می شوند. با این حال ، می توانید از آن با هر routingPreference استفاده کنید.

خارج

محاسبات اضافی برای انجام ضمن تکمیل درخواست.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده است. درخواست های حاوی این مقدار شکست خواهد خورد.
TOLLS اطلاعات عوارض برای مسیر (ها).
FUEL_CONSUMPTION تخمین مصرف سوخت برای مسیر (ها).
TRAFFIC_ON_POLYLINE Polylines آگاهی از ترافیک برای مسیر (ها).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions به عنوان یک رشته متن HTML فرمت شده ارائه شده است. این محتوا به معنای خوانده شده است. این محتوا فقط برای نمایش است. آن را به صورت برنامه ای تجزیه نکنید.
FLYOVER_INFO_ON_POLYLINE اطلاعات پرواز برای مسیر (ها). برای بازگشت این اطلاعات باید routes.polyline_details.flyover_info FieldMask مشخص شود. این داده ها فقط در حال حاضر برای متروهای خاص در هند جمع می شوند. این ویژگی آزمایشی است و Sku/Charge در معرض تغییر است.
NARROW_ROAD_INFO_ON_POLYLINE اطلاعات جاده ای باریک برای مسیر (ها). routes.polyline_details.narrow_road_info fieldmask باید برای بازگشت این اطلاعات مشخص شود. این داده ها فقط در حال حاضر برای متروهای خاص در هند جمع می شوند. این ویژگی آزمایشی است و Sku/Charge در معرض تغییر است.

مسیر

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

نمایندگی JSON
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string,
  "polylineDetails": {
    object (PolylineDetails)
  }
}
فیلدها
route Labels[]

enum ( RouteLabel )

برچسب هایی برای Route که برای شناسایی خصوصیات خاص مسیر برای مقایسه در برابر دیگران مفید هستند.

legs[]

object ( RouteLeg )

مجموعه ای از پاها (بخش های مسیر بین ایستگاه های راه) که مسیر را تشکیل می دهند. هر پا با سفر بین دو غیر via Waypoints مطابقت دارد. به عنوان مثال ، مسیری که دارای نقطه راه میانی نیست ، فقط یک پا دارد. A route that includes one non- via intermediate waypoint has two legs. A route that includes one via intermediate waypoint has one leg. The order of the legs matches the order of waypoints from origin to intermediates to destination .

distance Meters

integer

The travel distance of the route, in meters.

duration

string ( Duration format)

The length of time needed to navigate the route. If you set the routingPreference to TRAFFIC_UNAWARE , then this value is the same as staticDuration . If you set the routingPreference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

static Duration

string ( Duration format)

The duration of travel through the route without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The overall route polyline. This polyline is the combined polyline of all legs .

description

string

A description of the route.

warnings[]

string

An array of warnings to show when displaying the route.

viewport

object ( Viewport )

The viewport bounding box of the polyline.

travel Advisory

object ( RouteTravelAdvisory )

Additional information about the route.

optimized Intermediate Waypoint Index[]

integer

If you set optimizeWaypointOrder to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: Dallas, Bangor, Phoenix; Destination: New York; and the optimized intermediate waypoint order is Phoenix, Dallas, Bangor, then this field contains the values [2, 0, 1]. The index starts with 0 for the first intermediate waypoint provided in the input.

localized Values

object ( RouteLocalizedValues )

Text representations of properties of the Route .

route Token

string

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL . Route.route_token is not supported for requests that have Via waypoints.

polyline Details

object ( PolylineDetails )

Contains information about details along the polyline.

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

Enums
ROUTE_LABEL_UNSPECIFIED Default - not used.
DEFAULT_ROUTE The default "best" route returned for the route computation.
DEFAULT_ROUTE_ALTERNATE An alternative to the default "best" route. Routes like this will be returned when computeAlternativeRoutes is specified.
FUEL_EFFICIENT Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption.
SHORTER_DISTANCE Shorter travel distance route. این یک ویژگی آزمایشی است.

RouteLeg

Contains a segment between non- via waypoints.

JSON representation
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
فیلدها
distance Meters

integer

The travel distance of the route leg, in meters.

duration

string ( Duration format)

The length of time needed to navigate the leg. If the route_preference is set to TRAFFIC_UNAWARE , then this value is the same as staticDuration . If the route_preference is either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

static Duration

string ( Duration format)

The duration of travel through the leg, calculated without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The overall polyline for this leg that includes each step 's polyline.

start Location

object ( Location )

The start location of this leg. This location might be different from the provided origin . For example, when the provided origin is not near a road, this is a point on the road.

end Location

object ( Location )

The end location of this leg. This location might be different from the provided destination . For example, when the provided destination is not near a road, this is a point on the road.

steps[]

object ( RouteLegStep )

An array of steps denoting segments within this leg. Each step represents one navigation instruction.

travel Advisory

object ( RouteLegTravelAdvisory )

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg.

localized Values

object ( RouteLegLocalizedValues )

Text representations of properties of the RouteLeg .

steps Overview

object ( StepsOverview )

Overview information about the steps in this RouteLeg . This field is only populated for TRANSIT routes.

پلی لاین

Encapsulates an encoded polyline.

JSON representation
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
فیلدها
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following:
encoded Polyline

string

The string encoding of the polyline using the polyline encoding algorithm

geo Json Linestring

object ( Struct format)

Specifies a polyline using the GeoJSON LineString format .

RouteLegStep

Contains a segment of a RouteLeg . A step corresponds to a single navigation instruction. Route legs are made up of steps.

JSON representation
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
فیلدها
distance Meters

integer

The travel distance of this step, in meters. In some circumstances, this field might not have a value.

static Duration

string ( Duration format)

The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The polyline associated with this step.

start Location

object ( Location )

The start location of this step.

end Location

object ( Location )

The end location of this step.

navigation Instruction

object ( NavigationInstruction )

Navigation instructions.

travel Advisory

object ( RouteLegStepTravelAdvisory )

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step.

localized Values

object ( RouteLegStepLocalizedValues )

Text representations of properties of the RouteLegStep .

transit Details

object ( RouteLegStepTransitDetails )

Details pertaining to this step if the travel mode is TRANSIT .

travel Mode

enum ( RouteTravelMode )

The travel mode used for this step.

مانور

A set of values that specify the navigation action to take for the current step (for example, turn left, merge, or straight).

Enums
MANEUVER_UNSPECIFIED استفاده نشده است.
TURN_SLIGHT_LEFT Turn slightly to the left.
TURN_SHARP_LEFT Turn sharply to the left.
UTURN_LEFT Make a left u-turn.
TURN_LEFT به چپ بپیچید.
TURN_SLIGHT_RIGHT Turn slightly to the right.
TURN_SHARP_RIGHT Turn sharply to the right.
UTURN_RIGHT Make a right u-turn.
TURN_RIGHT به راست بپیچید.
STRAIGHT Go straight.
RAMP_LEFT Take the left ramp.
RAMP_RIGHT Take the right ramp.
MERGE Merge into traffic.
FORK_LEFT Take the left fork.
FORK_RIGHT Take the right fork.
FERRY Take the ferry.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
DEPART Initial maneuver.
NAME_CHANGE Used to indicate a street name change.

RouteLegStepTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions on a leg step.

JSON representation
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
speed Reading Intervals[]

object ( SpeedReadingInterval )

NOTE: This field is not currently populated.

RouteLegStepLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

RouteLegStepTransitDetails

Additional information for the RouteLegStep related to TRANSIT routes.

JSON representation
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
فیلدها
stop Details

object ( TransitStopDetails )

Information about the arrival and departure stops for the step.

localized Values

object ( TransitDetailsLocalizedValues )

Text representations of properties of the RouteLegStepTransitDetails .

headsign

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

headway

string ( Duration format)

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

transit Line

object ( TransitLine )

Information about the transit line used in this step.

stop Count

integer

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,

stopCount

returns 3.

trip Short Text

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the tripShortText of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

TransitStopDetails

Details about the transit stops for the RouteLegStep .

JSON representation
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
فیلدها
arrival Stop

object ( TransitStop )

Information about the arrival stop for the step.

arrival Time

string ( Timestamp format)

The estimated time of arrival for the step.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

departure Stop

object ( TransitStop )

Information about the departure stop for the step.

departure Time

string ( Timestamp format)

The estimated time of departure for the step.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

TransitStop

Information about a transit stop.

JSON representation
{
  "name": string,
  "location": {
    object (Location)
  }
}
فیلدها
name

string

The name of the transit stop.

location

object ( Location )

The location of the stop expressed in latitude/longitude coordinates.

TransitDetailsLocalizedValues

Localized descriptions of values for RouteTransitDetails .

JSON representation
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
فیلدها
arrival Time

object ( LocalizedTime )

Time in its formatted text representation with a corresponding time zone.

departure Time

object ( LocalizedTime )

Time in its formatted text representation with a corresponding time zone.

LocalizedTime

Localized description of time.

JSON representation
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
فیلدها
time

object ( LocalizedText )

The time specified as a string in a given time zone.

time Zone

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database , eg "America/New_York".

TransitLine

Contains information about the transit line used in this step.

JSON representation
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
فیلدها
agencies[]

object ( TransitAgency )

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon Uri

string

The URI for the icon associated with this line.

name Short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text Color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

object ( TransitVehicle )

The type of vehicle that operates on this transit line.

TransitAgency

A transit agency that operates a transit line.

نمایندگی JSON
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
فیلدها
name

string

The name of this transit agency.

phone Number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitVehicle

Information about a vehicle used in transit routes.

نمایندگی JSON
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
فیلدها
name

object ( LocalizedText )

The name of this vehicle, capitalized.

type

enum ( TransitVehicleType )

The type of vehicle used.

icon Uri

string

The URI for an icon associated with this vehicle type.

local Icon Uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Enums
TRANSIT_VEHICLE_TYPE_UNSPECIFIED استفاده نشده
BUS اتوبوس
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN راه آهن شهری.
FERRY فری
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN قطار پر سرعت.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL مونوریل.
OTHER All other vehicles.
RAIL راه آهن.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Trolleybus.

RouteLegTravelAdvisory

Contains the additional information that the user should be informed about on a leg step, such as possible traffic zone restrictions.

JSON representation
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
toll Info

object ( TollInfo )

Contains information about tolls on the specific RouteLeg . This field is only populated if we expect there are tolls on the RouteLeg . If this field is set but the estimatedPrice subfield is not populated, we expect that road contains tolls but we do not know an estimated price. If this field does not exist, then there is no toll on the RouteLeg .

speed Reading Intervals[]

object ( SpeedReadingInterval )

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the RouteLeg without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

RouteLegLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

duration

object ( LocalizedText )

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as staticDuration.

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

StepsOverview

Provides overview information about a list of RouteLegStep s.

JSON representation
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
فیلدها
multi Modal Segments[]

object ( MultiModalSegment )

Summarized information about different multi-modal segments of the RouteLeg.steps . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

MultiModalSegment

Provides summarized information about different multi-modal segments of the RouteLeg.steps . A multi-modal segment is defined as one or more contiguous RouteLegStep that have the same RouteTravelMode . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

JSON representation
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
فیلدها
navigation Instruction

object ( NavigationInstruction )

NavigationInstruction for the multi-modal segment.

travel Mode

enum ( RouteTravelMode )

The travel mode of the multi-modal segment.

step Start Index

integer

The corresponding RouteLegStep index that is the start of a multi-modal segment.

step End Index

integer

The corresponding RouteLegStep index that is the end of a multi-modal segment.

درگاه دید

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, ie it includes its boundary. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. Various cases include:

  • اگر low = high ، نمای از همان نقطه واحد تشکیل شده است.

  • اگر low.longitude > high.longitude , محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).

  • اگر low.longitude = -180 درجه و high.longitude = 180 درجه باشد، درگاه دید شامل تمام طول‌های جغرافیایی می‌شود.

  • اگر low.longitude = 180 درجه و high.longitude = -180 درجه باشد، محدوده طول جغرافیایی خالی است.

  • اگر low.latitude > high.latitude ، محدوده عرض جغرافیایی خالی است.

Both low and high must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.

For example, this viewport fully encloses New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON representation
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
فیلدها
low

object ( LatLng )

مورد نیاز. The low point of the viewport.

high

object ( LatLng )

مورد نیاز. The high point of the viewport.

RouteLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

duration

object ( LocalizedText )

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as staticDuration .

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

transit Fare

object ( LocalizedText )

Transit fare represented in text form.

PolylineDetails

Details corresponding to a given index or contiguous segment of a polyline. Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the PolylineDetails defines an interval and associated metadata.

JSON representation
{
  "flyoverInfo": [
    {
      object (FlyoverInfo)
    }
  ],
  "narrowRoadInfo": [
    {
      object (NarrowRoadInfo)
    }
  ]
}
فیلدها
flyover Info[]

object ( FlyoverInfo )

Flyover details along the polyline.

narrow Road Info[]

object ( NarrowRoadInfo )

Narrow road details along the polyline.

FlyoverInfo

Encapsulates information about flyovers along the polyline.

JSON representation
{
  "flyoverPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
flyover Presence

enum ( RoadFeatureState )

فقط خروجی Denotes whether a flyover exists for a given stretch of the polyline.

polyline Point Index

object ( PolylinePointIndex )

The location of flyover related information along the polyline.

RoadFeatureState

Encapsulates the states of road features along a stretch of polyline.

Enums
ROAD_FEATURE_STATE_UNSPECIFIED The road feature's state was not computed (default value).
EXISTS The road feature exists.
DOES_NOT_EXIST The road feature does not exist.

PolylinePointIndex

Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, startIndex and endIndex will be equal.

JSON representation
{
  "startIndex": integer,
  "endIndex": integer
}
فیلدها
start Index

integer

The start index of this detail in the polyline.

end Index

integer

The end index of this detail in the polyline.

NarrowRoadInfo

Encapsulates information about narrow roads along the polyline.

JSON representation
{
  "narrowRoadPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
narrow Road Presence

enum ( RoadFeatureState )

فقط خروجی Denotes whether a narrow road exists for a given stretch of the polyline.

polyline Point Index

object ( PolylinePointIndex )

The location of narrow road related information along the polyline.

GeocodingResults

Contains GeocodedWaypoints for origin, destination and intermediate waypoints. Only populated for address waypoints.

JSON representation
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
فیلدها
origin

object ( GeocodedWaypoint )

Origin geocoded waypoint.

destination

object ( GeocodedWaypoint )

Destination geocoded waypoint.

intermediates[]

object ( GeocodedWaypoint )

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

GeocodedWaypoint

Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.

JSON representation
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
فیلدها
geocoder Status

object ( Status )

Indicates the status code resulting from the geocoding operation.

type[]

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types .

partial Match

boolean

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

place Id

string

The place ID for this result.

intermediate Waypoint Request Index

integer

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.

،

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter $fields or fields , or by using an HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers ). The value is a comma separated list of field paths. See detailed documentation about how to construct the field paths .

For example, in this method:

  • Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
  • Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard ( * ) response field mask, or specifying the field mask at the top level ( routes ), because:

  • Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
  • Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
  • Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

درخواست HTTP

POST https://routes.googleapis.com/directions/v2:computeRoutes

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

The request body contains data with the following structure:

JSON representation
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
فیلدها
origin

object ( Waypoint )

مورد نیاز. Origin waypoint.

destination

object ( Waypoint )

مورد نیاز. Destination waypoint.

intermediates[]

object ( Waypoint )

اختیاری. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.

travel Mode

enum ( RouteTravelMode )

اختیاری. Specifies the mode of transportation.

routing Preference

enum ( RoutingPreference )

اختیاری. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. You can specify this option only when the travelMode is DRIVE or TWO_WHEELER , otherwise the request fails.

polyline Quality

enum ( PolylineQuality )

اختیاری. Specifies your preference for the quality of the polyline.

polyline Encoding

enum ( PolylineEncoding )

اختیاری. Specifies the preferred encoding for the polyline.

departure Time

string ( Timestamp format)

اختیاری. The departure time. If you don't set this value, then this value defaults to the time that you made the request. NOTE: You can only specify a departureTime in the past when RouteTravelMode is set to TRANSIT . Transit trips are available for up to 7 days in the past or 100 days in the future.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

arrival Time

string ( Timestamp format)

اختیاری. The arrival time. NOTE: Can only be set when RouteTravelMode is set to TRANSIT . You can specify either departureTime or arrivalTime , but not both. Transit trips are available for up to 7 days in the past or 100 days in the future.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

compute Alternative Routes

boolean

اختیاری. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints.

route Modifiers

object ( RouteModifiers )

اختیاری. A set of conditions to satisfy that affect the way routes are calculated.

language Code

string

اختیاری. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Unicode Locale Identifier . See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request.

region Code

string

اختیاری. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains .

units

enum ( Units )

اختیاری. Specifies the units of measure for the display fields. These fields include the instruction field in NavigationInstruction . The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don't provide this value, then the display units are inferred from the location of the first origin.

optimize Waypoint Order

boolean

اختیاری. If set to true, the service attempts to minimize the overall cost of the route by re-ordering the specified intermediate waypoints. The request fails if any of the intermediate waypoints is a via waypoint. Use ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index to find the new ordering. If ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index is not requested in the X-Goog-FieldMask header, the request fails. If optimizeWaypointOrder is set to false, ComputeRoutesResponse.optimized_intermediate_waypoint_index will be empty.

requested Reference Routes[]

enum ( ReferenceRoute )

اختیاری. Specifies what reference routes to calculate as part of the request in addition to the default route. A reference route is a route with a different route calculation objective than the default route. For example a FUEL_EFFICIENT reference route calculation takes into account various parameters that would generate an optimal fuel efficient route. When using this feature, look for routeLabels on the resulting routes.

extra Computations[]

enum ( ExtraComputation )

اختیاری. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

traffic Model

enum ( TrafficModel )

اختیاری. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the Route and RouteLeg which contains the predicted time in traffic based on historical averages. TrafficModel is only available for requests that have set RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE . Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

transit Preferences

object ( TransitPreferences )

اختیاری. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transitPreferences when RouteTravelMode is set to TRANSIT .

بدن پاسخگو

v2.computeRoutes the response message.

If successful, the response body contains data with the following structure:

JSON representation
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
فیلدها
routes[]

object ( Route )

Contains an array of computed routes (up to three) when you specify compute_alternatives_routes , and contains just one route when you don't. When this array contains multiple entries, the first one is the most recommended route. If the array is empty, then it means no route could be found.

fallback Info

object ( FallbackInfo )

In some cases when the server is not able to compute the route results with all of the input preferences, it may fallback to using a different way of computation. When fallback mode is used, this field contains detailed info about the fallback response. Otherwise this field is unset.

geocoding Results

object ( GeocodingResults )

Contains geocoding response info for waypoints specified as addresses.

PolylineQuality

A set of values that specify the quality of the polyline.

Enums
POLYLINE_QUALITY_UNSPECIFIED No polyline quality preference specified. Defaults to OVERVIEW .
HIGH_QUALITY Specifies a high-quality polyline - which is composed using more points than OVERVIEW , at the cost of increased response size. Use this value when you need more precision.
OVERVIEW Specifies an overview polyline - which is composed using a small number of points. Use this value when displaying an overview of the route. Using this option has a lower request latency compared to using the HIGH_QUALITY option.

PolylineEncoding

Specifies the preferred type of polyline to be returned.

Enums
POLYLINE_ENCODING_UNSPECIFIED No polyline type preference specified. Defaults to ENCODED_POLYLINE .
ENCODED_POLYLINE Specifies a polyline encoded using the polyline encoding algorithm .
GEO_JSON_LINESTRING Specifies a polyline using the GeoJSON LineString format

ReferenceRoute

A supported reference route on the ComputeRoutesRequest.

Enums
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده است. Requests containing this value fail.
FUEL_EFFICIENT Fuel efficient route.
SHORTER_DISTANCE

Route with shorter travel distance. این یک ویژگی آزمایشی است.

For DRIVE requests, this feature prioritizes shorter distance over driving comfort. For example, it may prefer local roads instead of highways, take dirt roads, cut through parking lots, etc. This feature does not return any maneuvers that Google Maps knows to be illegal.

For BICYCLE and TWO_WHEELER requests, this feature returns routes similar to those returned when you don't specify requestedReferenceRoutes .

This feature is not compatible with any other travel modes, via intermediate waypoints, or optimizeWaypointOrder ; such requests will fail. However, you can use it with any routingPreference .

ExtraComputation

Extra computations to perform while completing the request.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده است. Requests containing this value will fail.
TOLLS Toll information for the route(s).
FUEL_CONSUMPTION Estimated fuel consumption for the route(s).
TRAFFIC_ON_POLYLINE Traffic aware polylines for the route(s).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions presented as a formatted HTML text string. This content is meant to be read as-is. This content is for display only. Do not programmatically parse it.
FLYOVER_INFO_ON_POLYLINE Flyover information for the route(s). The routes.polyline_details.flyover_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.
NARROW_ROAD_INFO_ON_POLYLINE Narrow road information for the route(s). The routes.polyline_details.narrow_road_info fieldmask must be specified to return this information. This data will only currently be populated for certain metros in India. This feature is experimental, and the SKU/charge is subject to change.

مسیر

Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.

JSON representation
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string,
  "polylineDetails": {
    object (PolylineDetails)
  }
}
فیلدها
route Labels[]

enum ( RouteLabel )

Labels for the Route that are useful to identify specific properties of the route to compare against others.

legs[]

object ( RouteLeg )

A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non- via Waypoints . For example, a route with no intermediate waypoints has only one leg. A route that includes one non- via intermediate waypoint has two legs. A route that includes one via intermediate waypoint has one leg. The order of the legs matches the order of waypoints from origin to intermediates to destination .

distance Meters

integer

The travel distance of the route, in meters.

duration

string ( Duration format)

The length of time needed to navigate the route. If you set the routingPreference to TRAFFIC_UNAWARE , then this value is the same as staticDuration . If you set the routingPreference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

static Duration

string ( Duration format)

The duration of travel through the route without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The overall route polyline. This polyline is the combined polyline of all legs .

description

string

A description of the route.

warnings[]

string

An array of warnings to show when displaying the route.

viewport

object ( Viewport )

The viewport bounding box of the polyline.

travel Advisory

object ( RouteTravelAdvisory )

Additional information about the route.

optimized Intermediate Waypoint Index[]

integer

If you set optimizeWaypointOrder to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: Dallas, Bangor, Phoenix; Destination: New York; and the optimized intermediate waypoint order is Phoenix, Dallas, Bangor, then this field contains the values [2, 0, 1]. The index starts with 0 for the first intermediate waypoint provided in the input.

localized Values

object ( RouteLocalizedValues )

Text representations of properties of the Route .

route Token

string

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

NOTE: Route.route_token is only available for requests that have set ComputeRoutesRequest.routing_preference to TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL . Route.route_token is not supported for requests that have Via waypoints.

polyline Details

object ( PolylineDetails )

Contains information about details along the polyline.

RouteLabel

Labels for the Route that are useful to identify specific properties of the route to compare against others.

Enums
ROUTE_LABEL_UNSPECIFIED Default - not used.
DEFAULT_ROUTE The default "best" route returned for the route computation.
DEFAULT_ROUTE_ALTERNATE An alternative to the default "best" route. Routes like this will be returned when computeAlternativeRoutes is specified.
FUEL_EFFICIENT Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption.
SHORTER_DISTANCE Shorter travel distance route. این یک ویژگی آزمایشی است.

RouteLeg

Contains a segment between non- via waypoints.

JSON representation
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
فیلدها
distance Meters

integer

The travel distance of the route leg, in meters.

duration

string ( Duration format)

The length of time needed to navigate the leg. If the route_preference is set to TRAFFIC_UNAWARE , then this value is the same as staticDuration . If the route_preference is either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

static Duration

string ( Duration format)

The duration of travel through the leg, calculated without taking traffic conditions into consideration.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The overall polyline for this leg that includes each step 's polyline.

start Location

object ( Location )

The start location of this leg. This location might be different from the provided origin . For example, when the provided origin is not near a road, this is a point on the road.

end Location

object ( Location )

The end location of this leg. This location might be different from the provided destination . For example, when the provided destination is not near a road, this is a point on the road.

steps[]

object ( RouteLegStep )

An array of steps denoting segments within this leg. Each step represents one navigation instruction.

travel Advisory

object ( RouteLegTravelAdvisory )

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg.

localized Values

object ( RouteLegLocalizedValues )

Text representations of properties of the RouteLeg .

steps Overview

object ( StepsOverview )

Overview information about the steps in this RouteLeg . This field is only populated for TRANSIT routes.

پلی لاین

Encapsulates an encoded polyline.

JSON representation
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
فیلدها
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following:
encoded Polyline

string

The string encoding of the polyline using the polyline encoding algorithm

geo Json Linestring

object ( Struct format)

Specifies a polyline using the GeoJSON LineString format .

RouteLegStep

Contains a segment of a RouteLeg . A step corresponds to a single navigation instruction. Route legs are made up of steps.

JSON representation
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
فیلدها
distance Meters

integer

The travel distance of this step, in meters. In some circumstances, this field might not have a value.

static Duration

string ( Duration format)

The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

polyline

object ( Polyline )

The polyline associated with this step.

start Location

object ( Location )

The start location of this step.

end Location

object ( Location )

The end location of this step.

navigation Instruction

object ( NavigationInstruction )

Navigation instructions.

travel Advisory

object ( RouteLegStepTravelAdvisory )

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step.

localized Values

object ( RouteLegStepLocalizedValues )

Text representations of properties of the RouteLegStep .

transit Details

object ( RouteLegStepTransitDetails )

Details pertaining to this step if the travel mode is TRANSIT .

travel Mode

enum ( RouteTravelMode )

The travel mode used for this step.

مانور

A set of values that specify the navigation action to take for the current step (for example, turn left, merge, or straight).

Enums
MANEUVER_UNSPECIFIED استفاده نشده است.
TURN_SLIGHT_LEFT Turn slightly to the left.
TURN_SHARP_LEFT Turn sharply to the left.
UTURN_LEFT Make a left u-turn.
TURN_LEFT به چپ بپیچید.
TURN_SLIGHT_RIGHT Turn slightly to the right.
TURN_SHARP_RIGHT Turn sharply to the right.
UTURN_RIGHT Make a right u-turn.
TURN_RIGHT به راست بپیچید.
STRAIGHT Go straight.
RAMP_LEFT Take the left ramp.
RAMP_RIGHT Take the right ramp.
MERGE Merge into traffic.
FORK_LEFT Take the left fork.
FORK_RIGHT Take the right fork.
FERRY Take the ferry.
FERRY_TRAIN Take the train leading onto the ferry.
ROUNDABOUT_LEFT Turn left at the roundabout.
ROUNDABOUT_RIGHT Turn right at the roundabout.
DEPART Initial maneuver.
NAME_CHANGE Used to indicate a street name change.

RouteLegStepTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions on a leg step.

JSON representation
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
speed Reading Intervals[]

object ( SpeedReadingInterval )

NOTE: This field is not currently populated.

RouteLegStepLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

RouteLegStepTransitDetails

Additional information for the RouteLegStep related to TRANSIT routes.

JSON representation
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
فیلدها
stop Details

object ( TransitStopDetails )

Information about the arrival and departure stops for the step.

localized Values

object ( TransitDetailsLocalizedValues )

Text representations of properties of the RouteLegStepTransitDetails .

headsign

string

Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station.

headway

string ( Duration format)

Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

transit Line

object ( TransitLine )

Information about the transit line used in this step.

stop Count

integer

The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,

stopCount

returns 3.

trip Short Text

string

The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the tripShortText of the Amtrak train that leaves San Jose, CA at 15:10 on weekdays to Sacramento, CA.

TransitStopDetails

Details about the transit stops for the RouteLegStep .

JSON representation
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
فیلدها
arrival Stop

object ( TransitStop )

Information about the arrival stop for the step.

arrival Time

string ( Timestamp format)

The estimated time of arrival for the step.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

departure Stop

object ( TransitStop )

Information about the departure stop for the step.

departure Time

string ( Timestamp format)

The estimated time of departure for the step.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

TransitStop

Information about a transit stop.

JSON representation
{
  "name": string,
  "location": {
    object (Location)
  }
}
فیلدها
name

string

The name of the transit stop.

location

object ( Location )

The location of the stop expressed in latitude/longitude coordinates.

TransitDetailsLocalizedValues

Localized descriptions of values for RouteTransitDetails .

JSON representation
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
فیلدها
arrival Time

object ( LocalizedTime )

Time in its formatted text representation with a corresponding time zone.

departure Time

object ( LocalizedTime )

Time in its formatted text representation with a corresponding time zone.

LocalizedTime

Localized description of time.

JSON representation
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
فیلدها
time

object ( LocalizedText )

The time specified as a string in a given time zone.

time Zone

string

Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database , eg "America/New_York".

TransitLine

Contains information about the transit line used in this step.

JSON representation
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
فیلدها
agencies[]

object ( TransitAgency )

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon Uri

string

The URI for the icon associated with this line.

name Short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text Color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

object ( TransitVehicle )

The type of vehicle that operates on this transit line.

TransitAgency

A transit agency that operates a transit line.

JSON representation
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
فیلدها
name

string

The name of this transit agency.

phone Number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitVehicle

Information about a vehicle used in transit routes.

JSON representation
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
فیلدها
name

object ( LocalizedText )

The name of this vehicle, capitalized.

type

enum ( TransitVehicleType )

The type of vehicle used.

icon Uri

string

The URI for an icon associated with this vehicle type.

local Icon Uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Enums
TRANSIT_VEHICLE_TYPE_UNSPECIFIED استفاده نشده
BUS اتوبوس
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN راه آهن شهری.
FERRY فری
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN قطار پر سرعت.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL مونوریل.
OTHER All other vehicles.
RAIL راه آهن.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Trolleybus.

RouteLegTravelAdvisory

Contains the additional information that the user should be informed about on a leg step, such as possible traffic zone restrictions.

JSON representation
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
فیلدها
toll Info

object ( TollInfo )

Contains information about tolls on the specific RouteLeg . This field is only populated if we expect there are tolls on the RouteLeg . If this field is set but the estimatedPrice subfield is not populated, we expect that road contains tolls but we do not know an estimated price. If this field does not exist, then there is no toll on the RouteLeg .

speed Reading Intervals[]

object ( SpeedReadingInterval )

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the RouteLeg without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

RouteLegLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

duration

object ( LocalizedText )

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as staticDuration.

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

StepsOverview

Provides overview information about a list of RouteLegStep s.

JSON representation
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
فیلدها
multi Modal Segments[]

object ( MultiModalSegment )

Summarized information about different multi-modal segments of the RouteLeg.steps . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

MultiModalSegment

Provides summarized information about different multi-modal segments of the RouteLeg.steps . A multi-modal segment is defined as one or more contiguous RouteLegStep that have the same RouteTravelMode . This field is not populated if the RouteLeg does not contain any multi-modal segments in the steps.

JSON representation
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
فیلدها
navigation Instruction

object ( NavigationInstruction )

NavigationInstruction for the multi-modal segment.

travel Mode

enum ( RouteTravelMode )

The travel mode of the multi-modal segment.

step Start Index

integer

The corresponding RouteLegStep index that is the start of a multi-modal segment.

step End Index

integer

The corresponding RouteLegStep index that is the end of a multi-modal segment.

درگاه دید

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, ie it includes its boundary. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. Various cases include:

  • اگر low = high ، نمای از همان نقطه واحد تشکیل شده است.

  • اگر low.longitude > high.longitude , محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).

  • اگر low.longitude = -180 درجه و high.longitude = 180 درجه باشد، درگاه دید شامل تمام طول‌های جغرافیایی می‌شود.

  • اگر low.longitude = 180 درجه و high.longitude = -180 درجه باشد، محدوده طول جغرافیایی خالی است.

  • اگر low.latitude > high.latitude ، محدوده عرض جغرافیایی خالی است.

Both low and high must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.

For example, this viewport fully encloses New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON representation
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
فیلدها
low

object ( LatLng )

مورد نیاز. The low point of the viewport.

high

object ( LatLng )

مورد نیاز. The high point of the viewport.

RouteLocalizedValues

Text representations of certain properties.

JSON representation
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
فیلدها
distance

object ( LocalizedText )

Travel distance represented in text form.

duration

object ( LocalizedText )

Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as staticDuration .

static Duration

object ( LocalizedText )

Duration without taking traffic conditions into consideration, represented in text form.

transit Fare

object ( LocalizedText )

Transit fare represented in text form.

PolylineDetails

Details corresponding to a given index or contiguous segment of a polyline. Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the PolylineDetails defines an interval and associated metadata.

JSON representation
{
  "flyoverInfo": [
    {
      object (FlyoverInfo)
    }
  ],
  "narrowRoadInfo": [
    {
      object (NarrowRoadInfo)
    }
  ]
}
فیلدها
flyover Info[]

object ( FlyoverInfo )

Flyover details along the polyline.

narrow Road Info[]

object ( NarrowRoadInfo )

Narrow road details along the polyline.

FlyoverInfo

Encapsulates information about flyovers along the polyline.

JSON representation
{
  "flyoverPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
flyover Presence

enum ( RoadFeatureState )

فقط خروجی Denotes whether a flyover exists for a given stretch of the polyline.

polyline Point Index

object ( PolylinePointIndex )

The location of flyover related information along the polyline.

RoadFeatureState

Encapsulates the states of road features along a stretch of polyline.

Enums
ROAD_FEATURE_STATE_UNSPECIFIED The road feature's state was not computed (default value).
EXISTS The road feature exists.
DOES_NOT_EXIST The road feature does not exist.

PolylinePointIndex

Encapsulates the start and end indexes for a polyline detail. For instances where the data corresponds to a single point, startIndex and endIndex will be equal.

JSON representation
{
  "startIndex": integer,
  "endIndex": integer
}
فیلدها
start Index

integer

The start index of this detail in the polyline.

end Index

integer

The end index of this detail in the polyline.

NarrowRoadInfo

Encapsulates information about narrow roads along the polyline.

JSON representation
{
  "narrowRoadPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
فیلدها
narrow Road Presence

enum ( RoadFeatureState )

فقط خروجی Denotes whether a narrow road exists for a given stretch of the polyline.

polyline Point Index

object ( PolylinePointIndex )

The location of narrow road related information along the polyline.

GeocodingResults

Contains GeocodedWaypoints for origin, destination and intermediate waypoints. Only populated for address waypoints.

JSON representation
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
فیلدها
origin

object ( GeocodedWaypoint )

Origin geocoded waypoint.

destination

object ( GeocodedWaypoint )

Destination geocoded waypoint.

intermediates[]

object ( GeocodedWaypoint )

A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request.

GeocodedWaypoint

Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.

JSON representation
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
فیلدها
geocoder Status

object ( Status )

Indicates the status code resulting from the geocoding operation.

type[]

string

The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types .

partial Match

boolean

Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address.

place Id

string

The place ID for this result.

intermediate Waypoint Request Index

integer

The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint.