数据类型
针对API返回的data类型民意调查结果将返回下面列出的格式之一的信息。
结果有效载荷
属性
数据JSON有效负载的根结构具有以下属性。
| 名称 | 类型 | 描述 |
|---|---|---|
data | 数据对象列表 | 从源检索到的数据。 |
metadata | 元数据对象 | 与数据相关的元data 。 |
元数据
属性
| 名称 | 类型 | 描述 |
|---|---|---|
count | 整型 | data的对象数。 |
文件
整个API都可以看到file数据类型,因为它是对可以通过files类型轮询从API下载的文件的引用。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
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 | 串 | 谈话的第二方。 |
type | 字符串,可选 | 在消息传递服务处理各种消息类型时使用。例如,在iOS消息的情况下SMS和iMessage 。 |
text | 串 | 消息的正文。 |
from_me | 布尔 | 消息是发送还是接收。 |
attachments | 文件列表,可选 | file_id值的数组,可以与download_file方法一起使用。如果消息不包含附件,则返回空数组。 |
group_handles | 字符串列表,可选 | 对于人对人消息,此值为null ,而在组对话中,该值是表示电话号码或iMessage电子邮件地址的字符串数组。 |
group | 字符串,可选 | 邮件发送时组的名称。 |
group_id | 字符串,可选 | 该应用程序上下文中组的唯一标识符。这可能不是整数,如果存在,则仅提供conversation_id之外的信息。 |
group_contacts | 字符串,可选 | 引用组中iOS联系人的对象数组。 |
user | 字符串,可选 | 在多个用户/帐户可能正在使用来自设备的消息传递应用程序的情况下,消息传递应用程序的用户。 |
deleted | 布尔,可选 | 一个布尔值,用于指示消息是否已被删除。 |
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 | 串 | 物品ID。 |
data_type | 字符串,总是conversation | 项目数据类型ID。 |
group | 可选字符串 | 组名。 |
members | contact项目列表 | 参加对话。 |
联系
contact属性
| 名称 | 类型 | 描述 |
|---|---|---|
id | 串 | 物品ID。 |
data_type | 字符串,始终contact | 项目数据类型ID。 |
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 。它们分别对应于电话号码,电子邮件地址,网站URL,社交媒体帐户句柄和街道地址。
前四个具有相同的属性:
| 名称 | 类型 | 描述 |
|---|---|---|
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 | 串 | 物品ID。 |
data_type | 字符串,总是call | 项目数据类型ID。 |
call_type | 串 | 其中之一: Phone , FaceTime Video , FaceTime Audio 。 |
address | 串 | 通话目标。可以是电话号码,Apple ID或其他标识符。 |
duration | 浮动 | 通话时间。 |
answered | 布尔 | 是否接听电话。 |
from_me | 布尔 | 呼叫是呼出还是呼入。 |
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 | 串 | 物品ID。 |
data_type | 字符串,总是event | 项目数据类型ID。 |
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 | 可选字符串 | 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 | 项目数据类型ID。 |
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" }
'名称':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 | 项目数据类型ID。 |
name | 串 | Cookie的名称。 |
value | 串 | Cookie的值。 |
domain | 串 | Cookie的域说明符。 |
path | 串 | Cookie的路径说明符。 |
flags | 串 | Cookie上设置的所有标志。 |
creation_date | 约会时间 | Cookie的创建时间。 |
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" }