Indeks
LoyaltyClassService
(interfejs)LoyaltyObjectService
(interfejs)LoyaltyClass
(komunikat)LoyaltyClassAddMessageRequest
(komunikat)LoyaltyClassAddMessageResponse
(komunikat)LoyaltyClassGetRequest
(komunikat)LoyaltyClassInsertRequest
(komunikat)LoyaltyClassListRequest
(komunikat)LoyaltyClassListResponse
(komunikat)LoyaltyClassPatchRequest
(komunikat)LoyaltyClassUpdateRequest
(komunikat)LoyaltyObject
(komunikat)LoyaltyObjectAddMessageRequest
(komunikat)LoyaltyObjectAddMessageResponse
(komunikat)LoyaltyObjectGetRequest
(komunikat)LoyaltyObjectInsertRequest
(komunikat)LoyaltyObjectListRequest
(komunikat)LoyaltyObjectListResponse
(komunikat)LoyaltyObjectModifyLinkedOfferObjectsRequest
(komunikat)LoyaltyObjectPatchRequest
(komunikat)LoyaltyObjectUpdateRequest
(komunikat)LoyaltyPoints
(komunikat)LoyaltyPointsBalance
(komunikat)
LoyaltyClassService
AddMessage | |
---|---|
Dodaje komunikat do klasy programu lojalnościowego, do której odwołuje się podany identyfikator klasy.
|
Get | |
---|---|
Zwraca klasę programu lojalnościowego o podanym identyfikatorze klasy.
|
Insert | |
---|---|
Wstawia klasę programu lojalnościowego o podanym identyfikatorze i właściwościach.
|
List | |
---|---|
Zwraca listę wszystkich klas programu lojalnościowego dla podanego identyfikatora wydawcy.
|
Patch | |
---|---|
Aktualizuje klasę programu lojalnościowego, do której odwołuje się podany identyfikator klasy. Ta metoda obsługuje semantykę poprawki.
|
Update | |
---|---|
Aktualizuje klasę programu lojalnościowego, do której odwołuje się podany identyfikator klasy.
|
LoyaltyObjectService
AddMessage | |
---|---|
Dodaje komunikat do obiektu programu lojalnościowego, do którego odwołuje się podany identyfikator obiektu.
|
Get | |
---|---|
Zwraca obiekt programu lojalnościowego o podanym identyfikatorze obiektu.
|
Insert | |
---|---|
Wstawia obiekt programu lojalnościowego o podanym identyfikatorze i właściwościach.
|
List | |
---|---|
Zwraca listę wszystkich obiektów programu lojalnościowego dla podanego identyfikatora wydawcy.
|
ModifyLinkedOfferObjects | |
---|---|
Modyfikuje obiekty połączonej oferty dla obiektu programu lojalnościowego o podanym identyfikatorze.
|
Patch | |
---|---|
Aktualizuje obiekt programu lojalnościowego, do którego odwołuje się podany identyfikator obiektu. Ta metoda obsługuje semantykę poprawki.
|
Update | |
---|---|
Aktualizuje obiekt programu lojalnościowego, do którego odwołuje się podany identyfikator obiektu.
|
LoyaltyClass
Pola | |
---|---|
kind |
Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków |
program_name |
Wymagane. Nazwa programu, na przykład „Stroje Adama”. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
program_logo |
Wymagane. Logo programu lojalnościowego lub firmy. To logo jest wyświetlane w widoku szczegółów i widoku listy aplikacji. |
account_name_label |
Etykieta nazwy konta, na przykład „Nazwa użytkownika”. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
account_id_label |
Etykieta identyfikatora konta, na przykład „Identyfikator użytkownika”. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
rewards_tier_label |
Etykieta poziomu nagród, np. „Poziom nagród”. Zalecana maksymalna długość to 9 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
rewards_tier |
Poziom nagród, taki jak „Złoty” lub „Platynowy”. Zalecana maksymalna długość to 7 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
localized_program_name |
Przetłumaczona wartość pola program_name. Aplikacja może wyświetlać wielokropek po pierwszych 20 znakach, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
localized_account_name_label |
Przetłumaczona wartość pola account_name_label. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
localized_account_id_label |
Przetłumaczona wartość pola account_id_label. Zalecana maksymalna długość to 15 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
localized_rewards_tier_label |
Przetłumaczona wartość pola rewards_tier_label. Zalecana maksymalna długość to 9 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
localized_rewards_tier |
Przetłumaczona wartość pola rewards_tier. Zalecana maksymalna długość to 7 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
secondary_rewards_tier_label |
Etykieta dodatkowego poziomu nagród, na przykład „Poziom nagród”. |
localized_secondary_rewards_tier_label |
Przetłumaczona wartość pola secondary_rewards_tier_label. |
secondary_rewards_tier |
Dodatkowy poziom nagród, na przykład „Złoty” lub „Platynowy”. |
localized_secondary_rewards_tier |
Przetłumaczona wartość pola secondary_rewards_tier. |
discoverable_program |
Informacje o tym, jak można wykryć klasę i utworzyć jej instancję z poziomu aplikacji Google Pay. |
class_template_info |
Informacje na temat szablonu wyświetlania klasy. Jeśli nie są ustawione, Google przyjmuje domyślny zestaw pól do wyświetlenia. |
id |
Wymagane. Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”. |
version |
Wycofano |
issuer_name |
Wymagane. Nazwa wydawcy. Zalecana maksymalna długość to 20 znaków, co zapewnia możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
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. |
allow_multiple_users_per_object |
Wycofano. Zamiast niego użyj |
homepage_uri |
Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI ma taki sam efekt, jak wypełnienie identyfikatora URI w linksModuleData (gdy obiekt jest renderowany, link do strony głównej jest widoczny w miejscu, które można określić jako sekcja linksModuleData obiektu). |
locations[] |
Lista lokalizacji, w których można użyć obiektu. Platforma wykorzystuje te informacje do aktywowania powiadomień dla użytkowników przy użyciu geolokalizacji. Pamiętaj, że lokalizacje w obiekcie zastępują lokalizacje w klasie, które z kolei zastępują lokalizacje w identyfikatorze Miejsc Google. |
review_status |
Wymagane. Stan klasy. To pole można ustawić na Należy zachować stan Gdy uznasz, że klasa jest gotowa do użycia, ustaw to pole na Aktualizując klasę, która jest już w stanie |
review |
Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako |
info_module_data |
Wycofano. W zamian używaj textModulesData. |
image_modules_data[] |
Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy. |
text_modules_data[] |
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_module_data |
Dane modułu linków. Jeśli dane modułu linków są określone również w obiekcie, będą wyświetlane jedne i drugie. |
redemption_issuers[] |
Dostępne tylko dla partnerów obsługujących technologię smart tap. W razie wątpliwości skontaktuj się z działem pomocy. |
country_code |
Kod kraju używany do wyświetlania kraju karty (gdy użytkownik nie przebywa w tym kraju), a także do wyświetlania zlokalizowanej treści, gdy treść nie jest dostępna w języku użytkownika. |
hero_image |
Opcjonalny obraz banera wyświetlany z przodu karty. Jeśli go nie ma, nic nie jest wyświetlane. Obraz wyświetla się w 100% szerokości. |
word_mark |
Wycofano. |
enable_smart_tap |
Dostępne tylko dla partnerów obsługujących technologię smart tap. W razie wątpliwości skontaktuj się z działem pomocy. |
hex_background_color |
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 |
localized_issuer_name |
Przetłumaczony tekst pola issuer_name. Zalecana maksymalna długość to 20 znaków, co zapewnia możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
multiple_devices_and_holders_allowed_status |
Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy. |
callback_options |
Opcje wywołania zwrotnego, które mają być używane do wywoływania wydawcy przy każdym zapisie/usunięciu obiektu tej klasy przez użytkownika końcowego. Wszystkie obiekty tej klasy są odpowiednie dla wywołania zwrotnego. |
LoyaltyClassAddMessageRequest
Pola | |
---|---|
resource_id |
Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”. |
add_message_request |
Treść żądania. |
LoyaltyClassAddMessageResponse
Pola | |
---|---|
resource |
Zaktualizowany zasób LoyaltyClass. |
LoyaltyClassGetRequest
Pola | |
---|---|
resource_id |
Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”. |
LoyaltyClassInsertRequest
Pola | |
---|---|
resource |
Treść żądania. |
LoyaltyClassListRequest
Pola | |
---|---|
issuer_id |
Identyfikator wydawcy autoryzowanego do wyświetlenia listy klas. |
token |
Umożliwia uzyskanie następnego zestawu wyników, jeśli określono |
max_results |
Określa maksymalną liczbę wyników zwracanych przez listę. Jeśli wartość |
LoyaltyClassListResponse
Pola | |
---|---|
resources[] |
Zasoby odpowiadające żądaniu listy. |
pagination |
Podział odpowiedzi na strony. |
LoyaltyClassPatchRequest
Pola | |
---|---|
resource_id |
Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”. |
resource |
Treść żądania. |
LoyaltyClassUpdateRequest
Pola | |
---|---|
resource_id |
Unikalny identyfikator klasy. Ten identyfikator musi być unikalny wśród wszystkich klas 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 „-”. |
resource |
Treść żądania. |
LoyaltyObject
Pola | |
---|---|
kind |
Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków |
class_reference |
Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET. |
account_name |
Nazwa właściciela konta programu lojalnościowego, na przykład „Jan Kowalski”. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach. |
account_id |
Identyfikator konta programu lojalnościowego. Zalecana maksymalna długość to 20 znaków. |
loyalty_points |
Etykieta, saldo i typ punktów lojalnościowych. |
linked_offer_ids[] |
Lista obiektów oferty połączonych z tą kartą programu lojalnościowego. Obiekty oferty muszą już istnieć. Identyfikatory obiektów oferty powinny mieć format issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie. |
secondary_loyalty_points |
Dodatkowa etykieta, saldo i typ punktów lojalnościowych. Wyświetlane oprócz podstawowych punktów lojalnościowych. |
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_id |
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_time_interval |
Okres, przez jaki ten obiekt będzie |
locations[] |
Lista lokalizacji, w których można użyć obiektu. Platforma wykorzystuje te informacje do aktywowania powiadomień dla użytkowników przy użyciu geolokalizacji. Pamiętaj, że lokalizacje w obiekcie zastępują lokalizacje w klasie, które z kolei zastępują lokalizacje w identyfikatorze Miejsc Google. |
has_users |
Wskazuje, czy obiekt ma użytkowników. To pole jest ustawiane przez platformę. |
smart_tap_redemption_value |
Dostępne tylko dla partnerów obsługujących technologię smart tap. W razie wątpliwości skontaktuj się z działem pomocy. |
has_linked_device |
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. Przeznaczone do użytku przez wybranych partnerów. W przypadku wątpliwości skontaktuj się z działem pomocy. |
disable_expiration_notification |
Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole jest ustawione na wartość true, niezależnie od pola Obecnie można je ustawiać tylko dla ofert specjalnych. |
info_module_data |
Wycofano. W zamian używaj textModulesData. |
image_modules_data[] |
Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy. |
text_modules_data[] |
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_module_data |
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_link_data |
Opcjonalne informacje o łączu do aplikacji partnera. |
LoyaltyObjectAddMessageRequest
Pola | |
---|---|
resource_id |
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 „-”. |
add_message_request |
Treść żądania. |
LoyaltyObjectAddMessageResponse
Pola | |
---|---|
resource |
Zaktualizowany zasób LoyaltyObject. |
LoyaltyObjectGetRequest
Pola | |
---|---|
resource_id |
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 „-”. |
LoyaltyObjectInsertRequest
Pola | |
---|---|
resource |
Treść żądania. |
LoyaltyObjectListRequest
Pola | |
---|---|
class_id |
Identyfikator klasy, której obiekty zostaną wyświetlone. |
token |
Umożliwia uzyskanie następnego zestawu wyników, jeśli określono |
max_results |
Określa maksymalną liczbę wyników zwracanych przez listę. Jeśli wartość |
LoyaltyObjectListResponse
Pola | |
---|---|
resources[] |
Zasoby odpowiadające żądaniu listy. |
pagination |
Podział odpowiedzi na strony. |
LoyaltyObjectModifyLinkedOfferObjectsRequest
Pola | |
---|---|
resource_id |
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 „-”. |
modify_linked_offer_objects_request |
Identyfikatory obiektów oferty związanych z obiektem programu lojalnościowego. |
LoyaltyObjectPatchRequest
Pola | |
---|---|
resource_id |
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 „-”. |
resource |
Treść żądania. |
LoyaltyObjectUpdateRequest
Pola | |
---|---|
resource_id |
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 „-”. |
resource |
Treść żądania. |
LoyaltyPoints
Pola | |
---|---|
label |
Etykieta punktów lojalnościowych, na przykład „Punkty”. Zalecana maksymalna długość to 9 znaków. |
balance |
Saldo punktów lojalnościowych posiadacza konta, na przykład „500” lub „10,00 USD”. Zalecana maksymalna długość to 7 znaków. To pole jest wymagane w przypadku |
localized_label |
Przetłumaczona wartość pola label. Zalecana maksymalna długość to 9 znaków. |
LoyaltyPointsBalance
Pola | |
---|---|
string |
Saldo w postaci ciągu znaków. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money). |
int |
Saldo w postaci liczby całkowitej. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money). |
double |
Saldo w postaci liczby podwójnej precyzji. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money). |
money |
Saldo w postaci wartości walutowej. Powinien być wypełniony tylko jeden z tych podtypów (string, int, double, money). |