REST Resource: genericobject

Zasób: GeneralObject

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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Pola
genericType

enum (GenericType)

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

object (LocalizedString)

Wymagane. Nagłówek karty. Jest to zwykle nazwa firmy, na przykład „XXX Gym” lub „Ubezpieczenia AAA”. To pole jest wymagane i pojawia się w wierszu nagłówka na samej górze karty.
subheader

object (LocalizedString)

Tytuł karty, na przykład lokalizacja, w której można użyć tej karty. Jest wyświetlana tuż nad tytułem w wierszu tytułu w widoku szczegółów karty.
header

object (LocalizedString)

Wymagane. tytuł karty, na przykład „Kupon ze zniżką 50%”; lub „Karta biblioteczna” lub „Kupon”. To pole jest wymagane i pojawia się w wierszu tytułu widoku z informacjami o karcie.
hexBackgroundColor

string

Kolor tła karty. Jeśli zasada nie jest skonfigurowana, używany jest dominujący kolor banera powitalnego. Jeśli obraz banera powitalnego nie jest ustawiony, używany jest dominujący kolor logo. Jeśli logo nie jest ustawione, Google wybiera kolor.
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 oraz znaki ., _ i -.
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 wydawany 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ć jego wydawcy na ustawienie kodu Barcode.Alternative_text i wyświetlenie tylko tego kodu.
heroImage

object (Image)

Obraz banera wyświetlany z przodu karty, jeśli znajduje się na niej. Obraz wyświetla się w 100% szerokości.
validTimeInterval

object (TimeInterval)

Okres, przez jaki ten obiekt jest uznawany za prawidłowy lub użyteczny. Po upływie tego czasu obiekt zostanie uznany za nieaktualny, co wpłynie na renderowanie na urządzeniach użytkownika.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazu. Po ustawieniu obu tych obrazów zostanie wyrenderowany tylko jeden obraz z klasy i jeden z poziomu obiektu.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli w klasie zdefiniowano także textModulesData, obie te wartości będą wyświetlane. Maksymalna liczba wyświetlanych pól to 10 z klasy i 10 z obiektu.
groupingInfo

object (GroupingInfo)

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

string

Wartość, która będzie przesyłana do terminala z certyfikatem smart tap przez NFC w przypadku tego obiektu. Aby karta obsługiwała smart tap, musisz też prawidłowo skonfigurować pola enableSmartTap i redemptionIssuers na poziomie klasy. 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 przeniesiony do sekcji „Karty, które straciły ważność”. . Jeśli ta wartość nie zostanie podana, obiekt będzie uważany za ACTIVE.
hasUsers

boolean

Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę.
passConstraints

object (PassConstraints)

Przekazuj ograniczenia dla 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ę. Te ograniczenia będą stosowane tylko podczas zapisywania. Jeśli ograniczenia zmienią się po zapisaniu karty przez użytkownika, nowe ograniczenia nie zostaną zastosowane do zapisanej karty.

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 karnety 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_OTHER Inny typ

Powiadomienia

Wskazuje, czy w obiekcie trzeba włączyć powiadomienia. Obsługujemy tylko jedno z takich powiadomień. expiryNotification ma pierwszeństwo przed upcomingNotification. Inaczej mówiąc, jeśli skonfigurowano ustawienie expiryNotification, zignorujemy 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)

Zanim będzie można korzystać z karty, zostanie wyświetlone powiadomienie.

ExpiryNotification

Wskazuje, że wydawca chce, aby Portfel Google wysyłał powiadomienia o wygaśnięciu karty na 2 dni przed upływem daty ważności karty.

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 nadchodzące powiadomienia.

Metody

addmessage

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

get

 Zwraca obiekt ogólny o podanym identyfikatorze obiektu.

insert

 Wstawia obiekt ogólny 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.