REST Resource: transitobject

منبع: TransitObject

نمایندگی JSON
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
زمینه های
classReference

object ( TransitClass )

یک کپی از فیلدهای ارثی کلاس والد. این فیلدها در طول GET بازیابی می شوند.

ticketNumber

string

شماره بلیط این یک شناسه منحصر به فرد برای بلیط در سیستم اپراتور حمل و نقل است.

passengerType

enum ( PassengerType )

تعداد مسافران.

passengerNames

string

نام(های) مسافرانی که بلیط به آنها اختصاص داده شده است. فیلد passengerType فوق به معنای ارائه زمینه Google در این زمینه است.

tripId

string

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

ticketStatus

enum ( TicketStatus )

وضعیت بلیط. برای حالت هایی که روی نمایش تأثیر می گذارند، به جای آن از فیلد state استفاده کنید.

customTicketStatus

object ( LocalizedString )

یک وضعیت سفارشی برای استفاده برای مقدار وضعیت بلیط زمانی که ticketStatus گزینه مناسبی را ارائه نمی دهد. هم ticketStatus و هم customTicketStatus ممکن است تنظیم نشوند.

concessionCategory

enum ( ConcessionCategory )

دسته امتیاز برای بلیط.

customConcessionCategory

object ( LocalizedString )

یک دسته امتیاز سفارشی برای استفاده زمانی که concessionCategory گزینه مناسبی را ارائه نمی دهد. هر دو concessionCategory و customConcessionCategory ممکن است تنظیم نشوند.

ticketRestrictions

object ( TicketRestrictions )

اطلاعاتی در مورد اینکه چه نوع محدودیت هایی برای استفاده از این بلیط وجود دارد. مثلاً چه روزهایی از هفته باید استفاده شود یا چه مسیرهایی مجاز است.

purchaseDetails

object ( PurchaseDetails )

جزئیات خرید این بلیط

ticketLeg

object ( TicketLeg )

یک قسمت بلیط شامل اطلاعات حرکت و ورود به همراه اطلاعات سوار شدن و نشستن است. اگر قرار است بیش از یک پا مشخص شود، به جای آن از قسمت ticketLegs استفاده کنید. ticketLeg و ticketLegs ممکن است تنظیم نشده باشند.

ticketLegs[]

object ( TicketLeg )

هر بلیط ممکن است شامل یک یا چند پایه باشد. هر پا شامل اطلاعات حرکت و ورود به همراه اطلاعات سوار شدن و نشستن است. اگر قرار است فقط یک پا مشخص شود، به جای آن از قسمت ticketLeg استفاده کنید. ticketLeg و ticketLegs ممکن است تنظیم نشده باشند.

hexBackgroundColor

string

رنگ پس زمینه کارت اگر تنظیم نشده باشد از رنگ غالب تصویر قهرمان استفاده می شود و اگر تصویر قهرمان تنظیم نشده باشد از رنگ غالب لوگو استفاده می شود. قالب # rrggbb است که در آن rrggbb یک سه گانه RGB هگز است، مانند #ffcc00 . همچنین می توانید از نسخه کوتاه سه گانه RGB که # rgb است، مانند #fc0 استفاده کنید.

tripType

enum ( TripType )

ضروری. نوع سفری که این شی ترانزیت نشان می دهد. برای تعیین عنوان پاس و/یا نمادی که بین مبدا و مقصد استفاده شود استفاده می شود.

id

string

ضروری. شناسه منحصر به فرد برای یک شی. این شناسه باید در همه اشیاء صادرکننده منحصر به فرد باشد. این مقدار باید از issuer ID قالب پیروی کند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. شناسه منحصر به فرد باید فقط شامل کاراکترهای الفبای عددی، '.'، '_' یا '-' باشد.

classId

string

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

شناسه‌های کلاس باید از فرمت issuer ID پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود.

version
(deprecated)

string ( int64 format)

منسوخ

state

enum ( State )

ضروری. وضعیت جسم. این فیلد برای تعیین نحوه نمایش یک شی در برنامه استفاده می شود. به عنوان مثال، یک شی inactive به بخش "گذرنامه های منقضی" منتقل می شود.

barcode

object ( Barcode )

نوع و مقدار بارکد

messages[]

object ( Message )

مجموعه ای از پیام ها در برنامه نمایش داده می شود. همه کاربران این شیء پیام های مرتبط با آن را دریافت خواهند کرد. حداکثر تعداد این فیلدها 10 عدد می باشد.

