Ресурс REST: eventticketclass

Ресурс: EventTicketClass

JSON-представление

{
  "kind": string,
  "eventName": {
    object (LocalizedString)
  },
  "eventId": string,
  "logo": {
    object (Image)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "confirmationCodeLabel": enum (ConfirmationCodeLabel),
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "seatLabel": enum (SeatLabel),
  "customSeatLabel": {
    object (LocalizedString)
  },
  "rowLabel": enum (RowLabel),
  "customRowLabel": {
    object (LocalizedString)
  },
  "sectionLabel": enum (SectionLabel),
  "customSectionLabel": {
    object (LocalizedString)
  },
  "gateLabel": enum (GateLabel),
  "customGateLabel": {
    object (LocalizedString)
  },
  "finePrint": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  }
}
Поля
kind
(deprecated)

string

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

eventName

object (LocalizedString)

Обязательно. Название события, например "Зенит – Лейпциг".

eventId

string

Идентификатор события. Должен быть уникальным для каждого события в аккаунте. Используется для группировки билетов в случаях, когда у пользователя сохранено несколько билетов на одно событие. Длина не должна превышать 64 символа.

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

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

venue

object (EventVenue)

Информация о площадке.

dateTime

object (EventDateTime)

Дата и время события.

confirmationCodeLabel

enum (ConfirmationCodeLabel)

Метка для обозначения кода подтверждения (eventTicketObject.reservationInfo.confirmationCode) в подробных сведениях о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – confirmationCodeLabel и customConfirmationCodeLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия кода подтверждения. Если это поле не задано, метка не используется.

customConfirmationCodeLabel

object (LocalizedString)

Пользовательская метка для обозначения кода подтверждения (eventTicketObject.reservationInfo.confirmationCode) в подробных сведениях о карте. Используется, только если не подходит метка "Код подтверждения" по умолчанию и ни один из вариантов метки confirmationCodeLabel.

Заполнять сразу два поля – confirmationCodeLabel и customConfirmationCodeLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия кода подтверждения. Если это поле не задано, метка не используется.

seatLabel

enum (SeatLabel)

Метка для обозначения места (eventTicketObject.seatInfo.seat) в подробных сведениях о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – seatLabel и customSeatLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Место". Если это поле не задано, метка не используется.

customSeatLabel

object (LocalizedString)

Пользовательская метка для обозначения места (eventTicketObject.seatInfo.seat) в подробных сведениях о карте. Используется, только если не подходит метка "Место" по умолчанию и ни один из вариантов метки seatLabel.

Заполнять сразу два поля – seatLabel и customSeatLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Место". Если это поле не задано, метка не используется.

rowLabel

enum (RowLabel)

Метка для обозначения ряда (eventTicketObject.seatInfo.row) в подробных сведениях о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – rowLabel и customRowLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Ряд". Если это поле не задано, метка не используется.

customRowLabel

object (LocalizedString)

Пользовательская метка для обозначения ряда (eventTicketObject.seatInfo.row) в подробных сведениях о карте. Используется, только если не подходит метка "Ряд" по умолчанию и ни один из вариантов метки rowLabel.

Заполнять сразу два поля – rowLabel и customRowLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Ряд". Если это поле не задано, метка не используется.

sectionLabel

enum (SectionLabel)

Метка для обозначения сектора (eventTicketObject.seatInfo.section) в подробных сведениях о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – sectionLabel и customSectionLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Сектор". Если это поле не задано, метка не используется.

customSectionLabel

object (LocalizedString)

Пользовательская метка для обозначения сектора (eventTicketObject.seatInfo.section) в подробных сведениях о карте. Используется, только если не подходит метка "Сектор" по умолчанию и ни один из вариантов метки sectionLabel.

Заполнять сразу два поля – sectionLabel и customSectionLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Сектор". Если это поле не задано, метка не используется.

gateLabel

enum (GateLabel)

