REST Resource: transitclass

Zasób: TransitClass

Zapis 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)
  }
}
Pola
transitOperatorName

object (LocalizedString)

Nazwa operatora transportu publicznego.
transitType

enum (TransitType)

To pole jest wymagane. Rodzaj transportu, jaki reprezentuje ta klasa, na przykład „autobus”.
watermark

object (Image)

Obraz znaku wodnego wyświetlany na urządzeniu użytkownika.
languageOverride

string

Jeśli to pole jest obecne, bilety transportu publicznego udostępniane na urządzeniu użytkownika będą zawsze wyświetlane w tym języku. Reprezentuje tag języka BCP 47. Przykładowe wartości to „en-US”, „en-GB”, „de” i „de-AT”.
customTransitTerminusNameLabel

object (LocalizedString)

Własna etykieta dla wartości nazwy punktu końcowego (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Własna etykieta dla wartości numeru biletu (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Własna etykieta dla wartości ograniczeń trasy (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Własna etykieta dla wartości szczegółów ograniczeń trasy (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Własna etykieta dla wartości szczegółów ograniczeń czasowych (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Własna etykieta dla wartości innych ograniczeń (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Własna etykieta dla wartości numeru potwierdzenia zakupu (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Własna etykieta dla wartości kodu potwierdzenia (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Własna etykieta dla wartości nominalnej zakupu (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Własna etykieta dla wartości ceny zakupu (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Własna etykieta dla wartości komunikatu rabatu na transport publiczny (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Własna etykieta dla wartości przewozu (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Własna etykieta dla wartości lokalizacji miejsca (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Własna etykieta dla wartości trenera (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

Własna etykieta dla wartości peronu wejścia na pokład (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Własna etykieta dla wartości strefy wejścia na pokład (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Własna etykieta dla wartości klasy taryfy (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Własna etykieta dla wartości kategorii ulg na transport publiczny (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Własna etykieta dla wartości nazwy taryfy transportu publicznego (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Informacje o szablonie wyświetlania klasy. Jeśli nie są ustawione, Google użyje domyślnego zestawu pól do wyświetlenia.
enableSingleLegItinerary

boolean

Steruje wyświetlaniem planu podróży jednoetapowego dla tych zajęć. Domyślnie plan podróży wyświetla się tylko w przypadku podróży wieloetapowej.
id

string

To pole jest wymagane. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas wydawcy. Ta wartość powinna mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. Unikalny identyfikator powinien zawierać tylko znaki alfanumeryczne oraz znaki „.”, „_” lub „-”.
version
(deprecated)

string (int64 format)

Wycofano
issuerName

string

To pole jest wymagane. Nazwa wydawcy. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
messages[]

object (Message)

Tablica komunikatów wyświetlanych w aplikacji. Wszyscy użytkownicy tego obiektu będą otrzymywać powiązane z nim komunikaty. Maksymalna liczba tych pól to 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Rola wycofana. Użyj w zamian zasady multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI ma taki sam efekt jak wypełnienie identyfikatora URI w linksModuleData (przy renderowaniu obiektu link do strony głównej jest widoczny w miejscu, które można zwykle określić jako sekcję linksModuleData obiektu).
locations[]

object (LatLongPoint)

Uwaga: to pole nie jest obecnie obsługiwane w przypadku wyświetlania powiadomień geograficznych.
reviewStatus

enum (ReviewStatus)

To pole jest wymagane. Stan zajęć. To pole można ustawić na draft lub underReview za pomocą wywołań interfejsu API insert, patch lub update. Po zmianie stanu weryfikacji z draft nie można go zmienić z powrotem na draft.

Należy zachować wartość draft, gdy klasa jest w trakcie opracowywania. Klasy draft nie można użyć do utworzenia żadnego obiektu.

Pole to należy ustawić na underReview, gdy klasa jest gotowa do użycia. Platforma automatycznie ustawi to pole na approved i będzie można go natychmiast używać do tworzenia lub migrowania obiektów.

Aktualizując klasę, która jest już w stanie approved, należy ustawiać to pole na underReview.
review

object (Review)

Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako approved lub rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Rola wycofana. Zamiast tego użyj textModulesData.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazów. Maksymalna liczba wyświetlanych pól to 1 z poziomu obiektu i 1 dla poziomu obiektu klasy.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli dane modułu tekstowego są określone również w klasie, będą wyświetlane jedne i drugie. Maksymalna liczba wyświetlanych pól to 10 z obiektu i 10 z klasy.
redemptionIssuers[]

string (int64 format)

Określa, którzy wydawcy elementów promocyjnych mogą wykorzystać kartę za pomocą smart tap. Wydawca elementów promocyjnych jest identyfikowany po identyfikatorze wydawcy. Wydawca elementów promocyjnych musi mieć skonfigurowany co najmniej 1 klucz smart tap.

Aby karta obsługiwała smart tap, pola enableSmartTap i smartTapRedemptionLevel na poziomie obiektu też muszą być odpowiednio skonfigurowane.
countryCode

string

Kod kraju używany do wyświetlania kraju karty (gdy użytkownik nie znajduje się w tym kraju), a także do wyświetlania zlokalizowanej treści, gdy treść nie jest dostępna w języku użytkownika.
heroImage

object (Image)

Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli jej nie ma, nic nie jest wyświetlane. Obraz wyświetla się w 100% szerokości.
wordMark
(deprecated)

object (Image)

Rola wycofana.
enableSmartTap

boolean

Określa, czy ta klasa obsługuje smart tap. Aby karta obsługiwała smart tap, pola redemptionIssuers i smartTapRedemptionLevel na poziomie obiektu też muszą być odpowiednio skonfigurowane.
hexBackgroundColor

string

Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor obrazu banera powitalnego, a jeśli baner nie jest ustawiony, używany jest dominujący kolor logo. Format to #rrggbb, gdzie rrggbb to szesnastkowy zapis RGB, taki jak #ffcc00. Możesz także używać skróconej wersji zapisu RGB w formacie #rgb, jak w tym przypadku #fc0.
localizedIssuerName

object (LocalizedString)

Przetłumaczony tekst pola publisherName. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy.
callbackOptions

object (CallbackOptions)

Opcje wywołania zwrotnego, które mają być używane do wywoływania wydawcy przy każdym zapisaniu/usunięciu obiektu tej klasy przez użytkownika końcowego. Wszystkie obiekty tej klasy kwalifikują się do wywołania zwrotnego.
securityAnimation

object (SecurityAnimation)

Opcjonalne informacje o animacji zabezpieczeń. Jeśli ta zasada jest skonfigurowana, w szczegółach karty będzie renderowana animacja dotycząca bezpieczeństwa.
activationOptions

object (ActivationOptions)

Opcje aktywacji zgłoszenia aktywowanego.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Zobacz opcje wymagania odblokowania w przypadku biletu na przejazd.

TransitType

Wartości w polu enum
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Starsza wersja aliasu dla BUS. Rola wycofana.
RAIL
rail

Starsza wersja aliasu dla RAIL. Rola wycofana.
TRAM
tram

Starsza wersja aliasu dla TRAM. Rola wycofana.
FERRY
ferry

Starsza wersja aliasu dla FERRY. Rola wycofana.
OTHER
other

Starsza wersja aliasu dla OTHER. Rola wycofana.

ActivationOptions

Opcje aktywacji zajęć

Zapis JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Pola
activationUrl

string

Adres URL HTTPS, który obsługuje semantykę REST. Będzie używana do wysyłania próśb o aktywację od partnerów w przypadku określonych wartości wyzwalanych przez użytkowników.
allowReactivation

boolean

Zgłoś, aby umożliwić użytkownikom nawiązanie połączenia aktywacyjnego z innego urządzenia. Dzięki temu klient będzie mógł renderować przycisk aktywacji nawet wtedy, gdy stan aktywacji jest AKTYWNY, ale żądane urządzenie jest inne niż bieżące.

Metody

addmessage

 Dodaje komunikat do klasy biletu, do której odwołuje się podany identyfikator klasy.

get

 Zwraca klasę biletu o podanym identyfikatorze klasy.

insert

 Wstawia klasę biletu o podanym identyfikatorze i właściwościach.

list

 Zwraca listę wszystkich klas biletu dla podanego identyfikatora wydawcy.

patch

 Aktualizuje klasę biletu, do której odwołuje się podany identyfikator klasy.

update

 Aktualizuje klasę biletu, do której odwołuje się podany identyfikator klasy.