Типы данных

Updated over a week ago

Результаты, data для опросов типов data по API, будут возвращать информацию в одном из форматов, описанных ниже.

Результат полезной нагрузки

Атрибуты

Корневая структура данных JSON имеет следующие атрибуты.

имя	тип	описание
`data`	список объектов данных	Данные получены из источника.
`metadata`	объект метаданных	Метаданные, связанные с `data` .

Метаданные

Атрибуты

имя	тип	описание
`count`	ИНТ	Количество объектов в `data` .

файл

Тип данных file виден во всем API, так как это ссылка на файл, который можно загрузить из API посредством опроса типа files .

Атрибуты

название	тип	описание
`id`	строка	Идентификатор, используемый для запроса файла из API. Это значение гарантированно будет уникальным только в области действия текущего источника.
`data_type`	строка, всегда `file`	Спецификатор типа данных.
`name`	строка	Имя файла, исключая расширение.
`extension`	строка, необязательно	Расширение файла, если доступно.
`mime_type`	строка, необязательно	MIME-тип файла, если он доступен.
`size`	int, необязательно	Размер файла, если имеется.
`checksum`	строка, необязательно	Контрольная сумма md5, если доступна.

пример

{
  "id": "abc123",
  "data_type": "file",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "size": 2505426,
}

Образ

Расширяет файл .

название	тип	описание
`filename`	строка	Исходное имя файла. Расширение в этом имени файла должно соответствовать расширению файла.
`filepath`	строка	Путь к файлу относительно других файлов в его сервисе. Например, путь в резервной копии.
`width`	int, необязательно	Ширина файла, если доступно.
`height`	int, необязательно	Высота файла, если доступно.

пример

{
  "id": "abc123",
  "data_type": "image",
  "filename": "IMG_0003.JPG",
  "filepath": "Media/DCIM/100APPLE/IMG_0003.JPG",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "width": 3000,
  "height": 2002,
  "size": 2505426,
}

видео

Расширяет файл .

название	тип	описание
`filename`	строка	Исходное имя файла. Расширение в этом имени файла должно соответствовать расширению файла.
`filepath`	строка	Путь к файлу относительно других файлов в его сервисе. Например, путь в резервной копии.
`width`	int, необязательно	Ширина файла, если доступно.
`height`	int, необязательно	Высота файла, если доступно.
`duration`	int, необязательно	Продолжительность видео, если доступно.

пример

{
  "id": "abc123",
  "data_type": "video",
  "filename": "IMG_0009.MOV",
  "filepath": "Media/DCIM/100APPLE/IMG_0009.MOV",
  "name": "IMG_0009",
  "extension": "mov",
  "mime_type": "video/quicktime",
  "width": 1920,
  "height": 1080,
  "size": 5421796,
  "duration": 9.135623
}

Сообщение

Атрибуты

название	тип	описание
`id`	строка	Уникальный идентификатор сообщения. Используйте это для дедупликации возвращаемых данных, если это необходимо.
`data_type`	строка, всегда `message`	Спецификатор типа данных.
`conversation_id`	строка	Идентификатор группировки сообщений по разговору.
`handle`	строка	2-я сторона разговора.
`type`	строка, необязательно	Используется, когда служба сообщений обрабатывает различные типы сообщений. Например, `SMS` и `iMessage` в случае сообщений iOS.
`text`	строка	Тело сообщения.
`from_me`	BOOL	Было ли сообщение отправлено или получено.
`attachments`	список файлов, необязательно	Массив значений `file_id` который можно использовать с методом `download_file` . Если сообщение не содержит вложений, возвращается пустой массив.
`group_handles`	список строк, необязательно	Это значение равно `null` для личных сообщений, а в групповых беседах - это массив строк, представляющих номера телефонов или адреса электронной почты iMessage.
`group`	строка, необязательно	Название группы на момент отправки сообщения .
`group_id`	строка, необязательно	Уникальный идентификатор группы в контексте этого приложения. Это может быть не целое число, и, если оно присутствует, предоставляет только информацию в дополнение к `conversation_id` .
`group_contacts`	строка, необязательно	Массив объектов, ссылающихся на контакты iOS в группе.
`user`	строка, необязательно	Пользователь приложения обмена сообщениями в случае, когда несколько пользователей / учетных записей могут использовать приложение обмена сообщениями с устройства.
`deleted`	bool, необязательно	Логическое значение, указывающее, было ли сообщение удалено.
`date`	Дата и время	Когда сообщение было отправлено или получено.
`contact`	вложенный контакт, необязательно	Объект, ссылающийся на контакт iOS второго участника разговора.

пример

{
  "id": "a1b2c3d4",
  "data_type": "message",
  "conversation_id": "w6x7y8z9",
  "handle": "vodafone",
  "type": "SMS",
  "text": "Hi from Vodafone!",
  "attachments": [],
  "group_handles": [
    "+441234567890",
    "renate@reincubate.com"
  ],
  "from_me": false,
  "deleted": false,
  "date": "2020-01-01T00:00:00.000000Z"
}

разговор

Поток беседы.

