Method: annotatePaths (Automotive)

แสดงผลเส้นทางตามกลุ่มอินพุตย้อนกลับพร้อมคำอธิบายประกอบสำหรับแอตทริบิวต์แบบไดนามิกตลอดเส้นทาง

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
ช่อง
paths[]

object (Path)

ต้องระบุ เส้นทางที่ขอด้วยข้อมูลแอตทริบิวต์แบบไดนามิก เส้นทางทั้งหมดควรมีส่วนเริ่มต้นเดียวกัน นั่นคือเป็นกลุ่มที่พาหนะอยู่ในขณะนั้น โดยคาดว่ายานพาหนะจะอยู่ที่จุดเริ่มต้นของส่วนแรก หากเส้นทางไม่ได้เริ่มต้นที่กลุ่มเดียวกัน ระบบจะแสดงข้อผิดพลาด
annotationOptions

object (AnnotationOptions)

ต้องระบุ แอตทริบิวต์ข้อมูลแบบไดนามิกที่ขอซึ่งควรเพิ่มในเส้นทางอินพุต หากเว้นว่างไว้ ระบบจะไม่ใส่คำอธิบายประกอบให้กับคำขอ

เนื้อหาการตอบกลับ

AnnotatePathsResponse ประกอบด้วยเส้นทางอินพุตที่มีข้อมูลเพิ่มเติมสำหรับคำอธิบายประกอบที่ขอทั้งหมด

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
ช่อง
annotatedPaths[]

object (AnnotatedPath)

เส้นทางจากอินพุตที่มีคำอธิบายประกอบด้วยแอตทริบิวต์ที่ขอ

เส้นทาง

เส้นทางที่มีการขอแอตทริบิวต์แบบไดนามิก

เส้นทางควรมีส่วนที่เชื่อมต่อกันและสัญจรไปมาได้ ส่วนของเส้นทางจะเป็นไปตามเส้นทางตรรกะ และถ้าไม่พบเส้นทางในส่วนอินพุต ระบบจะแสดงข้อผิดพลาด ตัวอย่างเช่น หากส่วนในเส้นทางไม่มีปลายทางที่เชื่อมต่อ หรือเส้นทางว่างเปล่า จะทำให้เกิดข้อผิดพลาด

ปัจจุบันมีการจำกัดเส้นทางไว้ที่ 15 กิโลเมตร เส้นทางนี้จะวัดจากจุดเริ่มต้นของส่วนแรก ซึ่งเป็นตำแหน่งของรถ ระบบจะแสดงข้อผิดพลาดหากส่วนของเส้นทางเริ่มมีระยะทางเกิน 15 กม. จากจุดเริ่มต้นของส่วนแรก ส่วนสุดท้ายที่เริ่มต้นก่อนคือ 15 กม. และสิ้นสุดที่เกิน 15 กม. ก็ยอมรับได้ ระบบจะไม่ส่งคืนคำตอบบางส่วน

เส้นทางอาจมีกลุ่มเดียวกับอีกเส้นทางหนึ่ง แต่ก็เป็นไปได้ที่คำอธิบายประกอบของกลุ่มอาจมีการตอบสนองที่แตกต่างกันโดยขึ้นอยู่กับความแตกต่างในส่วนอื่นๆ ของเส้นทาง

การแสดง JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
ช่อง
segments[]

object (Segment)

ต้องระบุ รายการตามลำดับของกลุ่มที่เป็นเส้นทาง

กลุ่ม

กลุ่มที่เป็นของเส้นทาง

