REST Resource: offerobject

Ресурс: OfferObject

JSON-представление 
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Поля
kind
(deprecated)

string

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

classReference

object ( OfferClass )

Копия унаследованных полей родительского класса. Эти поля извлекаются во время GET.

id

string

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

classId

string

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

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

version
(deprecated)

string ( int64 format)

Устарело

state

enum ( State )

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

barcode

object ( Barcode )

Тип и значение штрих-кода.

messages[]

object ( Message )

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

validTimeInterval

object ( TimeInterval )

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

locations[]

object ( LatLongPoint )

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

hasUsers

boolean

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

smartTapRedemptionValue

string

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

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

Указывает, следует ли явно подавлять уведомления. Если для этого поля установлено значение true, независимо от поля messages , уведомления об истечении срока действия для пользователя будут подавлены. По умолчанию в этом поле установлено значение false.

В настоящее время это можно установить только для предложений.

infoModuleData

object ( InfoModuleData )

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

imageModulesData[]

object ( ImageModuleData )

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

textModulesData[]

object ( TextModuleData )

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

rotatingBarcode

object ( RotatingBarcode )

Тип и значение вращающегося штрих-кода.

heroImage

object ( Image )

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

groupingInfo

object ( GroupingInfo )

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

passConstraints

object ( PassConstraints )

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

saveRestrictions

object ( SaveRestrictions )

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

linkedObjectIds[]

string

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

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

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

notifyPreference

enum ( NotificationSettingsForUpdates )

Должны ли обновления полей этого объекта вызывать уведомления. Если установлено значение NOTIFY, мы попытаемся отправить пользователям уведомление об обновлении поля. Эти уведомления будут отправляться пользователям только в том случае, если поле входит в белый список. Если установлено значение DO_NOT_NOTIFY или NOTIFICATION_SETTINGS_UNSPECIFIED, уведомление не будет срабатывать. Этот параметр является временным и его необходимо устанавливать при каждом запросе PATCH или UPDATE, иначе уведомление не будет активировано.

valueAddedModuleData[]

object ( ValueAddedModuleData )

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

Методы

addmessage

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

get

 Возвращает объект предложения с заданным идентификатором объекта.

insert

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

list

 Возвращает список всех объектов предложений для данного идентификатора эмитента.

patch

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

update

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