Пакет google.walletobjects.v1.loyalty

Содержание

LoyaltyClassService

AddMessage

rpc AddMessage(LoyaltyClassAddMessageRequest) returns (LoyaltyClassAddMessageResponse)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyClassGetRequest) returns (LoyaltyClass)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyClassInsertRequest) returns (LoyaltyClass)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyClassListRequest) returns (LoyaltyClassListResponse)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyClassPatchRequest) returns (LoyaltyClass)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyClassUpdateRequest) returns (LoyaltyClass)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyObjectService

AddMessage

rpc AddMessage(LoyaltyObjectAddMessageRequest) returns (LoyaltyObjectAddMessageResponse)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyObjectGetRequest) returns (LoyaltyObject)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyObjectInsertRequest) returns (LoyaltyObject)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyObjectListRequest) returns (LoyaltyObjectListResponse)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
ModifyLinkedOfferObjects

rpc ModifyLinkedOfferObjects(LoyaltyObjectModifyLinkedOfferObjectsRequest) returns (LoyaltyObject)

Изменяет объекты offer, связанные объектом loyalty с указанным идентификатором.

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyObjectPatchRequest) returns (LoyaltyObject)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyObjectUpdateRequest) returns (LoyaltyObject)

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

Области действия

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyClass

Поля
kind
(deprecated)

string

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

program_name

string

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

account_name_label

string

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

account_id_label

string

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

rewards_tier_label

string

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

rewards_tier

string

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

localized_program_name

LocalizedString

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

localized_account_name_label

LocalizedString

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

localized_account_id_label

LocalizedString

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

localized_rewards_tier_label

LocalizedString

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

localized_rewards_tier

LocalizedString

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

secondary_rewards_tier_label

string

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

localized_secondary_rewards_tier_label

LocalizedString

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

secondary_rewards_tier

string

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

localized_secondary_rewards_tier

LocalizedString

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

discoverable_program

DiscoverableProgram

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

class_template_info

ClassTemplateInfo

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

id

string

Обязательно. Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

version
(deprecated)

int64

Больше не используется

issuer_name

string

Обязательно. Название эмитента. Рекомендуемая длина для корректного отображения на небольших экранах: максимум 20 символов.

messages[]

Message

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

allow_multiple_users_per_object
(deprecated)

bool

Вместо него используйте multipleDevicesAndHoldersAllowedStatus.

homepage_uri

Uri

URI главной страницы приложения. Если поле заполнено, ссылка на главную страницу отображается в разделе, за который обычно отвечает поле linksModuleData. Тот же результат будет, если указать URI непосредственно в поле linksModuleData.

locations[]

LatLongPoint

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

review_status

ReviewStatus

Обязательно. Статус класса. Задать значение draft или underReview можно через вызовы API с помощью методов insert, patch или update. Обратите внимание, что после изменения статуса draft на любой другой вернуть значение draft невозможно.

Пока класс остается на этапе разработки, для него должен быть указан статус draft. На стадии draft нельзя создавать объекты.

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

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

review

Review

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

info_module_data
(deprecated)

InfoModuleData

Вместо него используйте textModulesData.

image_modules_data[]

ImageModuleData

Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса.

text_modules_data[]

TextModuleData

Данные текстового модуля. Если для класса также задан текстовый модуль, то показываться будут оба. Отображается не более 10 полей из объекта и 10 полей из класса.

redemption_issuers[]

int64

Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки.

country_code

string

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

hero_image

Image

Дополнительный баннер, который отображается на лицевой стороне карты. Показывается только при наличии. Занимает всю ширину карты.

word_mark
(deprecated)

Image

Больше не используется.

enable_smart_tap

bool

Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки.

hex_background_color

string

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

localized_issuer_name

LocalizedString

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

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

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

callback_options

CallbackOptions

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

LoyaltyClassAddMessageRequest

Поля
resource_id

string

Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

add_message_request

AddMessageRequest

Текст запроса.

LoyaltyClassAddMessageResponse

Поля
resource

LoyaltyClass

Обновленный ресурс LoyaltyClass.

LoyaltyClassGetRequest

Поля
resource_id

string

Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

LoyaltyClassInsertRequest

Поля
resource

LoyaltyClass

Текст запроса.

LoyaltyClassListRequest

Поля
issuer_id

int64

Идентификатор эмитента, который имеет право получать список классов.

token

string

Используется для получения следующего набора результатов, если значение maxResults задано, однако в списке доступно больше классов, чем maxResults. Например, если список состоит из 200 классов, а значение maxResults – 20, в списке будут получены первые 20 классов и токен. Чтобы увидеть следующие 20 классов, выполните вызов списка ещё раз. В запросе укажите токен, а для maxResults задайте значение 20.

max_results

int32

Максимальное количество результатов в списке. Если параметр maxResults не задан, выводятся все результаты.

LoyaltyClassListResponse

Поля
resources[]

LoyaltyClass

Ресурсы, соответствующие запросу списка.

pagination

Pagination

Число страниц в ответе.

LoyaltyClassPatchRequest

Поля
resource_id

string

Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

resource

LoyaltyClass

Текст запроса.

LoyaltyClassUpdateRequest

Поля
resource_id

string

