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

string

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

program Name

string

Необходимый. Название программы, например «Одежда Адама». Приложение может отображать многоточие после первых 20 символов, чтобы обеспечить отображение всей строки на небольших экранах.

account Name Label

string

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

account Id Label

string

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

rewards Tier Label

string

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

rewards Tier

string

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

localized Program Name

object ( LocalizedString )

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

localized Account Name Label

object ( LocalizedString )

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

localized Account Id Label

object ( LocalizedString )

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

localized Rewards Tier Label

object ( LocalizedString )

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

localized Rewards Tier

object ( LocalizedString )

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

secondary Rewards Tier Label

string

Метка вторичного уровня вознаграждений, например «Уровень вознаграждений».

localized Secondary Rewards Tier Label

object ( LocalizedString )

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

secondary Rewards Tier

string

Вторичный уровень вознаграждений, например «Золотой» или «Платиновый».

localized Secondary Rewards Tier

object ( LocalizedString )

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

discoverable Program

object ( DiscoverableProgram )

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

class Template Info

object ( ClassTemplateInfo )

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

id

string

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

version
(deprecated)

string ( int64 format)

Устарело

issuer Name

string

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

messages[]

object ( Message )

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepage Uri

object ( Uri )

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

locations[]
(deprecated)

object ( LatLongPoint )

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

review Status

enum ( ReviewStatus )

Необходимый. Статус класса. Для этого поля можно установить draft или underReview используя вызовы API вставки, исправления или обновления. После изменения состояния проверки с draft его нельзя будет вернуть обратно в draft .

Это поле следует оставить для draft пока класс находится в стадии разработки. draft класс нельзя использовать для создания какого-либо объекта.

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

При обновлении уже approved класса вам следует продолжать устанавливать в этом поле значение underReview .

review

object ( Review )

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

infoModuleData
(deprecated)

object ( InfoModuleData )

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

image Modules Data[]

object ( ImageModuleData )

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

text Modules Data[]

object ( TextModuleData )

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

redemption Issuers[]

string ( int64 format)

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

enableSmartTap и одно из полей smartTapRedemptionValue , barcode.value , or accountId` уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

country Code

string

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

hero Image

object ( Image )

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

wordMark
(deprecated)

object ( Image )

Устарело.

enable Smart Tap

boolean

Определяет, поддерживает ли этот класс Smart Tap. redemptionIssuers и одно из полей smartTapRedemptionLevel , barcode.value , or accountId` уровня объекта также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap.

hex Background Color

string

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

localized Issuer Name

object ( LocalizedString )

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

multiple Devices And Holders Allowed Status

enum ( MultipleDevicesAndHoldersAllowedStatus )

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

callback Options

object ( CallbackOptions )

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

security Animation

object ( SecurityAnimation )

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

view Unlock Requirement

enum ( ViewUnlockRequirement )

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

notify Preference

enum ( NotificationSettingsForUpdates )

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

value Added Module Data[]

object ( ValueAddedModuleData )

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

Обнаруживаемая программа

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

JSON-представление 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Поля
merchant Signup Info

object ( DiscoverableProgramMerchantSignupInfo )

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

merchant Signin Info

object ( DiscoverableProgramMerchantSigninInfo )

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

state

enum ( State )

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

DiscoverableProgramMerchantРегистрацияИнформация

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

JSON-представление 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Поля
signup Website

object ( Uri )

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

signup Shared Datas[]

enum ( SharedDataType )

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

Шареддататипе

Перечисления
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)
  }
}
Поля
signin Website

object ( Uri )

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

Состояние

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

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

LIVE Видно всем.
live

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

DISABLED Не видно.
disabled

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

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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