REST Resource: genericobject

Zasób: TypoweObject

Identyfikator Ogólny obiektu Next: 121

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)
  }
}
Pola
genericType

enum (GenericType)

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

object (LocalizedString)

To pole jest wymagane. Nagłówek karty. Zwykle jest to nazwa firmy, na przykład „XXX Siłownia”, „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, na przykład lokalizacja, w której można jej użyć. Wyświetla się tuż nad tytułem w wierszu tytułu w widoku szczegółów karty.
header

object (LocalizedString)

To pole jest wymagane. Tytuł karty, na przykład „Kupon 50% taniej”, „Karta biblioteczna” lub „Kupon”. To pole jest wymagane i pojawia się w wierszu tytułu widoku szczegółów karty.
hexBackgroundColor

string

Kolor tła karty. Jeśli wartość nie jest skonfigurowana, używany jest dominujący kolor obrazu banera powitalnego. Jeśli nie zostanie ustawiony, używany jest dominujący kolor logo. Jeśli logo nie jest ustawione, kolor jest wybierany przez Google.
notifications

object (Notifications)

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

string

To pole jest 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 wystawiany przez Google i identifier jest wybierany przez Ciebie. Może on zawierać tylko znaki alfanumeryczne oraz ., _ i -.
classId

string

To pole jest 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ć wydawcy na ustawienie atrybutu Barcode.alternate_text i wyświetlanie tylko tego kodu.
heroImage

object (Image)

Obraz banera wyświetlany z przodu karty, jeśli występuje. Obraz będzie wyświetlany w pełnej szerokości.
validTimeInterval

object (TimeInterval)

Okres, przez jaki ten obiekt będzie uznawany za prawidłowy lub użyteczny. Po upływie określonego czasu obiekt zostanie uznany za nieważny, co wpłynie na renderowanie na urządzeniach użytkownika.
imageModulesData[]

object (ImageModuleData)

Dane modułu obrazów. Gdy ustawisz oba obrazy, wyrenderowany zostanie tylko jeden obraz z klasy i jeden z poziomu obiektu.
textModulesData[]

object (TextModuleData)

Dane modułu tekstowego. Jeśli klasa jest też zdefiniowana w klasie textModulesData, będą wyświetlane obie wartości. 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 dla tego obiektu. Aby karta obsługiwała smart tap, pola enableSmartTap i redemptionIssuers na poziomie zajęć również muszą być odpowiednio skonfigurowane. Obsługiwane są tylko znaki ASCII.
rotatingBarcode

object (RotatingBarcode)

Ustawienia/szczegóły kodu kreskowego obracającego się.
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 ten warunek nie zostanie podany, obiekt zostanie uznany za ACTIVE.
hasUsers

boolean

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

object (PassConstraints)

Przekazywanie ograniczeń obiektu. Obejmuje to ograniczenie możliwości NFC i wykonywania zrzutów ekranu.

GenericType

Typ ogólnej karty.

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 karnetów na siłownię,
GENERIC_LIBRARY_MEMBERSHIP karty członkowskie biblioteki,
GENERIC_RESERVATIONS Rezerwacje
GENERIC_AUTO_INSURANCE karty ubezpieczenia komunikacyjnego,
GENERIC_HOME_INSURANCE Karty ubezpieczenia domu
GENERIC_ENTRY_TICKET Bilety wstępu
GENERIC_RECEIPT Rachunki
GENERIC_OTHER Inny typ

Powiadomienia

Wskazuje, czy w obiekcie muszą być włączone powiadomienia. Obsługujemy tylko jedno powiadomienie o wygaśnięciu lub nadchodzące powiadomienie. expiryNotification ma pierwszeństwo przed upcomingNotification. Inaczej mówiąc, jeśli skonfigurowana jest zasada expiryNotification, zignorujemy pole upcomingNotification.

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

object (ExpiryNotification)

Powiadomienie zostanie wysłane o określonej godzinie przed wygaśnięciem karty.
upcomingNotification

object (UpcomingNotification)

Powiadomienie zostanie wysłane o określonej godzinie, zanim będzie można korzystać z karty.

ExpiryNotification

Wskazuje, że wydawca chce, aby Portfel Google wysyłał powiadomienia o wygaśnięciu 2 dni przed wygaśnięciem 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ł powiadomienie o ważności karty na 1 dzień przed jej uznaniem i możliwością użycia.

Zapis JSON 
{
  "enableNotification": boolean
}
Pola
enableNotification

boolean

Wskazuje, czy w obiekcie muszą być 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.