Passer au contenu principal
Ce module fournit un client pour interagir avec les endpoints de streaming de la X API. Les opérations de streaming en temps réel renvoient des générateurs qui produisent les données au fur et à mesure de leur arrivée. Les connexions de streaming sont gérées automatiquement avec une stratégie de nouvelle tentative avec backoff exponentiel pour une gestion robuste.

​
StreamClient

Classe Bases : object Client de streaming pour les opérations sur les flux

​
Constructeurs

​
__init__

​
Paramètres

​
path.client
Client

​
get_rule_counts

Obtenir le nombre de règles du flux Renvoie le nombre de règles dans le jeu de règles actives pour le flux filtré.

​
Paramètres

​
path.rules_count_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs RulesCount à afficher.

​
Renvoie

GetRuleCountsResponse - Données de la réponse

​
get_rules

Obtient les règles du flux Récupère l’ensemble des règles actives ou un sous-ensemble de règles pour le flux filtré.

​
Paramètres

​
path.ids
List or None
défaut:"None"
Une liste d’identifiants de règles séparés par des virgules.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
str or None
défaut:"None"
Cette valeur est renseignée en passant le « next_token » retourné dans une requête, afin de paginer les résultats.

​
Renvoie

IteratorGetRulesResponse

​
labels_compliance

Diffuse les libellés de Publications (Streaming) Diffuse tous les événements d’étiquetage appliqués aux Publications. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel dès qu’elles sont disponibles. Chaque élément émis représente un seul point de données provenant du flux. La connexion est gérée automatiquement avec une stratégie de nouvelle tentative (backoff exponentiel). Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les libellés de Publication seront fournis.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent à partir duquel les libellés de Publication seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’attente et les callbacks.

​
likes_compliance

Diffuser les données de conformité des Likes (streaming) Diffuse en continu toutes les données de conformité relatives aux Likes des utilisateurs. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel dès qu’elles sont disponibles. Chaque élément renvoyé représente une donnée individuelle issue du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de reprise de données demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les événements de conformité des Likes seront fournis.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent à partir duquel les événements de conformité des Likes seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
likes_firehose

Diffuser tous les Likes (streaming) Diffuse tous les Likes publics en temps réel. Il s’agit d’un endpoint de streaming qui renvoie les données en temps réel à mesure qu’elles deviennent disponibles. Chaque élément renvoyé représente un point de données individuel provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelles tentatives avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de backfill demandées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien pour lequel les mentions J’aime seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent pour lequel les Publications seront fournies.
​
path.like_with_tweet_author_fields
List or None
défaut:"None"
Une liste de champs LikeWithTweetAuthor, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs, séparés par des virgules, à étendre.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet, séparés par des virgules, à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
likes_sample10

Flux d’échantillonnage des Likes (streaming) Diffuse en temps réel un échantillon de 10 % des Likes publics. Il s’agit d’un endpoint de streaming qui renvoie les données en temps réel dès qu’elles sont disponibles. Chaque élément émis représente un seul point de données provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien jusqu’auquel les Mentions J’aime seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront fournies.
​
path.like_with_tweet_author_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs LikeWithTweetAuthor à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à développer.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs User à afficher.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Tweet à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser la gestion des nouvelles tentatives, des délais d’expiration et des fonctions de rappel.

​
posts

Diffuse des Publications filtrées (streaming) Diffuse en temps réel les Publications correspondant à l’ensemble de règles actif. Il s’agit d’un point de terminaison de streaming qui fournit des données en temps réel dès qu’elles sont disponibles. Chaque élément émis représente un seul point de données provenant du flux. La connexion est gérée automatiquement avec une logique de reconnexion utilisant un backoff exponentiel. Si le flux est déconnecté, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage requises.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs de Tweet à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs à développer.
​
path.media_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs Media à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs Poll à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs User à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs Place à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les fonctions de rappel.

​
posts_compliance

Diffuser les données de conformité des Publications (streaming) Diffuse en continu toutes les données de conformité liées aux Publications. Il s’agit d’un endpoint de streaming qui émet les données en temps réel au fur et à mesure qu’elles deviennent disponibles. Chaque élément émis représente une donnée individuelle provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelles tentatives à délai exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du Client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de backfill demandées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les événements de conformité des Publications seront fournis.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les événements de conformité des Publications seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif permettant de personnaliser la stratégie de nouvelle tentative, les délais d’expiration et les callbacks.

​
posts_firehose

Diffuser toutes les Publications (streaming) Diffuse toutes les Publications publiques en temps réel. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel à mesure qu’elles deviennent disponibles. Chaque élément renvoyé représente un seul point de données provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si la connexion au flux est interrompue, le SDK se reconnecte automatiquement sans intervention du Client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien jusqu’auquel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de Tweet à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à étendre.
​
path.media_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de média à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de sondage à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs d’utilisateur à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de lieu à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de nouvelle tentative, les délais d’expiration et les fonctions de rappel (callbacks).

​
posts_firehose_en

