ソースファイル
Relay サービスには、ポーリングのデータ抽出部分で使用されるソース ファイルを公開する機能が含まれています。たとえば、 ios_messages.messages
のポーリングは、iOS バックアップからsms.db
ファイルを調べてメッセージ データを取得します。ソース ファイルを使用して、 sms.db
ファイル自体が、抽出されたデータおよび関連する添付ファイルと共に返されます。
ソース ファイルの公開を有効にする
ソース ファイルの公開は、そのpoll_payload
属性を介して、または組織全体またはキー レベルの構成を介して、サブスクリプションごとに有効にすることができます。すべて同じ構成キーを使用します: publish_source_files
ソース ファイルの公開を有効にしてサブスクリプションを作成する
curl https://ricloud-api.reincubate.com/subscriptions \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "session": "<session ID>", "source": "<child source ID>", "poll_payload": { "data_types": ["ios_messages.messages"], "publish_source_files": true } }'
組織レベルでのソース ファイルの公開の構成
curl https://ricloud-api.reincubate.com/organisation \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "config": { "publish_source_files": true } }'
上記には、組織の管理者キーが必要です。
キー レベルでのソース ファイルの公開の構成
curl https://ricloud-api.reincubate.com/key \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "config": { "publish_source_files": true } }'
組織全体の構成は、キー レベルの構成によってオーバーライドできます。これは、ソース ファイルが本番環境でのみ使用される場合に役立ちます。同様に、どちらも poll ペイロード パラメーターでオーバーライドできます。これにより、ソース ファイルをケースバイケースで公開するかどうかを指定できます。
組織またはキー構成を介して機能を有効にすると、変更された動作が既存のサブスクリプションにさかのぼって適用されることに注意してください。
ソース ファイルの結果の操作
ソース ファイルの公開が有効になっている場合、API は、抽出プロセスの一部としてアクセスされたファイルを追跡し、それらをストレージ バケットに公開し、現在のポーリングに関連付けられた結果オブジェクトを作成します。
特定のデータ セットに関連するソース ファイルへの参照は、データ結果自体のmetadata
属性に含まれます。例えば:
{ "data": [{ "id": "a1b2c3d4", "data_type": "message", "conversation_id": "w6x7y8z9", "handle": "Pal", "type": "SMS", "text": "Hi, how’s it going?", "attachments": [{ "type": "image", "file_id": "a492be9a8dadabdc774286116232420224f14976", "file_path": "Library/SMS/Attachments/de/14/33A09D66-287E-4B64-A874-1A1234BD7E61/IMG_0006.PNG", "filename": "IMG_0006.PNG" }], "group_handles": [ "Pal", "renate@reincubate.com" ], "from_me": false, "deleted": false, "date": "2020-01-01T00:00:00.000000Z" }], "metadata": { "count": 1, "filters": null, "source_files": [{ "file_id": "3d0d7e5fb2ce288813306e4d4636395e047a3d28", "domain": "HomeDomain", "file_path": "Library/SMS/sms.db", "filename": "sms.db", "size": 123456, "date_last_modified": "2020-01-02T00:00:00.000000Z" }] } }
添付ファイルの結果と同様に、ソース ファイル エントリのfile_id
は、関連する結果のidentifier
属性に対応します。したがって、これはストレージ バケットに書き込まれるファイルの名前でもあります。