メインコンテンツへスキップ

​
サブモジュール

​
モジュールの内容

このモジュールは X API の activity エンドポイント群へのアクセスを提供し、 activity に関連するすべての機能に対するメインのエントリポイントとなります。

​
class xdk.activity.ActivityClient

アクティビティ操作を行うためのストリーミング Client

​
パラメータ

​
path.client
Client

​
__init__

​
パラメーター

​
path.client
Client

​
create_subscription

X アクティビティのサブスクリプションを作成 X アクティビティイベントのサブスクリプションを作成します body: リクエストボディ :returns: レスポンスデータ :rtype: CreateSubscriptionResponse

​
パラメータ

​
body.body
CreateSubscriptionRequest

​
delete_subscription

X アクティビティのサブスクリプションを削除します X アクティビティイベント用のサブスクリプションを削除します

​
パラメーター

​
path.subscription_id
Any
削除対象のサブスクリプションのID。

​
戻り値

DeleteSubscriptionResponse - レスポンスデータ

​
get_subscriptions

X アクティビティのサブスクリプションを取得する XAA の有効なサブスクリプション一覧を取得します :戻り値: レスポンスデータ :rtype: GetSubscriptionsResponse

​
戻り値

GetSubscriptionsResponse

​
stream

アクティビティストリーム (ストリーミング) Xアクティビティのストリーム これは、データが利用可能になり次第リアルタイムで提供するストリーミングエンドポイントです。 出力される各項目は、ストリームからの単一のデータポイントを表します。 接続は指数バックオフ方式のリトライロジックによって自動的に管理されます。 ストリームが切断された場合でも、SDKが利用者側の操作なしに自動で再接続します。

​
Parameters

​
path.backfill_minutes
int or None
デフォルト:"None"
リクエストするバックフィルの分数。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。ポストラベルが提供される最も早い UTC のタイムスタンプ。
​
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。ポストラベルが提供される最も遅い UTC のタイムスタンプ。
​
path.stream_config
StreamConfig
再試行動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
update_subscription

X アクティビティサブスクリプションの更新 X アクティビティイベントのサブスクリプションを更新します

​
パラメーター

​
path.subscription_id
Any
更新対象のサブスクリプションのID。
​
body.body
UpdateSubscriptionRequest
リクエストボディ