AccountActivityClient

​

サブモジュール

• xdk.account_activity.client モジュール
  • AccountActivityClient
    • AccountActivityClient.__init__()
    • AccountActivityClient.create_replay_job()
    • AccountActivityClient.create_subscription()
    • AccountActivityClient.delete_subscription()
    • AccountActivityClient.get_subscription_count()
    • AccountActivityClient.get_subscriptions()
    • AccountActivityClient.validate_subscription()
• xdk.account_activity.models モジュール
  • CreateReplayJobResponse
    • CreateReplayJobResponse.model_config
  • CreateSubscriptionRequest
    • CreateSubscriptionRequest.model_config
  • CreateSubscriptionResponse
    • CreateSubscriptionResponse.model_config
  • DeleteSubscriptionResponse
    • DeleteSubscriptionResponse.model_config
  • GetSubscriptionCountResponse
    • GetSubscriptionCountResponse.model_config
  • GetSubscriptionsResponse
    • GetSubscriptionsResponse.model_config
  • ValidateSubscriptionResponse
    • ValidateSubscriptionResponse.model_config

​

モジュール内容

このモジュールは、X API のアカウントアクティビティ系エンドポイントへのアクセスを提供し、アカウントアクティビティ関連機能へのメインエントリポイントとして機能します。

​

class xdk.account_activity.AccountActivityClient

アカウントアクティビティ用の Client

​

パラメータ

path.client · Client

​

__init__

​

パラメータ

path.client · Client

​

create_replay_job

リプレイジョブの作成 指定した webhook に紐づくすべてのサブスクリプションについて、最大過去 5 日分のアクティビティを取得するリプレイジョブを作成します。

​

パラメーター

path.webhook_id · Any

Webhook 設定の一意の識別子。

path.from_date · str

イベントが提供される最も古い (開始) UTC タイムスタンプ (含む) 。形式は yyyymmddhhmm。

path.to_date · str

イベントが提供される最新 (終了) UTC タイムスタンプ (含まない) 。形式は yyyymmddhhmm。

​

戻り値

CreateReplayJobResponse - レスポンスデータ

​

create_subscription

サブスクリプションを作成 対象ユーザーと指定された Webhook に対する Account Activity サブスクリプションを作成します。

​

パラメーター

path.webhook_id · Any

サブスクリプションを確認する対象の webhook ID。

body.body · CreateSubscriptionRequest

リクエストボディ

​

delete_subscription

サブスクリプションを削除 指定された webhook とユーザー id に対する Account Activity のサブスクリプションを削除します。

​

パラメーター

path.webhook_id · Any

サブスクリプション状態を確認する対象の webhook ID。

path.user_id · Any

サブスクリプションを解除するユーザーの ID。

​

戻り値

DeleteSubscriptionResponse - レスポンスデータ

​

get_subscription_count

サブスクリプション数を取得します
現在アクティブな Account Activity サブスクリプションの数を取得します。 :returns: レスポンスデータ :rtype: GetSubscriptionCountResponse

​

戻り値

GetSubscriptionCountResponse

​

get_subscriptions

サブスクリプションの取得 指定した webhook 用の、アクティブなすべてのサブスクリプションのリストを取得します。

​

パラメータ

path.webhook_id · Any

サブスクリプションを取得する webhook の ID です。

​

戻り値

GetSubscriptionsResponse - レスポンスデータ

​

validate_subscription

サブスクリプションの検証 指定された webhook に対して、ユーザーの Account Activity サブスクリプションを検証します。

​

パラメーター

path.webhook_id · Any

サブスクリプションを検証する対象の webhook の webhook ID です。

​

戻り値

ValidateSubscriptionResponse - レスポンスデータ