Saltar al contenido principal
Este módulo proporciona un cliente para interactuar con los endpoints de streaming de la X API. Las operaciones de streaming en tiempo real devuelven generadores que emiten datos a medida que llegan. Las conexiones de streaming se gestionan automáticamente mediante una lógica de reintentos con backoff exponencial para un manejo robusto.

​
StreamClient

Clase Bases: object Client de streaming para operaciones de streaming

​
Constructores

​
__init__

​
Parámetros

​
path.client
Client

​
get_rule_counts

Obtener el recuento de reglas del flujo Obtiene la cantidad de reglas en el conjunto de reglas activo para el flujo filtrado.

​
Parámetros

​
path.rules_count_fields
List or None
predeterminado:"None"
Lista separada por comas de campos RulesCount que se mostrarán.

​
Valores devueltos

GetRuleCountsResponse - Datos de respuesta

​
get_rules

Obtener las reglas del stream Obtiene el conjunto de reglas activo o un subconjunto de reglas para el stream filtrado.

​
Parameters

​
path.ids
List or None
predeterminado:"None"
Una lista separada por comas de ID de reglas.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
str or None
predeterminado:"None"
Este valor se establece pasando el ‘next_token’ devuelto en una solicitud para paginar los resultados.

​
Devuelve

IteratorGetRulesResponse

​
labels_compliance

Transmisión de etiquetas de Publicaciones (streaming) Transmite todos los eventos de etiquetado aplicados a las Publicaciones. Este es un endpoint de streaming que devuelve datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de relleno histórico solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua a partir de la cual se proporcionarán las etiquetas de las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente a partir de la cual se proporcionarán las etiquetas de las Publicaciones.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar la lógica de reintentos, los tiempos de espera y los callbacks.

​
likes_compliance

Transmitir datos de cumplimiento de Likes (streaming) Transmite todos los datos de cumplimiento relacionados con Likes de usuarios. Este es un endpoint de streaming que emite datos en tiempo real a medida que estén disponibles. Cada elemento emitido representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintento con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua a partir de la cual se proporcionarán los eventos de Likes Compliance.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente a partir de la cual se proporcionarán los eventos de Likes Compliance.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera y callbacks.

​
likes_firehose

Transmitir todos los Me gusta (streaming) Transmite en tiempo real todos los Me gusta públicos. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único dato del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana hasta la cual se proporcionarán los Me gusta.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.like_with_tweet_author_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos LikeWithTweetAuthor para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintento, los tiempos de espera y los callbacks.

​
likes_sample10

Likes muestreados (streaming) Transmite en tiempo real una muestra del 10 % de los Likes públicos. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único dato del stream. La conexión se gestiona automáticamente con una lógica de reintentos con backoff exponencial. Si el stream se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana hasta la cual se proporcionarán los Me gusta.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.like_with_tweet_author_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos LikeWithTweetAuthor para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos a expandir.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User para mostrar.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.

​
posts

Transmitir Publicaciones filtradas (streaming) Transmite en tiempo real las Publicaciones que coinciden con el conjunto de reglas activo. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único dato del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua desde la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuarios para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintento, los tiempos de espera y los callbacks.

​
posts_compliance

Transmitir datos de cumplimiento de Publicaciones (streaming) Transmite todos los datos de cumplimiento relacionados con Publicaciones. Este es un endpoint de streaming que entrega datos en tiempo real a medida que vayan estando disponibles. Cada elemento entregado representa un dato individual del stream. La conexión se gestiona automáticamente con una lógica de reintentos con backoff exponencial. Si el stream se desconecta, el SDK se volverá a conectar automáticamente sin intervención del Client.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua desde la que se proporcionarán los eventos de cumplimiento de Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la que se proporcionarán los eventos de cumplimiento de Publicaciones.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, timeouts y callbacks.

​
posts_firehose

Transmitir todas las Publicaciones (streaming) Transmite todas las Publicaciones públicas en tiempo real. Este es un endpoint de streaming que va entregando datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único punto de datos del stream. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el stream se desconecta, el SDK se volverá a conectar automáticamente sin que el cliente tenga que intervenir.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua para la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente para la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos a expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera (timeouts) y callbacks.

​
posts_firehose_en

Transmitir Publicaciones en inglés (streaming) Transmite en tiempo real todas las Publicaciones públicas en inglés. Este es un endpoint de streaming que emite datos a medida que están disponibles. Cada elemento emitido representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana a partir de la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos a expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.

​
posts_firehose_ja

Flujo de Publicaciones en japonés (streaming) Transmite en tiempo real todas las Publicaciones públicas en japonés. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único punto de datos del flujo. La conexión se gestiona automáticamente con una lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del Client.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua hasta la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.

​
posts_firehose_ko

Transmitir Publicaciones en coreano (streaming) Transmite en tiempo real todas las Publicaciones públicas en coreano. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se reconectará automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de recuperación de historial solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana hasta la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se ampliarán.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media que se mostrarán.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User que se mostrarán.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place que se mostrarán.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.

​
posts_firehose_pt

Transmitir Publicaciones en portugués (streaming) Transmite en tiempo real todas las Publicaciones públicas en portugués. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua a partir de la cual se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuarios para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintento, los tiempos de espera y los callbacks.

​
posts_sample

Transmitir Publicaciones de muestra (streaming) Transmite en tiempo real una muestra del 1 % de las Publicaciones públicas. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único dato del flujo. La conexión se gestiona automáticamente con una lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se reconectará automáticamente sin intervención del cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
La cantidad de minutos de backfill solicitados.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet, separados por comas, para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos, separados por comas, para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista de campos de Media, separados por comas, para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista de campos de Poll, separados por comas, para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de User, separados por comas, para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista de campos de Place, separados por comas, para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.

​
posts_sample10

Transmitir Publicaciones con una muestra del 10 % (streaming) Transmite en tiempo real una muestra del 10 % de las Publicaciones públicas. Este es un endpoint de streaming que entrega datos en tiempo real a medida que están disponibles. Cada elemento entregado representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintento con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua para la que se proporcionarán las Publicaciones.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente para la que se proporcionarán las Publicaciones.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media que se mostrarán.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User que se mostrarán.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place que se mostrarán.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera y callbacks.

​
update_rules

Actualizar reglas del stream Actualiza las reglas agregando o eliminando entradas del conjunto de reglas activo para el stream filtrado.

​
Parámetros

​
body.body
UpdateRulesRequest
Cuerpo de la solicitud

​
users_compliance

Transmitir datos de cumplimiento de usuarios (streaming) Transmite todos los datos de cumplimiento relacionados con usuarios. Este es un endpoint de streaming que emite datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único dato del stream. La conexión se gestiona automáticamente con una lógica de reintentos con backoff exponencial. Si el stream se desconecta, el SDK se volverá a conectar automáticamente sin intervención del cliente.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua a partir de la cual se proporcionarán los eventos de User Compliance.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente a partir de la cual se proporcionarán los eventos de User Compliance.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera y los callbacks.