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

AccountActivityClient

クラス 継承元: object アカウントアクティビティ関連の操作を行う 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 の ID です。

戻り値

ValidateSubscriptionResponse - レスポンスデータ