REST Resource: giftcardclass

Ресурс: GiftCardClass

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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Поля
kind
(deprecated)

string

Определяет, что это за ресурс. Значение: фиксированная строка "walletobjects#giftCardClass" .

merchantName

string

Название продавца, например «Одежда Адама». Приложение может отображать многоточие после первых 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

pinLabel

string

Метка, отображаемая для PIN-кода, например «4-значный PIN-код».

eventNumberLabel

string

Метка, отображаемая для номера события, например «Целевое событие №».

allowBarcodeRedemption

boolean

Определяет, поддерживает ли продавец погашение подарочной карты с помощью штрих-кода. Если это правда, приложение отображает штрих-код подарочной карты на экране сведений о подарочной карте. Если false, штрих-код не отображается.

localizedMerchantName

object ( LocalizedString )

Переведенные строки для MerchantName. Приложение может отображать многоточие после первых 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

localizedPinLabel

object ( LocalizedString )

Переведенные строки для pinLabel.

localizedEventNumberLabel

object ( LocalizedString )

Переведенные строки для eventNumberLabel.

cardNumberLabel

string

Метка, отображаемая для номера карты, например «Номер карты».

localizedCardNumberLabel

object ( LocalizedString )

Переведенные строки для cardNumberLabel.

classTemplateInfo

object ( ClassTemplateInfo )

Информация шаблона о том, как должен отображаться класс. Если этот параметр не установлен, Google вернется к набору полей по умолчанию для отображения.

id

string

Необходимый. Уникальный идентификатор класса. Этот идентификатор должен быть уникальным для всех классов издателя. Это значение должно соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами. Ваш уникальный идентификатор должен включать только буквенно-цифровые символы, «.», «_» или «-».

version
(deprecated)

string ( int64 format)

Устарело

issuerName

string

Необходимый. Название эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы полная строка отображалась на небольших экранах.

messages[]

object ( Message )

Массив сообщений, отображаемых в приложении. Все пользователи этого объекта получат связанные с ним сообщения. Максимальное количество этих полей — 10.

allowMultipleUsersPerObject
(deprecated)

boolean

Устарело. Вместо этого используйте multipleDevicesAndHoldersAllowedStatus .

homepageUri

object ( Uri )

URI домашней страницы вашего приложения. Заполнение URI в этом поле приводит к точно такому же поведению, как и заполнение URI в linkedModuleData (при визуализации объекта ссылка на домашнюю страницу отображается в том, что обычно считается разделом linkedModuleData объекта).

locations[]

object ( LatLongPoint )

Примечание. Это поле в настоящее время не поддерживается для запуска географических уведомлений.

reviewStatus

enum ( ReviewStatus )

Необходимый. Статус класса. В этом поле можно установить draft или underReview , используя вызовы API вставки, исправления или обновления. После изменения состояния проверки с draft его нельзя будет вернуть обратно в draft .

Это поле следует оставить для draft , пока класс находится в стадии разработки. draft класс нельзя использовать для создания какого-либо объекта.

Если вы считаете, что класс готов к использованию, вам следует установить в этом поле значение underReview . Платформа автоматически установит для этого поля значение approved , и его можно будет немедленно использовать для создания или переноса объектов.

При обновлении уже approved класса вам следует продолжать устанавливать в этом поле значение underReview .

review

object ( Review )

Комментарии к обзору, устанавливаемые платформой, когда класс помечается approved или rejected .

infoModuleData
(deprecated)

object ( InfoModuleData )

Устарело. Вместо этого используйте textModulesData.

imageModulesData[]

object ( ImageModuleData )

Данные модуля изображения. Максимальное количество отображаемых полей — 1 на уровне объекта и 1 на уровне объекта класса.

textModulesData[]

object ( TextModuleData )

Текстовые данные модуля. Если в классе также определены данные текстового модуля, будут отображены оба. Максимальное количество отображаемых полей — 10 для объекта и 10 для класса.

redemptionIssuers[]

string ( int64 format)

Определяет, какие эмитенты погашения могут выкупить пропуск через Smart Tap. Эмитенты погашения идентифицируются по идентификатору эмитента. У эмитентов погашения должен быть настроен хотя бы один ключ Smart Tap.

Поля enableSmartTap и smartTapRedemptionLevel уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

countryCode

string

Код страны, используемый для отображения страны карты (если пользователь не находится в этой стране), а также для отображения локализованного контента, когда контент недоступен в языковом стандарте пользователя.

heroImage

object ( Image )

Дополнительное изображение баннера, отображаемое на лицевой стороне карты. Если его нет, ничего не будет отображаться. Изображение будет отображаться с шириной 100%.

wordMark
(deprecated)

object ( Image )

Устарело.

enableSmartTap

boolean

Определяет, поддерживает ли этот класс Smart Tap. Поля redemptionIssuers и smartTapRedemptionLevel уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

hexBackgroundColor

string

Цвет фона карточки. Если этот параметр не установлен, используется доминирующий цвет главного изображения, а если главное изображение не установлено, используется доминирующий цвет логотипа. Формат: # rrggbb , где rrggbb — это шестнадцатеричный триплет RGB, например #ffcc00 . Вы также можете использовать сокращенную версию триплета RGB — rgb , например #fc0 .

localizedIssuerName

object ( LocalizedString )

Переведенные строки для имени эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы полная строка отображалась на небольших экранах.

multipleDevicesAndHoldersAllowedStatus

enum ( MultipleDevicesAndHoldersAllowedStatus )

Определяет, будут ли несколько пользователей и устройств сохранять один и тот же объект, ссылающийся на этот класс.

callbackOptions

object ( CallbackOptions )

Параметры обратного вызова, которые будут использоваться для обратного вызова эмитента при каждом сохранении/удалении объекта этого класса конечным пользователем. Все объекты этого класса имеют право на обратный вызов.

securityAnimation

object ( SecurityAnimation )

Дополнительная информация об анимации безопасности. Если этот параметр установлен, при деталях прохода будет отображаться анимация безопасности.

viewUnlockRequirement

enum ( ViewUnlockRequirement )

Просмотрите параметры требований к разблокировке подарочной карты.

Методы

addmessage

 Добавляет сообщение в класс подарочных карт, на который ссылается данный идентификатор класса.

get

 Возвращает класс подарочной карты с заданным идентификатором класса.

insert

 Вставляет класс подарочной карты с заданным идентификатором и свойствами.

list

 Возвращает список всех классов подарочных карт для данного идентификатора эмитента.

patch

 Обновляет класс подарочной карты, на который ссылается данный идентификатор класса.

update

 Обновляет класс подарочной карты, на который ссылается данный идентификатор класса.