название	тип	описание
`id`	строка	Идентификатор товара
`data_type`	строка, всегда `conversation`	Идентификатор типа данных элемента.
`group`	необязательная строка	Название группы.
`members`	список `contact`	Участники беседы.

контакт

атрибуты contact

название	тип	описание
`id`	строка	Идентификатор товара
`data_type`	строка, всегда `contact`	Идентификатор типа данных элемента.
`name`	необязательная строка	Полное имя контакта.
`first_name`	необязательная строка	Имя контакта.
`middle_name`	необязательная строка	Отчество контакта.
`last_name`	необязательная строка	Фамилия контакта.
`prefix`	необязательная строка	Префикс имени контакта.
`suffix`	необязательная строка	Суффикс имени контакта.
`nickname`	необязательная строка	Псевдоним контакта.
`records`	список элементов `contact.record`	Контактные записи, связанные с контактом.
`organisation`	необязательная строка	Название организации контакта.
`department`	необязательная строка	Отдел контактов внутри организации.
`jobtitle`	необязательная строка	Должность сотрудника в организации.
`birthday`	необязательная дата	День рождения контакта.

атрибут contact.record

Существует 5 типов записей записей контактов: Phone , Email , URL , Social Address и Address . Они соответствуют номеру телефона, адресу электронной почты, URL-адресу веб-сайта, идентификатору учетной записи в социальной сети и почтовому адресу соответственно.

Первые 4 имеют одинаковые атрибуты:

имя	тип	описание
`type`	строка	Один из: `Phone` , `Email` , `URL` , `Social` .
`name`	необязательная строка	Метка, связанная с записью.
`value`	строка	Ценность записи.

Тип записи контакта « Address » имеет дополнительные поля адреса:

название	тип	описание
`type`	строка, всегда `Address`	Запись номера телефона.
`name`	необязательная строка	Метка, связанная с номером.
`CountryCode`	необязательная строка	Код страны.
`Country`	необязательная строка	Название страны.
`ZIP`	необязательная строка	Почтовый индекс.
`State`	необязательная строка	Название штата или аббревиатура.
`City`	необязательная строка	Название города.
`Municipality`	необязательная строка	Название муниципалитета.
`SubLocality`	необязательная строка	Название района или района.
`Street`	необязательная строка	Название улицы

Образец данных

{
  "id": "2cf6a837304d6614",
  "data_type": "contact",
  "first_name": "John",
  "middle_name": "'Gala'",
  "last_name": "Appleseed",
  "prefix": "Mr.",
  "suffix": "Jr.",
  "nickname": "John'o",
  "records": [
    {
      "type": "Phone",
      "name": "MAIN",
      "value": "1-800-MY-APPLE"
    },
    {
      "type": "Phone",
      "name": "UK",
      "value": "0800 039 1010"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com/uk/"
    },
    {
      "City": "Cupertino",
      "State": "CA",
      "ZIP": "95014",
      "name": "WORK",
      "CountryCode": "US",
      "Country": "United States",
      "Street": "1 Infinite Loop",
      "type": "Address",
      "SubLocality": null,
      "Municipality": null
    }
  ],
  "organisation": "Apple Inc.",
  "department": "Marketing",
  "jobtitle": "VP Juicing",
  "birthday": "1976-04-01"
}

Вызов

Атрибуты

название	тип	описание
`id`	строка	Идентификатор товара
`data_type`	строка всегда `call`	Идентификатор типа данных элемента.
`call_type`	строка	Один из: `Phone` , `FaceTime Video` , `FaceTime Audio` .
`address`	строка	Цель звонка. Это может быть номер телефона, Apple ID или другой идентификатор.
`duration`	поплавок	Продолжительность звонка.
`answered`	BOOL	Ответили ли на звонок.
`from_me`	BOOL	Был ли звонок исходящим или входящим.
`date`	Дата и время	Когда был сделан звонок.

Образец данных

{
  "id": "24116c5b16b85217",
  "data_type": "call",
  "call_type": "Phone",
  "address": "07123456789",
  "duration": 5.131359,
  "answered": false,
  "from_me": true,
  "date": "2015-07-20 10:23:27.538011"
}

Событие

атрибуты event

название	тип	описание
`id`	строка	Идентификатор товара
`data_type`	строка, всегда `event`	Идентификатор типа данных элемента.
`unique_identifier`	необязательная строка	UID элемента для дедупликации между несколькими источниками данных событий.
`calendar`	необязательная строка	Название календаря
`calendar_uid`	необязательная строка	UID календаря.
`calendar_store`	необязательная строка	Тип хранилища календаря, т.е. `iCloud` , по `Default` .
`summary`	необязательная строка	Краткое изложение события или заголовок.
`description`	необязательная строка	Описание события.
`start_date`	необязательная дата и время	Когда событие начинается.
`end_date`	необязательная дата и время	Когда событие заканчивается.
`start_time_zone`	необязательная строка	Часовой пояс `start_date` .
`end_time_zone`	необязательная строка	Timeone из `end_date` .
`all_day`	логический	Длится ли событие целый день.
`travel_time`	необязательная продолжительность	Продолжительность путешествия по событию.
`recurrence`	необязательный вложенный `event.recurrence`	Настройки повторения события.
`location`	необязательная строка	Где событие происходит.
`start_location`	необязательная строка	Откуда начинается мероприятие.
`attendees`	необязательный список строк	Имена участников мероприятия.
`attached_url`	необязательная строка	URL-адрес, связанный с событием.
`creation_date`	необязательная дата и время	Когда событие было создано. Не устанавливается, если запись календаря по умолчанию, например, праздничные дни.

