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

​
サブモジュール

​
モジュールの内容

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

​
class xdk.stream.StreamClient

ストリーム操作用のストリーミングクライアント

​
パラメータ

​
path.client
Client

​
__init__

​
パラメータ

​
path.client
Client

​
get_rule_counts

ストリームルール数を取得します フィルターされたストリーム用のアクティブルールセットに含まれるルール数を取得します。

​
パラメーター

​
path.rules_count_fields
List or None
デフォルト:"None"
表示する RulesCount フィールドをカンマ区切りで指定します。

​
戻り値

GetRuleCountsResponse - レスポンスデータ

​
get_rules

ストリームルールを取得 フィルタリングされたストリームに対する有効なルールセット全体、またはその一部を取得します。

​
パラメータ

​
path.ids
List or None
デフォルト:"None"
ルールIDのカンマ区切りリスト。
​
path.max_results
int or None
デフォルト:"None"
結果の最大件数。
​
path.pagination_token
str or None
デフォルト:"None"
結果をページネーションするために、前回のリクエストのレスポンスで返された next_token を渡すことで設定される値です。

​
戻り値

IteratorGetRulesResponse

​
labels_compliance

ポストラベルのストリーミング ポストに適用されたすべてのラベル付与イベントをストリーミングします。 これは、データが利用可能になり次第リアルタイムで返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は、指数バックオフを用いたリトライロジックによって自動的に管理されます。 ストリームが切断された場合も、SDK はクライアントからの操作なしに自動で再接続します。

​
パラメーター

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

​
likes_compliance

Likes コンプライアンスデータのストリーミング (Streaming) ユーザーの Likes に関連するすべてのコンプライアンスデータをストリーム配信します。 これは、新しいデータが利用可能になり次第、リアルタイムでデータを返すストリーミングエンドポイントです。 出力される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフ方式の再試行ロジックにより自動的に管理されます。 ストリームが切断された場合、SDK は Client 側での操作なしに自動で再接続します。

​
パラメーター

​
path.backfill_minutes
int or None
デフォルト:"None"
要求するバックフィル対象期間 (分単位) 。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。Likes Compliance イベントが提供される最も早い UTC タイムスタンプ。
​
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。Likes Compliance イベントが提供される最も遅い UTC タイムスタンプ。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
likes_firehose

すべてのLikeをストリーミング (Streaming) 公開されているすべてのLikeをリアルタイムでストリーミングします。 これはストリーミングエンドポイントであり、データが利用可能になり次第リアルタイムで配信します。 配信される各項目は、ストリームからの単一のデータポイントを表します。 接続は指数バックオフのリトライロジックによって自動的に管理されます。 ストリームが切断された場合、SDKはクライアント側での操作なしに自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
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.like_with_tweet_author_fields
List or None
デフォルト:"None"
表示する LikeWithTweetAuthor フィールドのカンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのカンマ区切りリスト。
​
path.tweet_fields
List or None
デフォルト:"None"
表示する Tweet フィールドのカンマ区切りリスト。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、およびコールバックをカスタマイズするためのオプションの StreamConfig。

​
likes_sample10

Like サンプルストリーム (ストリーミング) 公開Likeの10%サンプルをリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムで配信するストリーミングエンドポイントです。 ストリームから返される各アイテムは、ストリーム中の1つのデータポイントを表します。 接続は、指数バックオフ付きのリトライロジックによって自動的に管理されます。 ストリームが切断された場合、SDKはClient側の介入なしに自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
path.backfill_minutes
int or None
デフォルト:"None"
リクエストするバックフィルの分数 (分単位) 。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。Likes が提供される最も早い UTC タイムスタンプ。
​
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。投稿が提供される最も遅い UTC タイムスタンプ。
​
path.like_with_tweet_author_fields
List or None
デフォルト:"None"
表示する LikeWithTweetAuthor フィールドのカンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのカンマ区切りリスト。
​
path.tweet_fields
List or None
デフォルト:"None"
表示する Tweet フィールドのカンマ区切りリスト。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts

フィルタリングされた投稿のストリーミング (Streaming) アクティブなルールセットにマッチする投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムで配信するストリーミングエンドポイントです。 返される各アイテムは、ストリームからの単一のデータポイントを表します。 接続は指数バックオフを用いた再試行ロジックにより自動的に管理されます。 ストリームが切断された場合、SDK はクライアント側の操作なしに自動で再接続します。

​
パラメーター

​
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.tweet_fields
List or None
デフォルト:"None"
表示する Tweet フィールドのカンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示する Media フィールドのカンマ区切りリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する Poll フィールドのカンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのカンマ区切りリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する Place フィールドのカンマ区切りリスト。
​
path.stream_config
StreamConfig
再試行動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_compliance

ポストコンプライアンスデータのストリーミング 投稿に関連するすべてのコンプライアンスデータをストリーム配信します。 これは、利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は、指数バックオフを用いた再試行ロジックで自動的に管理されます。 ストリームが切断された場合、SDK はクライアント側での操作なしに自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
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。

​
posts_firehose

すべての投稿のストリーム (ストリーミング) すべての公開投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムで出力するストリーミングエンドポイントです。 出力される各項目は、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフを用いた再試行ロジックによって自動的に管理されます。 ストリームが切断された場合、SDK はクライアント側での操作を必要とせず自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドのカンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドのカンマ区切りリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドのカンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドのカンマ区切りリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドのカンマ区切りリスト。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_firehose_en

