Indeks
GiftCardClassService
(interfejs)GiftCardObjectService
(interfejs)GiftCardClass
(komunikat)GiftCardClassAddMessageRequest
(komunikat)GiftCardClassAddMessageResponse
(komunikat)GiftCardClassGetRequest
(komunikat)GiftCardClassInsertRequest
(komunikat)GiftCardClassListRequest
(komunikat)GiftCardClassListResponse
(komunikat)GiftCardClassPatchRequest
(komunikat)GiftCardClassUpdateRequest
(komunikat)GiftCardObject
(komunikat)GiftCardObjectAddMessageRequest
(komunikat)GiftCardObjectAddMessageResponse
(komunikat)GiftCardObjectGetRequest
(komunikat)GiftCardObjectInsertRequest
(komunikat)GiftCardObjectListRequest
(komunikat)GiftCardObjectListResponse
(komunikat)GiftCardObjectPatchRequest
(komunikat)GiftCardObjectUpdateRequest
(komunikat)
GiftCardClassService
AddMessage | |
---|---|
Dodaje komunikat do klasy karty podarunkowej, do której odwołuje się podany identyfikator klasy.
|
Get | |
---|---|
Zwraca klasę karty podarunkowej o podanym identyfikatorze klasy.
|
Insert | |
---|---|
Wstawia klasę karty podarunkowej o podanym identyfikatorze i właściwościach.
|
List | |
---|---|
Zwraca listę wszystkich klas kart podarunkowych dla podanego identyfikatora wydawcy.
|
Patch | |
---|---|
Aktualizuje klasę karty podarunkowej, do której odnosi się podany identyfikator klasy. Ta metoda obsługuje semantykę poprawki.
|
Update | |
---|---|
Aktualizuje klasę karty podarunkowej, do której odnosi się podany identyfikator klasy.
|
GiftCardObjectService
AddMessage | |
---|---|
Dodaje komunikat do obiektu karty podarunkowej, do którego odwołuje się podany identyfikator obiektu.
|
Get | |
---|---|
Zwraca obiekt karty podarunkowej o podanym identyfikatorze obiektu.
|
Insert | |
---|---|
Wstawia obiekt karty podarunkowej o podanym identyfikatorze i właściwościach.
|
List | |
---|---|
Zwraca listę wszystkich obiektów kart podarunkowych dla podanego identyfikatora wydawcy.
|
Patch | |
---|---|
Aktualizuje obiekt karty podarunkowej, do którego odwołuje się podany identyfikator obiektu. Ta metoda obsługuje semantykę poprawki.
|
Update | |
---|---|
Aktualizuje obiekt karty podarunkowej, do którego odwołuje się podany identyfikator obiektu.
|
GiftCardClass
Pola | |
---|---|
kind |
Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków |
merchant_name |
Nazwa sprzedawcy, 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 |
Logo programu lub firmy zajmującej się kartami podarunkowymi. To logo jest wyświetlane w widoku szczegółów i widoku listy aplikacji. |
pin_label |
Etykieta wyświetlana dla kodu PIN, na przykład „4-cyfrowy kod PIN”. |
event_number_label |
Etykieta wyświetlana dla numeru wydarzenia, na przykład „Numer wydarzenia docelowego”. |
allow_barcode_redemption |
Określa, czy sprzedawca obsługuje wykorzystanie karty podarunkowej za pomocą kodu kreskowego. Jeśli jest ustawiona wartość true, aplikacja wyświetla kod kreskowy karty podarunkowej na ekranie z danymi karty podarunkowej. Jeśli jest ustawiona wartość false, kod kreskowy nie jest wyświetlany. |
localized_merchant_name |
Przetłumaczony tekst pola merchant_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_pin_label |
Przetłumaczony tekst pola pin_label. |
localized_event_number_label |
Przetłumaczony tekst pola event_number_label. |
card_number_label |
Etykieta wyświetlana dla numeru karty, na przykład „Numer karty”. |
localized_card_number_label |
Przetłumaczony tekst pola card_number_label. |
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. |
GiftCardClassAddMessageRequest
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. |
GiftCardClassAddMessageResponse
Pola | |
---|---|
resource |
Zaktualizowany zasób GiftCardClass. |
GiftCardClassGetRequest
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 „-”. |
GiftCardClassInsertRequest
Pola | |
---|---|
resource |
Treść żądania. |
GiftCardClassListRequest
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ść |
GiftCardClassListResponse
Pola | |
---|---|
resources[] |
Zasoby odpowiadające żądaniu listy. |
pagination |
Podział odpowiedzi na strony. |
GiftCardClassPatchRequest
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. |
GiftCardClassUpdateRequest
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. |
GiftCardObject
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. |
card_number |
Wymagane. Numer karty. |
pin |
Kod PIN karty. |
balance |
Saldo pieniężne karty. |
balance_update_time |
Data i godzina ostatniej aktualizacji salda. Wymagane jest przesunięcie. Jeśli saldo zostanie zaktualizowane, a ta właściwość nie zostanie podana, system domyślnie ustawi bieżący czas. |
event_number |
Numer zdarzenia karty – opcjonalne pole używane przez niektóre karty podarunkowe. |
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 linku do aplikacji partnera. |
GiftCardObjectAddMessageRequest
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. |
GiftCardObjectAddMessageResponse
Pola | |
---|---|
resource |
Zaktualizowany zasób GiftCardObject. |
GiftCardObjectGetRequest
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 „-”. |
GiftCardObjectInsertRequest
Pola | |
---|---|
resource |
Treść żądania. |
GiftCardObjectListRequest
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ść |
GiftCardObjectListResponse
Pola | |
---|---|
resources[] |
Zasoby odpowiadające żądaniu listy. |
pagination |
Podział odpowiedzi na strony. |
GiftCardObjectPatchRequest
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. |
GiftCardObjectUpdateRequest
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. |