Method: computeRoutes

تعرض هذه السمة المسار الأساسي بين نقطة الانطلاق والوجهة المطلوبتَين لوضع السفر المطلوب.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
الحقول
origin

object (Waypoint)

الحقل مطلوب. نقطة الانطلاق على المسار
destination

object (Waypoint)

الحقل مطلوب. نقطة على المسار للوجهة
travelMode

enum (RouteTravelMode)

اختياريّ. تحدّد هذه السمة وسيلة النقل.
intermediateWaypoints[]

object (Waypoint)

اختياريّ. محطات التوقف الوسيطة بين نقطة الانطلاق والوجهة التي يجب المرور بها بالترتيب يمكن استخدام ما يصل إلى 25 نقطة على المسار.

سيؤدي تحديد أكثر من 10 نقاط وسيطة على المسار إلى زيادة التكلفة وزيادة وقت الاستجابة. لا يمكن استخدام النقاط على المسار المتوسطة عندما تكون قيمة travelMode هي TRANSIT.
routingPreference

enum (RoutingPreference)

اختياريّ. تحدّد هذه المَعلمة كيفية استخدام بيانات حركة المرور لحساب المسار. لا يمكن استخدام ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL عندما تكون قيمة travelMode هي WALK أو BICYCLE. بالنسبة إلى "TRANSIT"، يتيح هذا الإعداد بيانات النقل العام في الوقت الفعلي، مثل التأخيرات والإلغاءات.
locationBias

object (LatLng)

اختياريّ. موقع جغرافي لتوجيه نتائج البحث نحوه، على سبيل المثال لإزالة الغموض عن طلبات البحث النصية عن النقاط على المسار
includePolyline

boolean

اختياريّ. ما إذا كان سيتم تضمين الخطوط المتعدّدة المرمّزة في مسارات الردّ القيمة التلقائية هي false. عند ضبط السمة على true، يتم عرض Route.encoded_polyline.
computeAlternativeRoutes

boolean

اختياريّ. ما إذا كان سيتم احتساب مسارات بديلة بالإضافة إلى المسار المقترَح تكون القيمة التلقائية false، وفي هذه الحالة يتم عرض المسار المقترَح فقط. عند ضبطها على "صحيح"، يتم عرض جميع المسارات المتاحة، مع العلم أنّ البدائل قد لا تكون متاحة لكل طلب.
تحدّد وقت المغادرة من نقطة الانطلاق أو الوصول إلى النقطة النهائية على المسار. يتم ضبط القيمة تلقائيًا على المغادرة في الوقت الحالي في حال عدم تحديد أي قيمة. بالنسبة إلى "TRANSIT"، يجب أن يكون الوقت قبل 7 أيام على الأكثر في الماضي وبعد 100 يوم على الأكثر في المستقبل. بالنسبة إلى وسائل النقل الأخرى، يجب ألا يكون الوقت في الماضي ويجب ألا يتجاوز 365 يومًا في المستقبل. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
departureTime

string (Timestamp format)

اختياريّ. تشير إلى أنّه يجب احتساب المسار استنادًا إلى وقت المغادرة.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
arrivalTime

string (Timestamp format)

اختياريّ. تشير إلى أنّه يجب احتساب المسار استنادًا إلى وقت الوصول.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
نهاية الحقول التي يستبعد كلّ منها الآخر

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال ComputeRoutesResponse.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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