Method: annotatePaths (Automotive)

इनपुट सेगमेंट-आधारित पाथ को पाथ के साथ-साथ डाइनैमिक एट्रिब्यूट के लिए एनोटेशन के साथ दिखाता है.

एचटीटीपी अनुरोध

POST https://routes.googleapis.com/annotations/v2:annotatePaths

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
फ़ील्ड
paths[]

object (Path)

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

object (AnnotationOptions)

ज़रूरी है. अनुरोध किए गए डाइनैमिक डेटा के ऐसे एट्रिब्यूट जिन्हें इनपुट पाथ में जोड़ा जाना चाहिए. अगर यह फ़ील्ड खाली है, तो अनुरोध की व्याख्या नहीं की जाएगी.

जवाब का मुख्य भाग

AnnotatePathsResponse में ऐसे इनपुट पाथ शामिल होते हैं जिनमें अनुरोध किए गए सभी एनोटेशन के लिए, अतिरिक्त डेटा जोड़ा जाता है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
फ़ील्ड
annotatedPaths[]

object (AnnotatedPath)

अनुरोध किए गए एट्रिब्यूट के साथ एनोटेट किए गए इनपुट का पाथ.

पाथ

वह पाथ जिस पर डाइनैमिक एट्रिब्यूट का अनुरोध किया जा रहा है.

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

फ़िलहाल, रास्ता 15 कि॰मी॰ तक का है. पाथ को पहले सेगमेंट की शुरुआत से मापा जाता है. इसे वाहन की जगह का माना जाता है. अगर पाथ में कोई सेगमेंट, पहले सेगमेंट की शुरुआत से 15 कि॰मी॰ से भी ज़्यादा दूरी पर शुरू होता है, तो गड़बड़ी दिखेगी. आखिरी सेगमेंट 15 कि॰मी॰ से पहले शुरू और 15 कि॰मी॰ के बाद खत्म हो सकता है. कोई भी आंशिक जवाब नहीं दिया जाएगा.

किसी पाथ में भी वही सेगमेंट हो सकते हैं जो किसी दूसरे पाथ में होते हैं. हालांकि, पाथ के दूसरे हिस्सों में अंतर के आधार पर, सेगमेंट की व्याख्या में अलग-अलग जवाब शामिल हो सकते हैं.

जेएसओएन के काेड में दिखाना 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
फ़ील्ड
segments[]

object (Segment)

ज़रूरी है. सेगमेंट की क्रम वाली सूची, जिससे पाथ बनाया जाता है.

सेगमेंट करें

किसी पाथ से जुड़ा सेगमेंट.

जेएसओएन के काेड में दिखाना 
{
  "polyline": {
    object (Polyline)
  },

  // Union field id can be only one of the following:
  "placeId": string
  // End of list of possible types for union field id.
}
फ़ील्ड
polyline

object (Polyline)

ज़रूरी है. सेगमेंट की पॉलीलाइन, जिसका इस्तेमाल आईडी न मिलने पर सेगमेंट की पहचान करने के लिए किया जा सकता है. साथ ही, अगर दो सेगमेंट का आईडी एक ही है, तो उनके बीच अंतर करने के लिए भी इसका इस्तेमाल किया जा सकता है. पॉलीलाइन को Google Maps Platform के कोड में बदले गए पॉलीलाइन एल्गोरिदम फ़ॉर्मैट का इस्तेमाल करके, कोड में बदला गया है.
यूनियन फ़ील्ड id. इसका इस्तेमाल, किसी आईडी स्पेस में इस सेगमेंट की पहचान करने के लिए किया जाता है. ज़रूरी है. id इनमें से सिर्फ़ एक हो सकती है:
placeId

string

सड़क के इस सेगमेंट के लिए जगह का आईडी. इसका इस्तेमाल सभी एपीआई में किया जाता है.

AnnotationOptions

इनपुट पाथ के लिए एनोटेशन का अनुरोध किया गया.

जेएसओएन के काेड में दिखाना 
{
  "includeLevelOfService": boolean
}
फ़ील्ड
includeLevelOfService

boolean

ज़रूरी नहीं. अगर वैल्यू को 'सही है' पर सेट किया जाता है, तो जवाब के सेगमेंट को अनुमानित ट्रैफ़िक वैल्यू के साथ दिखाया जाएगा. आम तौर पर, "सेवा का लेवल" ट्रैफ़िक फ़्लो की कैटगरी तय करने के लिए इस्तेमाल किया जाने वाला शब्द है, लेकिन इस एपीआई में सेवा की परिभाषाओं का लेवल सिर्फ़ इस एपीआई से जुड़ा है.

