پاسخ‌های مسیر

توسعه‌دهندگان منطقه اقتصادی اروپا (EEA)

این محصول در وضعیت قدیمی است. از اکتبر ۲۰۲۶، Directions API (قدیمی) دیگر نمی‌تواند برای پروژه‌های جدید Google Cloud فعال شود. پروژه‌های موجود همچنان کاملاً پشتیبانی می‌شوند. برای ویژگی‌های جدید و عملکرد بهبودیافته، به Routes API منتقل شوید.

پاسخ‌های نمونه

پاسخ‌های مسیرها در قالبی که با پرچم output در مسیر درخواست نشانی وب مشخص شده است برگردانده می‌شود.

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

نشانی وب

https://maps.googleapis.com/maps/api/directions/json
  ?destination=Los%20Angeles%2C%20CA
  &origin=Chicago%2C%20IL
  &waypoints=Joplin%2C%20MO%7COklahoma%20City%2C%20OK
  &key=YOUR_API_KEY

curl

curl -L -X GET 'https://maps.googleapis.com/maps/api/directions/json?origin=Chicago%2C%20IL&destination=Los%20Angeles%2C%20CA&waypoints=Joplin%2C%20MO%7COklahoma%20City%2C%20OK&key=YOUR_API_KEY'

نمونه بالا برونداد JSON را درخواست می‌کند. همچنین می‌توانید خروجی XML درخواست کنید. برای دیدن نمونه پاسخ‌های JSON و XML، برگه‌های زیر را انتخاب کنید.

(قالب) JSON

      
{
  "geocoded_waypoints":
    [
      {
        "geocoder_status": "OK",
        "place_id": "ChIJ7cv00DwsDogRAMDACa2m4K8",
        "types": ["locality", "political"],
      },
      {
        "geocoder_status": "OK",
        "place_id": "ChIJ69Pk6jdlyIcRDqM1KDY3Fpg",
        "types": ["locality", "political"],
      },
      {
        "geocoder_status": "OK",
        "place_id": "ChIJgdL4flSKrYcRnTpP0XQSojM",
        "types": ["locality", "political"],
      },
      {
        "geocoder_status": "OK",
        "place_id": "ChIJE9on3F3HwoAR9AhGJW_fL-I",
        "types": ["locality", "political"],
      },
    ],
  "routes":
    [
      {
        "bounds":
          {
            "northeast": { "lat": 41.8781139, "lng": -87.6297872 },
            "southwest": { "lat": 34.0523525, "lng": -118.2435717 },
          },
        "copyrights": "Map data ©2022 Google, INEGI",
        "legs":
          [
            {
              "distance": { "text": "579 mi", "value": 932311 },
              "duration": { "text": "8 hours 48 mins", "value": 31653 },
              "end_address": "Joplin, MO, USA",
              "end_location": { "lat": 37.0842449, "lng": -94.513284 },
              "start_address": "Chicago, IL, USA",
              "start_location": { "lat": 41.8781139, "lng": -87.6297872 },
              "steps":
                [
                  {
                    "distance": { "text": "443 ft", "value": 135 },
                    "duration": { "text": "1 min", "value": 24 },
                    "end_location": { "lat": 41.8769003, "lng": -87.6297353 },
                    "html_instructions": "Head <b>south</b> on <b>S Federal St</b> toward <b>W Van Buren St</b>",
                    "polyline": { "points": "eir~FdezuOdCEjBC" },
                    "start_location": { "lat": 41.8781139, "lng": -87.6297872 },
                    "travel_mode": "DRIVING",
                  },
                  {
                    "distance": { "text": "269 ft", "value": 82 },
                    "duration": { "text": "1 min", "value": 20 },
                    "end_location": { "lat": 41.8768866, "lng": -87.63073 },
                    "html_instructions": "Turn <b>right</b> at the 1st cross street onto <b>W Van Buren St</b>",
                    "maneuver": "turn-right",
                    "polyline": { "points": "sar~FzdzuO@fC?|@" },
                    "start_location": { "lat": 41.8769003, "lng": -87.6297353 },
                    "travel_mode": "DRIVING",
                  },
                  // Additional steps omitted for brevity
                ],
              "traffic_speed_entry": [],
              "via_waypoint": [],
            },
            // Additional legs (Joplin to Oklahoma City, Oklahoma City to Los Angeles) omitted for brevity
          ],
        "overview_polyline":
          {
            "points": "eir~FdezuOxyFzfFl`G|qZvtSzqo@d}EhlLtqIdjFhrTfvEdca@... (truncated for brevity)",
          },
        "summary": "I-55 S and I-44",
        "warnings": [],
        "waypoint_order": [0, 1],
      },
    ],
  "status": "OK",
}
      
      

