世論調査

ポーリングリソースには、データに対する特定の要求に関する情報が含まれています。ポーリングが作成されると、リクエストを完了するために1つ以上のタスクの作成がトリガーされます。

属性

タスク

ポーリングリソースの最も重要な役割は、関連するタスクの進行状況を反映し、エンドユーザーが結果が利用可能になり次第、結果を取得できるようにすることです。したがって、ポーリングリソースは、タスクに関連する属性を公開します。関連するタスクは、その状態によって分類されます。

結果

投票内で実行されているタスクによって発行された結果は、投票のresults属性に表示されます。これにより、投票が完了する前に結果を利用できます。

エラー

投票内で実行されているタスクによって発生したエラーは、投票のerrors属性に表示されます。

州

ポーリングの状態は、ポーリングが初期化を待っている（ pending ）、進行中（ processing ）、またはすべてのタスクが実行を終了した（ completed ）のいずれかを反映するだけです。

投票は、それに関連したタスク以外のエラー状態を反映しません。

ペイロード

ポーリングペイロードは、取得する必要がある情報の種類、データ型、およびファイルを示します。ポーリングペイロード属性スキーマについては、以下で説明します。

たとえば、iCloudアカウントソースのすべてのタイプの情報を取得するためのポーリングペイロードは次のようになります。

{
  "info_types": ["*"]
}

特定の日付からのみ、iCloudバックアップまたはReincubate Relayソースからさまざまなメッセージングデータを取得するには：

{
  "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"],
  "filters": {
    "since": "2019-09-15T22:04:12Z",
    "until": "2021-06-02T12:00:00Z"
  }
}

iCloudフォトライブラリの結果で参照される画像のファイルデータを取得するには：

{
  "files": ["icpl://xyz123", "icpl://abc321"]
}

異なる属性を同時に使用することもできます。

{
  "info_types": ["*"],
  "data_types": ["ios_phone.calls"]
}

フィルター

フィルターを使用すると、クライアントは返されるデータの量を、関心があると思われるデータのみに減らすことができます。たとえば、SMS データのポーリングをフィルターして、先月のデータのみに絞り込むことができます。

サブスクリプション ポーリング ペイロードのフィルター

サブスクリプションを使用して定期的なポーリングを生成する場合、ポーリング ペイロードに設定されたフィルターは、サブスクリプションの最初のポーリングでのみ使用されます。その後、API は次のことを行います。

• 同じ間隔を繰り返し再ポーリングすることを避けるため、 untilの値はすべて無視されます。
• untilが設定されている場合、次のポーリングではその時点以降のデータが取得されます。
• untilが設定されていない場合、次のポーリングでは最初のポーリング転送の時点からデータがフェッチされます (つまり、API は通常どおり段階的にポーリングします)。

データレベルのフィルター

phone_numbersやemail_addressesなどのデータ レベルのフィルターは、処理されたデータを自分に関連する項目のみに絞り込むのに役立ちます。これらは、フィルターのリスト内の値の 1 つに一致する別の項目と一致しないデータ項目、またはそれに関連するデータ項目を削除する組み込みフィルターです。たとえば、以下のペイロードを考えてみましょう。

{
  "data_types": ["ios_messages.messages"],
  "filters": {
    "phone_numbers": ["0123456789"],
    "email_addresses": ["test@example.com"]
  }
}

これにより、グループ会話を含む、指定された電話番号または電子メール アドレスが関与する会話に関連するすべてのメッセージが iOS メッセージから返されます。多くの連絡先には電話番号と、メッセージの iCloud アカウントなどの電子メールで識別されるアカウントが混在しているため、フィルタリングする複数の値を指定すると便利です。

Exclusion-based filters, like exclude_phone_numbers and exclude_email_addresses, do the opposite: removing any data that relates to the values provided. If both inclusion- and exclusion-based filters are provided, and an item relates to both, then the exclusion-based filter wins. For example, a group conversation that contains one contact with an included email address but also another contact with an excluded phone number will get filtered out of the data.

POST /polls作成する

特定のセッションに対するデータのポーリングを作成します。

sourceパラメータは、セッションのプライマリソースの子ソースを対象とする場合にのみ使用してください。たとえば、 rirelay.sourceからデータを取得する場合、 sourceパラメータはそのソースのIDである必要があります。

cURLを使う

curl https://ricloud-api.reincubate.com/polls \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "payload": {
    "info_types": ["*"]
  }
}'

ricloud-pyを使う

import ricloud

poll_payload = {
  'info_types': ['*'],
}

poll = ricloud.Poll.create(
  session='<session ID or ricloud.Session instance>',
  payload=poll_payload,
)

サンプル応答

{
  "id": "54554389-5f1a-4ccf-9bb8-024a031cf948",
  "resource": "poll",
  "organisation": 1,
  "key": 1,
  "user": 1,
  "source": 1,
  "session": "f5a7a7ef-ff21-47fe-9aa6-7ebd08123623",
  "subscription": null,
  "tasks_pending": [],
  "tasks_processing": [],
  "tasks_succeeded": [],
  "tasks_failed": [],
  "tasks_suspended": [],
  "results": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/results"
  },
  "errors": {
    "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/errors"
  },
  "state": "pending",
  "date_created": "2020-02-20T11:59:14.694337Z",
  "date_started": null,
  "date_completed": null
}

GET /polls/{poll ID}取得してください

cURLを使う

curl https://ricloud-api.reincubate.com/polls/<poll ID> \
  -H 'Authorization: Token <your key_token>'

ricloud-pyを使う

import ricloud

poll = ricloud.Poll.retrieve(<poll ID>)

GET /pollsリスト

cURLを使う

curl https://ricloud-api.reincubate.com/polls \
  -H 'Authorization: Token <your key_token>'

ricloud-pyを使う

import ricloud

polls = ricloud.Poll.list()

変更ログ

2024-12-09

• exclude_phone_numbersおよびexclude_emailsポーリング ペイロード パラメータを使用して、特定の連絡先の電子メール アドレスと電話番号に関連するデータを除外するためのサポートを追加します。

2023-11-28

• phone_numbersおよびemailsポーリング ペイロード パラメータを介して連絡先の電子メール アドレスと電話番号を使用してデータをフィルタリングするためのサポートを追加します。

2022-07-08

• ポーリング ペイロードのuntilフィルターのサポートが SMS 抽出に追加されました。これは、 sinceフィルターを補完し、クライアントがデータを取得する正確な日時範囲を指定できるようにします。

2020-05-05

• errors属性が投票オブジェクトに追加されました。これは、投票に関連付けられたエラーオブジェクトを含むネストされたリストオブジェクトです。

2020-02-20

• Major ：pollオブジェクトのresults属性は、単純なリスト属性ではなく、ネストされたリストオブジェクトになりました。これにより、投票が多数の結果を公開するときに、結果にページ番号を付けることができます。

2019-10-16

• subscriptionによってポーリングがトリガーされたかどうかを示すために、 subscription属性をポーリングオブジェクトに追加します。

2019-06-01

• ポーリングオブジェクトのpayload属性は、複数の操作タイプで構成できるようになりました。これは、ペイロードのinfo-types 、 data-types 、およびfilesまたはすべてを使用してポーリングを作成できることを意味しfiles 。
• Major構成可能なポーリングペイロードのために、pollオブジェクトのtype属性は非推奨になりました。