Идентификатор класса. Идентификаторы классов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

resource

LoyaltyClass

Текст запроса.

LoyaltyObject

Поля
kind
(deprecated)

string

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

class_reference

LoyaltyClass

Копия полей, унаследованных от родительского класса. Эти поля извлекаются в ходе операции GET.

account_name

string

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

account_id

string

Идентификатор участника программы. Рекомендуемая длина – не более 20 символов.

loyalty_points

LoyaltyPoints

Премиальные баллы, баланс и тип бонусной программы.

linked_offer_ids[]

string

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

Идентификатор объекта offer должен иметь формат issuer ID.identifier (первая часть предоставляется Google, вторая задается вами).

secondary_loyalty_points

LoyaltyPoints

Второстепенные премиальные баллы, баланс и тип бонусной программы. Отображается в дополнение к основным премиальным баллам.

id

string

Обязательно. Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

class_id

string

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

Идентификатор класса должен иметь формат issuer ID.identifier (первая часть предоставляется Google, вторая задается вами).

version
(deprecated)

int64

Больше не используется

state

State

Обязательно. Статус объекта. Это поле определяет, как объект будет отображаться в приложении. Например, объекты со статусом inactive показываются в разделе "Проездные с истекшим сроком действия".

barcode

Barcode

Тип и значение штрихкода.

messages[]

Message

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

valid_time_interval

TimeInterval

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

locations[]

LatLongPoint

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

has_users

bool

Это поле показывает, есть ли у объекта пользователи. Заполняется автоматически.

smart_tap_redemption_value

string

Доступно только для партнеров, поддерживающих интеллектуальную бесконтактную технологию. За дополнительной информацией обращайтесь в службу поддержки.

has_linked_device

bool

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

disable_expiration_notification

bool

Это поле показывает, должны ли блокироваться уведомления. Если установлено значение true, уведомления об истечении срока действия не будут приходить пользователю, даже если это противоречит настройке, заданной в поле messages. По умолчанию установлено значение false.

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

info_module_data

InfoModuleData

Больше не используется. Вместо него используйте textModulesData.

image_modules_data[]

ImageModuleData

Данные графического модуля. Отображается не более 1 поля из уровня объекта и 1 поля для уровня объекта класса.

text_modules_data[]

TextModuleData

Данные текстового модуля. Если для класса также задан текстовый модуль, то показываться будут оба. Отображается не более 10 полей из объекта и 10 полей из класса.

LoyaltyObjectAddMessageRequest

Поля
resource_id

string

Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

add_message_request

AddMessageRequest

Текст запроса.

LoyaltyObjectAddMessageResponse

Поля
resource

LoyaltyObject

Обновленный ресурс LoyaltyObject.

LoyaltyObjectGetRequest

Поля
resource_id

string

Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

LoyaltyObjectInsertRequest

Поля
resource

LoyaltyObject

Текст запроса.

LoyaltyObjectListRequest

Поля
class_id

string

Идентификатор класса, объекты которого будут перечислены.

token

string

Используется для получения следующего набора результатов, если значение maxResults задано, однако в списке доступно больше объектов, чем maxResults. Например, если список состоит из 200 объектов, а значение maxResults – 20, в списке будут получены первые 20 объектов и токен. Чтобы увидеть следующие 20 объектов, выполните вызов списка ещё раз. В запросе укажите токен, а для maxResults задайте значение 20.

max_results

int32

Максимальное количество результатов в списке. Если параметр maxResults не задан, выводятся все результаты.

LoyaltyObjectListResponse

Поля
resources[]

LoyaltyObject

Ресурсы, соответствующие запросу списка.

pagination

Pagination

Число страниц в ответе.

LoyaltyObjectModifyLinkedOfferObjectsRequest

Поля
resource_id

string

Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

modify_linked_offer_objects_request

ModifyLinkedOfferObjectsRequest

Идентификаторы объекта offer для объекта loyalty.

LoyaltyObjectPatchRequest

Поля
resource_id

string

Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

resource

LoyaltyObject

Текст запроса.

LoyaltyObjectUpdateRequest

Поля
resource_id

string

Уникальный идентификатор объекта. Идентификаторы объектов у одного эмитента не могут повторяться. Значение указывается в следующем формате: issuer ID.identifier. При этом первая часть предоставляется Google, а вторая – выбирается вами. Идентификатор может содержать только буквы, цифры, точки, символы подчеркивания и дефисы.

resource

LoyaltyObject

Текст запроса.

LoyaltyPoints

Поля
label

string

Метка бонусных баллов. Пример: "Баллы". Рекомендуемая максимальная длина – 9 символов.

balance

LoyaltyPointsBalance

Количество бонусных баллов у участника программы. Пример: "500" или "10,00 долларов США". Рекомендуемая максимальная длина – 7 символов. Обязательное поле для loyaltyPoints и secondaryLoyaltyPoints.

localized_label

LocalizedString

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

LoyaltyPointsBalance

Поля
string

string

Формат баланса – строка. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

int

int32

Формат баланса – целое число. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

double

double

Формат баланса – число двойной точности. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.

money

Money

Формат баланса – деньги. Можно выбрать только один вариант: строка, целое число, число двойной точности, деньги.