REST Resource: genericobject

Ресурс: GenericObject

Общий объект

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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Поля
generic Type

enum ( GenericType )

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

card Title

object ( LocalizedString )

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

subheader

object ( LocalizedString )

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

header

object ( LocalizedString )

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

hex Background Color

string

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

notifications

object ( Notifications )

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

id

string

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

class Id

string

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

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

barcode

object ( Barcode )

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

hero Image

object ( Image )

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

valid Time Interval

object ( TimeInterval )

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

image Modules Data[]

object ( ImageModuleData )

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

text Modules Data[]

object ( TextModuleData )

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

grouping Info

object ( GroupingInfo )

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

smart Tap Redemption Value

string

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

rotating Barcode

object ( RotatingBarcode )

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

state

enum ( State )

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

has Users

boolean

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

messages[]

object ( Message )

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

pass Constraints

object ( PassConstraints )

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

save Restrictions

object ( SaveRestrictions )

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

value Added Module Data[]

object ( ValueAddedModuleData )

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

linked Object Ids[]

string

linkedObjectIds — это список других объектов, таких как билет на мероприятие, программа лояльности, предложение, универсальный объект, подарочная карта, транзитный и посадочный талон, которые должны быть автоматически прикреплены к этому универсальному объекту. Если пользователь сохранил эту общую карту, то эти linkedObjectIds будут автоматически отправлены в кошелек пользователя (если только он не отключил настройку для получения таких связанных пропусков).

Убедитесь, что объекты, присутствующие в linkedObjectIds, уже вставлены — в противном случае вызовы завершатся неудачей. После связывания связанные объекты не могут быть отсоединены. Вы не можете связать объекты, принадлежащие другому эмитенту. Существует ограничение на количество объектов, которые можно связать с одним объектом. После достижения предела новые связанные объекты в вызове будут игнорироваться автоматически.

Идентификаторы объектов должны соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами.

Общий тип

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

Перечисления
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_LOYALTY_CARD Карты лояльности. Обратите внимание, что вместо этого общего типа рекомендуется использовать специальный тип пропуска для карты постоянного клиента. Специальный тип пропуска по карте постоянного клиента предлагает больше возможностей и функциональности, чем обычный тип пропуска.
GENERIC_OTHER Другой тип

Уведомления

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

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

object ( ExpiryNotification )

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

upcoming Notification

object ( UpcomingNotification )

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

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

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

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

boolean

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

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

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

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

boolean

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

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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