validTimeInterval

object ( TimeInterval )

مدت زمانی که این شی active خواهد بود و می توان از شی استفاده کرد. پس از سپری شدن این بازه زمانی، وضعیت یک شی به expired تغییر می کند.

locations[]

object ( LatLongPoint )

توجه: این فیلد در حال حاضر برای فعال کردن اعلان‌های جغرافیایی پشتیبانی نمی‌شود.

hasUsers

boolean

نشان می دهد که آیا شیء کاربر دارد یا خیر. این فیلد توسط پلتفرم تنظیم شده است.

smartTapRedemptionValue

string

مقداری که برای این شیء از طریق NFC به پایانه تأیید شده Smart Tap منتقل می شود. فیلدهای سطح کلاس enableSmartTap و redemptionIssuers نیز باید به درستی تنظیم شوند تا پاس از Smart Tap پشتیبانی کند. فقط کاراکترهای ASCII پشتیبانی می شوند.

hasLinkedDevice

boolean

آیا این شی در حال حاضر به یک دستگاه مرتبط است یا خیر. این فیلد زمانی توسط پلتفرم تنظیم می شود که کاربر شی را ذخیره می کند و آن را به دستگاه خود پیوند می دهد. برای استفاده توسط شرکای منتخب در نظر گرفته شده است. برای اطلاعات بیشتر با پشتیبانی تماس بگیرید.

disableExpirationNotification

boolean

نشان می دهد که آیا اعلان ها باید صریحاً سرکوب شوند یا خیر. اگر این فیلد روی درست تنظیم شود، صرف نظر از فیلد messages ، اعلان‌های انقضا به کاربر سرکوب می‌شوند. به طور پیش فرض، این فیلد روی false تنظیم شده است.

در حال حاضر، این فقط برای پیشنهادات قابل تنظیم است.

infoModuleData

object ( InfoModuleData )

منسوخ. به جای آن از textModulesData استفاده کنید.

imageModulesData[]

object ( ImageModuleData )

داده های ماژول تصویر حداکثر تعداد این فیلدهای نمایش داده شده 1 از سطح شی و 1 برای سطح شیء کلاس است.

textModulesData[]

object ( TextModuleData )

داده های ماژول متنی اگر داده های ماژول متنی نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. حداکثر تعداد این فیلدهای نمایش داده شده 10 از شی و 10 از کلاس است.

activationStatus

object ( ActivationStatus )

وضعیت فعال سازی برای شی. اگر کلاس دارای activationOptions باشد، لازم است.

rotatingBarcode

object ( RotatingBarcode )

نوع و مقدار بارکد چرخشی

deviceContext

object ( DeviceContext )

زمینه دستگاه مرتبط با شی.

heroImage

object ( Image )

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

groupingInfo

object ( GroupingInfo )

اطلاعاتی که نحوه گروه بندی پاس ها را کنترل می کند.

passConstraints

object ( PassConstraints )

تصویب محدودیت برای شی. شامل محدود کردن NFC و رفتارهای اسکرین شات است.

نوع مسافر

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

نام مستعار قدیمی برای SINGLE_PASSENGER . منسوخ.

MULTIPLE_PASSENGERS
multiplePassengers

نام مستعار قدیمی برای MULTIPLE_PASSENGERS . منسوخ.

وضعیت بلیط

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

نام مستعار قدیمی برای USED . منسوخ.

REFUNDED
refunded

نام مستعار قدیمی برای REFUNDED . منسوخ.

EXCHANGED
exchanged

نام مستعار میراث برای EXCHANGED . منسوخ.

دسته امتیاز

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

نام مستعار Legacy for ADULT . منسوخ.

CHILD
child

نام مستعار میراث برای CHILD . منسوخ.

SENIOR
senior

نام مستعار میراث برای SENIOR . منسوخ.

محدودیت های بلیط

نمایندگی JSON
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
زمینه های
routeRestrictions

object ( LocalizedString )

محدودیت در مورد مسیرهایی که ممکن است طی شود. به عنوان مثال، این ممکن است رشته "فقط قطارهای کراس کانتری رزرو شده" باشد.

routeRestrictionsDetails

object ( LocalizedString )

جزئیات بیشتر در مورد routeRestrictions بالا.

timeRestrictions

object ( LocalizedString )

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

otherRestrictions

object ( LocalizedString )

محدودیت‌های اضافی که در دسته‌های «مسیر» یا «زمان» قرار نمی‌گیرند.

جزئیات خرید

