Passer au contenu principal

​
Sous-modules

​
Contenu du module

Ce module donne accès aux endpoints de flux de la X API et sert de point d’entrée principal pour l’ensemble des fonctionnalités liées aux flux.

​
class xdk.stream.StreamClient

Client de streaming pour les opérations sur les flux

​
Paramètres

​
path.client
Client

​
__init__

​
Paramètres

​
path.client
Client

​
get_rule_counts

Obtenir le nombre de règles du flux Récupère le nombre de règles dans l’ensemble de règles actif pour le flux filtré.

​
Paramètres

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

​
Renvoie

GetRuleCountsResponse - Données de réponse

​
get_rules

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

​
Paramètres

​
path.ids
List or None
défaut:"None"
Une liste, séparée par des virgules, d’identifiants de règles.
​
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 transmettant le « next_token » renvoyé dans une requête afin de paginer les résultats.

​
Renvoie

IteratorGetRulesResponse

​
labels_compliance

Diffuse en continu 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 une donnée unique provenant 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.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 des 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 des libellés de Publication seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
likes_compliance

Flux de données de conformité pour les Likes (streaming) Diffuse toutes les données de conformité relatives aux Likes pour les 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 émis représente un point de données unique provenant 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.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 é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

Flux de tous les Likes (streaming) Diffuse tous les Likes publics en temps réel. Il s’agit d’un endpoint de streaming qui renvoie des données en temps réel dès qu’elles sont disponibles. Chaque élément renvoyé représente une seule donnée issue 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.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 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, 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 à étendre.
​
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 le comportement de réessai, les délais d’expiration et les fonctions de rappel.

​
likes_sample10

Flux échantillonné de Likes (diffusion en continu) Diffuse en temps réel un échantillon de 10 % des Likes publics. 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 automatiquement gérée avec une logique de nouvelle tentative avec repli 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 jusqu’auquel les Likes 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 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 permettant de personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
posts

Diffuser des Publications filtrées (streaming) Diffuse en temps réel les Publications correspondant à l’ensemble de règles actif. Il s’agit d’un endpoint de streaming qui émet les données en temps réel dès qu’elles sont disponibles. Chaque élément émis correspond à une seule donnée du flux. La connexion est gérée automatiquement avec une stratégie de nouvelles tentatives à délai 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 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 à afficher, séparés par des virgules.
​
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 à 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 callbacks.

​
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 fournit les données en temps réel dès qu’elles sont 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 nouvelle tentative à temporisation exponentielle. 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 à partir duquel les événements de conformité relatifs aux 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é relatifs aux Publications seront fournis.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
posts_firehose

Diffuser toutes les Publications (flux en continu) Diffuse toutes les Publications publiques en temps réel. Il s’agit d’un endpoint de streaming qui renvoie des données en temps réel au fur et à mesure qu’elles sont disponibles. Chaque élément renvoyé représente une seule donnée issue du flux. La connexion est gérée automatiquement à l’aide d’une stratégie de réessais avec temporisation exponentielle. 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 (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 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 à afficher, séparés par des virgules.
​
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 à 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
Objet StreamConfig facultatif permettant de personnaliser le comportement de réessai, les délais d’expiration et les 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 renvoie des données en temps réel dès qu’elles sont disponibles. Chaque élément renvoyé représente une donnée unique provenant du flux. La connexion est gérée automatiquement avec une stratégie de nouvelle tentative avec temporisation exponentielle. Si le flux se déconnecte, 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 de Tweet à afficher, séparés par des virgules.
​
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 à 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 callbacks.

​
posts_firehose_ja

Flux de Publications japonaises (streaming) Diffuse en temps réel toutes les Publications publiques en langue japonaise. 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 émis représente une donnée unique provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec temporisation exponentielle. 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 à partir duquel des 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 des 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 à étendre.
​
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 de Poll à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs d’utilisateur à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs de lieu à afficher.
​
path.stream_config
StreamConfig
StreamConfig facultatif pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
posts_firehose_ko

Diffusion des Publications en coréen (streaming) Diffuse en temps réel toutes les Publications publiques rédigées en coréen. 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 retourné représente un seul point de données du flux. La connexion est gérée automatiquement avec une stratégie de nouvelle tentative avec temporisation exponentielle. 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 le comportement de réessai, les délais d’attente et les callbacks.

​
posts_firehose_pt

Flux de Publications en portugais (streaming) Diffuse en continu toutes les Publications publiques en portugais 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 émis représente un seul point de données du flux. La connexion est automatiquement gérée à l’aide d’une stratégie 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 à 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 à 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 média à afficher, séparés par des virgules.
​
path.poll_fields
List or None
défaut:"None"
Une liste de champs de sondage à afficher, séparés par des virgules.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs d’utilisateur à afficher, séparés par des virgules.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs de lieu à afficher, séparés par des virgules.
​
path.stream_config
StreamConfig
StreamConfig optionnel pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​
posts_sample

Diffuser 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 les données en temps réel au fur et à mesure de leur disponibilité. Chaque élément renvoyé représente une donnée individuelle issue du flux. La connexion est automatiquement gérée avec une logique de nouvelle tentative avec temporisation exponentielle. Si le flux se déconnecte, le SDK se reconnectera automatiquement sans intervention de votre part.

​
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 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, à 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 de sondage, séparés par des virgules, à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste de champs de lieu, séparés par des virgules, à 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 produit des données en temps réel à mesure qu’elles deviennent disponibles. Chaque élément émis représente un point de données unique provenant du flux. La connexion est gérée automatiquement avec une stratégie de nouvelle tentative avec temporisation exponentielle. 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 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 à étendre, 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 le comportement de nouvelle tentative (retry), les délais d’expiration et les callbacks.

​
update_rules

Met à jour les règles du flux Ajoute ou supprime des règles de l’ensemble de règles actif pour le 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é liées aux utilisateurs. 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 renvoyé représente un seul point de données provenant du flux. La connexion est automatiquement gérée avec une stratégie de backoff exponentiel pour les nouvelles tentatives. 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 à 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 réessai, les délais d’expiration et les callbacks.