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

Содержание

GiftCardClassService

AddMessage

rpc AddMessage(GiftCardClassAddMessageRequest) returns (GiftCardClassAddMessageResponse)

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

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

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

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

rpc Get(GiftCardClassGetRequest) returns (GiftCardClass)

Возвращает класс gift card с указанным идентификатором.

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

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

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

rpc Insert(GiftCardClassInsertRequest) returns (GiftCardClass)

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

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

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

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

rpc List(GiftCardClassListRequest) returns (GiftCardClassListResponse)

Возвращает список всех классов gift card с указанным идентификатором Issuer ID.

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

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

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

rpc Patch(GiftCardClassPatchRequest) returns (GiftCardClass)

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

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

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

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

rpc Update(GiftCardClassUpdateRequest) returns (GiftCardClass)

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

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

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

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

GiftCardObjectService

AddMessage

rpc AddMessage(GiftCardObjectAddMessageRequest) returns (GiftCardObjectAddMessageResponse)

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

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

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

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

rpc Get(GiftCardObjectGetRequest) returns (GiftCardObject)

Возвращает объект gift card с указанным идентификатором.

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

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

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

rpc Insert(GiftCardObjectInsertRequest) returns (GiftCardObject)

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

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

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

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

rpc List(GiftCardObjectListRequest) returns (GiftCardObjectListResponse)

Возвращает список всех объектов gift card с указанным идентификатором Issuer ID.

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

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

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

rpc Patch(GiftCardObjectPatchRequest) returns (GiftCardObject)

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

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

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

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

rpc Update(GiftCardObjectUpdateRequest) returns (GiftCardObject)

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

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

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

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

GiftCardClass

Поля
kind
(deprecated)

string

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

string

Название продавца. Например: "Adam's Apparel". После первых 20 знаков может отображаться многоточие. Это нужно, чтобы строка помещалась на небольших экранах.
pin_label

string

Ярлык для PIN-кода. Например: "Четырехзначный PIN-код".
event_number_label

string

Ярлык для номера события. Например: "Целевое событие №".
allow_barcode_redemption

bool

Определяет, поддерживается ли у продавца возможность активировать подарочную карту с помощью штрихкода. Если выбрано значение true, на странице с информацией о подарочной карте отображается ее штрихкод. Если же установлено значение false, штрихкод не отображается.
localized_merchant_name

LocalizedString

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

LocalizedString

Переведенное значение pin_label.
localized_event_number_label

LocalizedString

Переведенное значение event_number_label.
card_number_label

string

Ярлык для номера карты. Например: "Номер карты".
localized_card_number_label

LocalizedString

Переведенное значение card_number_label.
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

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

GiftCardClassAddMessageRequest

Поля
resource_id

string

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

AddMessageRequest

Тело запроса.

GiftCardClassAddMessageResponse

Поля
resource

GiftCardClass

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

GiftCardClassGetRequest

Поля
resource_id

string

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

GiftCardClassInsertRequest

Поля
resource

GiftCardClass

Тело запроса.

GiftCardClassListRequest

Поля
issuer_id

int64

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

string

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

int32

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

GiftCardClassListResponse

Поля
resources[]

GiftCardClass

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

Pagination

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

GiftCardClassPatchRequest

Поля
resource_id

string

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

GiftCardClass

Тело запроса.

GiftCardClassUpdateRequest

Поля
resource_id

string

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

GiftCardClass

Тело запроса.

GiftCardObject

Поля
kind
(deprecated)

string

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

GiftCardClass

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

string

Обязательно. Номер карты.
pin

string

PIN-код карты.
balance

Money

Баланс средств карты.
balance_update_time

DateTime

Дата и время последнего обновления баланса.

Смещение указывается обязательно.

Если баланс был обновлен, но это значение не указано, по умолчанию будет установлено текущее время.
event_number

string

Номер события. Необязательное поле, используется для некоторых подарочных карт.
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 полей из класса.

GiftCardObjectAddMessageRequest

Поля
resource_id

string

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

AddMessageRequest

Тело запроса.

GiftCardObjectAddMessageResponse

Поля
resource

GiftCardObject

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

GiftCardObjectGetRequest

Поля
resource_id

string

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

GiftCardObjectInsertRequest

Поля
resource

GiftCardObject

Тело запроса.

GiftCardObjectListRequest

Поля
class_id

string

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

string

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

int32

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

GiftCardObjectListResponse

Поля
resources[]

GiftCardObject

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

Pagination

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

GiftCardObjectPatchRequest

Поля
resource_id

string

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

GiftCardObject

Тело запроса.

GiftCardObjectUpdateRequest

Поля
resource_id

string

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

GiftCardObject

Тело запроса.