WebhooksClient

サブモジュール

• xdk.webhooks.client モジュール
  • WebhooksClient
    • WebhooksClient.__init__()
    • WebhooksClient.create()
    • WebhooksClient.create_stream_link()
    • WebhooksClient.create_webhook_replay_job()
    • WebhooksClient.delete()
    • WebhooksClient.delete_stream_link()
    • WebhooksClient.get()
    • WebhooksClient.get_stream_links()
    • WebhooksClient.validate()
• xdk.webhooks.models モジュール
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • CreateStreamLinkResponse
    • CreateStreamLinkResponse.model_config
  • CreateWebhookReplayJobRequest
    • CreateWebhookReplayJobRequest.model_config
  • CreateWebhookReplayJobResponse
    • CreateWebhookReplayJobResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • DeleteStreamLinkResponse
    • DeleteStreamLinkResponse.model_config
  • GetResponse
    • GetResponse.model_config
  • GetStreamLinksResponse
    • GetStreamLinksResponse.model_config
  • ValidateResponse
    • ValidateResponse.model_config

モジュールの内容

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

class xdk.webhooks.WebhooksClient

Webhook 操作用の Client クラス

パラメータ

path.client · Client

__init__

パラメータ

path.client · Client

create

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

パラメータ

body.body · CreateRequest

create_stream_link

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

Parameters

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"

表示するメディアのフィールドを、カンマ区切りのリストで指定します。

path.poll_fields · str or None · デフォルト: "None"

表示する投票のフィールドを、カンマ区切りのリストで指定します。

path.user_fields · str or None · デフォルト: "None"

表示するユーザーのフィールドを、カンマ区切りのリストで指定します。

path.place_fields · str or None · デフォルト: "None"

表示する場所のフィールドを、カンマ区切りのリストで指定します。

戻り値

CreateStreamLinkResponse - レスポンスデータ

create_webhook_replay_job

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

パラメータ

body.body · CreateWebhookReplayJobRequest

delete

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

パラメータ

path.webhook_id · Any

削除する webhook の ID。

戻り値

DeleteResponse - レスポンスデータ

delete_stream_link

ストリーム リンクを削除する FilteredStream イベントと指定した webhook 間のリンクを削除します。

パラメーター

path.webhook_id · Any

FilteredStream のルールセットに関連付ける webhook の識別子 (id) です。

戻り値

DeleteStreamLinkResponse - レスポンスデータ

get

Webhook の取得 クライアント App に関連付けられた webhook 設定のリストを取得します。

パラメーター

path.webhook_config_fields · List or None · デフォルト: "None"

表示する WebhookConfig フィールドをカンマ区切りで指定するリストです。

戻り値

GetResponse - レスポンスデータ

get_stream_links

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

戻り値

GetStreamLinksResponse

validate

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

パラメーター

path.webhook_id · Any

検証する webhook の ID。

戻り値

ValidateResponse - レスポンスデータ