REST Resource: genericclass

Ресурс: GenericClass

Общий класс

JSON-представление
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Поля
id

string

Необходимый. Уникальный идентификатор класса. Этот идентификатор должен быть уникальным для всех от эмитента. Это значение должно иметь формат issuerID.identifier , где issuerID выдается Google, а identifier выбирается вами. Уникальный идентификатор может включать только буквенно-цифровые символы . , _ , или - .

class Template Info

object ( ClassTemplateInfo )

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

image Modules Data[]

object ( ImageModuleData )

Данные модуля изображения. Если для объекта также определены imageModulesData , будут отображены оба. Если оба установлены, будет отображаться только одно изображение из класса и одно из уровня объекта.

text Modules Data[]

object ( TextModuleData )

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

enable Smart Tap

boolean

Доступно только партнерам с поддержкой Smart Tap. Свяжитесь со службой поддержки для получения дополнительных рекомендаций.

redemption Issuers[]

string ( int64 format)

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

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

security Animation

object ( SecurityAnimation )

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

multiple Devices And Holders Allowed Status

enum ( MultipleDevicesAndHoldersAllowedStatus )

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

callback Options

object ( CallbackOptions )

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

view Unlock Requirement

enum ( ViewUnlockRequirement )

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

messages[]

object ( Message )

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

value Added Module Data[]

object ( ValueAddedModuleData )

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

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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