REST Resource: genericobject

Zasób: GenericObject

Obiekt ogólny

Zapis JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Pola
genericType

enum (GenericType)

Określ, do której GenericType należy karta.
cardTitle

object (LocalizedString)

Wymagane. nagłówek dokumentu. Zwykle jest to nazwa firmy, np. „Siłownia XXX” lub „Ubezpieczenia AAA”. To pole jest wymagane i pojawia się w wierszu nagłówka na samej górze karty.
subheader

object (LocalizedString)

Etykieta tytułu karty, np. lokalizacja, w której można jej używać. Pojawia się tuż nad tytułem w wierszu tytułu w widoku szczegółów karty.
header

object (LocalizedString)

Wymagane. Tytuł dokumentu, na przykład „Kupony 50% zniżki”, „Karta biblioteczna” lub „Bon”. To pole jest wymagane i pojawia się w wierszu tytułu widoku z informacjami o karcie.
hexBackgroundColor

string

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. Jeśli logo nie jest ustawione, kolor zostanie wybrany przez Google.
notifications

object (Notifications)

Ustawienia powiadomień włączone dla tego obiektu.
id

string

Wymagane. Unikalny identyfikator obiektu. Ten identyfikator musi być unikalny wśród wszystkich obiektów wydawcy. Ta wartość musi mieć format issuerID.identifier, gdzie issuerID jest wydawany przez Google, a identifier jest wybierany przez Ciebie. Unikalny identyfikator może zawierać tylko znaki alfanumeryczne, ., _ lub -.
classId

string

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 issuerID.identifier, gdzie issuerID jest wystawiany przez Google, a identifier jest wybierany przez Ciebie.
barcode

object (Barcode)

Typ i wartość kodu kreskowego. Jeśli karta nie ma kodu kreskowego, możemy zezwolić jej wydawcy na ustawienie wartości Barcode.alternate_text i wyświetlanie tylko tej wartości.
heroImage

object (Image)

Obraz banera wyświetlany z przodu karty (jeśli jest dostępny). Obraz wyświetla się w 100% szerokości.
validTimeInterval

object (TimeInterval)

Okres, przez jaki ten obiekt będzie uważany za ważny lub możliwy do użycia. Po upływie tego okresu obiekt zostanie uznany za wygasły, co wpłynie na renderowanie na urządzeniach użytkowników.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Gdy oba są ustawione, renderowany będzie tylko jeden obraz z poziomu klasy i jeden z poziomu obiektu.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli textModulesData jest zdefiniowana również w klasie, będą wyświetlane obydwie wartości. Maksymalna liczba wyświetlanych pól wynosi 10 z klasy i 10 z obiektu.
groupingInfo

object (GroupingInfo)

Informacje określające sposób grupowania kart.
smartTapRedemptionValue

string

Wartość, która zostanie przesłana do terminala z certyfikatem Smart Tap przez NFC dla tego obiektu. Aby karty obsługiwały funkcję smart tap, pola poziomu klasy enableSmartTap i redemptionIssuers muszą być też prawidłowo skonfigurowane. Obsługiwane są tylko znaki ASCII.
rotatingBarcode

object (RotatingBarcode)

Ustawienia/szczegóły obracającego się kodu kreskowego.
state

enum (State)

Stan obiektu. To pole służy do określania sposobu wyświetlania obiektu w aplikacji. Na przykład obiekt inactive jest przenoszony do sekcji „Karty, które straciły ważność”. Jeśli nie podasz tej wartości, obiekt zostanie uznany za ACTIVE.
hasUsers

boolean

Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę.
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.
passConstraints

object (PassConstraints)

Przekazywanie ograniczeń dotyczących obiektu. Obejmuje ograniczenie możliwości korzystania z NFC i zrzutów ekranu.
saveRestrictions

object (SaveRestrictions)

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.
valueAddedModuleData[]

object (ValueAddedModuleData)

Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na obiekt.
linkedObjectIds[]