نمایندگی JSON
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
زمینه های
purchaseReceiptNumber

string

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

purchaseDateTime

string

تاریخ/زمان خرید بلیط.

این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست).

مثلا:

1985-04-12T23:20:50.52Z 20 دقیقه و 50.52 ثانیه بعد از ساعت 23 12 آوریل 1985 در UTC خواهد بود.

1985-04-12T19:20:50.52-04:00 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985، 4 ساعت قبل از UTC (همان لحظه ای در زمان مثال بالا) خواهد بود. اگر این رویداد در نیویورک بود، این معادل زمان روشنایی روز شرقی (EDT) بود. به یاد داشته باشید که افست در مناطقی که ساعت تابستانی (یا تابستان) را رعایت می کنند، بسته به زمان سال متفاوت است.

1985-04-12T19:20:50.52 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985 بدون اطلاعات افست خواهد بود.

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

accountId

string

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

confirmationCode

string

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

ticketCost

object ( TicketCost )

هزینه بلیط.

هزینه بلیط

نمایندگی JSON
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
زمینه های
faceValue

object ( Money )

ارزش اسمی بلیط

purchasePrice

object ( Money )

قیمت واقعی خرید بلیط، پس از کسر مالیات و/یا تخفیف.

discountMessage

object ( LocalizedString )

پیامی در مورد هر نوع تخفیفی که اعمال شده است.

TicketLeg

نمایندگی JSON
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
زمینه های
originStationCode

string

کد ایستگاه مبدا اگر destinationStationCode موجود باشد یا originName وجود نداشته باشد، این مورد ضروری است.

originName

object ( LocalizedString )

نام ایستگاه مبدا. اگر desinationName موجود باشد یا originStationCode وجود نداشته باشد، این مورد ضروری است.

destinationStationCode

string

کد ایستگاه مقصد

destinationName

object ( LocalizedString )

نام مقصد

departureDateTime

string

تاریخ/زمان حرکت. اگر بازه زمانی اعتباری روی شی ترانزیت تنظیم نشده باشد، لازم است.

این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست).

مثلا:

1985-04-12T23:20:50.52Z 20 دقیقه و 50.52 ثانیه بعد از ساعت 23 12 آوریل 1985 در UTC خواهد بود.

1985-04-12T19:20:50.52-04:00 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985، 4 ساعت قبل از UTC (همان لحظه ای در زمان مثال بالا) خواهد بود. اگر این رویداد در نیویورک بود، این معادل زمان روشنایی روز شرقی (EDT) بود. به یاد داشته باشید که افست در مناطقی که ساعت تابستانی (یا تابستان) را رعایت می کنند، بسته به زمان سال متفاوت است.

1985-04-12T19:20:50.52 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985 بدون اطلاعات افست خواهد بود.

بخشی از تاریخ/زمان بدون افست «تاریخ/زمان محلی» در نظر گرفته می‌شود. این باید تاریخ/زمان محلی در ایستگاه مبدا باشد. برای مثال، اگر حرکت در ساعت 20 5 ژوئن 2018 در ایستگاه مبدا رخ دهد، بخش تاریخ/زمان محلی باید 2018-06-05T20:00:00 باشد. اگر تاریخ/زمان محلی در ایستگاه مبدا 4 ساعت قبل از UTC باشد، ممکن است یک افست -04:00 اضافه شود.

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

arrivalDateTime

string

تاریخ/زمان ورود.

این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست).

مثلا:

1985-04-12T23:20:50.52Z 20 دقیقه و 50.52 ثانیه بعد از ساعت 23 12 آوریل 1985 در UTC خواهد بود.

1985-04-12T19:20:50.52-04:00 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985، 4 ساعت قبل از UTC (همان لحظه ای در زمان مثال بالا) خواهد بود. اگر این رویداد در نیویورک بود، این معادل زمان روشنایی روز شرقی (EDT) بود. به یاد داشته باشید که افست در مناطقی که ساعت تابستانی (یا تابستان) را رعایت می کنند، بسته به زمان سال متفاوت است.

1985-04-12T19:20:50.52 20 دقیقه و 50.52 ثانیه بعد از ساعت 19 12 آوریل 1985 بدون اطلاعات افست خواهد بود.