Diffuser les Publications en anglais (streaming) Diffuse en temps réel toutes les Publications publiques en anglais. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel dès qu’elles sont disponibles. Chaque élément fourni représente un point de données unique provenant du flux. La connexion est automatiquement gérée avec une stratégie de nouvelle tentative avec délai exponentiel. Si le flux est déconnecté, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent jusqu’auquel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs de Tweet, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs, séparés par des virgules, à étendre.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media, séparés par des virgules, à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste de champs Poll, séparés par des virgules, à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs Place, séparés par des virgules, à afficher.
​
path.stream_config
StreamConfig
Un StreamConfig facultatif pour personnaliser le comportement de nouvelle tentative, les délais d’expiration et les callbacks.

​
posts_firehose_ja

Diffuser les Publications en japonais (streaming) Diffuse en temps réel toutes les Publications publiques en langue japonaise. Il s’agit d’un endpoint de streaming qui fournit des données en temps réel dès qu’elles sont disponibles. Chaque élément émis représente un seul point de données du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative utilisant un backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien pour lequel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent pour lequel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de Tweet à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à étendre.
​
path.media_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Media à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Poll à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs User à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Place à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de nouvelle tentative, les délais d’expiration et les callbacks.

​
posts_firehose_ko

Flux de Publications en coréen (streaming) Diffuse en continu toutes les Publications publiques en coréen, en temps réel. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel au fur et à mesure de leur disponibilité. Chaque élément renvoyé représente une seule donnée issue du flux. La connexion est gérée automatiquement avec une logique de nouvelles tentatives avec délai exponentiel. Si le flux est interrompu, le SDK se reconnecte automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de backfill demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. Le premier horodatage UTC à partir duquel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. Le dernier horodatage UTC jusqu’auquel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs de Tweet à afficher, séparés par des virgules.
​
path.expansions
List or None
défaut:"None"
Une liste de champs à étendre, séparés par des virgules.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media à afficher, séparés par des virgules.
​
path.poll_fields
List or None
défaut:"None"
Une liste de champs Poll à afficher, séparés par des virgules.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User à afficher, séparés par des virgules.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs Place à afficher, séparés par des virgules.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les fonctions de rappel.

​
posts_firehose_pt

Diffuser les Publications en portugais (streaming) Diffuse en temps réel toutes les Publications publiques en langue portugaise. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel dès qu’elles sont disponibles. Chaque élément émis représente une seule donnée issue du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est déconnecté, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien pour lequel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent pour lequel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet séparés par des virgules à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs séparés par des virgules à développer.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media séparés par des virgules à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste de champs Poll séparés par des virgules à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User séparés par des virgules à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs Place séparés par des virgules à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
posts_sample

Diffuse un échantillon de Publications (streaming) Diffuse en temps réel un échantillon de 1 % des Publications publiques. Il s’agit d’un endpoint de streaming qui fournit des données en temps réel au fur et à mesure qu’elles deviennent disponibles. Chaque élément émis représente une seule donnée issue du flux. La connexion est gérée automatiquement avec une logique de reprise et un backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du Client.

​
Paramètres

​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandées.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs de Tweet à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à développer.
​
path.media_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Media à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Poll à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs User à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Place à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de nouvelle tentative, les délais d’expiration et les callbacks.

​
posts_sample10

Diffuse 10 % de Publications échantillonnées (streaming) Diffuse en temps réel un échantillon de 10 % des Publications publiques. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel dès qu’elles sont disponibles. Chaque élément fourni représente un seul point de données provenant du flux. La connexion est automatiquement gérée avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage demandé.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien pour lequel les Publications seront fournies.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent pour lequel les Publications seront fournies.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs de Tweet, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs à développer, séparés par des virgules.
​
path.media_fields
List or None
défaut:"None"
Une liste de champs Media, séparés par des virgules, à afficher.
​
path.poll_fields
List or None
défaut:"None"
Une liste de champs Poll, séparés par des virgules, à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs Place, séparés par des virgules, à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser la stratégie de réessai, les délais d’expiration et les callbacks.

​
update_rules

Mettre à jour les règles du flux Ajoute ou supprime des règles de l’ensemble de règles actif du flux filtré.

​
Paramètres

​
body.body
UpdateRulesRequest
Corps de la requête

​
users_compliance

Diffuser les données de conformité des utilisateurs (streaming) Diffuse toutes les données de conformité relatives aux utilisateurs. Il s’agit d’un endpoint de streaming qui fournit les données en temps réel à mesure qu’elles deviennent disponibles. Chaque élément produit représente une seule donnée issue du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention du client.

​
Paramètres

​
path.partition
int
Le numéro de partition.
​
path.backfill_minutes
int or None
défaut:"None"
Le nombre de minutes de rattrapage sollicitées.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les événements de conformité utilisateur seront fournis.
​
path.end_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent à partir duquel les événements de conformité utilisateur seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de nouvelle tentative, les délais d’expiration et les callbacks.