REST Resource: selection.v1.projects.selectedRoutes

संसाधन: SelectedRoute

SelectedRoute, किसी ऐसे रास्ते को दिखाता है जिसके लिए ग्राहक, तय किए गए इस्तेमाल के उदाहरणों के लिए समय-समय पर जानकारी (जैसे, अवधि) पाना चाहता है.

JSON के काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
फ़ील्ड
name

string

आइडेंटिफ़ायर. SelectedRoute के संसाधन का नाम.

फ़ॉर्मैट: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

ज़रूरी नहीं. रास्ते का डिसप्ले नेम. यह एक वैकल्पिक फ़ील्ड है, जिसका इस्तेमाल ग्राहक कर सकता है. यह ज़रूरी नहीं है कि यह यूनीक हो. इसकी लंबाई 100 वर्णों तक सीमित है. इसमें यूनिकोड कोड पॉइंट गिने जाते हैं.
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. चुने गए रूट को पहली बार बनाए जाने का समय.

यह आरएफ़सी 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".
state

enum (State)

सिर्फ़ आउटपुट के लिए. चुने गए रास्ते की स्थिति.
routeAttributes

map (key: string, value: string)

ज़रूरी नहीं. चुने गए रास्ते के लिए कस्टम एट्रिब्यूट. इन्हें जोड़ने से, पुराने और रीयल-टाइम रूट की जानकारी को फ़िल्टर या ग्रुप किया जा सकता है. हर रूट के लिए, ज़्यादा से ज़्यादा 25 एट्रिब्यूट इस्तेमाल किए जा सकते हैं. हर कुंजी और वैल्यू, एक ऐसी स्ट्रिंग होनी चाहिए जो खाली न हो. साथ ही, इसमें ज़्यादा से ज़्यादा 100 वर्ण हो सकते हैं. इन्हें यूनिकोड कोड पॉइंट में गिना जाता है. कुंजियां goog से शुरू नहीं होनी चाहिए.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
वैल्यू के तौर पर, सिर्फ़ DynamicRoute को इस्तेमाल किया जा सकता है. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
dynamicRoute

object (DynamicRoute)

SelectedRoute एक डाइनैमिक रूट है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.
validationError

enum (ValidationError)

सिर्फ़ आउटपुट के लिए. STATE_INVALID स्थिति होने पर, चुने गए रास्ते की पुष्टि करने में हुई गड़बड़ी.
dynamicRouting

boolean

ज़रूरी नहीं. अगर इसे true पर सेट किया जाता है, तो चुने गए रास्ते को लाइव ट्रैफ़िक के आधार पर डाइनैमिक तौर पर बदला जा सकता है. यह बदलाव, इनपुट किए गए वेपॉइंट के हिसाब से होता है. अगर इसे false पर सेट किया जाता है, तो चुना गया रास्ता एक तय रास्ता होगा. यह रास्ता, लाइव ट्रैफ़िक के हिसाब से नहीं बदलेगा. साथ ही, यह रास्ता उस समय के ट्रैफ़िक के हिसाब से तय किया जाएगा जब इसे बनाया गया था. अगर इस फ़ील्ड को शामिल नहीं किया जाता है, तो इसकी वैल्यू डिफ़ॉल्ट रूप से false होगी. इससे पता चलता है कि यह एक तय रूट है.

DynamicRoute

यह वेपॉइंट (शुरुआती जगह, मंज़िल, और बीच की जगहें) वाले रास्ते को दिखाता है. इस बात की गारंटी होती है कि असल रास्ता, सभी वेपॉइंट से होकर गुज़रेगा. अगर dynamicRouting को false पर सेट किया जाता है, तो ट्रैफ़िक का हाल चाहे जो भी हो, असल रास्ता तय रहता है. अगर dynamicRouting को true पर सेट किया जाता है, तो ट्रैफ़िक का हाल के हिसाब से असल रास्ता बदल सकता है.