การแสดง JSON 
{
  "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)

ต้องระบุ เส้นประกอบของกลุ่มที่ใช้ระบุกลุ่มได้หากไม่พบรหัส และใช้เพื่อแยกกลุ่มระหว่าง 2 กลุ่มหากมีรหัสเดียวกัน เส้นประกอบนี้เข้ารหัสโดยใช้รูปแบบอัลกอริทึมโพลีไลน์ที่เข้ารหัสของ Google Maps Platform แบบมาตรฐาน
ฟิลด์สหภาพ id ใช้สำหรับระบุกลุ่มนี้ภายในพื้นที่รหัส ต้องระบุ id ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
placeId

string

รหัสสถานที่สําหรับส่วนของถนนนี้ ใช้ใน API

AnnotationOptions

คำอธิบายประกอบที่ขอสำหรับเส้นทางอินพุต

การแสดง JSON 
{
  "includeLevelOfService": boolean
}
ช่อง
includeLevelOfService

boolean

ไม่บังคับ เมื่อตั้งค่าเป็น "จริง" กลุ่มในการตอบสนองจะมีคำอธิบายประกอบด้วยค่าการเข้าชมที่คาดการณ์ "ระดับของบริการ" เป็นคำที่ใช้กันโดยทั่วไปเพื่ออธิบายการจัดหมวดหมู่โฟลว์การเข้าชม แต่ระดับของคำนิยามบริการใน API นี้เป็นของ API นี้เพียงอย่างเดียว

AnnotatedPath

สำเนาของเส้นทางอินพุตที่แสดงผลพร้อมแอตทริบิวต์ที่คาดการณ์

การแสดง JSON 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
ช่อง
annotatedSegments[]

object (AnnotatedSegment)

รายการลำดับของกลุ่มที่เป็นเส้นทางหลัก โดยมีคำอธิบายประกอบด้วยแอตทริบิวต์ที่ขอ

AnnotatedSegment

กลุ่มที่สร้างเส้นทาง มีแอตทริบิวต์ข้อมูลแบบไดนามิกที่มีคำอธิบายประกอบ

การแสดง JSON 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
ช่อง
segment

object (Segment)

รายละเอียดกลุ่มเป้าหมายที่ใช้แยกความแตกต่างจากกลุ่มอื่นๆ
segmentSpanAttributes[]

object (SegmentSpanAttribute)

แอตทริบิวต์ที่กำหนดให้กับกลุ่ม แอตทริบิวต์เหล่านี้อาจแตกต่างกันไปตามเส้นทางที่กลุ่มอยู่ ช่วงเวลาหนึ่งอาจครอบคลุมทั้งกลุ่ม ช่วงแอตทริบิวต์จะเรียงตามลำดับจากตำแหน่งของยานพาหนะไปยังจุดสิ้นสุดของเส้นทาง

SegmentSpanAttribute

SegmentSpanAttribute มีคำอธิบายประกอบที่แสดงผลจาก API

การแสดง JSON 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
ช่อง
segmentSpan

object (SegmentSpan)

อธิบายว่าคำอธิบายประกอบจะนำไปใช้ที่ใดในกลุ่ม
levelOfService

enum (LevelOfService)

ระดับการเข้าชมที่คาดการณ์ไว้สำหรับช่วงของกลุ่ม ซึ่งพิจารณาจากความเร็วของการเข้าชมที่คาดว่าจะเกิดขึ้นในกลุ่มนี้เมื่อยานพาหนะมาถึงจุดเริ่มต้นของส่วน

SegmentSpan

ใช้เพื่อคั่นส่วนย่อยของกลุ่ม หากช่วงหนึ่งครอบคลุมทั้งกลุ่ม startMeters จะเป็น 0 และ endMeters จะเป็นความยาวของกลุ่ม

การแสดง JSON 
{
  "startMeters": integer,
  "endMeters": integer
}
ช่อง
startMeters

integer

จุดเริ่มต้นของสแปนมาจากจุดเริ่มต้นของเส้นประกอบของเซกเมนต์
endMeters

integer

จุดสิ้นสุดของช่วงมาจากจุดเริ่มต้นของเส้นประกอบของเซกเมนต์

LevelOfService

ค่าของที่เก็บข้อมูลการเข้าชมที่คาดการณ์ไว้เพื่อใช้สำหรับฟังก์ชันการทำงานของ ADAS ซึ่งแมปกับระดับการเข้าชมทั่วไป ค่าที่ API นี้แสดงผลจะเป็นค่าอิสระและไม่ควรอ้างอิงเพื่อให้สอดคล้องกับ API อื่นๆ

Enum
LEVEL_OF_SERVICE_UNSPECIFIED ค่าเริ่มต้น ค่านี้หมายความว่าไม่มีค่าการเข้าชมที่คาดการณ์
LEVEL_OF_SERVICE_STOPPED การจราจรหยุดลง
LEVEL_OF_SERVICE_STOP_AND_GO การจราจรหยุดลงแล้ว
LEVEL_OF_SERVICE_SLOW มีการคาดการณ์ว่ารถจะชะลอตัว แต่ไม่รถติด
LEVEL_OF_SERVICE_NORMAL ความเร็วปกติ คาดว่าจะไม่ชะลอตัว