世論調査

更新しました

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

属性

タイプ説明
id 投票ID リソース識別子
resource 文字列、常にpoll リソースタイプ指定子
organisation 組織ID このリソースに関連付けられている組織。
key キーID このリソースに関連付けられているキー。
user ユーザーID このリソースに関連付けられているユーザー。
source ソースID 投票がターゲットにしているソース。これはセッションのソースの子ソースになることができます。
session セッションID ポーリングが使用しているセッション。
subscription オプションのサブスクリプションID 関連するサブスクリプションオブジェクトID(該当する場合)。
tasks_pending タスクIDのリスト処理を待っている投票に関連したタスク。
tasks_processing タスクIDのリスト処理中の投票に関連したタスク。
tasks_succeeded タスクIDのリスト成功したポーリングに関連するタスク。
tasks_failed タスクIDのリスト失敗したポーリングに関連するタスク。
tasks_suspended タスクIDのリスト中断されたポーリングに関連するタスク。
results 結果オブジェクトのリスト投票のタスクによって生成された結果オブジェクトのリスト。
state ひも pendingprocessingcompletedです。
date_created 日付時刻リソースが作成されたとき
date_started オプションの日時投票の処理が開始されたとき。
date_completed オプションの日時ポーリングの処理が終了したとき。

タスク

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

結果

投票内で実行されているタスクによって公開された結果は、投票のresults属性に表示されます。

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

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

ペイロード

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

タイプ説明
info_types info_typeオブジェクトのリスト取得する情報タイプを指定します。ワイルドカード*をサポートします。
data_types data_typeオブジェクトのリスト取得するデータ型を指定します。
files file IDのリスト。 取得するファイルを指定します。
filters ネストされたfiltersオブジェクト取得したデータに適用するフィルターを指定します。

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

{
  "info_types": ["*"]
}

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

{
  "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"],
  "filters": {
    "since": "2019-09-15T22:04:12Z"
  }
}

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

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

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

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

POST /polls作成する

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

セッションリソースはすでに特定のソースに直接関連付けられているため、 sourceパラメータを指定する必要はありません。しかしながら、ポーリングがセッションが結び付けられている一次ソースの子ソースをターゲットとするように指定することを提供することができる。たとえば、iCloudサービスでは、セッションはiCloudアカウントソース(iCloudサービスのプライマリソース)に対してのみ作成できますが、特定のiCloudバックアップ(iCloudアカウントの子ソース)からのデータのみを提供できますID

タイプ説明
key オプション、キーID 必要に応じて、この投票に使用されたキーを上書きします。これは、ユーザーに新しい機能を試してもらうときに役立ちます。
source オプション、ソースID オプションで、セッションにリンクされたソースの子ソースをターゲットにします。
session セッションID データ取得を認証するために使用されるセッション。
payload ネストされたポーリングペイロードポーリングの指定に使用されるポーリングペイロード

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,
)

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リスト

タイプ説明
key キーID 関連付けられているキーでフィルタします。これは、その時点でユーザーが使用していたキーです。
user ユーザーID 関連付けられたユーザーでフィルタします。
source ソースID ターゲットソースでフィルタリングします。
session セッションID ターゲットセッションでフィルタリングします。
subscription サブスクリプションID 関連付けられたサブスクリプションでフィルタリングします。
state ひもセッション状態でフィルタリングします。
date_created 日時フィルターリソースがいつ作成されたかによってフィルタします。
date_started 日時フィルターポーリングがいつ開始されたかでフィルターします。
date_completed 日時フィルター投票が終了したときにフィルタをかけます。

cURLを使う

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

ricloud-pyを使う

import ricloud

polls = ricloud.Poll.list()

どのように我々は助けることができます?

サポートチームがお手伝いします!

営業時間は月曜日から金曜日の午前9時から午後5時(GMT)です。 時間は現在 1:11 PM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

サポートセクションに移動 › エンタープライズチームに連絡する ›
私たちの素晴らしいサポートチーム

© 2008 - 2019 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. Reincubate®は登録商標です。 プライバシーと利用規約. マルチファクタ認証をお勧めします。 ロンドンで愛と建てられた。