JSON के काेड में दिखाना 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
फ़ील्ड
origin

object (LatLng)

ज़रूरी है. रास्ते की शुरुआत की जगह.
destination

object (LatLng)

ज़रूरी है. रास्ते की आखिरी जगह.
intermediates[]

object (LatLng)

ज़रूरी नहीं. रास्ते में मौजूद इंटरमीडिएट वेपॉइंट का सेट (टर्मिनल पॉइंट को छोड़कर). ये हमेशा पासिंग-बाय पॉइंट होते हैं. ज़्यादा से ज़्यादा 25 इंटरमीडिएट वेपॉइंट इस्तेमाल किए जा सकते हैं. इन्हें सही तरीके से जोड़ने पर, असल रास्ते में समय-समय पर होने वाले बदलावों को कम किया जा सकता है.

LatLng

अक्षांश/देशांतर के जोड़े को दिखाने वाला ऑब्जेक्ट. इसे डबल के पेयर के तौर पर दिखाया जाता है, ताकि अक्षांश और देशांतर की डिग्री दिखाई जा सके. जब तक कोई और जानकारी न दी गई हो, तब तक इस ऑब्जेक्ट को WGS84 स्टैंडर्ड के मुताबिक होना चाहिए. वैल्यू, सामान्य रेंज में होनी चाहिए.

JSON के काेड में दिखाना 
{
  "latitude": number,
  "longitude": number
}
फ़ील्ड
latitude

number

डिग्री में अक्षांश. यह [-90.0, +90.0] की रेंज में होना चाहिए.
longitude

number

डिग्री में देशांतर. यह [-180.0, +180.0] की रेंज में होना चाहिए.

राज्य

चुने गए रास्ते की स्थिति.

Enums
STATE_UNSPECIFIED इस रूट की स्थिति सेट नहीं है.
STATE_SCHEDULING रूट बना दिया गया है और उसे शेड्यूल किया जा रहा है.
STATE_RUNNING रूट बना लिया गया है और उसका शेड्यूल चालू है.
STATE_DELETING रूट को मिटाने के लिए मार्क किया गया है.
STATE_VALIDATING रूट की पुष्टि की जा रही है.
STATE_INVALID पुष्टि करने की किसी एक शर्त के आधार पर, रूट अमान्य है.

ValidationError

चुने गए रास्ते की पुष्टि करने में गड़बड़ी हुई.

Enums
VALIDATION_ERROR_UNSPECIFIED इस रूट की पुष्टि करने से जुड़ी गड़बड़ी सेट नहीं की गई है.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION यह रास्ता, प्रोजेक्ट के अधिकार क्षेत्र से बाहर है.
VALIDATION_ERROR_LOW_ROAD_USAGE रास्ते पर कम ट्रैफ़िक हो (बहुत कम लोग उस रास्ते से गुज़रते हों).

तरीके

batchCreate

 यह कई SelectedRoute संसाधन बनाता है और हर रूट के लिए, समय-समय पर कैश मेमोरी की जानकारी पाने का शेड्यूल शुरू करता है.

batchDelete

 यह तय किए गए प्रोजेक्ट के लिए, एक से ज़्यादा SelectedRoute संसाधन मिटाता है.

batchUpdate

 नामों के हिसाब से, एक से ज़्यादा SelectedRoute संसाधनों को अपडेट करता है.

create

 यह SelectedRoute बनाता है और रूट के लिए कैश मेमोरी की जानकारी को समय-समय पर वापस पाने के लिए शेड्यूल शुरू करता है.

delete

 यह किसी प्रोजेक्ट के लिए, चुने गए SelectedRoute को मिटाता है.

get

 नाम के हिसाब से, SelectedRoute की जानकारी मिलती है.

list

 पेज नंबर के साथ, तय किए गए प्रोजेक्ट के लिए सभी SelectedRoute संसाधनों की सूची दिखाता है.

patch

 यह SelectedRoute को उसके नाम के हिसाब से अपडेट करता है.