Ресурс REST: 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)
  }
}
Поля
kind
(deprecated)

string

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

classReference

object (LoyaltyClass)

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

accountName

string

Имя участника программы. Пример: "Иван Смирнов". Рекомендуемая длина для корректного отображения на небольших экранах – не более 20 символов.

accountId

string

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

loyaltyPoints

object (LoyaltyPoints)

Премиальные баллы, баланс и тип бонусной программы.

linkedOfferIds[]

string

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

Идентификатор объекта offer должен иметь формат issuer ID.identifier (первая часть предоставляется Google, вторая задается вами).

secondaryLoyaltyPoints

object (LoyaltyPoints)

Второстепенные премиальные баллы, баланс и тип бонусной программы. Отображается в дополнение к основным премиальным баллам.

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)

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

hasUsers

boolean

Это поле показывает, есть ли у объекта пользователи. Заполняется автоматически.

smartTapRedemptionValue

string

Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки.

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

В настоящее время параметр можно задать только для специальных предложений.

infoModuleData

object (InfoModuleData)

Больше не используется. Вместо него используйте textModulesData.

imageModulesData[]

object (ImageModuleData)

Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса.

textModulesData[]

object (TextModuleData)

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

LoyaltyPoints

JSON-представление

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Поля
label

string

Метка бонусных баллов. Пример: "Баллы". Рекомендуемая максимальная длина – 9 символов.

balance

object (LoyaltyPointsBalance)

Количество бонусных баллов у участника программы. Пример: "500" или "10,00 долларов США". Рекомендуемая максимальная длина – 7 символов. Обязательное поле для loyaltyPoints и secondaryLoyaltyPoints.

localizedLabel

object (LocalizedString)

Варианты метки на других языках. Рекомендуемая максимальная длина – 9 символов.

LoyaltyPointsBalance

JSON-представление

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Поля
string

string

Формат баланса – строка. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

int

integer

Формат баланса – целое число. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

double

number

Формат баланса – число двойной точности. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

money

object (Money)

Формат баланса – деньги. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

Методы

addmessage

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

get

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

insert

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

list

Возвращает список всех объектов типа loyalty, которые относятся к указанному идентификатору эмитента.

modifylinkedofferobjects

Изменяет объекты offer, связанные объектом loyalty с указанным идентификатором.

patch

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

update

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