Метка для обозначения входа (eventTicketObject.seatInfo.gate) в подробных сведениях о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – gateLabel и customGateLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Вход". Если это поле не задано, метка не используется.

customGateLabel

object (LocalizedString)

Пользовательская метка для обозначения входа (eventTicketObject.seatInfo.gate) в подробных сведениях о карте. Используется, только если не подходит метка "Вход" по умолчанию и ни один из вариантов метки gateLabel.

Заполнять сразу два поля – gateLabel и customGateLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия метки "Вход". Если это поле не задано, метка не используется.

finePrint

object (LocalizedString)

Подробные условия пользования билетом.

classTemplateInfo

object (ClassTemplateInfo)

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

id

string

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

version
(deprecated)

string (int64 format)

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

issuerName

string

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

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object (Uri)

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

locations[]

object (LatLongPoint)

reviewStatus

enum (ReviewStatus)

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

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

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

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

review

object (Review)

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

infoModuleData
(deprecated)

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

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

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

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

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

EventVenue

JSON-представление

{
  "kind": string,
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
Поля
kind
(deprecated)

string

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

name

object (LocalizedString)

Название площадки, например "Ледовый дворец".

Это обязательно.

address

object (LocalizedString)

Адрес площадки, например "пр. Пятилеток, 1, Санкт-Петербург, 193318". Строки адреса разделяются символами LF (\n).

Это обязательно.

EventDateTime

JSON-представление

{
  "kind": string,
  "doorsOpen": string,
  "start": string,
  "end": string,
  "doorsOpenLabel": enum (DoorsOpenLabel),
  "customDoorsOpenLabel": {
    object (LocalizedString)
  }
}
Поля
kind
(deprecated)

string

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

doorsOpen

string

Дата и время запуска публики.

Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601).

Пример:

1985-04-12T23:20:50.52Z – 23 часа, 20 минут и 50,52 секунды 12 апреля 1985 года по UTC.

1985-04-12T19:20:50.52-04:00 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года, за 4 часа до всемирного координированного времени (тот же момент времени, что и в примере выше). Если дата и время указаны для Нью-Йорка, то это будет эквивалентом североамериканского восточного летнего времени. Имейте в виду, что в регионах, где есть переход на летнее время, смещение варьируется в зависимости от времени года.

1985-04-12T19:20:50.52 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года без данных о смещении.

Фрагмент информации о дате и времени без данных о смещении считается местными датой и временем. Здесь следует указывать местное время и дату. Например, если мероприятие начинается 5 июня 2018 года в 20 часов по местному времени, сведения о местных дате и времени будут выглядеть так: 2018-06-05T20:00:00. Если местные дата и время меньше всемирного координированного времени на 4 часа, можно добавить фрагмент -04:00.

Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны.

start

string

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

Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601).

Пример:

1985-04-12T23:20:50.52Z – 23 часа, 20 минут и 50,52 секунды 12 апреля 1985 года по UTC.

1985-04-12T19:20:50.52-04:00 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года, за 4 часа до всемирного координированного времени (тот же момент времени, что и в примере выше). Если дата и время указаны для Нью-Йорка, то это будет эквивалентом североамериканского восточного летнего времени. Имейте в виду, что в регионах, где есть переход на летнее время, смещение варьируется в зависимости от времени года.

1985-04-12T19:20:50.52 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года без данных о смещении.

Фрагмент информации о дате и времени без данных о смещении считается местными датой и временем. Здесь следует указывать местное время и дату. Например, если мероприятие начинается 5 июня 2018 года в 20 часов по местному времени, сведения о местных дате и времени будут выглядеть так: 2018-06-05T20:00:00. Если местные дата и время меньше всемирного координированного времени на 4 часа, можно добавить фрагмент -04:00.

Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны.

end

string

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

Дата и время в расширенном формате ISO 8601. Смещение может указываться, но это необязательно. Время может быть указано с точностью до наносекунды; смещение – с точностью до секунды (хотя это и не подпадает под стандарт ISO 8601).

