REST Resource: loyaltyobject

Ресурс: LoyaltyObject

JSON-представление 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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#loyaltyObject" .

class Reference

object ( LoyaltyClass )

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

account Name

string

Имя владельца учетной записи программы лояльности, например «Джон Смит». Рекомендуемая максимальная длина — 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

account Id

string

Идентификатор учетной записи программы лояльности. Рекомендуемая максимальная длина — 20 символов.

loyalty Points

object ( LoyaltyPoints )

Метка, баланс и тип бонусных баллов за лояльность.

linked Offer Ids[]

string

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

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

secondary Loyalty Points

object ( LoyaltyPoints )

Метка, баланс и тип дополнительных бонусных баллов лояльности. Показывается в дополнение к основным баллам лояльности.

id

string

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

class Id

string

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

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

version
(deprecated)

string ( int64 format)

Устарело

state

enum ( State )

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

barcode

object ( Barcode )

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

messages[]

object ( Message )

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

valid Time Interval

object ( TimeInterval )

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

locations[]
(deprecated)

object ( LatLongPoint )

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

has Users

boolean

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

smart Tap Redemption Value

string

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

Если это значение не установлено, но поля уровня класса enableSmartTap и redemptionIssuers настроены правильно, поля barcode.value или accountId используются в качестве резервного варианта, если они присутствуют.

has Linked Device

boolean

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

disable Expiration Notification

boolean

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

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

info Module Data

object ( InfoModuleData )

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

image Modules Data[]

object ( ImageModuleData )

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

text Modules Data[]

object ( TextModuleData )

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

rotating Barcode

object ( RotatingBarcode )

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

hero Image

object ( Image )

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

grouping Info

object ( GroupingInfo )

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

pass Constraints

object ( PassConstraints )

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

save Restrictions

object ( SaveRestrictions )

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

linked Object Ids[]

string

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

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

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

notify Preference

enum ( NotificationSettingsForUpdates )

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

value Added Module Data[]

object ( ValueAddedModuleData )

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

Очки лояльности

JSON-представление 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Поля
label

string

Ярлык баллов лояльности, например «Баллы». Рекомендуемая максимальная длина — 9 символов.

balance

object ( LoyaltyPointsBalance )

Баланс баллов лояльности владельца счета, например «500» или «10 долларов США». Рекомендуемая максимальная длина — 7 символов. Это обязательное поле для loyaltyPoints и secondaryLoyaltyPoints .

localized Label

object ( LocalizedString )

Переведенные строки для метки. Рекомендуемая максимальная длина — 9 символов.

ЛояльностьБаланс

JSON-представление 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Поля
string

string

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

int

integer

Целочисленная форма баланса. Должен быть заполнен только один из этих подтипов (строка, int, double, деньги).

double

number

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

money

object ( Money )

Денежная форма баланса. Должен быть заполнен только один из этих подтипов (строка, int, double, деньги).

Методы

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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