- Ресурс: ТранзитОбъект
- Тип Пассажира
- Статус билета
- Категория концессии
- Ограничения на билеты
- ПокупкаДетали
- Стоимость билета
- БилетНога
- БилетСиденье
- Класс тарифа
- Тип поездки
- Статус активации
- Состояние
- Контекст устройства
- Методы
Ресурс: ТранзитОбъект
JSON-представление |
---|
{ "classReference": { object ( |
Поля | |
---|---|
classReference | Копия унаследованных полей родительского класса. Эти поля извлекаются во время GET. |
ticketNumber | Номер билета. Это уникальный идентификатор билета в системе транзитного оператора. |
passengerType | Количество пассажиров. |
passengerNames | Имена пассажиров, которым назначен билет. Вышеупомянутое поле |
tripId | Этот идентификатор используется для группировки билетов, если пользователь сохранил несколько билетов на одну поездку. |
ticketStatus | Статус билета. Для состояний, влияющих на отображение, используйте вместо этого поле |
customTicketStatus | Пользовательский статус, используемый для значения статуса заявки, когда |
concessionCategory | Категория льготного билета. |
customConcessionCategory | Пользовательская категория концессии, которую можно использовать, если |
ticketRestrictions | Информация о том, какие ограничения существуют на использование данного билета. Например, в какие дни недели его следует использовать или по каким маршрутам разрешено движение. |
purchaseDetails | Подробности покупки этого билета. |
ticketLeg | Отдельная часть билета содержит информацию об отправлении и прибытии, а также информацию о посадке и размещении. Если необходимо указать более одной ветви, используйте вместо этого поле |
ticketLegs[] | Каждый билет может содержать одну или несколько ветвей. На каждом этапе содержится информация об отправлении и прибытии, а также информация о посадке и размещении. Если необходимо указать только одну ногу, используйте вместо нее поле |
hexBackgroundColor | Цвет фона карточки. Если этот параметр не установлен, используется доминирующий цвет главного изображения, а если главное изображение не установлено, используется доминирующий цвет логотипа. Формат: # rrggbb , где rrggbb — это шестнадцатеричный триплет RGB, например |
tripType | Необходимый. Тип поездки, который представляет этот транзитный объект. Используется для определения названия пропуска и/или того, какой символ использовать между пунктом отправления и пунктом назначения. |
id | Необходимый. Уникальный идентификатор объекта. Этот идентификатор должен быть уникальным для всех объектов издателя. Это значение должно соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами. Уникальный идентификатор должен включать только буквенно-цифровые символы: «.», «_» или «-». |
classId | Необходимый. Класс, связанный с этим объектом. Класс должен быть того же типа, что и этот объект, уже существовать и быть одобрен. Идентификаторы классов должны соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами. |
version | Устарело |
state | Необходимый. Состояние объекта. Это поле используется для определения того, как объект отображается в приложении. Например, |
barcode | Тип и значение штрих-кода. |
messages[] | Массив сообщений, отображаемых в приложении. Все пользователи этого объекта получат связанные с ним сообщения. Максимальное количество этих полей — 10. |
validTimeInterval | Период времени, в течение которого этот объект будет |
locations[] | Примечание. Это поле в настоящее время не поддерживается для запуска географических уведомлений. |
hasUsers | Указывает, есть ли у объекта пользователи. Это поле задается платформой. |
smartTapRedemptionValue | Значение, которое будет передано на сертифицированный терминал Smart Tap через NFC для этого объекта. Поля уровня класса |
hasLinkedDevice | Связан ли этот объект в настоящее время с одним устройством. Это поле устанавливается платформой, когда пользователь сохраняет объект, привязывая его к своему устройству. Предназначен для использования избранными партнерами. Свяжитесь со службой поддержки для получения дополнительной информации. |
disableExpirationNotification | Указывает, следует ли явно подавлять уведомления. Если для этого поля установлено значение true, независимо от поля В настоящее время это можно установить только для предложений. |
infoModuleData | Устарело. Вместо этого используйте textModulesData. |
imageModulesData[] | Данные модуля изображения. Максимальное количество отображаемых полей — 1 на уровне объекта и 1 на уровне объекта класса. |
textModulesData[] | Текстовые данные модуля. Если в классе также определены данные текстового модуля, будут отображены оба. Максимальное количество отображаемых полей — 10 для объекта и 10 для класса. |
linksModuleData | Данные модуля ссылок. Если в классе также определены данные модуля ссылок, будут отображены оба. |
appLinkData | Дополнительная ссылка на приложение или веб-сайт, которая будет отображаться в виде кнопки на лицевой стороне пропуска. Если AppLinkData предоставлена для соответствующего класса, будет отображаться только объект AppLinkData. |
activationStatus | Статус активации объекта. Требуется, если для класса установлены |
rotatingBarcode | Тип и значение вращающегося штрих-кода. |
deviceContext | Контекст устройства, связанный с объектом. |
heroImage | Дополнительное изображение баннера, отображаемое на лицевой стороне карты. Если его нет, будет отображено изображение героя класса, если оно присутствует. Если изображение героя класса также отсутствует, ничего не будет отображаться. |
groupingInfo | Информация, управляющая группировкой пропусков. |
passConstraints | Передайте ограничения для объекта. Включает ограничение поведения NFC и снимков экрана. |
Тип Пассажира
Перечисления | |
---|---|
PASSENGER_TYPE_UNSPECIFIED | |
SINGLE_PASSENGER | |
singlePassenger | Устаревший псевдоним |
MULTIPLE_PASSENGERS | |
multiplePassengers | Устаревший псевдоним для |
Статус билета
Перечисления | |
---|---|
TICKET_STATUS_UNSPECIFIED | |
USED | |
used | Устаревший псевдоним для |
REFUNDED | |
refunded | Устаревший псевдоним |
EXCHANGED | |
exchanged | Устаревший псевдоним для |
Категория концессии
Перечисления | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED | |
ADULT | |
adult | Устаревший псевдоним для |
CHILD | |
child | Устаревший псевдоним для |
SENIOR | |
senior | Устаревший псевдоним для |
Ограничения на билеты
JSON-представление |
---|
{ "routeRestrictions": { object ( |
Поля | |
---|---|
routeRestrictions | Ограничения на маршруты, которые можно использовать. Например, это может быть строка «Только зарезервированные поезда CrossCountry». |
routeRestrictionsDetails | Подробнее о вышеуказанных |
timeRestrictions | Ограничения на время использования этого билета. |
otherRestrictions | Дополнительные ограничения, не подпадающие под категории «маршрут» или «время». |
ПокупкаДетали
JSON-представление |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Поля | |
---|---|
purchaseReceiptNumber | Номер квитанции/идентификатор для отслеживания покупки билета через организацию, продавшую билет. |
purchaseDateTime | Дата/время покупки билета. Это дата/время расширенного формата ISO 8601 со смещением или без него. Время может быть указано с точностью до наносекунды. Смещения могут быть указаны с точностью до секунды (хотя секунды смещения не являются частью ISO 8601). Например: Без информации о смещении некоторые богатые функции могут быть недоступны. |
accountId | Идентификатор учетной записи, использованной для покупки билета. |
confirmationCode | Код подтверждения покупки. Это может быть одинаково для нескольких разных билетов и используется для группировки билетов. |
ticketCost | Стоимость билета. |
Стоимость билета
JSON-представление |
---|
{ "faceValue": { object ( |
Поля | |
---|---|
faceValue | Номинальная стоимость билета. |
purchasePrice | Фактическая цена покупки билета после уплаты налогов и/или скидок. |
discountMessage | Сообщение с описанием любого вида скидки, которая была применена. |
БилетНога
JSON-представление |
---|
{ "originStationCode": string, "originName": { object ( |
Поля | |
---|---|
originStationCode | Код станции отправления. Это необходимо, если присутствует |
originName | Название исходной станции. Это необходимо, если присутствует |
destinationStationCode | Код станции назначения. |
destinationName | Имя пункта назначения. |
departureDateTime | Дата/время выезда. Это необходимо, если на транзитном объекте не установлен временной интервал действия. Это дата/время расширенного формата ISO 8601 со смещением или без него. Время может быть указано с точностью до наносекунды. Смещения могут быть указаны с точностью до секунды (хотя секунды смещения не являются частью ISO 8601). Например: Часть даты/времени без смещения считается «локальной датой/временем». Это должна быть местная дата/время на исходной станции. Например, если отправление происходит в 20 часов 5 июня 2018 года на станции отправления, местная часть даты/времени должна быть Без информации о смещении некоторые богатые функции могут быть недоступны. |
arrivalDateTime | Дата/время прибытия. Это дата/время расширенного формата ISO 8601 со смещением или без него. Время может быть указано с точностью до наносекунды. Смещения могут быть указаны с точностью до секунды (хотя секунды смещения не являются частью ISO 8601). Например: Часть даты/времени без смещения считается «локальной датой/временем». Это должна быть местная дата/время на станции назначения. Например, если событие происходит в 20 часов 5 июня 2018 года на станции назначения, локальная часть даты/времени должна быть Без информации о смещении некоторые богатые функции могут быть недоступны. |
fareName | Краткое описание/название тарифа на этом участке путешествия. Например, «Одноразовое использование в любое время». |
carriage | Название/номер поезда или корабля, на который пассажиру необходимо сесть. |
platform | Платформа или ворота, через которые пассажир может войти в вагон. |
zone | Зона посадки внутри платформы. |
ticketSeat | Зарезервированное место для пассажира(ов). Если необходимо указать более одного места, используйте вместо этого поле |
ticketSeats[] | Зарезервированное место для пассажира(ов). Если необходимо указать только одно место, используйте вместо него поле |
transitOperatorName | Название транзитного оператора, выполняющего этот участок поездки. |
transitTerminusName | Конечная станция или пункт назначения поезда/автобуса/и т.д. |
БилетСиденье
JSON-представление |
---|
{ "fareClass": enum ( |
Поля | |
---|---|
fareClass | Класс тарифа места, на которое оформлен билет. |
customFareClass | Пользовательский класс тарифа, который будет использоваться, если |
coach | Идентификатор вагона или автобуса, в котором находится билетное место. Например. "10" |
seat | Идентификатор места, где находится билетное место. Например. «42». Если конкретного идентификатора нет, используйте вместо него |
seatAssignment | Назначение пассажирского места. Например. «нет конкретного места». Используется, когда нет конкретного идентификатора, который можно было бы использовать в |
Класс тарифа
Перечисления | |
---|---|
FARE_CLASS_UNSPECIFIED | |
ECONOMY | |
economy | Устаревший псевдоним для |
FIRST | |
first | Устаревший псевдоним для |
BUSINESS | |
business | Устаревший псевдоним для |
Тип поездки
Перечисления | |
---|---|
TRIP_TYPE_UNSPECIFIED | |
ROUND_TRIP | |
roundTrip | Устаревший псевдоним для |
ONE_WAY | |
oneWay | Устаревший псевдоним для |
Статус активации
Статус активации объекта. Это поле включает статус активации, если значение поддерживает активацию.
JSON-представление |
---|
{
"state": enum ( |
Поля | |
---|---|
state | |
Состояние
Перечисления | |
---|---|
UNKNOWN_STATE | |
NOT_ACTIVATED | Не активирован, это статус по умолчанию |
not_activated | Устаревший псевдоним для |
ACTIVATED | Активировано |
activated | Устаревший псевдоним для |
Контекст устройства
Контекст устройства, связанный с объектом.
JSON-представление |
---|
{ "deviceToken": string } |
Поля | |
---|---|
deviceToken | Если установлено, информация о погашении будет возвращена на данное устройство только после активации объекта. Его не следует использовать в качестве стабильного идентификатора для отслеживания устройства пользователя. Он может меняться в разных проходах для одного и того же устройства или даже в разных активациях для одного и того же устройства. При установке этого вызывающие стороны также должны установить hasLinkedDevice для активируемого объекта. |
Методы | |
---|---|
| Добавляет сообщение к транзитному объекту, на который ссылается данный идентификатор объекта. |
| Возвращает транзитный объект с заданным идентификатором объекта. |
| Вставляет транзитный объект с заданным идентификатором и свойствами. |
| Возвращает список всех транзитных объектов для данного идентификатора эмитента. |
| Обновляет транзитный объект, на который ссылается данный идентификатор объекта. |
| Обновляет транзитный объект, на который ссылается данный идентификатор объекта. |