数据类型

更新

针对API返回的data类型民意调查结果将返回下面列出的格式之一的信息。

结果有效载荷

属性

数据JSON有效负载的根结构具有以下属性。

名称类型描述
data 数据对象列表从源检索到的数据。
metadata 元数据对象与数据相关的元data

元数据

属性

名称类型描述
count 整型 data的对象数。

File

整个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,
}

Image

Extends file.

名称类型描述
filename string The original file name of the file. The extension in this filename need to match the extension of the file.
filepath string The path of the file relative to other files within its service. For example, the path within a backup.
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,
}

Video

Extends file.

名称类型描述
filename string The original file name of the file. The extension in this filename need to match the extension of the file.
filepath string The path of the file relative to other files within its service. For example, the path within a backup.
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
}

Message

属性

名称类型描述
id 消息的唯一标识符。如有必要,使用此选项对重复数据进行重复数据删
data_type 字符串,总是message 数据类型说明符。
conversation_id 标识符按对话分组消息。
handle 谈话的第二方。
type 字符串,可选在消息传递服务处理各种消息类型时使用。例如,在iOS消息的情况下SMSiMessage
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"
}

Conversation

A conversation thread.

名称类型描述
id string Item ID.
data_type string, always conversation Item data type ID.
group optional string Name of group.
members list of contact items Participants in the conversation.

Contact

contact attributes

名称类型描述
id string Item ID.
data_type string, always contact Item data type ID.
name optional string The contact's full name.
first_name optional string The contact's first name.
middle_name optional string The contact's middle name.
last_name optional string The contact's last name.
prefix optional string The contact's name prefix.
suffix optional string The contact's name suffix.
nickname optional string The contact's nickname.
records list of contact.record items Contact records associated with the contact.
organisation optional string The contact's organisation name.
department optional string The contact's department within the organisation.
jobtitle optional string The contact's job title within the organisation.
birthday optional date The contact's birthday.

contact.record attribute

There are 5 types of contact record items: Phone, Email, URL, Social, and Address. They correspond to a phone number, email address, website URL, social media account handle, and street address, respectively.

The first 4 have the same attributes:

name type description
type string One of: Phone, Email, URL, Social.
name optional string The label associated with the record.
value string The value of the record.

The Address contact record type has additional address fields:

名称类型描述
type string, always Address A phone number record.
name optional string The label associated with the number.
CountryCode optional string A country code.
Country optional string A country name.
ZIP optional string A zip or postal code.
State optional string A state name or abbreviation.
City optional string A city name.
Municipality optional string A municipality name.
SubLocality optional string A neighbourhood or area name.
Street optional string A street address name.

Sample data

{
  "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"
}

Call

属性

名称类型描述
id string Item ID.
data_type string, always call Item data type ID.
call_type string One of: Phone, FaceTime Video, FaceTime Audio.
address string The target of the call. Could be a phone number, Apple ID, or other identifier.
duration float The duration of the call.
answered bool Whether the call was answered.
from_me bool Whether the call was outgoing or incoming.
date datetime When the call was made.

Sample data

{
  "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

event attributes

名称类型描述
id string Item ID.
data_type string, always event Item data type ID.
unique_identifier optional string Item UID for deduplicating across multiple event data sources.
calendar optional string Calendar name.
calendar_uid optional string Calendar UID.
calendar_store optional string Calendar store type, i.e. iCloud, Default.
summary optional string The event summary or title.
description optional string The event description.
start_date optional datetime When the event begins.
end_date optional datetime When the event finishes.
start_time_zone optional string The timezone of start_date.
end_time_zone optional string The timeone of end_date.
all_day boolean Whether the event lasts an entire day.
travel_time optional duration The event's travel time duration.
recurrence optional nested event.recurrence The event's recurrence settings.
location optional string Where the event is taking place.
start_location optional string Where the event is starting from.
attendees optional list of strings Names of event attendees.
attached_url optional string A URL associated with the event.
creation_date optional datetime When the event was created. Not set if default calendar entry, such as public holidays.

event.recurrence attributes

名称类型描述
interval integer The count of repeat to recurr at, i.e. 1 Yearly (once every 1 year).
repeat string One of: OneTime, Daily, Weekly, Monthly, Yearly.
repeat_end_date optional datetime When to stop recurring.

Sample data

{
  "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
}

Note

{
  "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"
}

Visit

A record of a website page visit.

属性

name type description
data_type string, always visit Item data type ID.
url string The URL of the page visited.
title string The visited page's title.
date_created datetime When the visit occurred.
{
  "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.value,

Cookie

A HTTP cookie.

属性

名称类型描述
data_type string, always cookie Item data type ID.
name string The cookie's name.
value string The cookie's value.
domain string The cookie's domain specifier.
path string The cookie's path specifier.
flags string Any flags set on the cookie.
creation_date datetime When the cookie was created.
expiry_date datetime When the cookie expires.
{
  "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"
}

Location

Data attributes

名称类型描述
data_type string, always location A data type identifier.
latitude float The location's latitude coordinate.
longitude float The location's longitude coordinate.
altitude float The location's altitude coordinate.
horizontal_accuracy float The horizontal accuracy for the measurement.
vertical_accuracy float The vertical accuracy for the measurement.
position_type string Identifier for the measurement method used.
date_created datetime When the measurement was made.

Sample data

{
  "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"
}

我们能帮你什么吗?

我们的支持团队在这里提供帮助!

我们的办公时间是格林威治标准时间周一至周五上午9点至下午5点。 时间目前是 6:48 AM的 GMT。

我们力争在一个工作日内答复所有垂询。

转到支持部分 › 联系企业团队 ›
我们的支持团队非常棒

© 2008 - 2020 Reincubate Ltd. 保留所有权利。 在英格兰和威尔士注册 #5189175, VAT GB151788978. Reincubate®是注册商标。 隐私政策 & 条款. 我们推荐多因素认证。 在伦敦建立了爱情。