атрибуты event.recurrence

название	тип	описание
`interval`	целое число	Количество `repeat` повторяется, т. Е. 1 раз в год (один раз в 1 год).
`repeat`	строка	Один из: `OneTime` , `Daily` , `Weekly` , `Monthly` , `Yearly` .
`repeat_end_date`	необязательная дата и время	Когда прекратить повторяться.

Образец данных

{
  "id": "3",
  "unique_identifier": "f5fcf872-34f6-3f60-ba03-74d5a7a3bbbb",
  "calendar": "Home",
  "calendar_id": "477a2001537fe178d6b77cdceb8bac2e",
  "calendar_store": "Default",
  "summary": "Christmas Day",
  "description": "Bank holiday in the UK",
  "start_date": "2017-12-25T00:00:00.000000",
  "end_date": "2017-12-25T23:59:59.000000",
  "start_time_zone": None,
  "end_time_zone": None,
  "all_day": True,
  "travel_time": None,
  "recurrence": {
    "interval": 1,
    "repeat": "Yearly",
    "repeat_end_date": None,
    "specifier": ""
  },
  "location": None,
  "start_location": None,
  "attendees": ["John Appleseed"],
  "attached_url": None,
  "creation_date": None
}

Запись

{
  "title": "Monday meeting:",
  "note": "Monday meeting:\n Discuss X,\n discuss Y.",
  "summary": null,
  "folder": "icloud",
  "sub_folder": "work",
  "attachments": [
    {
      "type": "image",
      "file_id": "8e22cf6e524357b4eb3da775d193072ebba9543f",
      "file_path": "Media/80DDDEAD-B33F-37B2-7219432C0359/Image.jpeg"
    }
  ],
  "creation_date": "2016-06-06 13:23:20.000000",
  "last_modified": "2016-06-07 15:21:25.000000"
}

Посещение

Запись о посещении веб-сайта.

Атрибуты

имя	тип	описание
`data_type`	строка, всегда `visit`	Идентификатор типа данных элемента.
`url`	строка	URL посещенной страницы.
`title`	строка	Заголовок посещенной страницы.
`date_created`	Дата и время	Когда визит произошел.

{
  "data_type": "visit",
  "url": "https://reincubate.com/",
  "title": "Reincubate: the app data company",
  "date_created": "2020-01-01T00:00:00.000000Z"
}

'name': self.name, 'creation_date': creation_date, 'expiry_date': expiry_date, 'domain': self.domain, 'flags': self.flags, 'path': self.path, 'value': self. ценность,

печенье

HTTP-cookie.

Атрибуты

название	тип	описание
`data_type`	строка, всегда `cookie`	Идентификатор типа данных элемента.
`name`	строка	Имя печенья.
`value`	строка	Значение куки.
`domain`	строка	Спецификатор домена cookie.
`path`	строка	Спецификатор пути cookie.
`flags`	строка	Любые флаги, установленные на куки.
`creation_date`	Дата и время	Когда печенье было создано.
`expiry_date`	Дата и время	Когда срок действия файла cookie истекает.

{
  "data_type": "cookie",
  "name": "sample_cookies",
  "value": "sample_value",
  "domain": "reincubate.com",
  "path": "/",
  "flags": "",
  "creation_date": "2020-01-01T00:00:00.000000Z",
  "expiry_date": "2020-01-01T00:00:00.000000Z"
}

Расположение

Атрибуты данных

название	тип	описание
`data_type`	строка, всегда `location`	Идентификатор типа данных.
`latitude`	поплавок	Координата широты местоположения.
`longitude`	поплавок	Координата долготы местоположения.
`altitude`	поплавок	Высотная координата местоположения.
`horizontal_accuracy`	поплавок	Горизонтальная точность измерения.
`vertical_accuracy`	поплавок	Вертикальная точность измерения.
`position_type`	строка	Идентификатор используемого метода измерения.
`date_created`	Дата и время	Когда измерение было сделано.

Образец данных

{
  "data_type": "location",
  "latitude": 51.507452392689146,
  "longitude": -0.07398372304584414,
  "altitude": 0.0,
  "horizontal_accuracy": 65.0,
  "vertical_accuracy": 0.0,
  "positioning_type": "Wifi",
  "date_created": "2020-01-01T00:00:00.000000Z"
}

Результат полезной нагрузки

Метаданные

файл

Образ

видео

Сообщение

разговор

контакт

Вызов

Событие

Запись

Посещение

печенье

Расположение

Как мы можем помочь?