REST Resource: projects.trips

منبع: سفر

یک سفر.

نمایش JSON 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
فیلدها
name

string

فقط خروجی. شناسه. نام منبع سفر. قالب: projects/{project_number}/trips/{tripId}.

config

object ( TripConfig )

تغییرناپذیر. پیکربندی برای سفر.

androidAppId

string

فقط ورودی. تغییرناپذیر. شناسه برنامه اندروید برنامه موبایلی که از سفر استفاده خواهد کرد. حداقل یکی از androidAppId یا iosAppId باید تنظیم شود.

iosAppId

string

فقط ورودی. تغییرناپذیر. شناسه بسته iOS برنامه تلفن همراه که از سفر استفاده خواهد کرد. حداقل یکی از androidAppId یا iosAppId باید تنظیم شود.

authToken

object ( AuthToken )

فقط خروجی. یک توکن مبهم که دسترسی به شروع یک سفر NavConnect در Google Maps یا Waze را مجاز می‌کند و به این برنامه‌ها دسترسی به‌روزرسانی سفر را می‌دهد. فقط توسط trips.create برگردانده می‌شود.

state

enum ( State )

فقط خروجی. حالت تریپ.

execution

object ( TripExecution )

فقط خروجی. آخرین داده‌ها در مورد اجرای سفر. اگر سفر در حالت خطا باشد، ممکن است این تنظیم نشود.

createTime

string ( Timestamp format)

فقط خروجی. زمان طبق سرور هنگام ایجاد سفر.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

updateTime

string ( Timestamp format)

فقط خروجی. زمانی که سرور آخرین به‌روزرسانی سفر را دریافت کرده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

تریپ‌کانفیگ

پیکربندی برای سفر.

نمایش JSON 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string,
  "enableRemainingRouteReporting": boolean
}
فیلدها
enableHighFrequencyUpdates

boolean

اختیاری. فعال کردن به‌روزرسانی‌های سفرهای پرتکرار.

توجه: فعال کردن این ویژگی، سفر را تحت استفاده در سطح سازمانی ثبت می‌کند و مشمول نرخ‌های سطح سازمانی است.

enablePubsub

boolean

اختیاری. فعال بودن یا نبودن اعلان‌های pubsub برای سفر.

pubsubFieldMask

string ( FieldMask format)

اختیاری. در صورت تنظیم، فقط زیرمجموعه مشخص‌شده از فیلدهای Trip در اعلان‌های pubsub گنجانده می‌شوند.

اگر تنظیم نشود، تمام فیلدهای Trip در اعلان‌های pubsub (رفتار پیش‌فرض) گنجانده می‌شوند.

فیلدهای زیر پشتیبانی نمی‌شوند:

  • androidAppId
  • iosAppId
  • authToken
  • config

نکته: اگر enablePubsub مقدار false داشته باشد، این فیلد نادیده گرفته می‌شود.

این لیستی از نام‌های کامل فیلدها است که با کاما از هم جدا شده‌اند. مثال: "user.displayName,photo" .

enableRemainingRouteReporting

boolean

اختیاری. آیا گزارش مسیر باقیمانده برای سفر فعال شود یا خیر.

توجه: فعال کردن این ویژگی، سفر را تحت استفاده در سطح سازمانی ثبت می‌کند و مشمول نرخ‌های سطح سازمانی است.

توکن احراز هویت

یک توکن احراز هویت.

نمایش JSON 
{
  "token": string,
  "expireTime": string
}
فیلدها
token

string

فقط خروجی. توکن احراز هویتی که باید به برنامه تلفن همراه منتقل شود.

expireTime

string ( Timestamp format)

فقط خروجی. زمانی که توکن احراز هویت منقضی می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

ایالت

تمام حالت‌های ممکن سفر.

انوم‌ها
STATE_UNSPECIFIED وضعیت سفر مشخص نشده است.
NEW این سفر ایجاد شده اما هنوز آغاز نشده است.
ENROUTE حامل در حال حرکت به سمت مقصد است.
ARRIVED حامل به مقصد رسید.
SUSPENDED سفر به حالت تعلیق درآمد.
FAILED این سفر با موفقیت به پایان نرسید.
CLIENT_ERROR این سفر به دلیل خطای کلاینت با شکست مواجه شد.
CANCELED این سفر صراحتاً توسط توسعه‌دهنده لغو شد.

اجرای سفر

داده‌های مربوط به اجرای سفر.

