Содержание
LoyaltyClassService
(интерфейс)LoyaltyObjectService
(интерфейс)LoyaltyClass
(сообщение)LoyaltyClassAddMessageRequest
(сообщение)LoyaltyClassAddMessageResponse
(сообщение)LoyaltyClassGetRequest
(сообщение)LoyaltyClassInsertRequest
(сообщение)LoyaltyClassListRequest
(сообщение)LoyaltyClassListResponse
(сообщение)LoyaltyClassPatchRequest
(сообщение)LoyaltyClassUpdateRequest
(сообщение)LoyaltyObject
(сообщение)LoyaltyObjectAddMessageRequest
(сообщение)LoyaltyObjectAddMessageResponse
(сообщение)LoyaltyObjectGetRequest
(сообщение)LoyaltyObjectInsertRequest
(сообщение)LoyaltyObjectListRequest
(сообщение)LoyaltyObjectListResponse
(сообщение)LoyaltyObjectModifyLinkedOfferObjectsRequest
(сообщение)LoyaltyObjectPatchRequest
(сообщение)LoyaltyObjectUpdateRequest
(сообщение)LoyaltyPoints
(сообщение)LoyaltyPointsBalance
(сообщение)
LoyaltyClassService
AddMessage | |
---|---|
Добавляет сообщение к классу loyalty с указанным идентификатором.
|
Get | |
---|---|
Возвращает класс loyalty, к которому относится указанный идентификатор.
|
Insert | |
---|---|
Добавляет класс loyalty с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех классов типа loyalty, которые относятся к указанному идентификатору эмитента.
|
Patch | |
---|---|
Обновляет класс loyalty с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет класс loyalty с указанным идентификатором.
|
LoyaltyObjectService
AddMessage | |
---|---|
Добавляет сообщение к объекту loyalty с указанным идентификатором.
|
Get | |
---|---|
Возвращает объект loyalty, к которому относится указанный идентификатор.
|
Insert | |
---|---|
Добавляет объект transit с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех объектов типа loyalty, которые относятся к указанному идентификатору эмитента.
|
ModifyLinkedOfferObjects | |
---|---|
Изменяет объекты offer, связанные объектом loyalty с указанным идентификатором.
|
Patch | |
---|---|
Обновляет объект loyalty с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет объект loyalty с указанным идентификатором.
|
LoyaltyClass
Поля | |
---|---|
kind |
Определяет тип ресурса. Значение: фиксированная строка |
program_name |
Обязательно. Название программы, например "Adam's Apparel". Если название длинное, то для корректного отображения на небольших экранах выводятся только первые 20 символов, а дальше ставится многоточие. |
program_logo |
Обязательно. Логотип программы лояльности и компании. Отображается в подробных сведениях и в списке приложений. |
account_name_label |
Метка названия аккаунта. Пример: "Имя участника". Рекомендуемая длина для корректного отображения на небольших экранах – не более 15 символов. |
account_id_label |
Метка идентификатора аккаунта. Пример: "Идентификатор участника". Рекомендуемая длина для корректного отображения на небольших экранах – не более 15 символов. |
rewards_tier_label |
Метка уровня бонусов. Пример: "Уровень бонусов". Рекомендуемая длина для корректного отображения на небольших экранах – не более 9 символов. |
rewards_tier |
Уровень бонусов. Пример: "Золотой" или "Платиновый". Рекомендуемая длина для корректного отображения на небольших экранах – не более 7 символов. |
localized_program_name |
Варианты поля program_name на других языках. Если название длинное, то для корректного отображения на небольших экранах выводятся только первые 20 символов, а дальше ставится многоточие. |
localized_account_name_label |
Варианты поля account_name_label на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 15 символов. |
localized_account_id_label |
Варианты поля account_id_label на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 15 символов. |
localized_rewards_tier_label |
Варианты поля rewards_tier_label на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 9 символов. |
localized_rewards_tier |
Варианты поля rewards_tier на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 7 символов. |
secondary_rewards_tier_label |
Метка второстепенного уровня бонусов. Пример: "Уровень бонусов". |
localized_secondary_rewards_tier_label |
Варианты поля secondary_rewards_tier_label на других языках. |
secondary_rewards_tier |
Второстепенный уровень бонусов. Пример: "Золотой" или "Платиновый". |
localized_secondary_rewards_tier |
Варианты поля secondary_rewards_tier на других языках. |
discoverable_program |
Информация о том, как обнаружить класс и создать на его основе объекты в приложении Google Pay. |
class_template_info |
Информация в шаблоне о том, как должен отображаться класс. Если этот объект не задан, то будет использоваться набор полей по умолчанию. |
id |
Обязательно. Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
version |
Больше не используется |
issuer_name |
Обязательно. Название эмитента. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов. |
messages[] |
Массив сообщений, которые будут отображаться в приложении. Связанные с ним сообщения увидят все пользователи этого объекта. Максимальное число полей – 10. |
allow_multiple_users_per_object |
Вместо него используйте |
homepage_uri |
URI главной страницы приложения. Если поле заполнено, ссылка на главную страницу отображается в разделе, за который обычно отвечает поле linksModuleData. Тот же результат будет, если указать URI непосредственно в поле linksModuleData. |
locations[] |
Список местоположений, где может использоваться объект. Эта информация необходима для показа уведомлений пользователям с учетом их местоположения. Указанные в этом объекте местоположения имеют приоритет перед указанными в классе, а они в свою очередь имеют приоритет над заданными идентификаторами Google Places ID. |
review_status |
Обязательно. Статус класса. Задать значение Пока класс остается на этапе разработки, для него должен быть указан статус Когда класс будет готов для проверки, необходимо изменить значение поля на Если вы захотите обновить класс со статусом |
review |
Комментарий о проверке, который платформа устанавливает, когда классу присваивается отметка |
info_module_data |
Вместо него используйте textModulesData. |
image_modules_data[] |
Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса. |
text_modules_data[] |
Данные текстового модуля. Если для класса также задан текстовый модуль, то показываться будут оба. Отображается не более 10 полей из объекта и 10 полей из класса. |
links_module_data |
Данные модуля ссылок. Если для объекта также задан модуль ссылок, то показываться будут оба. |
redemption_issuers[] |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
country_code |
Код страны, по которому определяется место выпуска карты. Используется, когда пользователь совершает покупки в другой стране. Этот код также необходим для показа локализованного контента, если оригинальный контент недоступен в регионе пользователя. |
hero_image |
Дополнительный баннер, который отображается на лицевой стороне карты. Показывается только при наличии. Занимает всю ширину карты. |
word_mark |
Больше не используется. |
enable_smart_tap |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
hex_background_color |
Цвет фона карты. Если он не задан, то для оформления фона будет использован преобладающий цвет главного изображения, а в случае отсутствия изображения – логотипа. Цвет указывается в следующем формате: #rrggbb, где rrggbb – это номер оттенка в системе RGB, записанный в виде шестнадцатеричного кода. Пример: |
localized_issuer_name |
Переведенное значение issuer_name. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов. |
multiple_devices_and_holders_allowed_status |
Определяет, будет ли один и тот же объект сохраняться у разных пользователей и устройств, ссылающихся на этот класс. |
callback_options |
Параметры обратного вызова, которые будут использоваться для вызова эмитента всякий раз, когда конечные пользователи станут сохранять или удалять объекты этого класса. Данная функция доступна для всех объектов в этом классе. |
LoyaltyClassAddMessageRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
LoyaltyClassAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс LoyaltyClass. |
LoyaltyClassGetRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
LoyaltyClassInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
LoyaltyClassListRequest
Поля | |
---|---|
issuer_id |
Идентификатор эмитента, который имеет право получать список классов. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если параметр |
LoyaltyClassListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
LoyaltyClassPatchRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
resource |
Текст запроса. |
LoyaltyClassUpdateRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
resource |
Текст запроса. |
LoyaltyObject
Поля | |
---|---|
kind |
Определяет тип ресурса. Значение: фиксированная строка |
class_reference |
Копия полей, унаследованных от родительского класса. Эти поля извлекаются в ходе операции GET. |
account_name |
Имя участника программы. Пример: "Иван Смирнов". Рекомендуемая длина для корректного отображения на небольших экранах – не более 20 символов. |
account_id |
Идентификатор участника программы. Рекомендуемая длина – не более 20 символов. |
loyalty_points |
Премиальные баллы, баланс и тип бонусной программы. |
linked_offer_ids[] |
Список объектов offer, привязанных к карте постоянного клиента. Объекты offer должны уже существовать. Идентификатор объекта offer должен иметь формат issuer ID.identifier (первая часть предоставляется Google, вторая задается вами). |
secondary_loyalty_points |
Второстепенные премиальные баллы, баланс и тип бонусной программы. Отображается в дополнение к основным премиальным баллам. |
id |
Обязательно. Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
class_id |
Обязательно. Класс, связанный с объектом. Элементы должны быть одного типа. Кроме того, класс должен быть существующим и одобренным. Идентификатор класса должен иметь формат issuer ID.identifier (первая часть предоставляется Google, вторая задается вами). |
version |
Больше не используется |
state |
Обязательно. Статус объекта. Это поле определяет, как объект будет отображаться в приложении. Например, объекты со статусом |
barcode |
Тип и значение штрихкода. |
messages[] |
Массив сообщений, которые будут отображаться в приложении. Связанные с ним сообщения увидят все пользователи этого объекта. Максимальное число полей – 10. |
valid_time_interval |
Период времени, в течение которого объект сохраняет состояние |
locations[] |
Список местоположений, где может использоваться объект. Эта информация необходима для показа уведомлений пользователям с учетом их местоположения. В случае конфликта данных этот список будет использоваться вместо адресов, содержащихся в классе, которые, в свою очередь, имеют приоритет над идентификаторами мест в Google. |
has_users |
Это поле показывает, есть ли у объекта пользователи. Заполняется автоматически. |
smart_tap_redemption_value |
Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки. |
has_linked_device |
Это поле показывает, связан ли объект с отдельным устройством. Заполняется автоматически, когда пользователь сохраняет объект и, тем самым, привязывает его к своему устройству. Доступно не для всех партнеров. За дополнительной информацией обращайтесь в службу поддержки. |
disable_expiration_notification |
Это поле показывает, должны ли блокироваться уведомления. Если установлено значение true, уведомления об истечении срока действия не будут приходить пользователю, даже если это противоречит настройке, заданной в поле В настоящее время параметр можно задать только для специальных предложений. |
info_module_data |
Больше не используется. Вместо него используйте textModulesData. |
image_modules_data[] |
Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса. |
text_modules_data[] |
Данные текстового модуля. Если для класса также задан текстовый модуль, то показываться будут оба. Отображается не более 10 полей из объекта и 10 полей из класса. |
links_module_data |
Данные модуля ссылок. Если для класса также задан модуль ссылок, то показываться будут оба. |
app_link_data |
Дополнительная информация о ссылке на приложение партнера. |
LoyaltyObjectAddMessageRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
LoyaltyObjectAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс LoyaltyObject. |
LoyaltyObjectGetRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
LoyaltyObjectInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
LoyaltyObjectListRequest
Поля | |
---|---|
class_id |
Идентификатор класса, объекты которого будут перечислены. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если параметр |
LoyaltyObjectListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
LoyaltyObjectModifyLinkedOfferObjectsRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
modify_linked_offer_objects_request |
Идентификаторы объекта offer для объекта loyalty. |
LoyaltyObjectPatchRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
resource |
Текст запроса. |
LoyaltyObjectUpdateRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы. |
resource |
Текст запроса. |
LoyaltyPoints
Поля | |
---|---|
label |
Метка бонусных баллов. Пример: "Баллы". Рекомендуемая максимальная длина – 9 символов. |
balance |
Количество бонусных баллов у участника программы. Пример: "500" или "10,00 долларов США". Рекомендуемая максимальная длина – 7 символов. Обязательное поле для |
localized_label |
Варианты метки на других языках. Рекомендуемая максимальная длина – 9 символов. |
LoyaltyPointsBalance
Поля | |
---|---|
string |
Формат баланса – строка. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги. |
int |
Формат баланса – целое число. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги. |
double |
Формат баланса – число двойной точности. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги. |
money |
Формат баланса – деньги. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги. |