Ta strona została przetłumaczona przez Cloud Translation API.

REST Resource: giftcardclass

Zasób: GiftCardClass
- Zapis JSON
Metody

Zasób: GiftCardClass

Zapis JSON

Zapis JSON
{ "kind": string, "merchantName": string, "programLogo": { object (`Image`) }, "pinLabel": string, "eventNumberLabel": string, "allowBarcodeRedemption": boolean, "localizedMerchantName": { object (`LocalizedString`) }, "localizedPinLabel": { object (`LocalizedString`) }, "localizedEventNumberLabel": { object (`LocalizedString`) }, "cardNumberLabel": string, "localizedCardNumberLabel": { object (`LocalizedString`) }, "classTemplateInfo": { object (`ClassTemplateInfo`) }, "id": string, "version": string, "issuerName": string, "messages": [ { object (`Message`) } ], "allowMultipleUsersPerObject": boolean, "homepageUri": { object (`Uri`) }, "locations": [ { object (`LatLongPoint`) } ], "reviewStatus": enum (`ReviewStatus`), "review": { object (`Review`) }, "infoModuleData": { object (`InfoModuleData`) }, "imageModulesData": [ { object (`ImageModuleData`) } ], "textModulesData": [ { object (`TextModuleData`) } ], "linksModuleData": { object (`LinksModuleData`) }, "redemptionIssuers": [ string ], "countryCode": string, "heroImage": { object (`Image`) }, "wordMark": { object (`Image`) }, "enableSmartTap": boolean, "hexBackgroundColor": string, "localizedIssuerName": { object (`LocalizedString`) }, "multipleDevicesAndHoldersAllowedStatus": enum (`MultipleDevicesAndHoldersAllowedStatus`), "callbackOptions": { object (`CallbackOptions`) }, "securityAnimation": { object (`SecurityAnimation`) }, "viewUnlockRequirement": enum (`ViewUnlockRequirement`), "wideProgramLogo": { object (`Image`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Pola
`kind (deprecated)`	`string` Ten element został wycofany. Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków `"walletobjects#giftCardClass"`.
`merchantName`	`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.
`programLogo`	`object (Image)` Logo programu lub firmy zajmującej się kartami podarunkowymi. To logo jest wyświetlane w widoku szczegółów i widoku listy w aplikacji.
`pinLabel`	`string` Etykieta wyświetlana dla kodu PIN, na przykład „4-cyfrowy kod PIN”.
`eventNumberLabel`	`string` Etykieta wyświetlana dla numeru zdarzenia, np. „Nr zdarzenia docelowego”.
`allowBarcodeRedemption`	`boolean` 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ść Fałsz, kod kreskowy nie jest wyświetlany.
`localizedMerchantName`	`object (LocalizedString)` Przetłumaczona wartość pola merchantName. 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.
`localizedPinLabel`	`object (LocalizedString)` Przetłumaczony tekst pola pinLabel.
`localizedEventNumberLabel`	`object (LocalizedString)` Przetłumaczona wartość pola eventNumberLabel.
`cardNumberLabel`	`string` Etykieta wyświetlana dla numeru karty, na przykład „Numer karty”.
`localizedCardNumberLabel`	`object (LocalizedString)` Przetłumaczony tekst pola cardNumberLabel.
`classTemplateInfo`	`object (ClassTemplateInfo)` Informacje o szablonie 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)`	`string (int64 format)` Ten element został wycofany. Wycofano
`issuerName`	`string` Wymagane. Nazwa wydawcy. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
`messages[]`	`object (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.
`allowMultipleUsersPerObject (deprecated)`	`boolean` Ten element został wycofany. Rola wycofana. Zamiast tego użyj pola `multipleDevicesAndHoldersAllowedStatus`.
`homepageUri`	`object (Uri)` Identyfikator URI strony głównej aplikacji. Wypełnienie identyfikatora URI w tym polu ma taki sam efekt, jak wypełnienie identyfikatora URI w linkiModuleData (gdy obiekt jest renderowany, link do strony głównej jest widoczny w miejscu, które można określić jako sekcję linksModuleData obiektu).
`locations[] (deprecated)`	`object (LatLongPoint)` Ten produkt został wycofany. Uwaga: to pole nie jest obecnie obsługiwane w przypadku wywoływania powiadomień geograficznych.
`reviewStatus`	`enum (ReviewStatus)` Wymagane. Stan klasy. To pole można ustawić na `draft` lub `underReview` za pomocą wywołań interfejsu API insert, patch lub update. Po zmianie stanu weryfikacji `draft` na `draft` nie można go zmienić z powrotem. 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`	`object (Review)` Komentarze do weryfikacji ustawione przez platformę, gdy klasa jest oznaczona jako `approved` lub `rejected`.
`infoModuleData (deprecated)`	`object (InfoModuleData)` Ten element został wycofany. Rola wycofana. Zamiast tego użyj textModulesData.
`imageModulesData[]`	`object (ImageModuleData)` Dane modułu obrazu. Maksymalna liczba wyświetlanych pól wynosi 1 z poziomu obiektu i 1 na poziomie obiektu klasy.
`textModulesData[]`	`object (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.
`linksModuleData`	`object (LinksModuleData)` 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.
`redemptionIssuers[]`	`string (int64 format)` Określa, którzy wydawcy elementów promocyjnych mogą wykorzystać kartę za pomocą smart tap. Wydawcy elementów promocyjnych są identyfikowani na podstawie identyfikatora wydawcy. Wydawcy ofert muszą mieć skonfigurowany co najmniej 1 klucz Smart Tap. Aby karta obsługiwała smart tap, pola `enableSmartTap` i `smartTapRedemptionLevel` na poziomie obiektu też muszą być prawidłowo skonfigurowane.
`countryCode`	`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.
`heroImage`	`object (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.
`wordMark (deprecated)`	`object (Image)` Ten element został wycofany. Rola wycofana.
`enableSmartTap`	`boolean` Określa, czy ta klasa obsługuje Smart Tap. Aby karta obsługiwała smart tap, pola `redemptionIssuers` i `smartTapRedemptionLevel` na poziomie obiektu też muszą być prawidłowo skonfigurowane.
`hexBackgroundColor`	`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`.
`localizedIssuerName`	`object (LocalizedString)` Przetłumaczona wartość pola issuerName. Zalecana maksymalna długość to 20 znaków, aby zapewnić możliwość wyświetlania pełnego ciągu znaków na mniejszych ekranach.
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` Wskazuje, czy wielu użytkowników i urządzeń zapisze ten sam obiekt odwołujący się do tej klasy.
`callbackOptions`	`object (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 kwalifikują się do wywołania zwrotnego.
`securityAnimation`	`object (SecurityAnimation)` Opcjonalne informacje o animacji zabezpieczeń. Jeśli ta opcja jest ustawiona, animacja bezpieczeństwa zostanie wyświetlona w szczegółach dokumentu.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` Wyświetl opcje wymagań odblokowania karty podarunkowej.
`wideProgramLogo`	`object (Image)` Szerokie logo programu lub firmy zajmującej się kartami podarunkowymi. Jeśli podasz logo, będzie ono używane zamiast logo programu w lewym górnym rogu widoku karty.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Określa, czy powiadomienia mają być wysyłane w przypadku aktualizacji pól w danej klasie. 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 nie określisz tej wartości, nie zostanie wysłane ż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.
`appLinkData`	`object (AppLinkData)` Opcjonalny link do aplikacji lub witryny, który będzie wyświetlany jako przycisk z przodu karty. Jeśli dla odpowiadającego obiektu podano dane AppLinkData, zostaną one użyte zamiast danych AppLink.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Opcjonalne dane modułu wartości dodanej. Maksymalnie 10 na zajęcia. W przypadku karty wyświetli się tylko 10 kart, przy czym priorytet będą miały te z obiektu.

Metody
`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 odwołuje się podany identyfikator klasy.
`update`	Aktualizuje klasę karty podarunkowej, do której odnosi się podany identyfikator klasy.

REST Resource: giftcardclass

Zasób: GiftCardClass

Metody

`addmessage`

`get`

`insert`

`list`

`patch`

`update`