REST Resource: providers.trips

منبع: سفر

فراداده سفر

نمایندگی JSON
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
زمینه های
name

string

فقط خروجی در قالب "provider/{provider}/trips/{trip}"

vehicleId

string

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

tripStatus

enum ( TripStatus )

وضعیت فعلی سفر

tripType

enum ( TripType )

نوع سفر.

pickupPoint

object ( TerminalLocation )

مکانی که مشتری نشان می دهد که آنها را تحویل می گیرند.

actualPickupPoint

object ( StopLocation )

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

actualPickupArrivalPoint

object ( StopLocation )

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

pickupTime

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

intermediateDestinations[]

object ( TerminalLocation )

توقف های میانی به منظور درخواست سفر (علاوه بر تحویل و تحویل). در ابتدا این برای سفرهای مشترک پشتیبانی نخواهد شد.

intermediateDestinationsVersion

string ( Timestamp format)

نشان دهنده آخرین باری است که intermediateDestinations اصلاح شده است. سرور شما باید این مقدار را کش کند و هنگام به روز رسانی intermediateDestinationIndex آن را در UpdateTripRequest ارسال کند تا اطمینان حاصل شود که intermediateDestinations تغییر نکرده است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

intermediateDestinationIndex

integer

هنگامی که TripStatus ENROUTE_TO_INTERMEDIATE_DESTINATION باشد، عددی بین [0..N-1] نشان می دهد که وسیله نقلیه از کدام مقصد میانی بعدی عبور خواهد کرد. هنگامی که TripStatus ARRIVED_AT_INTERMEDIATE_DESTINATION است، عددی بین [0..N-1] نشان می دهد که وسیله نقلیه در کدام مقصد میانی قرار دارد. ارائه دهنده این مقدار را تعیین می کند. اگر intermediateDestinations وجود نداشته باشد، این قسمت نادیده گرفته می شود.

actualIntermediateDestinationArrivalPoints[]

object ( StopLocation )

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

actualIntermediateDestinations[]

object ( StopLocation )

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

dropoffPoint

object ( TerminalLocation )

مکانی که مشتری نشان می دهد که آنها را ترک خواهند کرد.

actualDropoffPoint

object ( StopLocation )

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

dropoffTime

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

remainingWaypoints[]

object ( TripWaypoint )

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

vehicleWaypoints[]

object ( TripWaypoint )

این فیلد از سفارش دستی ایستگاه های بین راه برای سفر پشتیبانی می کند. این شامل تمام ایستگاه های بین راهی برای وسیله نقلیه تعیین شده، و همچنین ایستگاه های حمل و نقل و تحویل برای این سفر است. اگر سفر به وسیله نقلیه اختصاص داده نشده باشد، Fleet Engine این قسمت را نادیده می گیرد. به دلایل حفظ حریم خصوصی، این فیلد فقط در تماس های trips.update و trips.create توسط سرور پر می شود، نه در تماس های trips.get .

route[]

object ( LatLng )

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

currentRouteSegment

string

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

توجه: این فیلد فقط برای استفاده توسط Driver SDK و Consumer SDK در نظر گرفته شده است. رمزگشایی هنوز پشتیبانی نمی شود.

currentRouteSegmentVersion

string ( Timestamp format)

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

توجه: این فیلد فقط برای استفاده توسط Driver SDK و Consumer SDK در نظر گرفته شده است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

currentRouteSegmentTraffic

object ( ConsumableTrafficPolyline )

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

توجه: این فیلد فقط برای استفاده توسط Driver SDK و Consumer SDK در نظر گرفته شده است.

currentRouteSegmentTrafficVersion

string ( Timestamp format)

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

توجه: این فیلد فقط برای استفاده توسط Driver SDK و Consumer SDK در نظر گرفته شده است.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

currentRouteSegmentEndPoint

object ( TripWaypoint )

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

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string ( Timestamp format)

فقط خروجی ETA به ایستگاه بعدی (اولین ورودی در قسمت remainingWaypoints ). اگر سفر به وسیله نقلیه اختصاص داده نشده باشد، یا سفر غیرفعال (تکمیل یا لغو شده باشد)، مقدار مشخص نیست.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

remainingTimeToFirstWaypoint

string ( Duration format)

