Ключи верхнего уровня

Верхний уровень pass.json файл является словарем. Следующие разделы перечисляют требуемые и дополнительные ключи, используемые в этом словаре. Для каждого ключа, значение которого является словарем или массивом словарей, существует также раздел в Ключах Низшего уровня, перечисляющий ключи для того словаря.

Стандартные ключи

Информация, запрашивающаяся для всех передач.

Ключевое имя

Ввести

Описание

description

локализуемая строка

Требуемый. Краткое описание передачи, используемой технологиями доступности iOS.

Не пытайтесь включить все данные по передаче в ее описании, просто включать достаточно подробности для различения передач того же типа.

formatVersion

целое число

Требуемый. Версия формата файла. Значение должно быть 1.

organizationName

локализуемая строка

Требуемый. Имя дисплея организации, породившей и подписавшей передачу.

passTypeIdentifier

строка

Требуемый. Передайте идентификатор типа, как выпущено Apple. Значение должно соответствовать Вашему сертификату подписания.

serialNumber

строка

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

teamIdentifier

строка

Требуемый. Идентификатор команды организации, породившей и подписавшей передачу, как выпущено Apple.

Связанные ключи приложения

Информация о приложении, связанном с передачей.

Ключевое имя

Ввести

Описание

appLaunchURL

строка

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

Приложение получает этот URL в application:didFinishLaunchingWithOptions: и application:handleOpenURL: методы его делегата приложения.

Если этот ключ присутствует, associatedStoreIdentifiers ключ должен также присутствовать.

associatedStoreIdentifiers

массив чисел

Дополнительный. Список идентификаторов элемента iTunes Store для связанных приложений.

Только один элемент в списке используется — первый идентификатор элемента для приложения, совместимого с текущим устройством. Если приложение не установлено, ссылка открывает App Store и показывает приложение. Если приложение уже установлено, ссылка запускает приложение.

Сопутствующие ключи приложения

Пользовательская информация о передаче предусмотрела сопутствующее приложение для использования.

Ключевое имя

Ввести

Описание

userInfo

любые данные JSON

Дополнительный. Пользовательская информация для сопутствующих приложений. Эти данные не выведены на экран пользователю.

Например, передача для кафе могла включать информацию о любимом напитке пользователя и тестовой системе в машиночитаемой форме для сопутствующего приложения для чтения, упрощая размещать заказ для “обычного” из приложения.

Доступный в iOS 7.0.

Ключи истечения срока

Информация о том, когда передача истекает и допустимо ли это все еще.

Передача отмечена, как истекли, если текущая дата после даты истечения срока передачи, или если передача была явно отмечена, как аннулировано.

Ключевое имя

Ввести

Описание

expirationDate

Дата W3C, как строка

Дополнительный. Дата и время, когда истекает передача.

Значение должно быть полной датой с часами и минутами, и может дополнительно включать секунды.

Доступный в iOS 7.0.

voided

Булевская переменная

Дополнительный. Указывает, что передача является недействительной — например, один выплаченный купон использования времени. Значение по умолчанию false.

Доступный в iOS 7.0.

Ключи уместности

Информация, о где и когда передача релевантна.

Ключевое имя

Ввести

Описание

beacons

массив словарей маркера

Дополнительный. Маркеры, отмечающие расположения, где передача релевантна.

Для ключей этих словарей посмотрите Ключи Словаря Маркера

Доступный в iOS 7.0.

locations

массив словарей расположения

Дополнительный. Расположения, где передача релевантна. Например, расположение Вашего хранилища.

Для ключей этих словарей посмотрите Ключи Словаря Расположения.

maxDistance

число

Дополнительный. Максимальное расстояние в метрах от соответствующей широты и долготы, что передача релевантна. Это число по сравнению с расстоянием передачи по умолчанию, и меньшее значение используется.

Доступный в iOS 7.0.

relevantDate

Дата W3C, как строка

Дополнительный. Дата и время, когда передача становится релевантной. Например, время начала фильма.

Значение должно быть полной датой с часами и минутами, и может дополнительно включать секунды.

Ключи стиля

Указывает стиль передачи.

Обеспечьте точно один ключ — ключ, соответствующий типу передачи. Значение этого ключа является словарем, содержащим ключи в Ключах Словаря Структуры Передачи.

Ключевое имя

Ввести

Описание

boardingPass

словарь структуры передачи

Информация, определенная для посадочного талона.

coupon

словарь структуры передачи

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

eventTicket

словарь структуры передачи

Информация, определенная для билета.

generic

словарь структуры передачи

Информация, определенная для универсальной передачи.

storeCard

словарь структуры передачи

Информация, определенная для магазинной карточки.

Визуальные ключи появления

Визуальное моделирование и появление передачи.

Ключевое имя

Ввести

Описание

barcode

словарь штрихкода

Дополнительный. Информация, определенная для штрихкодов. Для ключей этого словаря посмотрите Ключи Словаря Штрихкода

backgroundColor

цвет, как строка

Дополнительный. Цвет фона передачи, указанной как триплет RGB стиля CSS. Например, rgb(23, 187, 82).

foregroundColor

цвет, как строка

Дополнительный. Основной цвет передачи, указанной как триплет RGB стиля CSS. Например, rgb(100, 10, 110).

groupingIdentifier

строка

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

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

Доступный в iOS 7.0.

labelColor

цвет, как строка

Дополнительный. Цвет текста метки, указанного как триплет RGB стиля CSS. Например, rgb(255, 255, 255).

Если опущено, цвет метки определяется автоматически.

logoText

локализуемая строка

Дополнительный. Текст выведен на экран рядом с логотипом на передаче.

suppressStripShine

Булевская переменная

Дополнительный. Если true, изображение полосы выведено на экран без эффекта сияния. Значение по умолчанию до iOS 7.0 false.

В iOS 7.0 никогда не применяется эффект сияния, и этот ключ осуждается.

Ключи веб-сервиса

Информация раньше обновляла передачи с помощью веб-сервиса.

; если веб-сервис, URL предоставлен, аутентификационный маркер требуется, иначе эти ключи не позволяются.

Ключевое имя

Ввести

Описание

authenticationToken

строка

Аутентификационный маркер для использования с веб-сервисом. Маркер должен быть 16 символами или дольше.

webServiceURL

строка

URL веб-сервиса, соответствующего API, описанному в Ссылке Веб-сервиса Сберкнижки.

Веб-сервис должен использовать протокол HTTPS; продвижение https:// включен в значение этого ключа.

На устройствах, сконфигурированных для разработки, существует UI в Настройках для разрешения веб-сервисов HTTP.