- 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 | |
---|---|
class |
Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET. |
ticket |
Numer biletu. Jest to unikalny identyfikator biletu w systemie operatora transportu publicznego. |
passenger |
Liczba pasażerów. |
passenger |
Nazwiska pasażerów, którym przydzielono bilet. Opisane wyżej pole |
trip |
Ten identyfikator służy do grupowania biletów, jeśli użytkownik zapisał kilka biletów na tę samą podróż. |
ticket |
Stan zgłoszenia. W przypadku stanów, które mają wpływ na wyświetlanie, użyj pola |
custom |
Własny stan używany w przypadku wartości stanu biletu, gdy |
concession |
Kategoria rodzaju ulgi na bilet. |
custom |
Niestandardowa kategoria ulgi, której należy użyć, gdy kategoria |
ticket |
Informacje o ograniczeniach dotyczących korzystania z tego biletu. Na przykład w które dni tygodnia należy go używać lub jakie trasy można pokonywać. |
purchase |
Szczegóły zakupu biletu. |
ticket |
Pojedynczy odcinek biletu zawiera informacje na temat odjazdu i przyjazdu, wejścia na pokład oraz przydzielonego miejsca. Jeśli chcesz określić więcej niż jeden odcinek biletu, użyj pola |
ticket |
Każdy bilet może zawierać jeden lub więcej odcinków. Każdy odcinek biletu zawiera informacje na temat odjazdu i przyjazdu, wejścia na pokład i przydzielenia miejsca. Jeśli chcesz określić tylko jeden odcinek, użyj pola |
hex |
Kolor tła karty. Jeśli nie jest ustawiony, używany jest dominujący kolor obrazu banera powitalnego, a jeśli obraz banera powitalnego nie jest ustawiony, używany jest dominujący kolor logo. Format to #rrggbb, gdzie rrggbb to szesnastkowy zapis RGB, taki jak |
trip |
Wymagane. Typ podróży, którą reprezentuje ten obiekt biletu. Służy do określenia tytułu dokumentu lub symbolu, który ma być używany między miejscem początkowym i 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 „-”. |
class |
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. |
valid |
Okres, przez jaki ten obiekt będzie |
locations[] |
Uwaga: to pole nie jest obecnie obsługiwane w przypadku wywoływania powiadomień geograficznych. |
has |
Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę. |
smart |
Wartość, która będzie przesyłana przez NFC do terminala z certyfikatem smart tap w przypadku tego obiektu. Aby karty obsługiwały funkcję smart tap, pola poziomu klasy |
has |
Wskazuje, czy ten obiekt jest aktualnie połączony z jednym urządzeniem. To pole jest ustawiane przez platformę, gdy użytkownik zapisuje obiekt, łącząc go ze swoim urządzeniem. Przeznaczony do użytku przez wybranych partnerów. Aby uzyskać więcej informacji, skontaktuj się z zespołem pomocy. |
disable |
Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole jest ustawione na wartość true, niezależnie od pola Obecnie można go ustawiać tylko dla ofert. |
info |
Rola wycofana. Zamiast tego użyj textModulesData. |
image |
Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy. |
text |
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 wynosi 10 z obiektu i 10 z klasy. |
links |
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. |
app |
Opcjonalny link do aplikacji lub witryny, który będzie wyświetlany jako przycisk z przodu dokumentu. Jeśli atrybut AppLinkData jest podany dla odpowiedniej klasy, wyświetlany będzie tylko obiekt AppLinkData. |
activation |
Stan aktywacji obiektu. Wymagany, jeśli zajęcia mają ustawione |
rotating |
Typ i wartość kodu kreskowego, który się zmienia. |
device |
Kontekst urządzenia powiązany z obiektem. |
hero |
Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli takiego nie ma, wyświetli się baner powitalny zajęć, jeśli są dostępne. Jeśli nie ma też banera powitalnego zajęć, nic się nie wyświetli. |
grouping |
Informacje określające sposób grupowania kart. |
pass |
Przekazywanie ograniczeń dotyczących obiektu. Obejmuje to ograniczenie działania NFC i zrzutów ekranu. |
save |
Ograniczenia dotyczące obiektu, które musi zostać zweryfikowane, zanim użytkownik spróbuje zapisać kartę. Pamiętaj, że te ograniczenia będą stosowane tylko podczas zapisywania. Jeśli ograniczenia zmienią się po zapisaniu dokumentu, nowe ograniczenia nie zostaną zastosowane do już zapisanego dokumentu. |
linked |
linkedObjectIds to lista innych obiektów, takich jak bilet na wydarzenie, karta lojalnościowa, oferta, karta podarunkowa, karta ogólna, karta pokładowa i karta na przejazd, które powinny być automatycznie dołączone do tego obiektu karty. Jeśli użytkownik zapisze tę kartę, te identyfikatory połączonych obiektów zostaną automatycznie przesłane do portfela użytkownika (chyba że wyłączy ustawienie dotyczące otrzymywania takich połączonych kart). Upewnij się, że obiekty w linkedObjectIds zostały już wstawione. W przeciwnym razie wywołania nie powiedzą się. Po połączeniu połączonych obiektów nie można ich odłączyć. Nie możesz połączyć obiektów należących do innego wydawcy. Liczba obiektów, które można połączyć z jednym obiektem, jest ograniczona. Gdy zostanie osiągnięty limit, nowe połączone obiekty w wywołaniu zostaną po cichu zignorowane. Identyfikatory obiektów powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. |
notify |
Określa, czy aktualizacje pól tego obiektu powinny wyzwalać powiadomienia. Gdy ustawisz opcję NOTIFY (powiadamiaj), spróbujemy wywołać powiadomienie o zmianie pola dla użytkowników. Te powiadomienia będą wysyłane tylko do użytkowników, jeśli pole jest częścią listy dozwolonych. Jeśli ustawisz wartość DO_NOT_NOTIFY lub NOTIFICATION_SETTINGS_UNSPECIFIED, nie zostanie uruchomione żadne powiadomienie. To ustawienie jest efemeryczne i należy je ustawiać dla każdego żądania PATCH lub UPDATE. W przeciwnym razie powiadomienie nie zostanie wywołane. |
value |
Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na obiekt. |
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 | |
---|---|
route |
Ograniczenia dotyczące możliwych tras. Może to być na przykład tekst „Tylko pociągi dalekobieżne z rezerwacją miejsc”. |
route |
Więcej informacji o powyższym |
time |
Ograniczenia dotyczące czasu wykorzystania tego biletu. |
other |
Dodatkowe ograniczenia, które nie należą do kategorii „trasy” ani „czasu”. |
PurchaseDetails
Zapis JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Pola | |
---|---|
purchase |
Numer rachunku lub identyfikator do śledzenia zakupu biletu przez podmiot, który sprzedał bilet. |
purchase |
Data i godzina zakupu biletu. Są to data i godzina w rozszerzonym formacie ISO 8601 bez przesunięcia lub z przesunięciem. Czas 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 takie nie jest objęte normą ISO 8601). Na przykład: W UTC
Bez informacji o przesunięciu Bez informacji o przesunięciu niektóre rozszerzone funkcje mogą być niedostępne. |
account |
Identyfikator konta użytego do zakupu biletu. |
confirmation |
Kod potwierdzający zakup. Może być taki sam dla wielu różnych biletów i służy do grupowania biletów. |
ticket |
Koszt biletu. |
TicketCost
Zapis JSON |
---|
{ "faceValue": { object ( |
Pola | |
---|---|
face |
Wartość nominalna biletu. |
purchase |
Rzeczywista cena zakupu biletu, po opodatkowaniu lub rabatach. |
discount |
Komunikat opisujący każdy zastosowany rabat. |
TicketLeg
Zapis JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Pola | |
---|---|
origin |
Kod stacji początkowej. Jest wymagane, jeśli podano |
origin |
Nazwa stacji początkowej. Jest wymagane, jeśli podano |
destination |
Kod stacji docelowej. |
destination |
Nazwa miejsca docelowego. |
departure |
Data i godzina wyjazdu. Pole jest wymagane, jeśli dla obiektu biletu nie określono przedziału czasu ważności. Są to data i godzina w rozszerzonym formacie ISO 8601 bez przesunięcia lub z przesunięciem. 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 takie nie jest objęte 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 rozszerzone funkcje mogą być niedostępne. |
arrival |
Data i godzina przyjazdu. Są to data i godzina w rozszerzonym formacie ISO 8601 bez przesunięcia lub z przesunięciem. 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 takie nie jest objęte 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 nastąpić na stacji docelowej o godzinie 20 dnia 5 czerwca 2018 roku, lokalną datą i godziną powinno być Bez informacji o przesunięciu niektóre rozszerzone funkcje mogą być niedostępne. |
fare |
Krótki opis lub nazwa opłaty za ten etap podróży. Np. „Dowolna godzina, jednorazowy”. |
carriage |
Nazwa lub numer pociągu albo statku, na który pasażer musi wejść. |
platform |
Peron lub brama, gdzie pasażer może wsiąść na statek lub do pociągu. |
zone |
Strefa wsiadania do pociągu w obrębie peronu. |
ticket |
Miejsce zarezerwowane dla pasażerów. Jeśli chcesz określić więcej niż jedno miejsce, użyj pola |
ticket |
Miejsce zarezerwowane dla pasażerów. Jeśli chcesz określić tylko jedno miejsce, użyj pola |
transit |
Nazwa operatora transportu publicznego obsługującego ten etap podróży. |
transit |
Stacja końcowa lub miejsce docelowe pociągu, autokaru itp. |
TicketSeat
Zapis JSON |
---|
{ "fareClass": enum ( |
Pola | |
---|---|
fare |
Klasa taryfy biletowanego miejsca. |
custom |
Niestandardowa klasa taryfy, którą należy zastosować, gdy |
coach |
Identyfikator wagonu lub autokaru, w którym znajduje się biletowane miejsce. np. „10” |
seat |
Identyfikator miejsca, w którym znajduje się biletowane miejsce. np. „42”. Jeśli nie ma określonego identyfikatora, użyj zamiast tego |
seat |
Przypisanie miejsca pasażera. np. „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ść obsługuje aktywację.
Zapis JSON |
---|
{
"state": enum ( |
Pola | |
---|---|
state |
|
Stan
Wartości w polu enum | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Nieaktywna – domyślny stan |
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 | |
---|---|
device |
Jeśli jest ustawiona, informacje o wykupieniu będą zwracane tylko na dane urządzenie po aktywacji obiektu. Nie należy go używać jako stabilnego identyfikatora do śledzenia urządzenia użytkownika. Może się zmieniać w przypadku różnych kart na tym samym urządzeniu, a nawet w przypadku różnych aktywacji na tym samym urządzeniu. Gdy to ustawienie jest włączone, osoby wywołujące muszą też ustawić parametr hasLinkedDevice na aktywowanym obiekcie. |
Metody |
|
---|---|
|
Dodaje wiadomość do obiektu biletu, do którego odwołuje się podany identyfikator obiektu. |
|
Zwraca obiekt biletu na przejazd 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. |