نمایش JSON 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "remainingRoute": {
    object (Route)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
فیلدها
origin

object ( Location )

فقط خروجی. مبدا سفر که عموماً موقعیت مکانی حمل‌کننده در شروع سفر NavConnect است.

destination

object ( Stop )

فقط خروجی. مقصد سفر همانطور که توسط برنامه تلفن همراه گزارش شده است.

location

object ( Location )

فقط خروجی. سیگنال موقعیت مکانی که آخرین موقعیت شناخته شده‌ی وسیله‌ی نقلیه را نشان می‌دهد. در صورت وجود، این موقعیت، موقعیت ثبت شده در جاده خواهد بود.

remainingRoute

object ( Route )

فقط خروجی. چندخطی را برای بخش باقی‌مانده از مسیر ارائه می‌دهد.

traveledDuration

string ( Duration format)

فقط خروجی. زمان طی شده تا این حد.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

remainingDuration

string ( Duration format)

فقط خروجی. زمان باقی مانده از این سفر طبق تخمین گوگل.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

traveledDistanceMeters

integer

فقط خروجی. مسافت طی شده از مبدا بر حسب متر.

remainingDistanceMeters

integer

فقط خروجی. فاصله باقی مانده تا مقصد بر حسب متر.

stopAddedInRoute

boolean

فقط خروجی. نشان می‌دهد که آیا در طول مسیر توقفی اضافه شده است یا خیر.

مکان

مکانی که توسط برنامه تلفن همراه گزارش شده است.

نمایش JSON 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
فیلدها
point

object ( LatLng )

فقط خروجی. موقعیت مکانی (عرض/طول).

sourceTime

string ( Timestamp format)

فقط خروجی. زمانی که مکان همانطور که توسط مشتری مشخص شده است، منبع یابی شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

serverTime

string ( Timestamp format)

فقط خروجی. زمانی که سرور این به‌روزرسانی موقعیت مکانی را دریافت کرده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

لات‌لنگ

شیء‌ای که یک جفت عرض/طول جغرافیایی را نشان می‌دهد. این به صورت یک جفت دوتایی بیان می‌شود تا درجه عرض جغرافیایی و درجه طول جغرافیایی را نشان دهد. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال باشند.

نمایش JSON 
{
  "latitude": number,
  "longitude": number
}
فیلدها
latitude

number

عرض جغرافیایی بر حسب درجه. باید در محدوده [-90.0، +90.0] باشد.

longitude

number

طول جغرافیایی بر حسب درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد.

توقف

توقفی در سفر که قرار است در آن کاری انجام شود.

نمایش JSON 
{
  "point": {
    object (LatLng)
  }
}
فیلدها
point

object ( LatLng )

الزامی. محل توقف به صورت طول/عرض.

مسیر

یک مسیر چندخطی.

نمایش JSON 
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
فیلدها
trafficInformation[]

object ( SpeedReadingInterval )

فقط خروجی. اطلاعات ترافیک روی چندخطی که به صورت فواصل خواندن سرعت توصیف می‌شوند.

یادداشت‌ها:

  • فواصل با هم همپوشانی ندارند.
  • فواصل به هم پیوسته هستند.
  • فواصل، کل چندخطی را پوشش می‌دهند.
  • فواصل بر اساس افزایش اندیس مرتب شده‌اند.
  • سرعت برای هر بازه مشخص شده است.

format فیلد یونیون. قالب مسیر.

قالبی که قرار داده می‌شود توسط پارامتر route_polyline_format کنترل می‌شود. اگر تنظیم نشود، به صورت پیش‌فرض روی یک چندخطی ساده تنظیم می‌شود. format می‌تواند فقط یکی از موارد زیر باشد:

simplePolyline

object ( SimplePolyline )

فقط خروجی. مسیر به عنوان یک لیست ساده از latlng ها.

encodedPolyline

string

فقط خروجی. مسیر به صورت یک چندخطی کدگذاری شده. به https://developers.google.com/maps/documentation/utilities/polylinealgorithm مراجعه کنید.

s2Polyline

string ( bytes format)

فقط خروجی. مسیر به صورت یک S2Polyline کدگذاری شده. به https://s2geometry.io/devguide/basic_types.html مراجعه کنید.

یک رشته کدگذاری شده با base64.

geoJson

object ( Struct format)

فقط خروجی. مسیر به صورت یک GeoJSON LineString. به https://tools.ietf.org/html/rfc7946#section-3.1.4 مراجعه کنید.

سیمپل‌پلی‌لاین

یک چندخطی را با استفاده از یک لیست ساده از نقاط نشان می‌دهد.

نمایش JSON 
{
  "points": [
    {
      object (LatLng)
    }
  ]
}
فیلدها
points[]

object ( LatLng )

فقط خروجی. لیست مرتبی از نقاط که نشان دهنده چندخطی هستند.

فاصله زمانی تندخوانی

نشانگر تراکم ترافیک در یک بخش پیوسته از یک مسیر. با توجه به مسیری با نقاط P_0، P_1، ...، P_N (شاخص مبتنی بر صفر)، SpeedReadingInterval یک بازه را تعریف می‌کند و ترافیک آن را با استفاده از دسته‌های Speed توصیف می‌کند.

نمایش JSON 
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
فیلدها
speed

enum ( Speed )

فقط خروجی. سرعت ترافیک در این بازه.

startPolylinePointIndex

integer

فقط خروجی. اندیس شروع این بازه در مسیر.

endPolylinePointIndex

integer

فقط خروجی. اندیس پایانی این بازه در مسیر.

سرعت

طبقه‌بندی سرعت چندخطی بر اساس داده‌های ترافیکی.

انوم‌ها
SPEED_UNSPECIFIED سرعتش مشخص نیست.
NORMAL سرعت عادی، بدون تأخیر در ترافیک.
SLOW کاهش سرعت تشخیص داده شد، میزان ترافیک کم تا متوسط.
TRAFFIC_JAM تأخیرهای ترافیکی، از جمله ترافیک متوقف شده.

روش‌ها

create

 سفر ایجاد می‌کند.

get

 سفری نصیبش می‌شود.