Zasób: OfferObject
Zapis JSON |
---|
{ "kind": string, "classReference": { object ( |
Pola | |
---|---|
kind |
Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków |
class |
Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET. |
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 do aktywowania powiadomień geograficznych. |
has |
Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę. |
smart |
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 |
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ć dodatkowe informacje, skontaktuj się z zespołem pomocy. |
disable |
Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole ma 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 podano AppLinkData dla odpowiedniej klasy, wyświetlany będzie tylko obiekt AppLinkData. |
rotating |
Typ i wartość kodu kreskowego, który się zmienia. |
hero |
Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli nie ma żadnego obrazu, wyświetli się obraz banera powitalnego (jeśli jest dostępny). 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 obiektu, które muszą 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 okresowa, karta pokładowa i karta pokładowa, które powinny być automatycznie dołączone do tego obiektu oferty. Jeśli użytkownik zapisze tę ofertę, te identyfikatory połączonych obiektów zostaną automatycznie przesłane do portfela użytkownika (chyba że wyłączy 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 rozłą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 tymczasowe i musi być ustawiane w ramach 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. |
Metody |
|
---|---|
|
Dodaje komunikat do obiektu oferty, do którego odwołuje się podany identyfikator obiektu. |
|
Zwraca obiekt oferty o podanym identyfikatorze obiektu. |
|
Wstawia obiekt oferty o podanym identyfikatorze i właściwościach. |
|
Zwraca listę wszystkich obiektów ofert dla podanego identyfikatora wydawcy. |
|
Aktualizuje obiekt oferty specjalnej, do którego odwołuje się podany identyfikator obiektu. |
|
Aktualizuje obiekt oferty specjalnej, do którego odwołuje się podany identyfikator obiektu. |