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

​
WebhooksClient

クラス 基底クラス: object Webhook 操作用の Client クラス

​
コンストラクタ

​
__init__

​
パラメータ

​
path.client
Client

​
create

Webhook の作成 新しい Webhook 設定を作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateResponse

​
パラメータ

​
body.body
CreateRequest
ストリームリンクを作成 指定した webhook に FilteredStream イベントを配信するためのリンクを作成します。

​
パラメータ

​
path.webhook_id
Any
FilteredStream のルールセットにリンクする webhook ID。
​
path.tweet_fields
str or None
デフォルト:"None"
表示するツイートのフィールドのカンマ区切りリスト。
​
path.expansions
str or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.media_fields
str or None
デフォルト:"None"
表示する Media のフィールドのカンマ区切りリスト。
​
path.poll_fields
str or None
デフォルト:"None"
表示する Poll のフィールドのカンマ区切りリスト。
​
path.user_fields
str or None
デフォルト:"None"
表示する User のフィールドのカンマ区切りリスト。
​
path.place_fields
str or None
デフォルト:"None"
表示する Place のフィールドのカンマ区切りリスト。

​
戻り値

CreateStreamLinkResponse - レスポンスデータ

​
create_webhook_replay_job

Webhook のリプレイジョブを作成します Webhook に対して配信された、または配信を試行したすべてのイベントについて、過去 24 時間以内にさかのぼってイベントを取得するリプレイジョブを作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateWebhookReplayJobResponse

​
パラメータ

​
body.body
CreateWebhookReplayJobRequest

​
delete

Webhook を削除 既存の Webhook 設定を削除します。

​
パラメータ

​
path.webhook_id
Any
削除する webhook の ID。

​
戻り値

DeleteResponse - レスポンスデータ ストリームリンクの削除 FilteredStream イベントと指定した Webhook とのリンクを削除します。

​
パラメーター

​
path.webhook_id
Any
FilteredStream ルールセットと関連付ける webhook の id です。

​
戻り値

DeleteStreamLinkResponse - レスポンスデータ

​
get

Webhook を取得します。 クライアントアプリケーションに関連付けられている webhook 設定の一覧を取得します。

​
Parameters

​
path.webhook_config_fields
List or None
デフォルト:"None"
表示対象の WebhookConfig フィールドをカンマ区切りで指定するリスト。

​
戻り値

GetResponse - レスポンスデータ ストリームリンクを取得 フィルタ済みストリームのルールセットに関連付けられた webhook リンクのリストを取得します。 :returns: レスポンスデータ :rtype: GetStreamLinksResponse

​
戻り値

GetStreamLinksResponse

​
validate

Webhook を検証します。 指定された webhook に対して CRC チェックを実行します。

​
パラメーター

​
path.webhook_id
Any
検証対象の webhook の ID。

​
戻り値

ValidateResponse - レスポンスデータ