REST Resource: transitclass

Ресурс: ТранзитКласс

JSON-представление 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Поля
transit Operator Name

object ( LocalizedString )

Название транзитного оператора.

transit Type

enum ( TransitType )

Необходимый. Тип транспорта, который представляет этот класс, например «автобус».

watermark

object ( Image )

Изображение водяного знака для отображения на устройстве пользователя.

language Override

string

Если это поле присутствует, транзитные билеты, подаваемые на устройство пользователя, всегда будут на этом языке. Представляет языковой тег BCP 47. Примеры значений: «en-US», «en-GB», «de» или «de-AT».

custom Transit Terminus Name Label

object ( LocalizedString )

Пользовательская метка, используемая для значения имени транзитной конечной остановки ( transitObject.ticketLeg.transitTerminusName ).

custom Ticket Number Label

object ( LocalizedString )

Пользовательская метка, используемая для значения номера билета ( transitObject.ticketNumber ).

custom Route Restrictions Label

object ( LocalizedString )

Пользовательская метка, используемая для значения ограничений маршрута ( transitObject.ticketRestrictions.routeRestrictions ).

custom Route Restrictions Details Label

object ( LocalizedString )

Пользовательская метка, используемая для значения сведений об ограничениях маршрута ( transitObject.ticketRestrictions.routeRestrictionsDetails ).

custom Time Restrictions Label

object ( LocalizedString )

Пользовательская метка, используемая для значения сведений об ограничениях по времени ( transitObject.ticketRestrictions.timeRestrictions ).

custom Other Restrictions Label

object ( LocalizedString )

Пользовательская метка, используемая для значения других ограничений ( transitObject.ticketRestrictions.otherRestrictions ).

custom Purchase Receipt Number Label

object ( LocalizedString )

Пользовательская метка, используемая для значения номера квитанции о покупке ( transitObject.purchaseDetails.purchaseReceiptNumber ).

custom Confirmation Code Label

object ( LocalizedString )

Пользовательская метка, используемая для значения кода подтверждения ( transitObject.purchaseDetails.confirmationCode ).

custom Purchase Face Value Label

object ( LocalizedString )

Пользовательская метка, используемая для номинальной стоимости покупки ( transitObject.purchaseDetails.ticketCost.faceValue ).

custom Purchase Price Label

object ( LocalizedString )

Пользовательская метка, используемая для значения цены покупки ( transitObject.purchaseDetails.ticketCost.purchasePrice ).

custom Discount Message Label

object ( LocalizedString )

Пользовательская метка, используемая для значения сообщения о скидке на проезд ( transitObject.purchaseDetails.ticketCost.discountMessage ).

custom Carriage Label

object ( LocalizedString )

Пользовательская метка, используемая для значения перевозки ( transitObject.ticketLeg.carriage ).

custom Seat Label

object ( LocalizedString )

Пользовательская метка, используемая для значения местоположения места ( transitObject.ticketLeg.ticketSeat.seat ).

custom Coach Label

object ( LocalizedString )

Пользовательская метка, используемая для значения тренера ( transitObject.ticketLeg.ticketSeat.coach ).

custom Platform Label

object ( LocalizedString )

Пользовательская метка, используемая для значения посадочной платформы ( transitObject.ticketLeg.platform ).

custom Zone Label

object ( LocalizedString )

Пользовательская метка, используемая для значения зоны посадки ( transitObject.ticketLeg.zone ).

custom Fare Class Label

object ( LocalizedString )

Пользовательская метка, используемая для значения класса тарифа ( transitObject.ticketLeg.ticketSeat.fareClass ).

custom Concession Category Label

object ( LocalizedString )

Пользовательская метка, используемая для значения категории концессии на транзит ( transitObject.concessionCategory ).

custom Fare Name Label

object ( LocalizedString )

Пользовательская метка, используемая для значения имени транзитного тарифа ( transitObject.ticketLeg.fareName ).

class Template Info

object ( ClassTemplateInfo )

Информация шаблона о том, как должен отображаться класс. Если этот параметр не установлен, Google вернется к набору полей по умолчанию для отображения.

enable Single Leg Itinerary

boolean

Управляет отображением одноэтапного маршрута для этого класса. По умолчанию маршрут отображается только для поездок с несколькими этапами.

id

string

Необходимый. Уникальный идентификатор класса. Этот идентификатор должен быть уникальным для всех классов издателя. Это значение должно соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами. Ваш уникальный идентификатор должен включать только буквенно-цифровые символы, «.», «_» или «-».

version
(deprecated)

string ( int64 format)

Устарело

issuer Name

string

Необходимый. Название эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы полная строка отображалась на небольших экранах.

messages[]

object ( Message )

Массив сообщений, отображаемых в приложении. Все пользователи этого объекта получат связанные с ним сообщения. Максимальное количество этих полей — 10.

allowMultipleUsersPerObject
(deprecated)

boolean

Устарело. Вместо этого используйте multipleDevicesAndHoldersAllowedStatus .

homepage Uri

object ( Uri )

URI домашней страницы вашего приложения. Заполнение URI в этом поле приводит к точно такому же поведению, как и заполнение URI в linkedModuleData (при визуализации объекта ссылка на домашнюю страницу отображается в том, что обычно считается разделом linkedModuleData объекта).

locations[]
(deprecated)

object ( LatLongPoint )

Примечание. Это поле в настоящее время не поддерживается для запуска географических уведомлений.

review Status

enum ( ReviewStatus )

Необходимый. Статус класса. В этом поле можно установить draft или underReview используя вызовы API вставки, исправления или обновления. После изменения состояния проверки с draft его нельзя будет вернуть обратно в draft .