string

linkedObjectIds to lista innych obiektów, takich jak bilet na wydarzenie, karta lojalnościowa, oferta, karta podarunkowa, bilet na przejazd transportem publicznym lub karta pokładowa, które powinny być automatycznie dołączone do tego obiektu ogólnego. Jeśli użytkownik zapisał tę ogólną kartę, identyfikatory połączonych obiektów zostaną automatycznie przekazane do jego portfela (chyba że wyłączył on ustawienie 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 łączyć obiektów należących do innego wystawcy. 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.

GenericType

Typ karty ogólnej.

Wartości w polu enum
GENERIC_TYPE_UNSPECIFIED Nieokreślony typ ogólny.
GENERIC_SEASON_PASS Karnet sezonowy
GENERIC_UTILITY_BILLS Rachunki za media
GENERIC_PARKING_PASS Bilet parkingowy
GENERIC_VOUCHER Kupon
GENERIC_GYM_MEMBERSHIP Karty członkostwa na siłownię
GENERIC_LIBRARY_MEMBERSHIP karty członkowskie biblioteczne,
GENERIC_RESERVATIONS Rezerwacje
GENERIC_AUTO_INSURANCE karty ubezpieczenia samochodowego.
GENERIC_HOME_INSURANCE karty ubezpieczenia domu,
GENERIC_ENTRY_TICKET Bilety wstępu
GENERIC_RECEIPT Potwierdzenia
GENERIC_LOYALTY_CARD karty lojalnościowe, Pamiętaj, że zamiast ogólnego typu karty zalecamy korzystanie z dedykowanego typu karty. Specjalny typ karty lojalnościowej oferuje więcej funkcji niż typowy typ karty.
GENERIC_OTHER Inny typ

Powiadomienia

Wskazuje, czy obiekt musi mieć włączone powiadomienia. Obsługujemy tylko jedną z tych opcji: ExpiryNotification lub UpcomingNotification. Zasada expiryNotification ma pierwszeństwo przed zasadą upcomingNotification. Innymi słowy, jeśli pole expiryNotification jest ustawione, ignorujemy pole upcomingNotification.

Zapis JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Pola
expiryNotification

object (ExpiryNotification)

To powiadomienie zostanie wysłane w określonym momencie przed wygaśnięciem karty.
upcomingNotification

object (UpcomingNotification)

Powiadomienie zostanie wysłane w określonym czasie przed tym, jak karta stanie się aktywna.

ExpiryNotification

Wskazuje, że wydawca chce, aby Portfel Google wysyłał powiadomienia o wygaśnięciu karty 2 dni przed jej wygaśnięciem.

Zapis JSON 
{
  "enableNotification": boolean
}
Pola
enableNotification

boolean

Wskazuje, czy obiekt musi mieć włączone powiadomienia o wygaśnięciu.

UpcomingNotification

Wskazuje, że wydawca chce, aby Portfel Google wysłał zbliżające się powiadomienie o ważności karty na 1 dzień przed tym, jak karta będzie ważna i będzie można z niej korzystać.

Zapis JSON 
{
  "enableNotification": boolean
}
Pola
enableNotification

boolean

Wskazuje, czy obiekt musi mieć włączone powiadomienie o nadchodzących wydarzeniach.

Metody

addmessage

 Dodaje komunikat do obiektu ogólnego, do którego odwołuje się podany identyfikator obiektu.

get

 Zwraca ogólny obiekt o podanym identyfikatorze obiektu.

insert

 Wstawia ogólny obiekt o podanym identyfikatorze i właściwościach.

list

 Zwraca listę wszystkich obiektów ogólnych dla podanego identyfikatora wydawcy.

patch

 Aktualizuje obiekt ogólny, do którego odwołuje się podany identyfikator obiektu.

update

 Aktualizuje obiekt ogólny, do którego odwołuje się podany identyfikator obiektu.