英語の投稿ストリーム (ストリーミング) 公開されているすべての英語の投稿をリアルタイムでストリーミングします。 これは、利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 出力される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフ方式のリトライロジックにより自動的に管理されます。 ストリームが切断された場合でも、SDK はクライアント側の操作なしに自動的に再接続します。

​
Parameters

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示するツイートフィールドのカンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示する Media フィールドのカンマ区切りリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する Poll フィールドのカンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのカンマ区切りリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する Place フィールドのカンマ区切りリスト。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするための任意の StreamConfig。

​
posts_firehose_ja

日本語の投稿をストリーミングする (Streaming) すべての日本語の公開投稿をリアルタイムでストリーミングします。 これはストリーミングエンドポイントであり、利用可能になり次第データをリアルタイムで配信します。 配信される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は、指数バックオフ付きのリトライロジックによって自動的に管理されます。 ストリームが切断された場合でも、SDK はクライアント側での操作なしに自動的に再接続します。

​
パラメータ

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りで指定したリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定したリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドをカンマ区切りで指定したリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドをカンマ区切りで指定したリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りで指定したリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドをカンマ区切りで指定したリスト。
​
path.stream_config
StreamConfig
リトライ動作やタイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_firehose_ko

韓国語の投稿をストリーミングします (Streaming) すべての韓国語の公開投稿をリアルタイムでストリーミングします。 これはストリーミングエンドポイントであり、データが利用可能になり次第リアルタイムで順次返します。 ストリームから返される各アイテムは、ストリーム上の単一のデータポイントを表します。 接続は指数バックオフ付きの再試行ロジックによって自動的に管理されます。 ストリームが切断された場合、SDK はクライアント側での明示的な操作なしに自動的に再接続します。

​
パラメータ

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示する Tweet フィールドのコンマ区切りリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのコンマ区切りリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示する Media フィールドのコンマ区切りリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する Poll フィールドのコンマ区切りリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのコンマ区切りリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する Place フィールドのコンマ区切りリスト。
​
path.stream_config
StreamConfig
再試行動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_firehose_pt

ポルトガル語の投稿ストリーミング (Streaming) すべての公開ポルトガル語投稿をリアルタイムでストリーミングします。 これはストリーミングエンドポイントであり、データが利用可能になり次第リアルタイムで返します。 返される各項目は、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフ方式のリトライロジックによって自動的に管理されます。 ストリームが切断された場合、SDK はクライアントの操作を必要とせずに自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドを、カンマ区切りのリストで指定します。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドを、カンマ区切りのリストで指定します。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドを、カンマ区切りのリストで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドを、カンマ区切りのリストで指定します。
​
path.stream_config
StreamConfig
再試行動作、タイムアウト、コールバックをカスタマイズするための任意の StreamConfig。

​
posts_sample

サンプル投稿をストリーミングします (Streaming) 公開投稿の 1% サンプルをリアルタイムでストリーミングします。 これは、利用可能になり次第データをリアルタイムで返すストリーミングエンドポイントです。 生成される各アイテムは、ストリームから得られた 1 つのデータポイントを表します。 接続は指数バックオフによる再試行ロジックによって自動的に管理されます。 ストリームが切断された場合、SDK はクライアント側での操作なしに自動的に再接続します。

​
パラメーター

​
path.backfill_minutes
int or None
デフォルト:"None"
バックフィルを行う時間 (分) 。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドをカンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアのフィールドをカンマ区切りのリストで指定します。
​
path.poll_fields
List or None
デフォルト:"None"
表示する投票のフィールドをカンマ区切りのリストで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドをカンマ区切りのリストで指定します。
​
path.stream_config
StreamConfig
再試行動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_sample10

投稿を 10% サンプリングしてストリーミングします (Streaming) 公開投稿の 10% サンプルをリアルタイムでストリーミングします。 これはストリーミングエンドポイントであり、データが利用可能になり次第、リアルタイムでデータを返します。 返される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフによるリトライロジックで自動的に管理されます。 ストリームが切断された場合でも、SDK は Client 側での操作なしに自動的に再接続します。

​
パラメータ

​
path.partition
int
パーティション番号。
​
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.tweet_fields
List or None
デフォルト:"None"
表示する Tweet フィールドをカンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
​
path.media_fields
List or None
デフォルト:"None"
表示する Media フィールドをカンマ区切りのリストで指定します。
​
path.poll_fields
List or None
デフォルト:"None"
表示する Poll フィールドをカンマ区切りのリストで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドをカンマ区切りのリストで指定します。
​
path.place_fields
List or None
デフォルト:"None"
表示する Place フィールドをカンマ区切りのリストで指定します。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
update_rules

ストリームルールを更新します フィルタリングされたストリームのアクティブなルールセットから、ルールを追加または削除します。

​
パラメータ

​
body.body
UpdateRulesRequest
リクエストボディ

​
users_compliance

Users のコンプライアンスデータをストリーミングします。 Users に関連するすべてのコンプライアンスデータをストリーム配信します。 これはストリーミングエンドポイントであり、データが利用可能になり次第リアルタイムで配信します。 各アイテムは、ストリームからの 1 件のデータポイントを表します。 接続は指数バックオフによるリトライロジックで自動的に管理されます。 ストリームが切断された場合、SDK は Client 側の操作なしに自動的に再接続します。

​
パラメーター

​
path.partition
int
パーティション番号。
​
path.backfill_minutes
int or None
デフォルト:"None"
要求するバックフィルの時間 (分) 。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。User Compliance イベントが提供される最も早い UTC タイムスタンプ。
​
path.end_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。User Compliance イベントが提供される最も遅い UTC タイムスタンプ。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするための省略可能な StreamConfig。