REST Resource: eventticketobject

Ресурс: EventTicketObject

JSON-представление
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Поля
kind
(deprecated)

string

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

class Reference

object ( EventTicketClass )

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

seat Info

object ( EventSeat )

Детали мест для этого билета.

reservation Info

object ( EventReservationInfo )

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

ticket Holder Name

string

Имя владельца билета, если билет закреплен за лицом. Например, «Джон Доу» или «Джейн Доу».

ticket Number

string

Номер билета. Это может быть уникальный идентификатор для всех билетов в системе эмитента, для всех билетов на мероприятие (например, XYZ1234512345) или для всех билетов в заказе (1, 2, 3 и т. д.).

ticket Type

object ( LocalizedString )

Тип билета, например «Взрослый» или «Детский», «VIP» или «Стандарт».

face Value

object ( Money )

Номинальная стоимость билета, соответствующая той, которая будет напечатана на физической версии билета.

grouping Info

object ( GroupingInfo )

Информация, управляющая группировкой пропусков.

linked Offer Ids[]

string

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

Идентификаторы объектов предложения должны соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами.

hex Background Color

string

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

id

string

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

class Id

string

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

Идентификаторы классов должны соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами.

version
(deprecated)

string ( int64 format)

Устарело

state

enum ( State )

Необходимый. Состояние объекта. Это поле используется для определения того, как объект отображается в приложении. Например, inactive объект перемещается в раздел «Просроченные пропуска».

barcode

object ( Barcode )

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

messages[]

object ( Message )

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

valid Time Interval

object ( TimeInterval )

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

locations[]
(deprecated)

object ( LatLongPoint )

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

has Users

boolean

Указывает, есть ли у объекта пользователи. Это поле задается платформой.

smart Tap Redemption Value

string

Значение, которое будет передано на сертифицированный терминал Smart Tap через NFC для этого объекта. Поля уровня класса enableSmartTap и redemptionIssuers также должны быть настроены правильно, чтобы пропуск поддерживал Smart Tap. Поддерживаются только символы ASCII.

has Linked Device

boolean

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

disable Expiration Notification

boolean

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

В настоящее время это можно установить только для предложений.

info Module Data

object ( InfoModuleData )

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

image Modules Data[]

object ( ImageModuleData )

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

text Modules Data[]

object ( TextModuleData )

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

rotating Barcode

object ( RotatingBarcode )

Тип и значение вращающегося штрих-кода.

hero Image

object ( Image )

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

pass Constraints

object ( PassConstraints )

Передайте ограничения для объекта. Включает ограничение поведения NFC и снимков экрана.

save Restrictions

object ( SaveRestrictions )

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

linked Object Ids[]

string

linkedObjectIds — это список других объектов, таких как билет на мероприятие, программа лояльности, предложение, универсальный билет, подарочная карта, транзитный и посадочный талон, которые должны быть автоматически прикреплены к этому объекту билета на мероприятие. Если пользователь сохранил этот билет на событие, то эти linkedObjectIds будут автоматически отправлены в кошелек пользователя (если только он не отключил настройку для получения таких связанных пропусков).

Убедитесь, что объекты, присутствующие в linkedObjectIds, уже вставлены — в противном случае вызовы завершатся неудачно. После связывания связанные объекты не могут быть отсоединены. Вы не можете связать объекты, принадлежащие другому эмитенту. Существует ограничение на количество объектов, которые можно связать с одним объектом. После достижения предела новые связанные объекты в вызове будут игнорироваться автоматически.

Идентификаторы объектов должны соответствовать формату issuer ID . identifier , первый из которых выдается Google, а второй выбирается вами.

notify Preference

enum ( NotificationSettingsForUpdates )

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

value Added Module Data[]

object ( ValueAddedModuleData )

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

Место для мероприятия

JSON-представление
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
Поля
kind
(deprecated)

string

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

seat

object ( LocalizedString )

Номер места, например «1», «2», «3» или любой другой идентификатор места.

Это поле можно локализовать, поэтому вы можете переводить слова или использовать разные алфавиты для символов идентификатора.

row

object ( LocalizedString )

Ряд сидений, например «1», E, «BB» или «A5».

Это поле можно локализовать, поэтому вы можете переводить слова или использовать разные алфавиты для символов идентификатора.

section

object ( LocalizedString )

Раздел сиденья, типа "121".

Это поле можно локализовать, поэтому вы можете переводить слова или использовать разные алфавиты для символов идентификатора.

gate

object ( LocalizedString )

Выходы, через которые владелец билета должен войти, чтобы занять свое место, например «А» или «Запад».

Это поле можно локализовать, поэтому вы можете переводить слова или использовать разные алфавиты для символов идентификатора.

EventReservationInfo

JSON-представление
{
  "kind": string,
  "confirmationCode": string
}
Поля
kind
(deprecated)

string

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

confirmation Code

string

Код подтверждения бронирования мероприятия. Он также может иметь форму «номера заказа», «номера подтверждения», «номера бронирования» или другого эквивалента.

Методы

addmessage

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

get

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

insert

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

list

Возвращает список всех объектов билетов событий для данного идентификатора издателя.

modifylinkedofferobjects

Изменяет связанные объекты предложения для объекта билета на мероприятие с заданным идентификатором.

patch

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

update

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