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
}
فیلدها
enableHighFrequencyUpdates

boolean

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

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

enablePubsub

boolean

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

pubsubFieldMask

string ( FieldMask format)

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

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

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

  • androidAppId
  • iosAppId
  • authToken
  • config

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

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

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

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

نمایش 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 این سفر به دلیل خطای کلاینت با شکست مواجه شد.

اجرای سفر

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

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

object ( Location )

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

destination

object ( Stop )

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

location

object ( Location )

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

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 )

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

روش‌ها

create

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

get

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