بخشی از تاریخ/زمان بدون افست «تاریخ/زمان محلی» در نظر گرفته می‌شود. این باید تاریخ/زمان محلی در ایستگاه مقصد باشد. برای مثال، اگر رویداد در ساعت 20 5 ژوئن 2018 در ایستگاه مقصد رخ دهد، بخش تاریخ/زمان محلی باید 2018-06-05T20:00:00 باشد. اگر تاریخ/زمان محلی در ایستگاه مقصد 4 ساعت قبل از UTC باشد، ممکن است یک افست -04:00 اضافه شود.

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

fareName

object ( LocalizedString )

شرح کوتاه / نام کرایه این مرحله از سفر. به عنوان مثال "هر زمان یکبار استفاده".

carriage

string

نام/شماره قطار یا کشتی که مسافر باید سوار شود.

platform

string

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

zone

string

منطقه سوار شدن در داخل سکو.

ticketSeat

object ( TicketSeat )

صندلی رزرو شده برای مسافر(ها). اگر قرار است بیش از یک صندلی مشخص شود، به جای آن از قسمت ticketSeats استفاده کنید. هر دو ticketSeat و ticketSeats ممکن است تنظیم نشده باشند.

ticketSeats[]

object ( TicketSeat )

صندلی رزرو شده برای مسافر(ها). اگر قرار است فقط یک صندلی مشخص شود، به جای آن از قسمت ticketSeat استفاده کنید. هر دو ticketSeat و ticketSeats ممکن است تنظیم نشده باشند.

transitOperatorName

object ( LocalizedString )

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

transitTerminusName

object ( LocalizedString )

ایستگاه پایانی یا مقصد قطار/اتوبوس/غیره.

TicketSeat

نمایندگی JSON
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
زمینه های
fareClass

enum ( FareClass )

کلاس کرایه صندلی بلیت شده.

customFareClass

object ( LocalizedString )

یک کلاس کرایه سفارشی برای استفاده در صورت عدم اعمال fareClass . ممکن است هر دو fareClass و customFareClass تنظیم نشوند.

coach

string

شناسه واگن قطار یا اتوبوسی که صندلی بلیط در آن قرار دارد. به عنوان مثال. "10"

seat

string

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

seatAssignment

object ( LocalizedString )

تعیین تکلیف صندلی مسافر. به عنوان مثال. "بدون صندلی مشخص". برای استفاده زمانی که هیچ شناسه خاصی برای استفاده در seat وجود ندارد.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

نام مستعار میراث برای ECONOMY . منسوخ.

FIRST
first

نام مستعار Legacy برای FIRST . منسوخ.

BUSINESS
business

نام مستعار میراث برای BUSINESS . منسوخ.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

نام مستعار قدیمی برای ROUND_TRIP . منسوخ.

ONE_WAY
oneWay

نام مستعار قدیمی برای ONE_WAY . منسوخ.

وضعیت فعال سازی

وضعیت فعال سازی شی اگر ارزشمند از فعال سازی پشتیبانی می کند، این فیلد شامل وضعیت فعال سازی می شود.

نمایندگی JSON
{
  "state": enum (State)
}
زمینه های
state

enum ( State )

حالت

Enums
UNKNOWN_STATE
NOT_ACTIVATED فعال نشده، این وضعیت پیش فرض است
not_activated

نام مستعار قدیمی برای NOT_ACTIVATED . منسوخ.

ACTIVATED فعال شد
activated

نام مستعار قدیمی برای ACTIVATED . منسوخ.

DeviceContext

زمینه دستگاه مرتبط با شی.

نمایندگی JSON
{
  "deviceToken": string
}
زمینه های
deviceToken

string

در صورت تنظیم، اطلاعات بازخرید تنها پس از فعال شدن شی به دستگاه داده شده بازگردانده می شود. این نباید به عنوان یک شناسه پایدار برای ردیابی دستگاه کاربر استفاده شود. می تواند در پاس های مختلف برای یک دستگاه یا حتی در بین فعال سازی های مختلف برای یک دستگاه تغییر کند. هنگام تنظیم این، تماس گیرندگان باید hasLinkedDevice را نیز روی شی فعال شده تنظیم کنند.

مواد و روش ها

addmessage

 پیامی را به شی ترانزیت ارجاع شده توسط شناسه شی داده شده اضافه می کند.

get

 شی ترانزیت را با شناسه شی داده شده برمی گرداند.

insert

 یک شی ترانزیت را با شناسه و ویژگی های داده شده درج می کند.

list

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

patch

 شی ترانزیت ارجاع شده توسط شناسه شی داده شده را به روز می کند.

update

 شی ترانزیت ارجاع شده توسط شناسه شی داده شده را به روز می کند.