REST Resource: genericobject

Ресурс: GenericObject

Следующий идентификатор универсального объекта: 121

JSON-представление
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
Поля
genericType

enum ( GenericType )

Укажите, к какому GenericType принадлежит карта.

cardTitle

object ( LocalizedString )

Необходимый. Заголовок пропуска. Обычно это название компании, например «XXX Gym», «AAA Insurance». Это поле является обязательным и отображается в строке заголовка в самом верху прохода.

subheader

object ( LocalizedString )

Название пропуска, например место, где этот пропуск можно использовать. Появляется прямо над заголовком в строке заголовка в подробном представлении о пропуске.

header

object ( LocalizedString )

Необходимый. Название пропуска, например «Купон на скидку 50 %», «Библиотечная карта» или «Ваучер». Это поле является обязательным и отображается в строке заголовка подробного представления прохода.

hexBackgroundColor

string

Цвет фона карточки. Если он не установлен, используется доминирующий цвет главного изображения, а если главное изображение не установлено, используется доминирующий цвет логотипа, а если логотип не установлен, цвет будет выбран Google.

notifications

object ( Notifications )

Настройки уведомлений, включенные для этого объекта.

id

string

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

classId

string

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

Идентификаторы классов должны иметь формат issuerID.identifier , где issuerID выдается Google, а identifier выбирается вами.

barcode

object ( Barcode )

Тип и значение штрих-кода. Если в пропуске нет штрих-кода, мы можем разрешить эмитенту установить Barcode.alternate_text и отобразить именно его.

heroImage

object ( Image )

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

validTimeInterval

object ( TimeInterval )

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

imageModulesData[]

object ( ImageModuleData )

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

textModulesData[]

object ( TextModuleData )

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

groupingInfo

object ( GroupingInfo )

Информация, управляющая группировкой пропусков.

smartTapRedemptionValue

string

Значение, которое будет передано на сертифицированный терминал Smart Tap через NFC для этого объекта. Поля уровня класса enableSmartTap и redemptionIssuers также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap. Поддерживаются только символы ASCII.

rotatingBarcode

object ( RotatingBarcode )

Настройки/детали вращающегося штрих-кода.

state

enum ( State )

Состояние объекта. Это поле используется для определения того, как объект отображается в приложении. Например, inactive объект перемещается в раздел «Просроченные пропуска». Если это не предусмотрено, объект будет считаться ACTIVE .

hasUsers

boolean

Указывает, есть ли у объекта пользователи. Это поле задается платформой.

passConstraints

object ( PassConstraints )

Передайте ограничения для объекта. Включает ограничение поведения NFC и снимков экрана.

Общий тип

Тип общей карты.

Перечисления
GENERIC_TYPE_UNSPECIFIED Неопределенный универсальный тип.
GENERIC_SEASON_PASS Сезонный билет
GENERIC_UTILITY_BILLS Счета за коммунальные услуги
GENERIC_PARKING_PASS Парковочный талон
GENERIC_VOUCHER Ваучер
GENERIC_GYM_MEMBERSHIP Членские билеты в тренажерный зал
GENERIC_LIBRARY_MEMBERSHIP Членские билеты библиотеки
GENERIC_RESERVATIONS Бронирование
GENERIC_AUTO_INSURANCE Карты автострахования
GENERIC_HOME_INSURANCE Карты страхования жилья
GENERIC_ENTRY_TICKET Входные билеты
GENERIC_RECEIPT Квитанции
GENERIC_OTHER Другой тип

Уведомления

Указывает, необходимо ли для объекта включить уведомление. Мы поддерживаем только одно из ExpiryNotification/UpcomingNotification. expiryNotification имеет приоритет над upcomingNotification . Другими словами, если установлен expiryNotification , мы игнорируем поле upcomingNotification .

JSON-представление
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Поля
expiryNotification

object ( ExpiryNotification )

Уведомление будет срабатывать в определенное время до истечения срока действия карты.

upcomingNotification

object ( UpcomingNotification )

Уведомление будет срабатывать в определенное время, прежде чем карта станет доступной для использования.

Уведомление об истечении срока действия

Указывает, что эмитент хочет, чтобы Google Кошелек отправлял уведомления об истечении срока действия карты за 2 дня до истечения срока действия карты.

JSON-представление
{
  "enableNotification": boolean
}
Поля
enableNotification

boolean

Указывает, необходимо ли для объекта включить уведомление об истечении срока действия.

Предстоящее уведомление

Указывает, что эмитент хочет, чтобы Google Кошелек отправлял предстоящее уведомление о сроке действия карты за 1 день до того, как карта станет действительной/пригодной к использованию.

JSON-представление
{
  "enableNotification": boolean
}
Поля
enableNotification

boolean

Указывает, необходимо ли для объекта включить предстоящее уведомление.

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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