AnnotatedPath

अनुमानित एट्रिब्यूट के साथ दिखाए गए इनपुट पाथ की कॉपी.

जेएसओएन के काेड में दिखाना 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
फ़ील्ड
annotatedSegments[]

object (AnnotatedSegment)

मुख्य पाथ बनाने वाले सेगमेंट की क्रम वाली सूची, जिसमें अनुरोध किए गए एट्रिब्यूट के साथ एनोटेट किया गया है.

AnnotatedSegment

सेगमेंट जो एक पाथ बनाता है और जिसके बारे में डाइनैमिक डेटा एट्रिब्यूट के साथ एनोटेट किया जाता है.

जेएसओएन के काेड में दिखाना 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
फ़ील्ड
segment

object (Segment)

सेगमेंट की जानकारी का इस्तेमाल करके, इसे दूसरे सेगमेंट से अलग किया जाता है.
segmentSpanAttributes[]

object (SegmentSpanAttribute)

सेगमेंट के लिए असाइन की गई विशेषताएं. सेगमेंट के पाथ के आधार पर ये एट्रिब्यूट अलग-अलग हो सकते हैं. किसी स्पैन से पूरा सेगमेंट कवर हो सकता है. एट्रिब्यूट की अवधि, वाहन की जगह से पाथ के आखिर तक फ़ॉरवर्ड क्रम में होगी.

SegmentSpanAttribute

segmentSpanAttribute में, एपीआई से मिले एनोटेशन शामिल होते हैं.

जेएसओएन के काेड में दिखाना 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
फ़ील्ड
segmentSpan

object (SegmentSpan)

इससे पता चलता है कि सेगमेंट में एनोटेशन कहां लागू होते हैं.
levelOfService

enum (LevelOfService)

सेगमेंट के लिए ट्रैफ़िक का अनुमानित लेवल, जिसे इस सेगमेंट की संभावित ट्रैफ़िक स्पीड से तय किया जाता है. ऐसा तब होता है, जब वाहन सेगमेंट की शुरुआत में आता है.

SegmentSpan

इसका इस्तेमाल, किसी सेगमेंट के सब-सेक्शन की सीमा तय करने के लिए किया जाता है. अगर किसी स्पैन में पूरा सेगमेंट कवर होता है, तो startMeters की वैल्यू 0 होगी और endMeters, सेगमेंट की लंबाई होगी.

जेएसओएन के काेड में दिखाना 
{
  "startMeters": integer,
  "endMeters": integer
}
फ़ील्ड
startMeters

integer

जहां स्पैन की शुरुआत, सेगमेंट की पॉलीलाइन के शुरुआती पॉइंट से होती है.
endMeters

integer

जहां स्पैन का अंत सेगमेंट की पॉलीलाइन के शुरुआती बिंदु से होता है.

LevelOfService

ट्रैफ़िक बकेट की अनुमानित वैल्यू, जिनका इस्तेमाल ADAS की सुविधाओं के लिए किया जाता है. ये वैल्यू, ट्रैफ़िक के सामान्य लेवल के बारे में जानकारी देती हैं. इस एपीआई से मिलने वाली वैल्यू अलग-अलग होती हैं. इसलिए, अन्य एपीआई से जुड़ी वैल्यू पर भरोसा नहीं किया जाना चाहिए.

Enums
LEVEL_OF_SERVICE_UNSPECIFIED डिफ़ॉल्ट मान. इस वैल्यू का मतलब है कि ट्रैफ़िक की कोई अनुमानित वैल्यू उपलब्ध नहीं है.
LEVEL_OF_SERVICE_STOPPED ट्रैफ़िक रोक दिया गया है.
LEVEL_OF_SERVICE_STOP_AND_GO ट्रैफ़िक रुक-रुककर चलता है.
LEVEL_OF_SERVICE_SLOW ट्रैफ़िक धीमा होने का अनुमान है, लेकिन ट्रैफ़िक जाम की कोई संभावना नहीं है.
LEVEL_OF_SERVICE_NORMAL सामान्य गति, धीमे ट्रैफ़िक की संभावना नहीं है.