Пример:

1985-04-12T23:20:50.52Z – 23 часа, 20 минут и 50,52 секунды 12 апреля 1985 года по UTC.

1985-04-12T19:20:50.52-04:00 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года, за 4 часа до всемирного координированного времени (тот же момент времени, что и в примере выше). Если дата и время указаны для Нью-Йорка, то это будет эквивалентом североамериканского восточного летнего времени. Имейте в виду, что в регионах, где есть переход на летнее время, смещение варьируется в зависимости от времени года.

1985-04-12T19:20:50.52 – 19 часов, 20 минут и 50,52 секунды 12 апреля 1985 года без данных о смещении.

Фрагмент информации о дате и времени без данных о смещении считается местными датой и временем. Здесь следует указывать местное время и дату. Например, если мероприятие начинается 5 июня 2018 года в 20 часов по местному времени, сведения о местных дате и времени будут выглядеть так: 2018-06-05T20:00:00. Если местные дата и время меньше всемирного координированного времени на 4 часа, можно добавить фрагмент -04:00.

Если не указать данные о смещении, некоторые расширенные функции могут быть недоступны.

doorsOpenLabel

enum (DoorsOpenLabel)

Метка для обозначения времени начала запуска (doorsOpen) при просмотре сведений о карте. Каждая доступная опция сопоставлена с набором локализованных строк, которые показываются пользователю в зависимости от его местоположения.

Заполнять сразу два поля – doorsOpenLabel и customDoorsOpenLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия времени начала запуска. Если это поле не задано, метка не используется.

customDoorsOpenLabel

object (LocalizedString)

Пользовательская метка для обозначения времени начала запуска (doorsOpen) при просмотре сведений о карте. Используется, только если не подходит метка "Время начала запуска" по умолчанию и ни один из вариантов метки doorsOpenLabel.

Заполнять сразу два поля – doorsOpenLabel и customDoorsOpenLabel – нельзя. Если не задано ни одно из них, значением метки по умолчанию будет локализованная версия времени начала запуска. Если это поле не задано, метка не используется.

DoorsOpenLabel

Перечисления
DOORS_OPEN_LABEL_UNSPECIFIED
DOORS_OPEN
doorsOpen

Устаревший псевдоним элемента DOORS_OPEN.

GATES_OPEN
gatesOpen

Устаревший псевдоним элемента GATES_OPEN.

ConfirmationCodeLabel

Перечисления
CONFIRMATION_CODE_LABEL_UNSPECIFIED
CONFIRMATION_CODE
confirmationCode

Устаревший псевдоним элемента CONFIRMATION_CODE.

CONFIRMATION_NUMBER
confirmationNumber

Устаревший псевдоним элемента CONFIRMATION_NUMBER.

ORDER_NUMBER
orderNumber

Устаревший псевдоним элемента ORDER_NUMBER.

RESERVATION_NUMBER
reservationNumber

Устаревший псевдоним элемента RESERVATION_NUMBER.

SeatLabel

Перечисления
SEAT_LABEL_UNSPECIFIED
SEAT
seat

Устаревший псевдоним элемента SEAT.

RowLabel

Перечисления
ROW_LABEL_UNSPECIFIED
ROW
row

Устаревший псевдоним элемента ROW.

SectionLabel

Перечисления
SECTION_LABEL_UNSPECIFIED
SECTION
section

Устаревший псевдоним элемента SECTION.

THEATER
theater

Устаревший псевдоним элемента THEATER.

GateLabel

Перечисления
GATE_LABEL_UNSPECIFIED
GATE
gate

Устаревший псевдоним элемента GATE.

DOOR
door

Устаревший псевдоним элемента DOOR.

ENTRANCE
entrance

Устаревший псевдоним элемента ENTRANCE.

Методы

addmessage

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

get

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

insert

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

list

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

patch

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

update

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