Pakiet google.walletobjects.v1.giftcard

Indeks

GiftCardClassService

AddMessage

rpc AddMessage(GiftCardClassAddMessageRequest) returns (GiftCardClassAddMessageResponse)

Dodaje komunikat do klasy karty podarunkowej, do której odwołuje się podany identyfikator klasy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(GiftCardClassGetRequest) returns (GiftCardClass)

Zwraca klasę karty podarunkowej o podanym identyfikatorze klasy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(GiftCardClassInsertRequest) returns (GiftCardClass)

Wstawia klasę karty podarunkowej o podanym identyfikatorze i właściwościach.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(GiftCardClassListRequest) returns (GiftCardClassListResponse)

Zwraca listę wszystkich klas kart podarunkowych dla podanego identyfikatora wydawcy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(GiftCardClassPatchRequest) returns (GiftCardClass)

Aktualizuje klasę karty podarunkowej, do której odnosi się podany identyfikator klasy. Ta metoda obsługuje semantykę poprawki.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(GiftCardClassUpdateRequest) returns (GiftCardClass)

Aktualizuje klasę karty podarunkowej, do której odnosi się podany identyfikator klasy.

Zakresy autoryzacji

Wymaga poniższego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

GiftCardObjectService

AddMessage

rpc AddMessage(GiftCardObjectAddMessageRequest) returns (GiftCardObjectAddMessageResponse)

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

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(GiftCardObjectGetRequest) returns (GiftCardObject)

Zwraca obiekt karty podarunkowej o podanym identyfikatorze obiektu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(GiftCardObjectInsertRequest) returns (GiftCardObject)

Wstawia obiekt karty podarunkowej o podanym identyfikatorze i właściwościach.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(GiftCardObjectListRequest) returns (GiftCardObjectListResponse)

Zwraca listę wszystkich obiektów kart podarunkowych dla podanego identyfikatora wydawcy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(GiftCardObjectPatchRequest) returns (GiftCardObject)

Aktualizuje obiekt karty podarunkowej, do którego odwołuje się podany identyfikator obiektu. Ta metoda obsługuje semantykę poprawki.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(GiftCardObjectUpdateRequest) returns (GiftCardObject)

Aktualizuje obiekt karty podarunkowej, do którego odwołuje się podany identyfikator obiektu.

Zakresy autoryzacji

Wymaga poniższego zakresu OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

GiftCardClass

Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#giftCardClass".

merchant_name

string

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.

pin_label

string

Etykieta wyświetlana dla kodu PIN, na przykład „4-cyfrowy kod PIN”.

event_number_label

string

Etykieta wyświetlana dla numeru wydarzenia, na przykład „Numer wydarzenia docelowego”.

allow_barcode_redemption

bool

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

LocalizedString

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

LocalizedString

Przetłumaczony tekst pola pin_label.

localized_event_number_label

LocalizedString

Przetłumaczony tekst pola event_number_label.

card_number_label

string

Etykieta wyświetlana dla numeru karty, na przykład „Numer karty”.

localized_card_number_label

LocalizedString

Przetłumaczony tekst pola card_number_label.

class_template_info

ClassTemplateInfo

Informacje na temat szablonu wyświetlania klasy. Jeśli nie są ustawione, Google przyjmuje domyślny zestaw pól do wyświetlenia.

id

string

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
(deprecated)

int64

Wycofano

issuer_name

string

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[]

Message

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
(deprecated)

bool

Wycofano. Zamiast niego użyj multipleDevicesAndHoldersAllowedStatus.

homepage_uri

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[]

LatLongPoint

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

ReviewStatus

Wymagane. Stan klasy. To pole można ustawić na draft lub underReview za pomocą wywołań API insert, patch lub update. Po zmianie stanu weryfikacji draft na inny nie można go zmienić z powrotem na draft.

Należy zachować stan draft, gdy klasa jest w fazie rozwoju. Klasy w stanie draft nie można użyć do utworzenia żadnego obiektu.

Gdy uznasz, że klasa jest gotowa do użycia, ustaw to pole na underReview. Platforma automatycznie ustawi to pole na approved i będzie można go natychmiast używać do tworzenia lub migrowania obiektów.

Aktualizując klasę, która jest już w stanie approved, należy ustawiać to pole na underReview.

review

Review

Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako approved lub rejected.

info_module_data
(deprecated)

InfoModuleData

Wycofano. W zamian używaj textModulesData.

image_modules_data[]

ImageModuleData

Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy.

text_modules_data[]

TextModuleData

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.

redemption_issuers[]

int64

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

string

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

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
(deprecated)

Image

Wycofano.

enable_smart_tap

bool

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

string

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 #ffcc00. Możesz także używać skróconej wersji zapisu RGB w formacie #rgb, jak w tym przykładzie: #fc0.

localized_issuer_name

