- Ресурс: ТранзитОбъект
- Тип Пассажира
- Статус билета
- Категория концессии
- Ограничения на билеты
- ПокупкаДетали
- Стоимость билета
- БилетНога
- БилетСиденье
- Класс тарифа
- Тип поездки
- Статус активации
- Состояние
- Контекст устройства
- Методы
Ресурс: ТранзитОбъект
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 | Значение, которое будет передано на сертифицированный терминал Smart Tap через NFC для этого объекта. Поля уровня класса |
has Linked Device | Связан ли этот объект в настоящее время с одним устройством. Это поле устанавливается платформой, когда пользователь сохраняет объект, привязывая его к своему устройству. Предназначен для использования избранными партнерами. Свяжитесь со службой поддержки для получения дополнительной информации. |
disable Expiration Notification | Указывает, следует ли явно подавлять уведомления. Если для этого поля установлено значение true, независимо от поля В настоящее время это можно установить только для предложений. |
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, а второй выбирается вами. |
value Added Module Data[] | Дополнительные данные модуля с добавленной стоимостью. Максимум десять на объекте. |
Тип Пассажира
Перечисления | |
---|---|
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 ( |
Поля | |
---|---|
route Restrictions | Ограничения на маршруты, которые можно использовать. Например, это может быть строка «Только зарезервированные поезда CrossCountry». |
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 | Сообщение с описанием любого вида скидки, которая была применена. |
БилетНога
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 | Назначение пассажирского сиденья. Например. «нет конкретного места». Используется, когда нет конкретного идентификатора, который можно было бы использовать в |
Класс тарифа
Перечисления | |
---|---|
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 } |
Поля | |
---|---|
device Token | Если установлено, информация о погашении будет возвращена на данное устройство только после активации объекта. Его не следует использовать в качестве стабильного идентификатора для отслеживания устройства пользователя. Он может меняться в разных проходах для одного и того же устройства или даже в разных активациях для одного и того же устройства. При установке этого вызывающие стороны также должны установить hasLinkedDevice для активируемого объекта. |
Методы | |
---|---|
| Добавляет сообщение к транзитному объекту, на который ссылается данный идентификатор объекта. |
| Возвращает транзитный объект с заданным идентификатором объекта. |
| Вставляет транзитный объект с заданным идентификатором и свойствами. |
| Возвращает список всех транзитных объектов для данного идентификатора эмитента. |
| Обновляет транзитный объект, на который ссылается данный идентификатор объекта. |
| Обновляет транзитный объект, на который ссылается данный идентификатор объекта. |