Method: annotatePaths (Automotive)

مسیرهای مبتنی بر بخش ورودی را با حاشیه نویسی برای ویژگی های پویا در طول مسیرها برمی گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی 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 )

ضروری. چند خط قطعه، که می تواند برای شناسایی قطعه در صورت یافتن شناسه و همچنین برای تمایز بین دو بخش در صورت داشتن شناسه یکسان استفاده شود. چند خط با استفاده از قالب الگوریتم چند خطی رمزگذاری شده پلتفرم Google Maps استاندارد کدگذاری می شود.

id فیلد اتحادیه برای شناسایی این بخش در یک فضای 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ها اعتماد کرد.

Enums
LEVEL_OF_SERVICE_UNSPECIFIED مقدار پیش فرض. این مقدار به این معنی است که هیچ ارزش ترافیکی پیش بینی شده ای در دسترس نیست.
LEVEL_OF_SERVICE_STOPPED ترافیک متوقف شده است.
LEVEL_OF_SERVICE_STOP_AND_GO ترافیک متوقف شده و برو.
LEVEL_OF_SERVICE_SLOW کاهش سرعت پیش‌بینی می‌شود، اما ترافیک پیش‌بینی نمی‌شود.
LEVEL_OF_SERVICE_NORMAL سرعت معمولی، بدون کاهش سرعت پیش بینی می شود.