REST Resource: 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)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
Поля
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 )

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

localizedProvider

object ( LocalizedString )

Переведенные строки для провайдера. Рекомендуемая максимальная длина — 12 символов, чтобы полная строка отображалась на небольших экранах.

localizedDetails

object ( LocalizedString )

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

localizedFinePrint

object ( LocalizedString )

Переведенные строки для FinePrint.

shortTitle

string

Сокращенная версия названия предложения, например «Скидка 20 %», которая отображается пользователям как краткая ссылка на содержание предложения. Рекомендуемая максимальная длина — 20 символов.

localizedShortTitle

object ( LocalizedString )

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

classTemplateInfo

object ( ClassTemplateInfo )

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

id

string

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

version
(deprecated)

string ( int64 format)

Устарело

issuerName

string

Необходимый. Название эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

messages[]

object ( Message )

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object ( Uri )

URI домашней страницы вашего приложения. Заполнение URI в этом поле приводит к тому же поведению, что и заполнение URI в linkedModuleData (при визуализации объекта ссылка на домашнюю страницу отображается в том, что обычно считается разделом linkedModuleData объекта).

locations[]
(deprecated)

object ( LatLongPoint )

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

reviewStatus

enum ( ReviewStatus )

Необходимый. Статус класса. В этом поле можно установить draft или статус класса. В этом поле можно установить значение draft или underReview , используя вызовы API вставки, исправления или обновления. После изменения состояния проверки с 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)

Определяет, какие эмитенты погашения могут выкупить пропуск через Smart Tap. Эмитенты погашения идентифицируются по идентификатору эмитента. У эмитентов погашения должен быть настроен хотя бы один ключ Smart Tap.

Поля enableSmartTap и smartTapRedemptionLevel на уровне объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

countryCode

string

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

heroImage

object ( Image )

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

wordMark
(deprecated)

object ( Image )

Устарело.

enableSmartTap

boolean

Определяет, поддерживает ли этот класс Smart Tap. Поля redemptionIssuers и smartTapRedemptionLevel уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

hexBackgroundColor

string

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

localizedIssuerName

object ( LocalizedString )

Переведенные строки для имени эмитента. Рекомендуемая максимальная длина — 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

multipleDevicesAndHoldersAllowedStatus

enum ( MultipleDevicesAndHoldersAllowedStatus )

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

callbackOptions

object ( CallbackOptions )

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

securityAnimation

object ( SecurityAnimation )

Дополнительная информация об анимации безопасности. Если этот параметр установлен, при деталях прохода будет отображаться анимация безопасности.

viewUnlockRequirement

enum ( ViewUnlockRequirement )

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

wideTitleImage

object ( Image )

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

notifyPreference

enum ( NotificationSettingsForUpdates )

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

valueAddedModuleData[]

object ( ValueAddedModuleData )

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

merchantLocations[]

object ( MerchantLocation )

Торговые локации. В классе максимум десять человек. Любые дополнительные MerchantLocations, добавленные сверх 10, будут отклонены. Эти местоположения будут вызывать уведомление, когда пользователь входит в радиус, установленный Google, от точки. Это поле заменяет устаревшие LatLongPoints.

Канал погашения

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

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

ONLINE
online

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

BOTH
both

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

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

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

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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