Содержание
OfferClassService
(интерфейс)OfferObjectService
(интерфейс)OfferClass
(сообщение)OfferClass.RedemptionChannel
(перечисление)OfferClassAddMessageRequest
(сообщение)OfferClassAddMessageResponse
(сообщение)OfferClassGetRequest
(сообщение)OfferClassInsertRequest
(сообщение)OfferClassListRequest
(сообщение)OfferClassListResponse
(сообщение)OfferClassPatchRequest
(сообщение)OfferClassUpdateRequest
(сообщение)OfferObject
(сообщение)OfferObjectAddMessageRequest
(сообщение)OfferObjectAddMessageResponse
(сообщение)OfferObjectGetRequest
(сообщение)OfferObjectInsertRequest
(сообщение)OfferObjectListRequest
(сообщение)OfferObjectListResponse
(сообщение)OfferObjectPatchRequest
(сообщение)OfferObjectUpdateRequest
(сообщение)
OfferClassService
AddMessage | |
---|---|
Добавляет сообщение к классу offer с указанным идентификатором.
|
Get | |
---|---|
Возвращает класс offer, к которому относится указанный идентификатор.
|
Insert | |
---|---|
Добавляет класс offer с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех классов типа offer, которые относятся к указанному идентификатору эмитента.
|
Patch | |
---|---|
Обновляет класс offer с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет класс offer с указанным идентификатором.
|
OfferObjectService
AddMessage | |
---|---|
Добавляет сообщение к объекту offer с указанным идентификатором.
|
Get | |
---|---|
Возвращает объект offer, к которому относится указанный идентификатор.
|
Insert | |
---|---|
Добавляет объект offer с заданными идентификатором и свойствами.
|
List | |
---|---|
Возвращает список всех объектов типа offer, которые относятся к указанному идентификатору эмитента.
|
Patch | |
---|---|
Обновляет объект offer с указанным идентификатором. Этот метод поддерживает семантику PATCH.
|
Update | |
---|---|
Обновляет объект offer с указанным идентификатором.
|
OfferClass
Поля | |
---|---|
kind |
Определяет тип ресурса. Значение: фиксированная строка |
title |
Обязательно. Заголовок предложения. Пример: "Скидка 20 % на любую футболку". Рекомендуемая длина для корректного отображения на небольших экранах – не более 60 символов. |
redemption_channel |
Обязательно. Каналы реализации специального предложения. |
provider |
Обязательно. Название компании-поставщика специального предложения. Можно указать агрегатора или продавца. Рекомендуемая длина для корректного отображения на небольших экранах – не более 12 символов. |
title_image |
Основное изображение, которым сопровождается предложение. Отображается в подробных сведениях и в списке приложения. |
details |
Подробные сведения о предложении. |
fine_print |
Условия, при которых действует предложение, и другие примечания. Пример: "Скидка 20 % на любую футболку в магазине Adam's Apparel." |
help_uri |
Ссылка на справочные материалы о предложении. Пример: |
localized_title |
Варианты поля title на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 60 символов. |
localized_provider |
Варианты поля provider на других языках. Рекомендуемая длина для корректного отображения на небольших экранах – не более 12 символов. |
localized_details |
Варианты поля details на других языках. |
localized_fine_print |
Варианты поля fine_print на других языках. |
short_title |
Более короткий заголовок предложения. Пример: "Скидка 20 %". Рекомендуемая длина – не более 20 символов. |
localized_short_title |
Варианты поля short_title на других языках. Рекомендуемая длина – не более 20 символов. |
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 |
Параметры обратного вызова, которые будут использоваться для вызова эмитента всякий раз, когда конечные пользователи станут сохранять или удалять объекты этого класса. Данная функция доступна для всех объектов в этом классе. |
RedemptionChannel
Перечисления | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
|
INSTORE |
|
instore |
Устаревший псевдоним элемента |
ONLINE |
|
online |
Устаревший псевдоним элемента |
BOTH |
|
both |
Устаревший псевдоним элемента |
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
Устаревший псевдоним элемента |
OfferClassAddMessageRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
OfferClassAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс OfferClass. |
OfferClassGetRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
OfferClassInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
OfferClassListRequest
Поля | |
---|---|
issuer_id |
Идентификатор эмитента, который имеет право получать список классов. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если параметр |
OfferClassListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
OfferClassPatchRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
OfferClassUpdateRequest
Поля | |
---|---|
resource_id |
Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
OfferObject
Поля | |
---|---|
kind |
Определяет тип ресурса. Значение: фиксированная строка |
class_reference |
Копия полей, унаследованных от родительского класса. Эти поля извлекаются в ходе операции GET. |
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 |
Дополнительная информация о ссылке на приложение партнера. |
OfferObjectAddMessageRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
add_message_request |
Текст запроса. |
OfferObjectAddMessageResponse
Поля | |
---|---|
resource |
Обновленный ресурс OfferObject. |
OfferObjectGetRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
OfferObjectInsertRequest
Поля | |
---|---|
resource |
Текст запроса. |
OfferObjectListRequest
Поля | |
---|---|
class_id |
Идентификатор класса, объекты которого будут перечислены. |
token |
Используется для получения следующего набора результатов, если значение |
max_results |
Максимальное количество результатов в списке. Если параметр |
OfferObjectListResponse
Поля | |
---|---|
resources[] |
Ресурсы, соответствующие запросу списка. |
pagination |
Число страниц в ответе. |
OfferObjectPatchRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Текст запроса. |
OfferObjectUpdateRequest
Поля | |
---|---|
resource_id |
Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, нижние подчеркивания и дефисы. |
resource |
Тело запроса. |