- منبع: TransitObject
- نوع مسافر
- وضعیت بلیط
- دسته امتیاز
- محدودیت های بلیط
- جزئیات خرید
- هزینه بلیط
- TicketLeg
- صندلی بلیط
- FareClass
- TripType
- وضعیت فعال سازی
- ایالت
- DeviceContext
- روش ها
منبع: TransitObject
نمایندگی JSON |
---|
{ "classReference": { object ( |
فیلدها | |
---|---|
class Reference | یک کپی از فیلدهای ارثی کلاس والد. این فیلدها در طول GET بازیابی می شوند. |
ticket Number | شماره بلیط این یک شناسه منحصر به فرد برای بلیط در سیستم اپراتور حمل و نقل است. |
passenger Type | تعداد مسافران. |
passenger Names | نام(های) مسافرانی که بلیط به آنها اختصاص داده شده است. فیلد |
trip Id | اگر کاربر چند بلیط را برای یک سفر ذخیره کرده باشد، از این شناسه برای گروه بندی بلیط ها با هم استفاده می شود. |
ticket Status | وضعیت بلیط. برای حالت هایی که روی نمایش تأثیر می گذارند، به جای آن از فیلد |
custom Ticket Status | یک وضعیت سفارشی برای استفاده برای مقدار وضعیت بلیط زمانی که |
concession Category | دسته امتیاز برای بلیط. |
custom Concession Category | یک دسته امتیاز سفارشی برای استفاده زمانی که |
ticket Restrictions | اطلاعاتی در مورد اینکه چه نوع محدودیت هایی برای استفاده از این بلیط وجود دارد. مثلاً چه روزهایی از هفته باید استفاده شود یا چه مسیرهایی مجاز است. |
purchase Details | جزئیات خرید این بلیط |
ticket Leg | یک قسمت بلیط شامل اطلاعات حرکت و ورود به همراه اطلاعات سوار شدن و نشستن است. اگر قرار است بیش از یک پا مشخص شود، به جای آن از قسمت |
ticket Legs[] | هر بلیط ممکن است شامل یک یا چند پایه باشد. هر پا شامل اطلاعات حرکت و ورود به همراه اطلاعات سوار شدن و نشستن است. اگر قرار است فقط یک پا مشخص شود، به جای آن از قسمت |
hex Background Color | رنگ پس زمینه کارت اگر تنظیم نشده باشد از رنگ غالب تصویر قهرمان استفاده می شود و اگر تصویر قهرمان تنظیم نشده باشد از رنگ غالب لوگو استفاده می شود. قالب # rrggbb است که در آن rrggbb یک سه گانه RGB هگز است، مانند |
trip Type | مورد نیاز. نوع سفری که این شی ترانزیت نشان می دهد. برای تعیین عنوان پاس و/یا نمادی که بین مبدا و مقصد استفاده شود استفاده می شود. |
id | مورد نیاز. شناسه منحصر به فرد برای یک شی. این شناسه باید در همه اشیاء صادرکننده منحصر به فرد باشد. این مقدار باید از issuer ID قالب پیروی کند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. شناسه منحصر به فرد باید فقط شامل کاراکترهای الفبای عددی، '.'، '_' یا '-' باشد. |
class Id | مورد نیاز. کلاس مرتبط با این شی. کلاس باید از همان نوع این شی باشد، باید از قبل وجود داشته باشد و باید تایید شود. شناسههای کلاس باید از فرمت issuer ID پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. |
version | منسوخ شده است |
state | مورد نیاز. وضعیت جسم. این فیلد برای تعیین نحوه نمایش یک شی در برنامه استفاده می شود. به عنوان مثال، یک شی |
barcode | نوع و مقدار بارکد |
messages[] | مجموعه ای از پیام ها در برنامه نمایش داده می شود. همه کاربران این شیء پیام های مرتبط با آن را دریافت خواهند کرد. حداکثر تعداد این فیلدها 10 عدد می باشد. |
valid Time Interval | مدت زمانی که این شی |
locations[] | توجه: این فیلد در حال حاضر برای فعال کردن اعلانهای جغرافیایی پشتیبانی نمیشود. |
has Users | نشان می دهد که آیا شیء کاربر دارد یا خیر. این فیلد توسط پلتفرم تنظیم شده است. |
smart Tap Redemption Value | مقداری که برای این شیء از طریق NFC به پایانه تأیید شده Smart Tap منتقل می شود. فیلدهای سطح کلاس |
has Linked Device | آیا این شی در حال حاضر به یک دستگاه مرتبط است یا خیر. این فیلد زمانی توسط پلتفرم تنظیم می شود که کاربر شی را ذخیره می کند و آن را به دستگاه خود پیوند می دهد. برای استفاده توسط شرکای منتخب در نظر گرفته شده است. برای اطلاعات بیشتر با پشتیبانی تماس بگیرید. |
disable Expiration Notification | نشان می دهد که آیا اعلان ها باید صریحاً سرکوب شوند یا خیر. اگر این فیلد روی درست تنظیم شود، صرف نظر از فیلد در حال حاضر، این فقط برای پیشنهادات قابل تنظیم است. |
info Module Data | منسوخ شده است. به جای آن از textModulesData استفاده کنید. |
image Modules Data[] | داده های ماژول تصویر حداکثر تعداد این فیلدهای نمایش داده شده 1 از سطح شی و 1 برای سطح شیء کلاس است. |
text Modules Data[] | داده های ماژول متنی اگر داده های ماژول متنی نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. حداکثر تعداد این فیلدهای نمایش داده شده 10 از شی و 10 از کلاس است. |
links Module Data | داده های ماژول را پیوند می دهد. اگر داده های ماژول پیوندها نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. |
app Link Data | پیوند برنامه یا وب سایت اختیاری که به عنوان یک دکمه در جلوی پاس نمایش داده می شود. اگر AppLinkData برای کلاس مربوطه ارائه شده باشد، فقط شی AppLinkData نمایش داده می شود. |
activation Status | وضعیت فعال سازی برای شی. اگر کلاس دارای |
rotating Barcode | نوع و مقدار بارکد چرخشی |
device Context | زمینه دستگاه مرتبط با شی. |
hero Image | تصویر بنر اختیاری در جلوی کارت نمایش داده می شود. اگر هیچ کدام وجود نداشته باشد، تصویر قهرمان کلاس، در صورت وجود، نمایش داده می شود. اگر تصویر قهرمان کلاس نیز وجود نداشته باشد، چیزی نمایش داده نخواهد شد. |
grouping Info | اطلاعاتی که نحوه گروه بندی پاس ها را کنترل می کند. |
pass Constraints | تصویب محدودیت برای شی. شامل محدود کردن NFC و رفتارهای اسکرین شات است. |
save Restrictions | محدودیتهایی در مورد شیئی که باید قبل از اینکه کاربر تلاش کند پاس را ذخیره کند تأیید شود. توجه داشته باشید که این محدودیت فقط در زمان صرفه جویی اعمال خواهد شد. اگر پس از ذخیره گذرنامه توسط کاربر، محدودیتها تغییر کردند، محدودیتهای جدید برای مجوز ذخیرهشده قبلی اعمال نمیشوند. |
linked Object Ids[] | linkedObjectIds لیستی از اشیاء دیگر مانند بلیط رویداد، وفاداری، پیشنهاد، عمومی، کارت هدیه، حمل و نقل و کارت پرواز هستند که باید به طور خودکار به این شی حمل و نقل متصل شوند. اگر کاربری این کارت ترانزیت را ذخیره کرده باشد، این linkedObjectIds به طور خودکار به کیف پول کاربر منتقل میشوند (مگر اینکه تنظیم را برای دریافت چنین مجوزهای پیوندی خاموش کرده باشند). مطمئن شوید که اشیاء موجود در linkedObjectIds قبلاً درج شده اند - در غیر این صورت، تماس ها ناموفق خواهند بود. پس از پیوند، اشیاء پیوند شده را نمی توان لغو پیوند کرد. شما نمی توانید اشیاء متعلق به صادرکننده دیگری را پیوند دهید. محدودیتی برای تعداد اشیایی وجود دارد که می توان به یک شیء متصل کرد. پس از رسیدن به حد مجاز، اشیاء پیوند شده جدید در تماس بیصدا نادیده گرفته میشوند. شناسههای شیء باید از issuer ID قالب پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. |
notify Preference | اینکه آیا بهروزرسانیهای فیلد برای این شی باید اعلانها را راهاندازی کند یا خیر. وقتی روی NOTIFY تنظیم شود، سعی می کنیم یک اعلان به روز رسانی فیلد را برای کاربران فعال کنیم. این اعلانها تنها در صورتی برای کاربران ارسال میشوند که این قسمت بخشی از یک لیست مجاز باشد. اگر روی DO_NOT_NOTIFY یا NOTIFICATION_SETTINGS_UNSPECIFIED تنظیم شود، هیچ اعلانی فعال نخواهد شد. این تنظیم زودگذر است و باید با هر درخواست PATCH یا UPDATE تنظیم شود، در غیر این صورت اعلانی راه اندازی نمی شود. |
value Added Module Data[] | داده های ماژول ارزش افزوده اختیاری. حداکثر ده روی جسم. |
نوع مسافر
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED | |
SINGLE_PASSENGER | |
singlePassenger | نام مستعار قدیمی برای |
MULTIPLE_PASSENGERS | |
multiplePassengers | نام مستعار قدیمی برای |
وضعیت بلیط
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED | |
USED | |
used | نام مستعار قدیمی برای |
REFUNDED | |
refunded | نام مستعار قدیمی برای |
EXCHANGED | |
exchanged | نام مستعار میراث برای |
دسته امتیاز
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED | |
ADULT | |
adult | نام مستعار میراث برای |
CHILD | |
child | نام مستعار میراث برای |
SENIOR | |
senior | نام مستعار میراث برای |
محدودیت بلیط
نمایندگی JSON |
---|
{ "routeRestrictions": { object ( |
فیلدها | |
---|---|
route Restrictions | محدودیت در مورد مسیرهایی که ممکن است طی شود. به عنوان مثال، این ممکن است رشته "فقط قطارهای کراس کانتری رزرو شده" باشد. |
route Restrictions Details | جزئیات بیشتر در مورد |
time Restrictions | محدودیتهایی درباره زمانهایی که ممکن است از این بلیط استفاده شود. |
other Restrictions | محدودیتهای اضافی که در دستههای «مسیر» یا «زمان» قرار نمیگیرند. |
جزئیات خرید
نمایندگی JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
فیلدها | |
---|---|
purchase Receipt Number | شماره رسید / شناسه برای پیگیری خرید بلیط از طریق ارگانی که بلیت را فروخته است. |
purchase Date Time | تاریخ/زمان خرید بلیط این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست). به عنوان مثال: بدون اطلاعات افست، برخی از ویژگی های غنی ممکن است در دسترس نباشند. |
account Id | شناسه حساب مورد استفاده برای خرید بلیط. |
confirmation Code | کد تایید خرید این ممکن است برای چندین بلیط مختلف یکسان باشد و برای گروه بندی بلیط ها با هم استفاده می شود. |
ticket Cost | هزینه بلیط. |
هزینه بلیط
نمایندگی JSON |
---|
{ "faceValue": { object ( |
فیلدها | |
---|---|
face Value | ارزش اسمی بلیط |
purchase Price | قیمت واقعی خرید بلیط، پس از کسر مالیات و/یا تخفیف. |
discount Message | پیامی در مورد هر نوع تخفیفی که اعمال شده است. |
TicketLeg
نمایندگی JSON |
---|
{ "originStationCode": string, "originName": { object ( |
فیلدها | |
---|---|
origin Station Code | کد ایستگاه مبدا اگر |
origin Name | نام ایستگاه مبدا. اگر |
destination Station Code | کد ایستگاه مقصد |
destination Name | نام مقصد |
departure Date Time | تاریخ/زمان حرکت. اگر بازه زمانی اعتباری روی شی ترانزیت تنظیم نشده باشد، لازم است. این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست). به عنوان مثال: بخشی از تاریخ/زمان بدون افست «تاریخ/زمان محلی» در نظر گرفته میشود. این باید تاریخ/زمان محلی در ایستگاه مبدا باشد. برای مثال، اگر حرکت در ساعت 20 5 ژوئن 2018 در ایستگاه مبدا رخ دهد، بخش تاریخ/زمان محلی باید بدون اطلاعات افست، برخی از ویژگی های غنی ممکن است در دسترس نباشند. |
arrival Date Time | تاریخ/زمان ورود. این تاریخ/زمان با فرمت توسعه یافته ISO 8601، با یا بدون افست است. زمان ممکن است با دقت نانوثانیه مشخص شود. افست ها ممکن است با دقت ثانیه مشخص شوند (حتی اگر ثانیه های افست بخشی از ISO 8601 نیست). به عنوان مثال: بخشی از تاریخ/زمان بدون افست «تاریخ/زمان محلی» در نظر گرفته میشود. این باید تاریخ/زمان محلی در ایستگاه مقصد باشد. برای مثال، اگر رویداد در ساعت 20 5 ژوئن 2018 در ایستگاه مقصد رخ دهد، بخش تاریخ/زمان محلی باید بدون اطلاعات افست، برخی از ویژگی های غنی ممکن است در دسترس نباشند. |
fare Name | شرح کوتاه / نام کرایه این مرحله از سفر. به عنوان مثال "هر زمان یکبار استفاده". |
carriage | نام/شماره قطار یا کشتی که مسافر باید سوار شود. |
platform | سکو یا دروازه ای که مسافر می تواند سوار کالسکه شود. |
zone | منطقه سوار شدن در داخل سکو. |
ticket Seat | صندلی رزرو شده برای مسافر(ها). اگر قرار است بیش از یک صندلی مشخص شود، به جای آن از قسمت |
ticket Seats[] | صندلی رزرو شده برای مسافر(ها). اگر قرار است فقط یک صندلی مشخص شود، به جای آن از قسمت |
transit Operator Name | نام اپراتور ترانزیت که این مرحله از سفر را انجام می دهد. |
transit Terminus Name | ایستگاه پایانی یا مقصد قطار/اتوبوس/غیره. |
صندلی بلیط
نمایندگی JSON |
---|
{ "fareClass": enum ( |
فیلدها | |
---|---|
fare Class | کلاس کرایه صندلی بلیت شده. |
custom Fare Class | یک کلاس کرایه سفارشی برای استفاده در صورت عدم اعمال |
coach | شناسه واگن قطار یا اتوبوسی که صندلی بلیط در آن قرار دارد. به عنوان مثال "10" |
seat | شناسه محل قرارگیری صندلی بلیط. به عنوان مثال "42". اگر شناسه خاصی وجود ندارد، به جای آن از |
seat Assignment | تعیین تکلیف صندلی مسافر. به عنوان مثال "بدون صندلی مشخص". برای استفاده زمانی که هیچ شناسه خاصی برای استفاده در |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED | |
ECONOMY | |
economy | نام مستعار میراث برای |
FIRST | |
first | نام مستعار Legacy برای |
BUSINESS | |
business | نام مستعار میراث برای |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED | |
ROUND_TRIP | |
roundTrip | نام مستعار قدیمی برای |
ONE_WAY | |
oneWay | نام مستعار قدیمی برای |
وضعیت فعال سازی
وضعیت فعال سازی شی اگر ارزشمند از فعال سازی پشتیبانی می کند، این فیلد شامل وضعیت فعال سازی می شود.
نمایندگی JSON |
---|
{
"state": enum ( |
فیلدها | |
---|---|
state | |
ایالت
Enums | |
---|---|
UNKNOWN_STATE | |
NOT_ACTIVATED | فعال نشده، این وضعیت پیش فرض است |
not_activated | نام مستعار قدیمی برای |
ACTIVATED | فعال شد |
activated | نام مستعار قدیمی برای |
DeviceContext
زمینه دستگاه مرتبط با شی.
نمایندگی JSON |
---|
{ "deviceToken": string } |
فیلدها | |
---|---|
device Token | در صورت تنظیم، اطلاعات بازخرید تنها پس از فعال شدن شی به دستگاه داده شده بازگردانده می شود. این نباید به عنوان یک شناسه پایدار برای ردیابی دستگاه کاربر استفاده شود. می تواند در پاس های مختلف برای یک دستگاه یا حتی در بین فعال سازی های مختلف برای یک دستگاه تغییر کند. هنگام تنظیم این، تماس گیرندگان باید hasLinkedDevice را نیز روی شی فعال شده تنظیم کنند. |
روش ها | |
---|---|
| پیامی را به شی ترانزیت ارجاع شده توسط شناسه شی داده شده اضافه می کند. |
| شی ترانزیت را با شناسه شی داده شده برمی گرداند. |
| یک شی ترانزیت را با شناسه و ویژگی های داده شده درج می کند. |
| فهرستی از همه اشیاء حمل و نقل را برای شناسه صادرکننده معین برمی گرداند. |
| شی ترانزیت ارجاع شده توسط شناسه شی داده شده را به روز می کند. |
| شی ترانزیت ارجاع شده توسط شناسه شی داده شده را به روز می کند. |