データ型
APIに対するdata型ポーリングで返された結果は、以下に概説されている形式のいずれかで情報を返します。
結果ペイロード
属性
データJSONペイロードのルート構造には、次の属性があります。
| 名前 | タイプ | 解説 |
|---|---|---|
data | データオブジェクトのリスト | ソースから取得したデータ。 |
metadata | メタデータオブジェクト | データに関連するメタdata 。 |
メタデータ
属性
| 名前 | タイプ | 解説 |
|---|---|---|
count | int | data内のオブジェクトの数。 |
ファイル
fileデータタイプは、 filesタイプポーリングを通じて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 | ひも | 会話の第二者。 |
type | 文字列、オプション | メッセージングサービスがさまざまな種類のメッセージを処理するときに使用されます。たとえば、iOSメッセージの場合はSMSおよびiMessageです。 |
text | ひも | メッセージの本文 |
from_me | ブール | メッセージが送受信されたかどうか。 |
attachments | ファイルのリスト、オプション | download_fileメソッドで使用できるfile_id値の配列。メッセージに添付ファイルが含まれていない場合は、空の配列が返されます。 |
group_handles | 文字列のリスト、オプション | 個人間メッセージの場合、この値はnullです。グループ会話では、電話番号またはiMessageのEメールアドレスを表すストリングの配列です。 |
group | 文字列、オプション | メッセージが送信された時点のグループの名前。 |
group_id | 文字列、オプション | そのアプリのコンテキスト内のグループの一意の識別子。これは整数ではない可能性があり、存在する場合はconversation_idに加えて情報のみを提供します。 |
group_contacts | 文字列、オプション | グループ内のiOS連絡先を参照するオブジェクトの配列。 |
user | 文字列、オプション | 複数のユーザー/アカウントがデバイスからのメッセージングアプリを使用している可能性がある場合のメッセージングアプリのユーザー。 |
deleted | ブール、オプション | メッセージが削除されたかどうかを示すブール値。 |
date | 日付時刻 | メッセージが送信または受信されたとき |
contact | 入れ子になった連絡先、オプション | 会話の第2者の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属性
連絡先レコードアイテムには、 Phone 、 Email 、 URL 、 Social 、 Address 5種類がありURL 。これらは、それぞれ電話番号、電子メールアドレス、Webサイト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 | ストリング | アイテム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年に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" }
'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 | アイテムのデータタイプID。 |
name | ストリング | クッキーの名前。 |
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" }