- Zasób: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Stan
- DeviceContext
- Metody
Zasób: TransitObject
Zapis JSON |
---|
{ "classReference": { object ( |
Pola | |
---|---|
classReference |
Kopia odziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET. |
ticketNumber |
Numer biletu. Jest to unikalny identyfikator biletu w systemie operatora transportu publicznego. |
passengerType |
Liczba pasażerów. |
passengerNames |
Nazwiska pasażerów, którym przydzielono bilet. Opisane wyżej pole |
tripId |
Ten identyfikator służy do grupowania biletów, jeśli użytkownik zapisał kilka biletów na tę samą podróż. |
ticketStatus |
Stan zgłoszenia. W przypadku stanów, które mają wpływ na wyświetlanie, użyj pola |
customTicketStatus |
Własny stan używany w przypadku wartości stanu biletu, gdy |
concessionCategory |
Kategoria ulgi na bilet. |
customConcessionCategory |
Niestandardowa kategoria ulgi, której należy użyć, gdy |
ticketRestrictions |
Informacje o ograniczeniach dotyczących korzystania z tego biletu. Na przykład w jakie dni tygodnia należy go używać lub jakie trasy można pokonywać. |
purchaseDetails |
Szczegóły zakupu biletu. |
ticketLeg |
Pojedynczy odcinek biletu zawiera informacje na temat odjazdu i przyjazdu oraz informacje o wsiadaniu i miejscach. Jeśli chcesz określić więcej niż jeden etap, użyj pola |
ticketLegs[] |
Każdy bilet może zawierać jeden lub więcej odcinków. Każdy odcinek biletu zawiera informacje na temat odjazdu i przyjazdu oraz informacje o wejściu na pokład i przydzielonym miejscu. Jeśli chcesz określić tylko jeden odcinek, użyj pola |
hexBackgroundColor |
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 |
tripType |
Wymagane. Typ podróży, którą reprezentuje ten obiekt biletu. Służy do określenia tytułu karty lub symbolu, który ma być używany między miejscem wylotu a miejscem docelowym. |
id |
Wymagane. Unikalny identyfikator obiektu. Ten identyfikator musi być unikalny wśród wszystkich obiektów 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 „-”. |
classId |
Wymagane. Klasa powiązana z tym obiektem. Klasa musi być tego samego typu co ten obiekt, musi już istnieć i musi być zatwierdzona. Identyfikatory klas powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. |
version |
Wycofano |
state |
Wymagane. Stan obiektu. To pole służy do określania sposobu wyświetlania obiektu w aplikacji. Na przykład obiekt |
barcode |
Typ i wartość kodu kreskowego. |
messages[] |
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. |
validTimeInterval |
Okres, przez jaki ten obiekt będzie |
locations[] |
Uwaga: to pole nie jest obecnie obsługiwane w przypadku wyświetlania powiadomień geograficznych. |
hasUsers |
Wskazuje, czy obiekt zawiera użytkowników. To pole jest ustawiane przez platformę. |
smartTapRedemptionValue |
Wartość, która będzie przesyłana do terminala z certyfikatem Smart Tap przez NFC dla tego obiektu. Aby karta obsługiwała smart tap, pola |
hasLinkedDevice |
Wskazuje, czy ten obiekt jest obecnie połączony z jednym urządzeniem. To pole jest ustawiane przez platformę, gdy użytkownik zapisuje obiekt, łącząc go ze swoim urządzeniem. Przeznaczone do użytku przez wybranych partnerów. Aby uzyskać dodatkowe informacje, skontaktuj się z zespołem pomocy. |
disableExpirationNotification |
Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole ma wartość Prawda, niezależnie od pola Obecnie można to zrobić tylko w przypadku ofert. |
infoModuleData |
Rola wycofana. Zamiast tego użyj textModulesData. |
imageModulesData[] |
Dane modułu obrazów. Maksymalna liczba wyświetlanych pól to 1 z poziomu obiektu i 1 dla poziomu obiektu klasy. |
textModulesData[] |
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. |
linksModuleData |
Dane modułu linków. Jeśli dane modułu linków są określone również w klasie, będą wyświetlane jedne i drugie. |
appLinkData |
Opcjonalny link do aplikacji lub strony internetowej, który będzie wyświetlany jako przycisk z przodu karty. Jeśli zostanie podany parametr AppLinkData dla odpowiadającego mu obiektu tylko klasy, zostanie wyświetlony AppLinkData. |
activationStatus |
Stan aktywacji obiektu. Wymagane, jeśli zajęcia mają ustawiony |
rotatingBarcode |
Typ i wartość kodu kreskowego obracającego się. |
deviceContext |
Kontekst urządzenia powiązany z obiektem. |
heroImage |
Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli go nie ma, wyświetli się baner powitalny zajęć (jeśli jest dostępny). Jeśli nie znajdziesz też banera powitalnego zajęć, nic się nie wyświetli. |
groupingInfo |
Informacje określające sposób grupowania kart. |
passConstraints |
Przekazywanie ograniczeń obiektu. Obejmuje to ograniczenie możliwości NFC i wykonywania zrzutów ekranu. |
PassengerType
Wartości w polu enum | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Starsza wersja aliasu dla |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Starsza wersja aliasu dla |
TicketStatus
Wartości w polu enum | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Starsza wersja aliasu dla |
REFUNDED |
|
refunded |
Starsza wersja aliasu dla |
EXCHANGED |
|
exchanged |
Starsza wersja aliasu dla |
ConcessionCategory
Wartości w polu enum | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Starsza wersja aliasu dla |
CHILD |
|
child |
Starsza wersja aliasu dla |
SENIOR |
|
senior |
Starsza wersja aliasu dla |
TicketRestrictions
Zapis JSON |
---|
{ "routeRestrictions": { object ( |
Pola | |
---|---|
routeRestrictions |
Ograniczenia dotyczące możliwych tras. Może to być np. tekst „Tylko zarezerwowane pociągi przełajowe”. |
routeRestrictionsDetails |
Więcej informacji na ten temat ( |
timeRestrictions |
Ograniczenia dotyczące czasu wykorzystania tego biletu. |
otherRestrictions |
Dodatkowe ograniczenia, które nie należą do kategorii „trasa” ani „czasu”. |
PurchaseDetails
Zapis JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Pola | |
---|---|
purchaseReceiptNumber |
Numer rachunku/identyfikator do śledzenia zakupu biletu przez podmiot, który sprzedał bilet. |
purchaseDateTime |
Data i godzina zakupu biletu. Jest to data i godzina w rozszerzonym formacie ISO 8601 z przesunięciem lub bez niego. Godzinę można określić z dokładnością do nanosekundy. Przesunięcia można określić z dokładnością do sekundy (pomimo że przesunięcie sekundy nie jest zgodne z normą ISO 8601). Na przykład: W UTC
Bez informacji o przesunięciu niektóre zaawansowane funkcje mogą być niedostępne. |
accountId |
Identyfikator konta użytego do zakupu biletu. |
confirmationCode |
Kod potwierdzenia zakupu. Może być taki sam dla wielu różnych biletów i służy do grupowania biletów. |
ticketCost |
Koszt biletu. |
TicketCost
Zapis JSON |
---|
{ "faceValue": { object ( |
Pola | |
---|---|
faceValue |
Wartość nominalna biletu. |
purchasePrice |
Rzeczywista cena zakupu biletu, po opodatkowaniu lub rabatach. |
discountMessage |
Komunikat opisujący każdy zastosowany rabat. |
TicketLeg
Zapis JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Pola | |
---|---|
originStationCode |
Kod stacji początkowej. Jest wymagane, jeśli podano |
originName |
Nazwa stacji początkowej. Jest wymagane, jeśli podano |
destinationStationCode |
Kod stacji docelowej. |
destinationName |
Nazwa miejsca docelowego. |
departureDateTime |
Data i godzina wyjazdu. Jest to wymagane, jeśli dla obiektu biletu nie ustawiono przedziału czasu ważności. Jest to data i godzina w rozszerzonym formacie ISO 8601 z przesunięciem lub bez niego. Godzinę można określić z dokładnością do nanosekundy. Przesunięcia można określić z dokładnością do sekundy (pomimo że przesunięcie sekundy nie jest zgodne z normą ISO 8601). Na przykład: W UTC
Część daty i godziny bez przesunięcia jest uważana za „lokalną datę i godzinę”. Powinny to być lokalna data i godzina na stacji początkowej. Jeśli na przykład wyjazd ze stacji początkowej ma nastąpić o godzinie 20 dnia 5 czerwca 2018 roku, lokalną datą i godziną powinno być Bez informacji o przesunięciu niektóre zaawansowane funkcje mogą być niedostępne. |
arrivalDateTime |
Data i godzina przyjazdu. Jest to data i godzina w rozszerzonym formacie ISO 8601 z przesunięciem lub bez niego. Godzinę można określić z dokładnością do nanosekundy. Przesunięcia można określić z dokładnością do sekundy (pomimo że przesunięcie sekundy nie jest zgodne z normą ISO 8601). Na przykład: W UTC
Część daty i godziny bez przesunięcia jest uważana za „lokalną datę i godzinę”. Powinny to być lokalna data i godzina na stacji docelowej. Jeśli na przykład wydarzenie ma miejsce na stacji docelowej o godzinie 20 dnia 5 czerwca 2018 roku, lokalną datą i godziną powinno być Bez informacji o przesunięciu niektóre zaawansowane funkcje mogą być niedostępne. |
fareName |
Krótki opis lub nazwa opłaty za ten etap podróży. Na przykład „Jednorazowe użycie w dowolnym momencie”. |
carriage |
Nazwa lub numer pociągu lub statku, na który pasażer musi wejść. |
platform |
Peron lub brama, gdzie pasażer może wsiąść na pojazd. |
zone |
Strefa wsiadania do pociągu w obrębie peronu. |
ticketSeat |
Miejsce zarezerwowane dla pasażera lub pasażerów. Jeśli chcesz określić więcej niż jedno miejsce, użyj pola |
ticketSeats[] |
Miejsce zarezerwowane dla pasażera lub pasażerów. Jeśli chcesz określić tylko jedno miejsce, użyj pola |
transitOperatorName |
Nazwa operatora transportu publicznego obsługującego ten etap podróży. |
transitTerminusName |
Stacja końcowa lub miejsce docelowe pociągu, autobusu itp. |
TicketSeat
Zapis JSON |
---|
{ "fareClass": enum ( |
Pola | |
---|---|
fareClass |
Klasa taryfowa biletowanego miejsca. |
customFareClass |
Niestandardowa klasa taryfy, którą należy zastosować, jeśli |
coach |
Identyfikator wagonu lub wagonu, w którym znajduje się biletowane miejsce. Na przykład: „10” |
seat |
Identyfikator miejsca, w którym znajduje się biletowane miejsce. Na przykład: „42”. Jeśli nie ma określonego identyfikatora, zamiast tego użyj |
seatAssignment |
Przypisanie miejsca pasażera. Na przykład: „brak określonego miejsca”. Należy używać, gdy w |
FareClass
Wartości w polu enum | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Starsza wersja aliasu dla |
FIRST |
|
first |
Starsza wersja aliasu dla |
BUSINESS |
|
business |
Starsza wersja aliasu dla |
TripType
Wartości w polu enum | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Starsza wersja aliasu dla |
ONE_WAY |
|
oneWay |
Starsza wersja aliasu dla |
ActivationStatus
Stan aktywacji obiektu. To pole zawiera stan aktywacji, jeśli wartość może pomóc.
Zapis JSON |
---|
{
"state": enum ( |
Pola | |
---|---|
state |
|
Stan
Wartości w polu enum | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Nie aktywowano, to stan domyślny |
not_activated |
Starsza wersja aliasu dla |
ACTIVATED |
Aktywowano |
activated |
Starsza wersja aliasu dla |
DeviceContext
Kontekst urządzenia powiązany z obiektem.
Zapis JSON |
---|
{ "deviceToken": string } |
Pola | |
---|---|
deviceToken |
Jeśli zasada jest skonfigurowana, informacje o wykorzystaniu promocji będą zwracane do danego urządzenia tylko po aktywacji obiektu. Nie należy używać go jako stabilnego identyfikatora do śledzenia urządzenia użytkownika. Może się zmieniać w różnych kartach dla tego samego urządzenia, a nawet w przypadku różnych aktywacji na tym samym urządzeniu. W przypadku tego ustawienia elementy wywołujące muszą też ustawić hasLinkedDevice w aktywowanym obiekcie. |
Metody |
|
---|---|
|
Dodaje wiadomość do obiektu biletu, do którego odwołuje się podany identyfikator obiektu. |
|
Zwraca obiekt biletu z podanym identyfikatorem obiektu. |
|
Wstawia obiekt biletu z podanym identyfikatorem i właściwościami. |
|
Zwraca listę wszystkich obiektów biletu dla podanego identyfikatora wydawcy. |
|
Aktualizuje obiekt biletu, do którego odwołuje się podany identyfikator obiektu. |
|
Aktualizuje obiekt biletu, do którego odwołuje się podany identyfikator obiektu. |