Это поле следует оставить для draft пока класс находится в стадии разработки. draft класс нельзя использовать для создания какого-либо объекта.

Если вы считаете, что класс готов к использованию, вам следует установить в этом поле значение underReview . Платформа автоматически установит для этого поля значение approved , и его можно будет немедленно использовать для создания или переноса объектов.

При обновлении уже approved класса вам следует продолжать устанавливать в этом поле значение underReview .

review

object ( Review )

Комментарии к обзору, устанавливаемые платформой, когда класс помечается как approved или rejected .

infoModuleData
(deprecated)

object ( InfoModuleData )

Устарело. Вместо этого используйте textModulesData.

image Modules Data[]

object ( ImageModuleData )

Данные модуля изображения. Максимальное количество отображаемых полей — 1 на уровне объекта и 1 на уровне объекта класса.

text Modules Data[]

object ( TextModuleData )

Текстовые данные модуля. Если в классе также определены данные текстового модуля, будут отображены оба. Максимальное количество отображаемых полей — 10 для объекта и 10 для класса.

redemption Issuers[]

string ( int64 format)

Определяет, какие эмитенты погашения могут выкупить пропуск через Smart Tap. Эмитенты погашения идентифицируются по идентификатору эмитента. У эмитентов погашения должен быть настроен хотя бы один ключ Smart Tap.

Поля enableSmartTap и smartTapRedemptionLevel уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

country Code

string

Код страны, используемый для отображения страны карты (если пользователь не находится в этой стране), а также для отображения локализованного контента, когда контент недоступен в языковом стандарте пользователя.

hero Image

object ( Image )

Дополнительное изображение баннера, отображаемое на лицевой стороне карты. Если его нет, ничего не будет отображаться. Изображение будет отображаться с шириной 100%.

wordMark
(deprecated)

object ( Image )

Устарело.

enable Smart Tap

boolean

Определяет, поддерживает ли этот класс Smart Tap. Поля redemptionIssuers и smartTapRedemptionLevel уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

hex Background Color

string

Цвет фона карточки. Если этот параметр не установлен, используется доминирующий цвет главного изображения, а если главное изображение не установлено, используется доминирующий цвет логотипа. Формат: # rrggbb , где rrggbb — это шестнадцатеричный триплет RGB, например #ffcc00 . Вы также можете использовать сокращенную версию триплета RGB — rgb , например #fc0 .

localized Issuer Name

object ( LocalizedString )

Переведенные строки для имени эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

multiple Devices And Holders Allowed Status

enum ( MultipleDevicesAndHoldersAllowedStatus )

Определяет, будут ли несколько пользователей и устройств сохранять один и тот же объект, ссылающийся на этот класс.

callback Options

object ( CallbackOptions )

Параметры обратного вызова, которые будут использоваться для обратного вызова эмитента при каждом сохранении/удалении объекта этого класса конечным пользователем. Все объекты этого класса имеют право на обратный вызов.

security Animation

object ( SecurityAnimation )

Дополнительная информация об анимации безопасности. Если этот параметр установлен, при деталях прохода будет отображаться анимация безопасности.

activation Options

object ( ActivationOptions )

Варианты активации активируемого билета.

view Unlock Requirement

enum ( ViewUnlockRequirement )

Просмотрите параметры требования разблокировки для транзитного билета.

notify Preference

enum ( NotificationSettingsForUpdates )

Должны ли обновления полей этого класса вызывать уведомления. Если установлено значение NOTIFY, мы попытаемся отправить пользователям уведомление об обновлении поля. Эти уведомления будут отправляться пользователям только в том случае, если поле является частью белого списка. Если установлено значение DO_NOT_NOTIFY или NOTIFICATION_SETTINGS_UNSPECIFIED, уведомление не будет срабатывать. Этот параметр является временным и его необходимо устанавливать при каждом запросе PATCH или UPDATE, иначе уведомление не будет активировано.

value Added Module Data[]

object ( ValueAddedModuleData )

Дополнительные данные модуля с добавленной стоимостью. Максимум десять в классе. Для прохода будут отображаться только десять, приоритет отдается тем, которые принадлежат объекту.

Тип Транзита

Перечисления
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Устаревший псевдоним для BUS . Устарело.

RAIL
rail

Устаревший псевдоним для RAIL . Устарело.

TRAM
tram

Устаревший псевдоним для TRAM . Устарело.

FERRY
ferry

Устаревший псевдоним FERRY . Устарело.

OTHER
other

Устаревший псевдоним для OTHER . Устарело.

Параметры активации

ActivationOptions для класса

JSON-представление 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Поля
activation Url

string

URL-адрес HTTPS, поддерживающий семантику REST. Будет использоваться для запроса активации у партнеров по заданной ценности, инициированной пользователями.

allow Reactivation

boolean

Флаг, позволяющий пользователям совершать активационные вызовы с другого устройства. Это позволяет клиенту отображать кнопку активации включенной, даже если активацияStatus имеет значение ACTIVATED, но запрошенное устройство отличается от текущего устройства.

Методы

addmessage

 Добавляет сообщение в транзитный класс, на который ссылается данный идентификатор класса.

get

 Возвращает транзитный класс с заданным идентификатором класса.

insert

 Вставляет транзитный класс с заданным идентификатором и свойствами.

list

 Возвращает список всех классов транзита для данного идентификатора эмитента.

patch

 Обновляет транзитный класс, на который ссылается данный идентификатор класса.

update

 Обновляет транзитный класс, на который ссылается данный идентификатор класса.