Datatypen

Resultaten die voor enquêtes van het data
geretourneerd aan de API, retourneren informatie in een van de onderstaande indelingen.
Resultaat laadvermogen
attributen
De rootstructuur van de data-JSON-payload heeft de volgende kenmerken.
naam | type | Beschrijving |
---|---|---|
data | lijst met gegevensobjecten | De gegevens opgehaald uit de bron. |
metadata | metadata-object | Metadata gerelateerd aan data . |
Metadata
attributen
naam | type | Beschrijving |
---|---|---|
count | int | Het aantal objecten in data . |
het dossier
De file
datatype wordt gezien gedurende de API, want het is een verwijzing naar een bestand dat van de API kan worden gedownload via een files
soort poll.
attributen
naam | type | Omschrijving |
---|---|---|
id | draad | ID die wordt gebruikt om het bestand aan te vragen bij de API. De waarde is alleen gegarandeerd uniek in het bereik van de huidige bron. |
data_type | string, altijd file | Specificatie van gegevenstype. |
name | draad | De naam van het bestand, exclusief de extensie. |
extension | string, optioneel | De extensie van het bestand indien beschikbaar. |
mime_type | string, optioneel | Het MIME-type van het bestand indien beschikbaar. |
size | int, optioneel | De grootte van het bestand indien beschikbaar. |
checksum | string, optioneel | De md5-controlesom, indien beschikbaar. |
Voorbeeld
{ "id": "abc123", "data_type": "file", "name": "IMG_0003", "extension": "jpg", "mime_type": "image/jpeg", "size": 2505426, }
Beeld
Breidt bestand uit .
naam | type | Omschrijving |
---|---|---|
filename | draad | De oorspronkelijke bestandsnaam van het bestand. De extensie in deze bestandsnaam moet overeenkomen met de extensie van het bestand. |
filepath | draad | Het pad van het bestand ten opzichte van andere bestanden binnen de service. Bijvoorbeeld het pad binnen een backup. |
width | int, optioneel | De breedte van het bestand indien beschikbaar. |
height | int, optioneel | De hoogte van het bestand indien beschikbaar. |
Voorbeeld
{ "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
Breidt bestand uit .
naam | type | Omschrijving |
---|---|---|
filename | draad | De oorspronkelijke bestandsnaam van het bestand. De extensie in deze bestandsnaam moet overeenkomen met de extensie van het bestand. |
filepath | draad | Het pad van het bestand ten opzichte van andere bestanden binnen de service. Bijvoorbeeld het pad binnen een backup. |
width | int, optioneel | De breedte van het bestand indien beschikbaar. |
height | int, optioneel | De hoogte van het bestand indien beschikbaar. |
duration | int, optioneel | De lengte van de video indien beschikbaar. |
Voorbeeld
{ "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 }
Bericht
attributen
naam | type | Omschrijving |
---|---|---|
id | draad | Een unieke ID voor het bericht. Gebruik dit om de geretourneerde gegevens indien nodig te ontdubbelen. |
data_type | string, altijd message | Specificatie van gegevenstype. |
conversation_id | draad | ID die berichten groepeert op basis van een gesprek. |
handle | draad | De 2e partij van het gesprek. |
type | string, optioneel | Wordt gebruikt wanneer een berichtenservice verschillende berichttypen verwerkt. Bijvoorbeeld SMS en iMessage in het geval van iOS-berichten. |
text | draad | Het lichaam van het bericht. |
from_me | bool | Of het bericht is verzonden of ontvangen. |
attachments | lijst met bestanden, optioneel | Een array met file_id waarden die kunnen worden gebruikt met de methode download_file . Als het bericht geen bijlage bevat, wordt een lege array geretourneerd. |
group_handles | lijst met strings, optioneel | Deze waarde is null voor berichten van persoon tot persoon en in groepsgesprekken is een reeks tekenreeksen die telefoonnummers of iMessage-e-mailadressen vertegenwoordigen. |
group | string, optioneel | De naam van de groep op het moment dat het bericht werd verzonden . |
group_id | string, optioneel | De unieke ID voor de groep binnen de context van die app. Dit is mogelijk geen geheel getal en geeft, indien aanwezig, alleen informatie naast conversation_id . |
group_contacts | string, optioneel | Een array van objecten die verwijzen naar iOS-contactpersonen in de groep. |
user | string, optioneel | De gebruiker van de berichten-app in het geval dat meerdere gebruikers / accounts mogelijk een berichten-app van het apparaat gebruiken. |
deleted | bool, optioneel | Een Booleaanse waarde om aan te geven of het bericht was verwijderd. |
date | datum Tijd | Wanneer het bericht is verzonden of ontvangen. |
contact | genest contact, optioneel | Een object dat verwijst naar een iOS-contact van de tweede partij van het gesprek. |
Voorbeeld
{ "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" }
Gesprek
Een gespreksdraad.
naam | type | Omschrijving |
---|---|---|
id | draad | Item ID. |
data_type | string, altijd conversation | Gegevenstype item-ID. |
group | optionele string | Naam van de groep. |
members | lijst met contact | Deelnemers aan het gesprek. |
Contact
contact
naam | type | Omschrijving |
---|---|---|
id | draad | Item ID. |
data_type | string, altijd contact | Gegevenstype item-ID. |
name | optionele string | De volledige naam van de contactpersoon. |
first_name | optionele string | Voornaam van de contactpersoon. |
middle_name | optionele string | De middelste naam van de contactpersoon. |
last_name | optionele string | Achternaam van de contactpersoon. |
prefix | optionele string | Het voorvoegsel van de contactpersoon. |
suffix | optionele string | Het achtervoegsel van de naam van de contactpersoon. |
nickname | optionele string | De bijnaam van de contactpersoon. |
records | lijst met contact.record items | Contactrecords die aan de contactpersoon zijn gekoppeld. |
organisation | optionele string | De naam van de contactpersoon. |
department | optionele string | De contactafdeling binnen de organisatie. |
jobtitle | optionele string | De functie van de contactpersoon binnen de organisatie. |
birthday | optionele datum | De verjaardag van de contactpersoon. |
contact.record
attribuut
Er zijn 5 soorten contactrecorditems: Phone
, Email
, URL
, Social
en Address
. Ze komen overeen met respectievelijk een telefoonnummer, e-mailadres, website-URL, accountafhandeling op sociale media en adres.
De eerste 4 hebben dezelfde kenmerken:
naam | type | Omschrijving |
---|---|---|
type | draad | Een van: Phone , Email , URL , Social . |
name | optionele string | Het label dat aan de record is gekoppeld. |
value | draad | De waarde van het record. |
Het Address
heeft extra adresvelden:
naam | type | Omschrijving |
---|---|---|
type | string, altijd Address | Een telefoonnummerrecord. |
name | optionele string | Het label dat bij het nummer hoort. |
CountryCode | optionele string | Een landcode. |
Country | optionele string | Een landnaam. |
ZIP | optionele string | Een postcode of postcode. |
State | optionele string | Een staatsnaam of afkorting. |
City | optionele string | Een plaatsnaam. |
Municipality | optionele string | Een gemeente naam. |
SubLocality | optionele string | Een buurt- of gebiedsnaam. |
Street | optionele string | Een straatnaam. |
Voorbeeldgegevens
{ "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" }
Bel
attributen
naam | type | Omschrijving |
---|---|---|
id | draad | Item ID. |
data_type | string, altijd call | Gegevenstype item-ID. |
call_type | draad | Een van: Phone , FaceTime Video , FaceTime Audio . |
address | draad | Het doel van de oproep. Dit kan een telefoonnummer, Apple ID of een andere ID zijn. |
duration | vlotter | De duur van het gesprek. |
answered | bool | Of de oproep is beantwoord. |
from_me | bool | Of de oproep uitgaand of inkomend was. |
date | datum Tijd | Toen de oproep werd gedaan. |
Voorbeeldgegevens
{ "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" }
Evenement
event
naam | type | Omschrijving |
---|---|---|
id | draad | Item ID. |
data_type | string, altijd event | Gegevenstype item-ID. |
unique_identifier | optionele string | Item-UID voor ontdubbeling over meerdere gebeurtenisgegevensbronnen. |
calendar | optionele string | Kalender naam. |
calendar_uid | optionele string | Agenda-UID. |
calendar_store | optionele string | Type kalenderopslag, dwz iCloud , Default . |
summary | optionele string | Het evenementoverzicht of de titel. |
description | optionele string | De evenementbeschrijving. |
start_date | optionele datetime | Wanneer het evenement begint. |
end_date | optionele datetime | Als het evenement is afgelopen. |
start_time_zone | optionele string | De tijdzone van start_date . |
end_time_zone | optionele string | De tijd van end_date . |
all_day | boolean | Of het evenement een hele dag duurt. |
travel_time | optionele duur | De reistijd van het evenement. |
recurrence | optioneel genest event.recurrence | De herhalingsinstellingen van de gebeurtenis. |
location | optionele string | Waar het evenement plaatsvindt. |
start_location | optionele string | Waar het evenement begint. |
attendees | optionele lijst met strings | Namen van deelnemers aan het evenement. |
attached_url | optionele string | Een URL die aan het evenement is gekoppeld. |
creation_date | optionele datetime | Wanneer de gebeurtenis is gemaakt. Niet ingesteld als standaard agenda-item, zoals op feestdagen. |
event.recurrence
attributen
naam | type | Omschrijving |
---|---|---|
interval | geheel getal | Het aantal repeat tot herhaling op, dwz 1 jaarlijks (eenmaal per 1 jaar). |
repeat | draad | Een van: OneTime , Daily , Weekly , Monthly , Yearly . |
repeat_end_date | optionele datetime | Wanneer u moet stoppen met terugkeren. |
Voorbeeldgegevens
{ "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 }
Notitie
{ "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" }
Bezoek
Een record van een bezoek aan een websitepagina.
attributen
naam | type | Omschrijving |
---|---|---|
data_type | string, visit altijd | Gegevenstype item-ID. |
url | draad | De URL van de bezochte pagina. |
title | draad | De titel van de bezochte pagina. |
date_created | datum Tijd | Wanneer het bezoek plaatsvond. |
{ "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. waarde,
Koekje
Een HTTP-cookie.
attributen
naam | type | Omschrijving |
---|---|---|
data_type | string, altijd cookie | Gegevenstype item-ID. |
name | draad | De naam van de cookie. |
value | draad | De waarde van de cookie. |
domain | draad | Het domein van de cookie. |
path | draad | Het pad van de cookie. |
flags | draad | Eventuele vlaggen op de cookie. |
creation_date | datum Tijd | Toen de cookie werd aangemaakt. |
expiry_date | datum Tijd | Wanneer de cookie verloopt. |
{ "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" }
Plaats
Data attributen
naam | type | Omschrijving |
---|---|---|
data_type | string, altijd location | Een gegevenstype-ID. |
latitude | vlotter | De breedtegraadcoördinaat van de locatie. |
longitude | vlotter | De lengtegraadcoördinaat van de locatie. |
altitude | vlotter | De hoogtecoördinaat van de locatie. |
horizontal_accuracy | vlotter | De horizontale nauwkeurigheid voor de meting. |
vertical_accuracy | vlotter | De verticale nauwkeurigheid voor de meting. |
position_type | draad | Identificatiecode voor de gebruikte meetmethode. |
date_created | datum Tijd | Wanneer de meting is uitgevoerd. |
Voorbeeldgegevens
{ "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" }