LocalizedString

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

MultipleDevicesAndHoldersAllowedStatus

Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy.

callback_options

CallbackOptions

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

string

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

AddMessageRequest

Treść żądania.

GiftCardClassAddMessageResponse

Pola
resource

GiftCardClass

Zaktualizowany zasób GiftCardClass.

GiftCardClassGetRequest

Pola
resource_id

string

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

GiftCardClass

Treść żądania.

GiftCardClassListRequest

Pola
issuer_id

int64

Identyfikator wydawcy autoryzowanego do wyświetlenia listy klas.

token

string

Umożliwia uzyskanie następnego zestawu wyników, jeśli określono maxResults, ale liczba klas dostępnych na liście jest większa niż maxResults. Jeśli na przykład na liście jest 200 klas i wywołujesz listę z wartością maxResults ustawioną na 20, lista zwróci pierwsze 20 klas i token. Wywołaj ponownie listę z wartością maxResults ustawioną na 20 i tokenem, aby uzyskać kolejne 20 klas.

max_results

int32

Określa maksymalną liczbę wyników zwracanych przez listę. Jeśli wartość maxResults nie jest zdefiniowana, zwracane są wszystkie wyniki.

GiftCardClassListResponse

Pola
resources[]

GiftCardClass

Zasoby odpowiadające żądaniu listy.

pagination

Pagination

Podział odpowiedzi na strony.

GiftCardClassPatchRequest

Pola
resource_id

string

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

GiftCardClass

Treść żądania.

GiftCardClassUpdateRequest

Pola
resource_id

string

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

GiftCardClass

Treść żądania.

GiftCardObject

Pola
kind
(deprecated)

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "walletobjects#giftCardObject".

class_reference

GiftCardClass

Kopia dziedziczonych pól klasy nadrzędnej. Te pola są pobierane podczas żądania GET.

card_number

string

Wymagane. Numer karty.

pin

string

Kod PIN karty.

balance

Money

Saldo pieniężne karty.

balance_update_time

DateTime

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

string

Numer zdarzenia karty – opcjonalne pole używane przez niektóre karty podarunkowe.

id

string

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

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 issuer ID.identifier, gdzie pierwszy identyfikator jest wystawiany przez Google, a drugi jest wybierany przez Ciebie.

version
(deprecated)

int64

Wycofano

state

State

Wymagane. 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ść”.

barcode

Barcode

Typ i wartość kodu kreskowego.

messages[]

Message

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

TimeInterval

Okres, przez jaki ten obiekt będzie active i będzie można go używać. Po upływie tego czasu stan obiektu zostanie zmieniony na expired.

locations[]

LatLongPoint

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

bool

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

smart_tap_redemption_value

string

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

bool

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

bool

Wskazuje, czy powiadomienia powinny być jawnie pomijane. Jeśli to pole jest ustawione na wartość true, niezależnie od pola messages powiadomienia o utracie ważności kierowane do użytkownika będą pomijane. Domyślnie to pole jest ustawione na false.

Obecnie można je ustawiać tylko dla ofert specjalnych.

info_module_data

InfoModuleData

Wycofano. W zamian używaj textModulesData.

image_modules_data[]

ImageModuleData

Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 dla poziomu obiektu klasy.

text_modules_data[]

TextModuleData

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.

GiftCardObjectAddMessageRequest

Pola
resource_id

string

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

AddMessageRequest

Treść żądania.

GiftCardObjectAddMessageResponse

Pola
resource

GiftCardObject

Zaktualizowany zasób GiftCardObject.

GiftCardObjectGetRequest

Pola
resource_id

string

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

GiftCardObject

Treść żądania.

GiftCardObjectListRequest

Pola
class_id

string

Identyfikator klasy, której obiekty zostaną wyświetlone.

token

string

Umożliwia uzyskanie następnego zestawu wyników, jeśli określono maxResults, ale liczba obiektów dostępnych na liście jest większa niż maxResults. Jeśli na przykład na liście jest 200 obiektów i wywołujesz listę z wartością maxResults ustawioną na 20, lista zwróci pierwsze 20 obiektów i token. Wywołaj ponownie listę z wartością maxResults ustawioną na 20 i tokenem, aby uzyskać kolejne 20 obiektów.

max_results

int32

Określa maksymalną liczbę wyników zwracanych przez listę. Jeśli wartość maxResults nie jest zdefiniowana, zwracane są wszystkie wyniki.

GiftCardObjectListResponse

Pola
resources[]

GiftCardObject

Zasoby odpowiadające żądaniu listy.

pagination

Pagination

Podział odpowiedzi na strony.

GiftCardObjectPatchRequest

Pola
resource_id

string

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

GiftCardObject

Treść żądania.

GiftCardObjectUpdateRequest

Pola
resource_id

string

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

GiftCardObject

Treść żądania.