فقط خروجی مدت زمان بازگشت داده های سفر تا زمان در Trip.eta_to_first_waypoint . اگر سفر به وسیله نقلیه اختصاص داده نشده باشد، یا سفر غیرفعال (تکمیل یا لغو شده باشد)، مقدار مشخص نیست.

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

remainingWaypointsVersion

string ( Timestamp format)

فقط خروجی آخرین باری را نشان می دهد که remainingWaypoints تغییر کرده است (یک نقطه راه اضافه، حذف یا تغییر کرده است).

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

remainingWaypointsRouteVersion

string ( Timestamp format)

فقط خروجی آخرین باری را که remainingWaypoints.path_to_waypoint و remainingWaypoints.traffic_to_waypoint تغییر کرده‌اند را نشان می‌دهد. برنامه مشتری شما باید این مقدار را در حافظه پنهان ذخیره کند و آن را در GetTripRequest ارسال کند تا مطمئن شود که مسیرها و ترافیک remainingWaypoints تنها در صورت به روز رسانی بازگردانده می شوند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

numberOfPassengers

integer

تغییرناپذیر. تعداد مسافران این سفر را نشان می دهد و راننده را شامل نمی شود. یک وسیله نقلیه باید دارای ظرفیت موجود برای بازگرداندن در خودروها باشد. پاسخ vehicles.search .

lastLocation

object ( VehicleLocation )

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

lastLocationSnappable

boolean

فقط خروجی نشان می دهد که آیا می توان lastLocation وسیله نقلیه را به قطعه مسیر فعلی منتقل کرد یا خیر. اگر lastLocation یا currentRouteSegment وجود نداشته باشد، نادرست است. توسط Fleet Engine محاسبه شده است. هر گونه به روز رسانی از مشتریان نادیده گرفته می شود.

view

enum ( TripView )

زیر مجموعه فیلدهای Trip که پر می شوند و نحوه تفسیر آنها.

وضعیت سفر

وضعیت یک سفر نشان دهنده پیشرفت آن است.

Enums
UNKNOWN_TRIP_STATUS پیش‌فرض، برای وضعیت سفر نامشخص یا ناشناخته استفاده می‌شود.
NEW سفر تازه ایجاد شده
ENROUTE_TO_PICKUP راننده در حال حرکت به سمت نقطه وانت است.
ARRIVED_AT_PICKUP راننده به نقطه وانت رسیده است.
ARRIVED_AT_INTERMEDIATE_DESTINATION راننده به مقصدی میانی رسیده و منتظر سوار است.
ENROUTE_TO_INTERMEDIATE_DESTINATION راننده در حال حرکت به سمت یک مقصد میانی (نه نقطه سقوط) است.
ENROUTE_TO_DROPOFF راننده سوار را سوار کرده و به سمت مقصد بعدی می رود.
COMPLETE سوار پیاده شده و سفر کامل شده است.
CANCELED این سفر قبل از تحویل گرفتن توسط راننده، سوار، یا ارائه دهنده اشتراک سوار لغو شد.

StopLocation

مکان واقعی که در آن توقف (انتقال / خروج) اتفاق افتاده است.

نمایندگی JSON
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
زمینه های
point

object ( LatLng )

ضروری. مکان واقعی را نشان می دهد.

timestamp

string ( Timestamp format)

زمان وقوع توقف را نشان می دهد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

stopTime
(deprecated)

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

TripView

انتخابگر برای مجموعه های مختلف فیلدهای سفر در پاسخ trips.get . برای متن به AIP-157 مراجعه کنید. نماهای اضافی به احتمال زیاد اضافه خواهد شد.

Enums
TRIP_VIEW_UNSPECIFIED مقدار پیش فرض برای سازگاری با عقب، API به طور پیش‌فرض روی یک نمای SDK خواهد بود. برای اطمینان از ثبات و پشتیبانی، به مشتریان توصیه می‌شود که یک TripView غیر از SDK انتخاب کنند.
SDK شامل فیلدهایی است که ممکن است با استفاده از کتابخانه های عمومی قابل تفسیر یا پشتیبانی نباشند.
JOURNEY_SHARING_V1S فیلدهای سفر برای مورد استفاده اشتراک گذاری سفر پر شده است. این نما برای ارتباطات سرور به سرور در نظر گرفته شده است.

مواد و روش ها

create

 یک سفر در Fleet Engine ایجاد می کند و سفر جدید را برمی گرداند.

get

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

update

 داده های سفر را به روز می کند.