XML

      
<DirectionsResponse>
 <status>OK</status>
 <route>
  <summary>I-55 S and I-44</summary>
  <leg>
   <step>
    <travel_mode>DRIVING</travel_mode>
    <start_location>
     <lat>41.8781139</lat>
     <lng>-87.6297872</lng>
    </start_location>
    <end_location>
     <lat>41.8769003</lat>
     <lng>-87.6297353</lng>
    </end_location>
    <polyline>
     <points>eir~FdezuOdCEjBC</points>
    </polyline>
    <duration>
     <value>24</value>
     <text>1 min</text>
    </duration>
    <html_instructions>Head &lt;b&gt;south&lt;/b&gt; on &lt;b&gt;S Federal St&lt;/b&gt; toward &lt;b&gt;W Van Buren St&lt;/b&gt;</html_instructions>
    <distance>
     <value>135</value>
     <text>443 ft</text>
    </distance>
   </step>
   <step>
    <travel_mode>DRIVING</travel_mode>
    <start_location>
     <lat>41.8769003</lat>
     <lng>-87.6297353</lng>
    </start_location>
    <end_location>
     <lat>41.8768866</lat>
     <lng>-87.6307300</lng>
    </end_location>
    <polyline>
     <points>sar~FzdzuO@fC?|@</points>
    </polyline>
    <duration>
     <value>20</value>
     <text>1 min</text>
    </duration>
    <html_instructions>Turn &lt;b&gt;right&lt;/b&gt; at the 1st cross street onto &lt;b&gt;W Van Buren St&lt;/b&gt;</html_instructions>
    <distance>
     <value>82</value>
     <text>269 ft</text>
    </distance>
    <maneuver>turn-right</maneuver>
   </step>
   <!-- Additional steps omitted for brevity -->
   <duration>
    <value>31653</value>
    <text>8 hours 48 mins</text>
   </duration>
   <distance>
    <value>932311</value>
    <text>579 mi</text>
   </distance>
   <start_location>
    <lat>41.8781139</lat>
    <lng>-87.6297872</lng>
   </start_location>
   <end_location>
    <lat>37.0842449</lat>
    <lng>-94.5132840</lng>
   </end_location>
   <start_address>Chicago, IL, USA</start_address>
   <end_address>Joplin, MO, USA</end_address>
  </leg>
  <!-- Additional legs (Joplin to Oklahoma City, Oklahoma City to Los Angeles) omitted for brevity -->
  <copyrights>Map data ©2022 Google, INEGI</copyrights>
  <overview_polyline>
   <points>eir~FdezuOxyFzfFl`G|qZvtSzqo@d}EhlLtqIdjFhrTfvEdca@... (truncated for brevity)</points>
  </overview_polyline>
  <waypoint_index>0</waypoint_index>
  <waypoint_index>1</waypoint_index>
  <bounds>
   <southwest>
    <lat>34.0523525</lat>
    <lng>-118.2435717</lng>
   </southwest>
   <northeast>
    <lat>41.8781139</lat>
    <lng>-87.6297872</lng>
   </northeast>
  </bounds>
 </route>
 <geocoded_waypoint>
  <geocoder_status>OK</geocoder_status>
  <type>locality</type>
  <type>political</type>
  <place_id>ChIJ7cv00DwsDogRAMDACa2m4K8</place_id>
 </geocoded_waypoint>
 <geocoded_waypoint>
  <geocoder_status>OK</geocoder_status>
  <type>locality</type>
  <type>political</type>
  <place_id>ChIJ69Pk6jdlyIcRDqM1KDY3Fpg</place_id>
 </geocoded_waypoint>
 <geocoded_waypoint>
  <geocoder_status>OK</geocoder_status>
  <type>locality</type>
  <type>political</type>
  <place_id>ChIJgdL4flSKrYcRnTpP0XQSojM</place_id>
 </geocoded_waypoint>
 <geocoded_waypoint>
  <geocoder_status>OK</geocoder_status>
  <type>locality</type>
  <type>political</type>
  <place_id>ChIJE9on3F3HwoAR9AhGJW_fL-I</place_id>
 </geocoded_waypoint>
</DirectionsResponse>
      
      

بقیه این سند از نحو JSON استفاده خواهد کرد. در بیشتر موارد، قالب برونداد برای اهداف نشان دادن مفاهیم یا نام‌های فیلد در مستندات اهمیتی ندارد. بااین‌حال، به تفاوت‌های ظریف زیر توجه کنید:

  • نتایج XML در عنصر ریشه <DirectionsResponse> قرار می‌گیرند.
  • JSON ورودی‌های دارای چندین عنصر را با آرایه‌های جمع (مانند steps و legs) نشان می‌دهد، درحالی‌که XML این ورودی‌ها را بااستفاده از چندین عنصر مفرد (مانند <step> و <leg>) نشان می‌دهد.
  • ‫JSON ترتیب نقطه‌مسیر را ازطریق فیلد waypoint_order نشان می‌دهد، درحالی‌که XML این موارد را بااستفاده از عناصر <waypoint_index> جداگانه نشان می‌دهد.
  • عناصر خالی ازطریق آرایه‌های خالی در JSON نشان داده می‌شوند، اما با عدم وجود هرگونه عنصری ازاین‌قبیل در XML. پاسخی که هیچ نتیجه‌ای تولید نمی‌کند، برای مثال، آرایه routes خالی در JSON برمی‌گرداند، اما هیچ عنصر <route> در XML برنمی‌گرداند.

DirectionsResponse

فیلد الزامی نوع شرح
الزامی Array<DirectionsRoute>

حاوی آرایه‌ای از مسیرها از مبدأ تا مقصد است. مسیرها شامل «بخش‌ها» و «مراحل» تودرتو هستند.

برای اطلاعات بیشتر، DirectionsRoute را ببینید.

الزامی DirectionsStatus

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

برای اطلاعات بیشتر، DirectionsStatus را ببینید.

اختیاری Array<TravelMode>

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

برای اطلاعات بیشتر، TravelMode را ببینید.

اختیاری رشته

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

اختیاری Array<DirectionsGeocodedWaypoint>

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

اگر سرویس هیچ نتیجه‌ای برنگرداند، این جزئیات برای نقاط‌مسیر مشخص‌شده به‌عنوان مقادیر متنی عرض/طول جغرافیایی وجود نخواهد داشت. دلیلش این است که چنین نقطه‌مسیرهایی فقط پس‌از پیدا شدن مسیر، برای دریافت نشانی نماینده‌شان زمین‌کدیابی معکوس می‌شوند. یک شیء JSON خالی مکان‌های مربوطه را در آرایه geocoded_waypoints اشغال خواهد کرد.

برای اطلاعات بیشتر، DirectionsGeocodedWaypoint را ببینید.

DirectionsRoute

مسیرها شامل legs و steps تودرتو است.

فیلد الزامی نوع شرح
الزامی مرزها

حاوی کادر محدودکننده ناحیه نمایش overview_polyline است.

برای اطلاعات بیشتر، محدوده‌ها را ببینید.

الزامی رشته

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

الزامی Array<DirectionsLeg>

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

برای اطلاعات بیشتر، DirectionsLeg را ببینید.

الزامی DirectionsPolyline

حاوی شیئی است که نمایش چندخطی کدبندی‌شده مسیر را نگه می‌دارد. این چندخطی مسیر تقریبی (هموارشده) مسیرهای حاصل است.

برای اطلاعات بیشتر، DirectionsPolyline را ببینید.

الزامی رشته

حاوی شرح نوشتاری کوتاهی برای مسیر است که برای نام‌گذاری و ابهام‌زدایی مسیر از جایگزین‌ها مناسب است.

الزامی Array<string>

حاوی آرایه‌ای از هشدارها است که هنگام نمایش این مسیرها نشان داده می‌شود. باید این هشدارها را خودتان مدیریت و نمایش دهید.

الزامی آرایه<عدد صحیح>

آرایه‌ای که ترتیب نقاط‌مسیر را در مسیر محاسبه‌شده نشان می‌دهد. اگر درخواست optimize:true در پارامتر نقاط‌مسیر آن ارسال شده باشد، ممکن است ترتیب این نقاط‌مسیر تغییر کند.

اختیاری کرایه

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

برای اطلاعات بیشتر، به کرایه مراجعه کنید.

محدوده

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

فیلد الزامی نوع شرح
الزامی LatLngLiteral برای اطلاعات بیشتر، LatLngLiteral را ببینید.
الزامی LatLngLiteral برای اطلاعات بیشتر، LatLngLiteral را ببینید.

LatLngLiteral

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

فیلد الزامی نوع شرح
الزامی شماره

عرض جغرافیایی به درجه اعشاری

الزامی شماره

طول جغرافیایی به درجه اعشاری

DirectionsLeg

فیلد الزامی نوع شرح
الزامی رشته

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

الزامی LatLngLiteral

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

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

الزامی رشته

حاوی نشانی قابل‌خواندن برای انسان (معمولاً نشانی خیابان) است که از زمین‌کدیابی معکوس start_location این بخش به‌دست آمده است. این محتوا باید همان‌طور که هست خوانده شود. نشانی قالب‌بندی‌شده را به‌صورت برنامه‌نویسی تجزیه نکنید.

الزامی LatLngLiteral

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

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

الزامی آرایه<DirectionsStep>

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

برای اطلاعات بیشتر، DirectionsStep را ببینید.

traffic_speed_entry

اختیاری Array<DirectionsTrafficSpeedEntry>

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

برای اطلاعات بیشتر، DirectionsTrafficSpeedEntry را ببینید.

الزامی Array<DirectionsViaWaypoint>

مکان‌های نقاط‌مسیر میانی درطول این بخش.

برای اطلاعات بیشتر، DirectionsViaWaypoint را ببینید.

اختیاری TimeZoneTextValueObject

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

برای اطلاعات بیشتر، TimeZoneTextValueObject را ببینید.

اختیاری TimeZoneTextValueObject

حاوی زمان تخمینی حرکت برای این بخش است که به‌عنوان شیء «زمان» مشخص شده است. departure_time فقط برای مسیرهای حمل‌ونقل عمومی دردسترس است.

برای اطلاعات بیشتر، TimeZoneTextValueObject را ببینید.

اختیاری TextValueObject

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

برای اطلاعات بیشتر، TextValueObject را ببینید.

اختیاری TextValueObject

کل مدت این بخش.

برای اطلاعات بیشتر، TextValueObject را ببینید.

اختیاری TextValueObject

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

  • درخواست شامل نقطه‌مسیرهای توقف بین راه نیست. اگر درخواست شامل نقطه‌مسیر باشد، باید پیشوند via: داشته باشد تا از توقف بین راه جلوگیری شود.
  • درخواست به‌طور خاص برای مسیرهای رانندگی است—پارامتر حالت روی driving تنظیم شده است.
  • درخواست شامل پارامتر departure_time است.
  • شرایط ترافیک برای مسیر درخواستی دردسترس است.

برای اطلاعات بیشتر، TextValueObject را ببینید.

DirectionsStep

هر عنصر در آرایه مراحل، یک مرحله از مسیرهای محاسبه‌شده را تعریف می‌کند. مرحله، اتمی‌ترین واحد مسیر جهت است که شامل یک مرحله است که یک دستورالعمل خاص و واحد را در سفر توصیف می‌کند. مثلاً «در خیابان غربی به چپ بپیچید. ‫4th St.‎» این مرحله نه‌تنها دستورالعمل را شرح می‌دهد، بلکه حاوی اطلاعات مسافت و مدت‌زمان مربوط به نحوه ارتباط این مرحله با مرحله بعدی است. برای مثال، مرحله‌ای که با عنوان «ادغام در I-80 West» مشخص شده است ممکن است حاوی مدت «۳۷ مایل» و «۴۰ دقیقه» باشد، که نشان می‌دهد مرحله بعدی ۳۷ مایل/۴۰ دقیقه از این مرحله فاصله دارد.

هنگام استفاده از Directions API برای جستجوی مسیرهای حمل‌ونقل عمومی، آرایه مراحل شامل جزئیات حمل‌ونقل عمومی اضافی به‌صورت آرایه transit_details خواهد بود. اگر مسیرها شامل چندین حالت حمل‌ونقل باشد، مسیرهای دقیق برای مراحل پیاده‌روی یا رانندگی در آرایه مراحل داخلی ارائه خواهد شد. برای مثال، مرحله پیاده‌روی شامل مسیرهای شروع و پایان مکان‌ها خواهد بود: «پیاده‌روی به Innes Ave و Fitch St». آن مرحله شامل مسیرهای پیاده‌روی دقیق برای آن مسیر در آرایه مراحل داخلی خواهد بود، مانند: «به سمت شمال غربی بروید»، «به چپ بپیچید به سمت آریلیوس واکر»، و «به چپ بپیچید به سمت خیابان اینس».

فیلد الزامی نوع شرح
الزامی TextValueObject

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

برای اطلاعات بیشتر، TextValueObject را ببینید.

الزامی LatLngLiteral

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

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

الزامی رشته

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

الزامی DirectionsPolyline

حاوی یک شیء نقاط است که نمایش چندخطی کدبندی‌شده مرحله را نگه می‌دارد. این چندخطی مسیر تقریبی (هموارشده) مرحله است.

برای اطلاعات بیشتر، DirectionsPolyline را ببینید.

الزامی LatLngLiteral

حاوی مکان نقطه شروع این مرحله است.

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

الزامی TravelMode

حاوی نوع حالت سفر استفاده‌شده است.

برای اطلاعات بیشتر، TravelMode را ببینید.

اختیاری TextValueObject

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

برای اطلاعات بیشتر، TextValueObject را ببینید.

اختیاری رشته

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

The allowed values include: turn-slight-left, turn-sharp-left, turn-left, turn-slight-right, turn-sharp-right, keep-right, keep-left, uturn-left, uturn-right, turn-right, straight, ramp-left, ramp-right, merge, fork-left, fork-right, ferry, ferry-train, roundabout-left, and roundabout-right
اختیاری

حاوی مسیرهای دقیق برای مراحل پیاده‌روی یا رانندگی در مسیرهای حمل‌ونقل عمومی است. زیرمراحل فقط زمانی دردسترس است که travel_mode روی «transit» تنظیم شده باشد. آرایه مراحل داخلی از همان نوع مراحل است.

اختیاری DirectionsTransitDetails

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

برای اطلاعات بیشتر، DirectionsTransitDetails را ببینید.

TextValueObject

شیء حاوی مقدار عددی و نمایش نوشتاری قالب‌بندی‌شده آن.

فیلد الزامی نوع شرح
الزامی رشته

مقدار رشته‌ای.

الزامی شماره

مقدار عددی.

DirectionsPolyline

کدبندی چندخطی یک الگوریتم فشرده‌سازی پراتلاف است که به شما امکان می‌دهد مجموعه‌ای از مختصات را به‌عنوان یک رشته واحد ذخیره کنید. مختصات نقطه بااستفاده از مقادیر علامت‌دار کدگذاری می‌شود. If you only have a few static points, you may also want to use the interactive polyline encoding utility.

فرایند کدبندی مقدار دودویی را به مجموعه‌ای از کدهای نویسه برای نویسه‌های ASCII تبدیل می‌کند و برای این کار از طرح کدبندی آشنای base64 استفاده می‌کند: برای اطمینان از نمایش صحیح این نویسه‌ها، مقادیر کدبندی‌شده قبل‌از تبدیل شدن به ASCII، با ۶۳ (نویسه ASCII‏ «؟») جمع می‌شوند. این الگوریتم همچنین کدهای نویسه اضافی را برای یک نقطه معین با بررسی کم‌اهمیت‌ترین بیت هر گروه بایت بررسی می‌کند؛ اگر این بیت روی ۱ تنظیم شده باشد، نقطه هنوز به‌طور کامل شکل نگرفته است و باید داده‌های اضافی به‌دنبال آن بیاید.

علاوه‌براین، برای صرفه‌جویی در فضا، نقاط فقط شامل انحراف از نقطه قبلی هستند (البته به‌جز نقطه اول). همه نقاط در Base64 به‌عنوان عدد صحیح علامت‌دار کدبندی می‌شوند، زیرا عرض‌های جغرافیایی و طول‌های جغرافیایی مقادیر علامت‌دار هستند. قالب کدبندی در چندخطی باید دو مختصات را که نشان‌دهنده عرض جغرافیایی و طول جغرافیایی است با دقت معقولی نشان دهد. با فرض حداکثر طول جغرافیایی ‎+/- ۱۸۰ درجه با دقت ۵ رقم اعشار (۱۸۰٫۰۰۰۰۰ تا ‎-۱۸۰٫۰۰۰۰۰)، این امر به مقدار عدد صحیح دودویی علامت‌دار ۳۲ بیتی نیاز دارد.

فیلد الزامی نوع شرح
الزامی رشته

نمایش رشته‌ای تکی از چندخطی.

TravelMode

  • DRIVING (پیش‌فرض) نشان‌دهنده محاسبه بااستفاده از شبکه جاده‌ای است.
  • BICYCLING درخواست محاسبه برای دوچرخه‌سواری بااستفاده از مسیرهای دوچرخه و خیابان‌های ترجیحی (درصورت وجود).
  • TRANSIT درخواست محاسبه بااستفاده از مسیرهای حمل‌ونقل عمومی (درصورت وجود).
  • WALKING درخواست محاسبه برای پیاده‌روی بااستفاده از مسیرهای پیاده‌روی و پیاده‌روها (درصورت دردسترس بودن) می‌کند.

DirectionsTransitDetails

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

فیلد الزامی نوع شرح
اختیاری DirectionsTransitStop

ایستگاه حمل‌ونقل عمومی مقصد.

برای اطلاعات بیشتر، DirectionsTransitStop را ببینید.

اختیاری TimeZoneTextValueObject برای اطلاعات بیشتر، TimeZoneTextValueObject را ببینید.
اختیاری DirectionsTransitStop

ایستگاه حمل‌ونقل عمومی مبدأ.

برای اطلاعات بیشتر، DirectionsTransitStop را ببینید.

اختیاری TimeZoneTextValueObject برای اطلاعات بیشتر، TimeZoneTextValueObject را ببینید.
اختیاری رشته

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

اختیاری عدد صحیح

تعداد ثانیه‌های موردانتظار بین حرکت‌ها از یک ایستگاه را در این زمان مشخص می‌کند. برای مثال، با مقدار headway برابر با ۶۰۰، اگر اتوبوس را ازدست بدهید، انتظار می‌رود ۱۰ دقیقه منتظر بمانید.

اختیاری DirectionsTransitLine

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

برای اطلاعات بیشتر، DirectionsTransitLine را ببینید.

اختیاری عدد صحیح

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

اختیاری رشته

نوشتاری که در زمان‌بندی‌ها و تابلوهای راهنما برای شناسایی سفر حمل‌ونقل عمومی برای مسافران نشان داده می‌شود. نوشتار باید به‌طور منحصربه‌فرد سفری را در یک روز خدمات مشخص کند. برای مثال، «538» trip_short_name قطار Amtrak است که در روزهای هفته ساعت ۱۵:۱۰ از سن خوزه، کالیفرنیا به مقصد ساکرامنتو، کالیفرنیا حرکت می‌کند.

DirectionsTransitStop

فیلد الزامی نوع شرح
الزامی LatLngLiteral

مکان ایستگاه.

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

الزامی رشته

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

TimeZoneTextValueObject

شیء حاوی زمان تاریخ یونیکس، منطقه زمانی، و نمایش متنی قالب‌بندی‌شده آن.

فیلد الزامی نوع شرح
الزامی رشته

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

الزامی رشته

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

الزامی شماره

زمان مشخص‌شده به‌عنوان زمان تاریخ یونیکس، یا ثانیه‌ها از نیمه‌شب ۱ ژانویه ۱۹۷۰ ساعت هماهنگ جهانی.

DirectionsTransitLine

فیلد الزامی نوع شرح
الزامی Array<DirectionsTransitAgency>

سازمان حمل‌ونقل عمومی (یا سازمان‌هایی) که این خط حمل‌ونقل عمومی را اداره می‌کند.

برای اطلاعات بیشتر، DirectionsTransitAgency را ببینید.

الزامی رشته

نام کامل این خط حمل‌ونقل عمومی، مثلاً «8 Avenue Local».

اختیاری رشته

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

اختیاری رشته

حاوی نشانی وب نماد مرتبط با این خط است.

اختیاری رشته

نام کوتاه این خط حمل‌ونقل عمومی. این معمولاً شماره خط است، مثلاً «M7» یا «۳۵۵».

اختیاری رشته

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

اختیاری رشته

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

اختیاری DirectionsTransitVehicle

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

برای اطلاعات بیشتر، DirectionsTransitVehicle را ببینید.

DirectionsTransitAgency

فیلد الزامی نوع شرح
اختیاری رشته

نام این سازمان حمل‌ونقل عمومی.

اختیاری رشته

شماره تلفن سازمان حمل‌ونقل عمومی.

اختیاری رشته

نشانی وب دفتر حمل‌ونقل عمومی.

DirectionsTransitVehicle

فیلد الزامی نوع شرح
الزامی رشته

نام این خودرو، با حروف بزرگ.

الزامی رشته

نوع وسیله نقلیه استفاده‌شده.

  • BUS - اتوبوس.
  • CABLE_CAR - وسیله نقلیه‌ای که روی کابل حرکت می‌کند، معمولاً روی زمین. تله‌کابین‌ها ممکن است از نوع GONDOLA_LIFT باشند.
  • COMMUTER_TRAIN - قطار حومه‌ای.
  • FERRY - کشتی.
  • FUNICULAR - وسیله نقلیه‌ای که با کابل از شیب تندی بالا کشیده می‌شود. یک قطار کابلی معمولاً از دو واگن تشکیل شده است که هر واگن به‌عنوان وزنه تعادل برای دیگری عمل می‌کند.
  • GONDOLA_LIFT - تله‌کابین.
  • HEAVY_RAIL - ریلی سنگین.
  • HIGH_SPEED_TRAIN - قطار پرسرعت.
  • INTERCITY_BUS - اتوبوس بین‌شهری.
  • LONG_DISTANCE_TRAIN - قطار راه دور.
  • METRO_RAIL - قطار شهری.
  • MONORAIL - Monorail.
  • OTHER - همه وسایل نقلیه دیگر این نوع را برمی‌گردانند.
  • RAIL - راه‌آهن.
  • SHARE_TAXI - تاکسی خطی نوعی اتوبوس است که می‌تواند مسافران را در هر نقطه‌ای از مسیر سوار و پیاده کند.
  • SUBWAY - قطار شهری زیرزمینی.
  • TRAM - قطار شهری روی زمین.
  • TROLLEYBUS - اتوبوس برقی.
The allowed values include: BUS, CABLE_CAR, 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, and TROLLEYBUS
اختیاری رشته

حاوی نشانی وب نماد مرتبط با این نوع خودرو است.

اختیاری رشته

حاوی نشانی وب برای نماد مرتبط با این نوع خودرو، براساس علائم حمل‌ونقل محلی است.

DirectionsTrafficSpeedEntry

فیلد الزامی نوع شرح
الزامی شماره

انحراف درطول مسیر (به متر) که این دسته سرعت تا آن معتبر است.

الزامی رشته

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

DirectionsViaWaypoint

فیلد الزامی نوع شرح
اختیاری LatLngLiteral

مکان نقطه‌مسیر.

برای اطلاعات بیشتر، LatLngLiteral را ببینید.

اختیاری عدد صحیح

نمایه مرحله حاوی نقطه‌مسیر.

اختیاری شماره

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

کرایه

کرایه کل برای مسیر.

{
  "currency" : "USD",
  "value" : 6,
  "text" : "$6.00"
}
فیلد الزامی نوع شرح
الزامی رشته

کد ارز ISO 4217 که نشان‌دهنده ارزی است که مبلغ با آن بیان شده است.

الزامی رشته

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

الزامی شماره

مبلغ کل کرایه، به واحد پول مشخص‌شده.

DirectionsStatus

فیلد وضعیت در شیء پاسخ «مسیرها» حاوی وضعیت درخواست است و ممکن است حاوی اطلاعات اشکال‌زدایی باشد تا به شما کمک کند دلیل ناموفق بودن سرویس «مسیرها» را ردیابی کنید. فیلد وضعیت ممکن است حاوی مقادیر زیر باشد:

  • ‫OK نشان می‌دهد که پاسخ حاوی نتیجه معتبری است.
  • NOT_FOUND نشان می‌دهد که حداقل یکی از مکان‌های مشخص‌شده در مبدأ، مقصد، یا نقاط مسیر درخواست زمین‌کدیابی نشده است.
  • ZERO_RESULTS نشان می‌دهد که هیچ مسیری بین مبدأ و مقصد پیدا نشد.
  • MAX_WAYPOINTS_EXCEEDED نشان می‌دهد که نقاط‌مسیر بسیار زیادی در درخواست ارائه شده است. برای برنامه‌هایی که از Directions API به‌عنوان سرویس وب یا سرویس مسیرها در Maps JavaScript API استفاده می‌کنند، حداکثر تعداد مجاز نقاط‌مسیر ۲۵ است، به‌علاوه مبدأ و مقصد.
  • MAX_ROUTE_LENGTH_EXCEEDED نشان می‌دهد که مسیر درخواست‌شده خیلی طولانی است و نمی‌تواند پردازش شود. این خطا زمانی رخ می‌دهد که مسیرهای پیچیده‌تری برگردانده شود. تعداد نقاط‌مسیر، پیچ‌ها، یا دستورالعمل‌ها را کاهش دهید.
  • INVALID_REQUEST نشان می‌دهد که درخواست ارائه‌شده نامعتبر بوده است. دلایل معمول این وضعیت شامل پارامتر یا مقدار پارامتر نامعتبر است.
  • OVER_DAILY_LIMIT نشان‌دهنده هریک از موارد زیر است:
    • کلید میانای برنامه‌سازی کاربردی وجود ندارد یا نامعتبر است.
    • صدور صورت‌حساب در حسابتان فعال نشده است.
    • از سقف استفاده خودتحمیلی فراتر رفته است.
    • روش پرداخت ارائه‌شده دیگر معتبر نیست (برای مثال، کارت اعتباری منقضی شده است).
    برای آشنایی با نحوه رفع این مشکل، پرسشگان Maps را ببینید.
  • OVER_QUERY_LIMIT نشان می‌دهد که سرویس درخواست‌های بسیار زیادی از برنامه شما در دوره زمانی مجاز دریافت کرده است.
  • REQUEST_DENIED نشان می‌دهد که سرویس استفاده از سرویس مسیرها را توسط برنامه شما رد کرده است.
  • UNKNOWN_ERROR نشان می‌دهد که درخواست مسیر به‌دلیل خطای سرور پردازش نشده است. اگر دوباره امتحان کنید، ممکن است درخواست موفقیت‌آمیز باشد.

DirectionsGeocodedWaypoint

فیلد الزامی نوع شرح
اختیاری رشته

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

The allowed values include: OK, and ZERO_RESULTS
اختیاری

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

مطابقت‌های جزئی اغلب برای نشانی‌های خیابانی رخ می‌دهد که در منطقه‌ای که در درخواست ارسال می‌کنید وجود ندارند. وقتی درخواستی با دو یا چند مکان در یک محل مطابقت داشته باشد، ممکن است مطابقت‌های جزئی نیز برگردانده شود. برای مثال، «21 Henr St, Bristol, UK» مطابقت جزئی برای هر دو خیابان Henry و Henrietta برمی‌گرداند. توجه داشته باشید که اگر درخواستی شامل مؤلفه نشانی با املای نادرست باشد، سرویس زمین‌کدیابی ممکن است نشانی جایگزینی پیشنهاد دهد. پیشنهادهایی که به این روش راه‌اندازی می‌شوند نیز به‌عنوان مطابقت جزئی علامت‌گذاری خواهند شد.

اختیاری رشته

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

اختیاری Array<string>

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

  • administrative_area_level_1 نشان‌دهنده نهاد مدنی رده اول زیر سطح کشور است. در ایالات متحده، این سطوح اداری همان ایالت‌ها هستند. برخی‌از کشورها این سطوح اداری را ندارند. در بیشتر موارد، نام‌های کوتاه administrative_area_level_1 با زیربخش‌های ISO 3166-2 و دیگر فهرست‌های پرکاربرد مطابقت زیادی دارند؛ بااین‌حال این موضوع تضمین نمی‌شود زیرا نتایج زمین‌کدیابی ما براساس انواع مختلفی از سیگنال‌ها و داده‌های مکان است.
  • administrative_area_level_2 نشان‌دهنده نهاد مدنی رده دوم زیر سطح کشور است. در ایالات متحده، این سطوح اداری شهرستان‌ها هستند. برخی‌از کشورها این سطوح اداری را ندارند.
  • administrative_area_level_3 نشان‌دهنده نهاد مدنی رده سوم زیر سطح کشور است. این نوع نشان‌دهنده تقسیمات کشوری جزئی است. برخی‌از کشورها این سطوح اداری را ندارند.
  • administrative_area_level_4 نشان‌دهنده نهاد مدنی رده چهارم زیر سطح کشور است. این نوع نشان‌دهنده تقسیمات کشوری جزئی است. برخی‌از کشورها این سطوح اداری را ندارند.
  • ‫administrative_area_level_5 نشان‌دهنده نهاد مدنی رده پنجم زیر سطح کشور است. این نوع نشان‌دهنده تقسیمات کشوری جزئی است. برخی‌از کشورها از این سطوح اداری استفاده نمی‌کنند.
  • airport نشان‌دهنده فرودگاه است.
  • colloquial_area نشان‌دهنده نام جایگزین رایج برای نهاد است.
  • country نشان‌دهنده نهاد سیاسی ملی است و معمولاً بالاترین نوع ترتیبی است که Geocoder برمی‌گرداند.
  • intersection نشان‌دهنده تقاطع اصلی است، معمولاً تقاطع دو جاده اصلی.
  • locality نشان‌دهنده نهاد سیاسی شهر یا شهرک ثبت‌شده است.
  • natural_feature نشان‌دهنده عارضه طبیعی برجسته است.
  • neighborhood نشان‌دهنده محله نام‌گذاری‌شده است
  • park نشان‌دهنده پارک نام‌گذاری‌شده است.
  • plus_code نشان‌دهنده مرجع مکان کدگذاری‌شده است که از طول و عرض جغرافیایی مشتق شده است. در مکان‌هایی که نشانی خیابان وجود ندارد (ساختمان‌ها شماره ندارند یا خیابان‌ها نام‌گذاری نشده‌اند)، می‌توان از Plus Code به‌جای نشانی خیابان استفاده کرد. برای جزئیات، به https://plus.codes مراجعه کنید.
  • point_of_interest نشان‌دهنده نقطه موردعلاقه نام‌گذاری‌شده است. معمولاً این «نقاط موردعلاقه» نهادهای محلی برجسته‌ای هستند که به‌راحتی در دسته دیگری قرار نمی‌گیرند، مثل «ساختمان امپایر استیت» یا «برج ایفل».
  • political نشان‌دهنده نهاد سیاسی است. معمولاً این نوع نشان‌دهنده چندضلعی‌ای از برخی‌از ادارات مدنی است.
  • postal_code نشان‌دهنده کد پستی است که برای آدرس‌دهی پست در داخل کشور استفاده می‌شود.
  • premise نشان‌دهنده مکانی با نام مشخص است، معمولاً ساختمان یا مجموعه‌ای از ساختمان‌ها با نامی مشترک
  • route نشان‌دهنده مسیر نام‌گذاری‌شده است (مثل «US 101»).
  • street_address نشان‌دهنده نشانی دقیق خیابان است.
  • sublocality نشان‌دهنده نهاد مدنی درجه اول زیر یک محل است. برای برخی مکان‌ها ممکن است یکی از انواع اضافی را دریافت کند: sublocality_level_1 تا sublocality_level_5. هر سطح زیرمنطقه یک نهاد مدنی است. اعداد بزرگ‌تر نشان‌دهنده منطقه جغرافیایی کوچک‌تر است.
  • subpremise نشان‌دهنده نهاد درجه اولی در زیر مکان نام‌گذاری‌شده است، معمولاً ساختمانی منفرد در مجموعه‌ای از ساختمان‌ها با نامی مشترک
  • ‫tourist_attraction نشان‌دهنده جاذبه گردشگری است.
  • train_station نشان‌دهنده ایستگاه قطار است.
  • transit_station نشان‌دهنده ایستگاه حمل‌ونقل عمومی است.

فهرست خالی انواع نشان می‌دهد که هیچ نوع شناخته‌شده‌ای برای مؤلفه نشانی خاص وجود ندارد، برای مثال، Lieu-dit در فرانسه.