メインコンテンツへスキップ
このモジュールは、X API のストリームエンドポイントを操作するためのクライアントを提供します。 リアルタイムストリーミング処理では、データの到着に応じて順次データを生成するジェネレーターを返します。 ストリーミング接続は、堅牢な動作を実現するため、指数バックオフ付きのリトライロジックによって自動的に管理されます。

​
StreamClient

クラス 基底クラス: object ストリーム操作を行うための Client

​
コンストラクタ

​
__init__

​
パラメータ

​
path.client
Client

​
get_rule_counts

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

​
Parameters

​
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 は Client の操作なしに自動で再接続します。

​
パラメータ

​
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。

​
likes_compliance

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

​
パラメーター

​
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。Likes コンプライアンスイベントが提供される UTC タイムスタンプの最も遅い時刻。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
likes_firehose

すべてのいいねをストリーミング (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。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。

​
likes_sample10

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

​
パラメーター

​
path.partition
int
パーティション番号。
​
path.backfill_minutes
int or None
デフォルト:"None"
要求するバックフィルの時間（分）。
​
path.start_time
str or None
デフォルト:"None"
YYYY-MM-DDTHH:mm:ssZ。Like データが提供される最も早い 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

フィルタされた投稿をストリーミングします（ストリーミング） アクティブなルールセットに一致する投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 生成される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は、指数バックオフを用いたリトライロジックによって自動的に管理されます。 ストリームが切断された場合でも、クライアント側での操作なしに 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"
表示するツイートのフィールドをカンマ区切りで指定したリスト。
​
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

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

​
パラメータ

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

​
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"
表示する Place フィールドのカンマ区切りのリスト。
​
path.stream_config
StreamConfig
リトライ動作、タイムアウト、コールバックをカスタマイズするためのオプションの StreamConfig。

​
posts_firehose_en

英語の投稿をストリーミングする（Streaming） すべての英語の公開投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの 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"
表示するメディアのフィールドをカンマ区切りで指定するリスト。
​
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_ja

日本語の投稿をストリーミングします (ストリーミング) すべての日本語の公開投稿をリアルタイムでストリーミングします。 これは、利用可能になったデータをリアルタイムで返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの単一のデータポイントを表します。 接続は指数バックオフ方式の再試行ロジックで自動的に管理されます。 ストリームが切断された場合でも、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"
表示するツイートのフィールドのカンマ区切りリスト。
​
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） すべての公開されている韓国語の投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの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"
表示するメディアのフィールドをカンマ区切りリストで指定します。
​
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_pt

ポルトガル語の投稿をストリーミングします (Streaming) すべての公開ポルトガル語投稿をリアルタイムでストリーミングします。 これは、データが利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 ストリームから返される各アイテムは、単一のデータポイントを表します。 接続は指数バックオフ方式のリトライロジックにより自動的に管理されます。 ストリームが切断された場合、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。

​
posts_sample

サンプリングされた投稿をストリーミングします（ストリーミング） 公開投稿の 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"
表示する 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_sample10

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

​
パラメーター

​
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。