Ресурс REST: OfferClass

Ресурс: OfferClass

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

{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  }
}
Поля
kind
(deprecated)

string

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

title

string

Обязательно. Заголовок предложения. Пример: "Скидка 20 % на любую футболку". Рекомендуемая длина для корректного отображения на небольших экранах – не более 60 символов.

redemptionChannel

enum (RedemptionChannel)

Обязательно. Каналы реализации специального предложения.

provider

string

Обязательно. Название компании-поставщика специального предложения. Можно указать агрегатора или продавца. Рекомендуемая длина для корректного отображения на небольших экранах – не более 12 символов.

titleImage

object (Image)

Основное изображение, которым сопровождается предложение. Отображается в подробных сведениях и в списке приложения.

details

string

Подробные сведения о предложении.

finePrint

string

Условия, при которых действует предложение, и другие примечания. Пример: "Скидка 20 % на любую футболку в магазине Adam's Apparel."

helpUri

object (Uri)

Ссылка на справочные материалы о предложении. Пример: http://myownpersonaldomain.com/help.

localizedTitle

object (LocalizedString)

Варианты поля title на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 60 символов.

localizedProvider

object (LocalizedString)

Варианты поля provider на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 12 символов.

localizedDetails

object (LocalizedString)

Варианты поля details на других языках.

localizedFinePrint

object (LocalizedString)

Варианты поля finePrint на других языках.

shortTitle

string

Более короткий заголовок предложения. Пример: "Скидка 20 %". Рекомендуемая длина – не более 20 символов.

localizedShortTitle

object (LocalizedString)

Варианты поля short_title на других языках. Рекомендуемая длина – не более 20 символов.

classTemplateInfo

object (ClassTemplateInfo)

Информация в шаблоне о том, как должен отображаться класс. Если этот объект не задан, то будет использоваться набор полей по умолчанию.

id

string

Обязательно. Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: идентификатор эмитента.ваш идентификатор. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

version
(deprecated)

string (int64 format)

Больше не используется

issuerName

string

Обязательно. Название эмитента. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов.

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

Вместо него используйте multipleDevicesAndHoldersAllowedStatus.

homepageUri

object (Uri)

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

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Обязательно. Статус класса. Пример: draft. Задать значение draft или underReview можно через вызовы API с помощью методов insert, patch или update. Обратите внимание, что после изменения статуса draft на любой другой вернуть значение draft невозможно.

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

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

Если вы захотите обновить класс со статусом approved, значение поля нужно будет изменить на underReview.

review

object (Review)

Комментарий о проверке, который платформа устанавливает, когда классу присваивается отметка approved или rejected.

infoModuleData
(deprecated)

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

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

countryCode

string

Код страны, по которому определяется место выпуска карты. Используется, когда пользователь совершает покупки в другой стране. Этот код также необходим для показа локализованного контента, если оригинальный контент недоступен в регионе пользователя.

heroImage

object (Image)

Дополнительный баннер, который отображается на лицевой стороне карты. Показывается только при наличии. Занимает всю ширину карты.

wordMark
(deprecated)

object (Image)

Больше не используется.

enableSmartTap

boolean

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

hexBackgroundColor

string

Цвет фона карты. Если он не задан, то для оформления фона будет использован преобладающий цвет главного изображения, а в случае отсутствия изображения – логотипа. Используется формат #rrggbb, где rrggbb – код цвета RGB в шестнадцатеричном формате, например #ffcc00. Также можно использовать сокращенную версию в формате #rgb, например #fc0.

localizedIssuerName

object (LocalizedString)

Варианты поля issuerName на других языках. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

RedemptionChannel

Перечисления
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Устаревший псевдоним элемента INSTORE.

ONLINE
online

Устаревший псевдоним элемента ONLINE.

BOTH
both

Устаревший псевдоним элемента BOTH.

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Устаревший псевдоним элемента TEMPORARY_PRICE_REDUCTION.

Методы

addmessage

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

get

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

insert

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

list

Представляет список всех классов типа offer, которые относятся к представленному идентификатору Issuer ID.

patch

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

update

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