Ресурс REST: loyaltyclass

Ресурс: LoyaltyClass

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

{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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#loyaltyClass".

programName

string

Обязательно. Название программы, например "Adam's Apparel". Если название длинное, то для корректного отображения на небольших экранах выводятся только первые 20 символов, а дальше ставится многоточие.

accountNameLabel

string

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

accountIdLabel

string

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

rewardsTierLabel

string

Метка уровня бонусов. Пример: "Уровень бонусов". Рекомендуемая длина для корректного отображения на небольших экранах – не более 9 символов.

rewardsTier

string

Уровень бонусов. Пример: "Золотой" или "Платиновый". Рекомендуемая длина для корректного отображения на небольших экранах – не более 7 символов.

localizedProgramName

object (LocalizedString)

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

localizedAccountNameLabel

object (LocalizedString)

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

localizedAccountIdLabel

object (LocalizedString)

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

localizedRewardsTierLabel

object (LocalizedString)

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

localizedRewardsTier

object (LocalizedString)

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

secondaryRewardsTierLabel

string

Метка второстепенного уровня бонусов. Пример: "Уровень бонусов".

localizedSecondaryRewardsTierLabel

object (LocalizedString)

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

secondaryRewardsTier

string

Второстепенный уровень бонусов. Пример: "Золотой" или "Платиновый".

localizedSecondaryRewardsTier

object (LocalizedString)

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

discoverableProgram

object (DiscoverableProgram)

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

classTemplateInfo

object (ClassTemplateInfo)

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

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 главной страницы приложения. Если поле заполнено, ссылка на главную страницу отображается в разделе, за который обычно отвечает поле linksModuleData. Тот же результат будет, если указать URI непосредственно в поле linksModuleData.

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

Обязательно. Статус класса. Задать значение 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)

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

DiscoverableProgram

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

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

{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Поля
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Информация о возможности регистрации и добавления ценного объекта для этой программы на веб-сайте продавца. Используется при активной переменной MERCHANT_HOSTED_SIGNUP.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Информация о возможности входа и добавления ценного объекта для этой программы на веб-сайте продавца. Используется при активной переменной MERCHANT_HOSTED_SIGNIN.

state

enum (State)

Статус доступа обнаруженной программы.

DiscoverableProgramMerchantSignupInfo

Информация о порядке действий при регистрации для участия в этой программе, размещенном на ресурсах продавца.

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

{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Поля
signupWebsite

object (Uri)

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

signupSharedDatas[]

enum (SharedDataType)

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

SharedDataType

Перечисления
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS однострочное адресное поле
ADDRESS_LINE_1 многострочные адресные поля
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Информация о порядке действий при входе для участия в этой программе, размещенном на ресурсах продавца.

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

{
  "signinWebsite": {
    object (Uri)
  }
}
Поля
signinWebsite

object (Uri)

URL-адрес, по которому пользователь может войти на веб-сайт продавца.

State

Перечисления
STATE_UNSPECIFIED
TRUSTED_TESTERS Доступно только тестировщикам, имеющим доступ к аккаунту продавца.
trustedTesters

Устаревший псевдоним элемента TRUSTED_TESTERS. Больше не поддерживается.

LIVE Доступно всем.
live

Устаревший псевдоним элемента LIVE. Больше не поддерживается.

DISABLED Недоступно пользователям.
disabled

Устаревший псевдоним элемента DISABLED. Больше не поддерживается.

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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