Содержание
TransitClassService
(интерфейс)TransitObjectService
(интерфейс)PurchaseDetails
(сообщение)TicketCost
(сообщение)TicketLeg
(сообщение)TicketRestrictions
(сообщение)TicketSeat
(сообщение)TicketSeat.FareClass
(перечисление)TransitClass
(сообщение)TransitClass.TransitType
(перечисление)TransitClassAddMessageRequest
(сообщение)TransitClassAddMessageResponse
(сообщение)TransitClassGetRequest
(сообщение)TransitClassInsertRequest
(сообщение)TransitClassListRequest
(сообщение)TransitClassListResponse
(сообщение)TransitClassPatchRequest
(сообщение)TransitClassUpdateRequest
(сообщение)TransitObject
(сообщение)TransitObject.ConcessionCategory
(перечисление)TransitObject.PassengerType
(перечисление)TransitObject.TicketStatus
(перечисление)TransitObject.TripType
(перечисление)TransitObjectAddMessageRequest
(сообщение)TransitObjectAddMessageResponse
(сообщение)TransitObjectGetRequest
(сообщение)TransitObjectInsertRequest
(сообщение)TransitObjectListRequest
(сообщение)TransitObjectListResponse
(сообщение)TransitObjectPatchRequest
(сообщение)TransitObjectUpdateRequest
(сообщение)
TransitClassService
AddMessage | |
---|---|
Добавляет сообщение к классу transit с указанным идентификатором.
|
Get | |
---|---|
Возвращает класс transit с указанным идентификатором.
|
Insert | |
---|---|
Добавляет класс transit с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех классов transit с указанным идентификатором Issuer ID.
|
Patch | |
---|---|
Обновляет класс transit с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет класс transit с указанным идентификатором.
|
TransitObjectService
AddMessage | |
---|---|
Добавляет сообщение к объекту transit с указанным идентификатором.
|
Get | |
---|---|
Возвращает объект transit с указанным идентификатором.
|
Insert | |
---|---|
Добавляет объект transit с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех объектов transit с указанным идентификатором Issuer ID.
|
Patch | |
---|---|
Обновляет объект transit с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет объект transit с указанным идентификатором.
|
PurchaseDetails
Поля | |
---|---|
purchase_receipt_number |
Номер квитанции/идентификатор, по которому можно отследить покупку билета. Присваивается соответствующей организацией. |
purchase_date_time |
Дата и время покупки билета. Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601). Пример:
Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны. |
account_id |
Идентификатор аккаунта, с помощью которого совершается покупка. |
confirmation_code |
Код подтверждения для билета. Можно использовать одинаковый код для нескольких билетов, которые нужно сгруппировать. |
ticket_cost |
Стоимость билета |
TicketCost
Поля | |
---|---|
face_value |
Номинальная цена билета. |
purchase_price |
Фактическая цена билета с учетом налогов и скидок. |
discount_message |
Описание скидки, которая была применена. |
TicketLeg
Поля | |
---|---|
origin_station_code |
Код станции отправления. Его нужно указать, если заполнено поле |
origin_name |
Название станции отправления. Его нужно указать, если заполнено поле |
destination_station_code |
Код станции назначения. |
destination_name |
Название станции назначения. |
departure_date_time |
Дата и время отправления. Эта информация обязательна, если для объекта transit не указан срок действия. Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601). Пример:
Фрагмент информации о дате и времени без данных о смещении считается местными датой и временем. Их нужно указывать, ориентируясь на станцию отправления. Например, если отъезд назначен со станции отправления на 5 июня 2018 года в 20 часов по местному времени, сведения о местных дате и времени будут выглядеть так: Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны. |
arrival_date_time |
Дата и время прибытия. Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601). Пример:
Фрагмент информации о дате и времени без данных о смещении считается местными датой и временем. Их нужно указывать, ориентируясь на станцию назначения. Например, если событие происходит на станции назначения 5 июня 2018 года в 20 часов по местному времени, сведения о местных дате и времени будут выглядеть так: Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны. |
fare_name |
Название или краткое описание тарифа, применимого к определенному этапу маршрута. Пример: "Бессрочный билет на одну поездку". |
carriage |
Название или номер поезда или корабля, право проезда на котором дает билет. |
platform |
Платформа или иной пункт, где осуществляется посадка. |
zone |
Зона в пределах платформы или иного пункта, где осуществляется посадка. |
ticket_seat |
Место, зарезервированное для пассажира. Если мест два и более, вместо этого поля нужно заполнить поле |
ticket_seats[] |
Место, зарезервированное для пассажира. Если место только одно, вместо этого поля нужно заполнить поле |
transit_operator_name |
Название компании-перевозчика, которая отвечает за определенный этап маршрута. |
transit_terminus_name |
Конечная станция или пункт назначения транспортного средства. |
TicketRestrictions
Поля | |
---|---|
route_restrictions |
Ограничения, которые могут быть применены для маршрута. Пример: "Только поезда типа CrossCountry". |
route_restrictions_details |
Дополнительная информация для поля |
time_restrictions |
Ограничения на то, когда можно использовать билет. |
other_restrictions |
Дополнительные ограничения, которые не подпадают под категории "маршрут" и "время" |
TicketSeat
Поля | |
---|---|
fare_class |
Класс места, которое указано в билете. |
custom_fare_class |
Заполните это поле, если ни одно из значений поля |
coach |
Номер вагона, в котором расположено место, указанное в билете (например, "10"). |
seat |
Номер места, которое указано в билете (например, "42". Если конкретного идентификатора нет, используйте поле |
seat_assignment |
Назначение места пассажира (например, "без места". Используется, когда для поля |
FareClass
Перечисления | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Устаревший псевдоним элемента |
FIRST |
|
first |
Устаревший псевдоним элемента |
BUSINESS |
|
business |
Устаревший псевдоним элемента |
TransitClass
Поля | |
---|---|
transit_operator_name |
Название компании-перевозчика. |
logo |
Обязательно. Изображение – логотип билета. Отображается в подробных сведениях о карте в приложении. |
transit_type |
Обязательно. Тип перевозки, соответствующий данному классу. Например, "автобус". |
watermark |
Изображение – водяной знак, который будет отображаться на устройстве пользователя. |
language_override |
Если есть это поле, то все проездные билеты на устройстве пользователя будут отображаться на этом языке. Представляет собой языковой тег BCP 47. Примеры значений: en-US, en-GB, de, de-AT. |
custom_transit_terminus_name_label |
Пользовательский ярлык для обозначения названия конечного пункта ( |
custom_ticket_number_label |
Пользовательский ярлык для обозначения номера билета ( |
custom_route_restrictions_label |
Пользовательский ярлык для обозначения ограничений по маршрутам ( |
custom_route_restrictions_details_label |
Пользовательский ярлык для обозначения сведений об ограничениях по маршрутам ( |
custom_time_restrictions_label |
Пользовательский ярлык для обозначения сведений об ограничениях по времени ( |
custom_other_restrictions_label |
Пользовательский ярлык для обозначения прочих ограничений ( |
custom_purchase_receipt_number_label |
Пользовательский ярлык для обозначения номера квитанции ( |
custom_confirmation_code_label |
Пользовательский ярлык для обозначения кода подтверждения ( |
custom_purchase_face_value_label |
Пользовательский ярлык для обозначения номинальной цены покупки ( |
custom_purchase_price_label |
Пользовательский ярлык для обозначения цены покупки ( |
custom_discount_message_label |
Пользовательский ярлык для обозначения пометки о скидке ( |
custom_carriage_label |
Пользовательский ярлык для обозначения номера рейса ( |
custom_seat_label |
Пользовательский ярлык для обозначения места ( |
custom_coach_label |
Пользовательский ярлык для обозначения вагона ( |
custom_platform_label |
Пользовательский ярлык для обозначения посадочной платформы ( |
custom_zone_label |
Пользовательский ярлык для обозначения посадочной зоны ( |
custom_fare_class_label |
Пользовательский ярлык для обозначения класса тарифа ( |
custom_concession_category_label |
Пользовательский ярлык для обозначения категории скидки ( |
custom_fare_name_label |
Пользовательский ярлык для обозначения названия тарифа ( |
class_template_info |
Информация в шаблоне о том, как должен отображаться класс. Если этот объект не задан, то будет использоваться набор полей по умолчанию. |
enable_single_leg_itinerary |
Определяет, будут ли отображаться маршруты для поездок без пересадок для этого класса. По умолчанию маршруты отображаются только для поездок с пересадками. |
id |
Обязательно. Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
version |
Больше не используется |
issuer_name |
Обязательно. Название эмитента. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов. |
messages[] |
Массив сообщений, которые будут отображаться в приложении. Связанные с ним сообщения увидят все пользователи этого объекта. Максимальное число полей – 10. |
allow_multiple_users_per_object |
Вместо него используйте |
homepage_uri |
URI главной страницы приложения. Если вы заполните это поле, то результат будет тот же, что и при указании URI в поле linksModuleData: ссылка на главную страницу появится в разделе linksModuleData отображаемого объекта. |
locations[] |
|
review_status |
Обязательно. Статус класса. Задать значение Пока класс остается на этапе разработки, для него должен быть указан статус Когда класс будет готов для проверки, необходимо изменить значение поля на Если вы захотите обновить класс со статусом |
review |
Комментарий о проверке, который платформа устанавливает, когда классу присваивается отметка |
info_module_data |
Вместо него используйте textModulesData. |
image_modules_data[] |
Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса. |
text_modules_data[] |
Данные текстового модуля. Если для класса также задан текстовый модуль, то показываться будут оба. Отображается не более 10 полей из объекта и 10 полей из класса. |
links_module_data |
Данные модуля ссылок. Если для объекта также задан модуль ссылок, то показываться будут оба. |
redemption_issuers[] |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
country_code |
Код страны, по которому определяется место выпуска карты. Используется, когда пользователь совершает покупки в другой стране. Этот код также необходим для показа локализованного контента, если оригинальный контент недоступен в регионе пользователя. |
hero_image |
Дополнительный баннер, который отображается на лицевой стороне карты. Показывается только при наличии. Занимает всю ширину карты. |
word_mark |
Больше не используется. |
enable_smart_tap |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
hex_background_color |
Цвет фона карты. Если он не задан, то для оформления фона будет использован преобладающий цвет главного изображения, а в случае отсутствия изображения – логотипа. Цвет указывается в следующем формате: #rrggbb, где rrggbb – это номер оттенка в системе RGB, записанный в виде шестнадцатеричного кода. Пример: |
localized_issuer_name |
Переведенное значение issuer_name. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов. |
multiple_devices_and_holders_allowed_status |
Определяет, будет ли один и тот же объект сохраняться у разных пользователей и устройств, ссылающихся на этот класс. |
callback_options |
Параметры обратного вызова, которые будут использоваться для вызова эмитента всякий раз, когда конечные пользователи станут сохранять или удалять объекты этого класса. Данная функция доступна для всех объектов этого класса. |
TransitType
Перечисления | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
Устаревший псевдоним элемента |
RAIL |
|
rail |
Устаревший псевдоним элемента |
TRAM |
|
tram |
Устаревший псевдоним элемента |
FERRY |
|
ferry |
Устаревший псевдоним элемента |
OTHER |
|
other |
Устаревший псевдоним элемента |
TransitClassAddMessageRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
TransitClassAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс TransitClass. |
TransitClassGetRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
TransitClassInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
TransitClassListRequest
Поля | |
---|---|
issuer_id |
Идентификатор эмитента, который имеет право получать список классов. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если значение |
TransitClassListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
TransitClassPatchRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
TransitClassUpdateRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
TransitObject
Поля | |
---|---|
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[] |
Список местоположений, где может использоваться объект. Эта информация необходима для показа уведомлений пользователям с учетом их местоположения. В случае конфликта данных этот список будет использоваться вместо адресов, содержащихся в классе, которые, в свою очередь, имеют приоритет над идентификаторами мест в Google. |
has_users |
Это поле показывает, есть ли у объекта пользователи. Заполняется автоматически. |
smart_tap_redemption_value |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
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 |
Дополнительная информация о ссылке на приложение партнера. |
Категория скидки
Перечисления | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Устаревший псевдоним элемента |
CHILD |
|
child |
Устаревший псевдоним элемента |
SENIOR |
|
senior |
Устаревший псевдоним элемента |
PassengerType
Перечисления | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Устаревший псевдоним элемента |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Устаревший псевдоним элемента |
TicketStatus
Перечисления | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Устаревший псевдоним элемента |
REFUNDED |
|
refunded |
Устаревший псевдоним элемента |
EXCHANGED |
|
exchanged |
Устаревший псевдоним элемента |
TripType
Перечисления | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Устаревший псевдоним элемента |
ONE_WAY |
|
oneWay |
Устаревший псевдоним элемента |
TransitObjectAddMessageRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
TransitObjectAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс TransitObject. |
TransitObjectGetRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
TransitObjectInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
TransitObjectListRequest
Поля | |
---|---|
class_id |
Идентификатор класса, объекты которого будут перечислены. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если значение |
TransitObjectListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
TransitObjectPatchRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
TransitObjectUpdateRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Тело запроса. |