Saltar al contenido principal

​
Submódulos

​
Contenido del módulo

Este módulo proporciona acceso a los endpoints de streaming de la X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con el streaming.

​
class xdk.stream.StreamClient

Cliente de streaming para operaciones de streams

​
Parámetros

​
path.client
Client

​
__init__

​
Parámetros

​
path.client
Client

​
get_rule_counts

Obtener el recuento de reglas Devuelve el número de reglas en el conjunto de reglas activo para el flujo filtrado.

​
Parámetros

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

​
Devuelve

GetRuleCountsResponse - Datos de respuesta

​
get_rules

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

​
Parámetros

​
path.ids
List or None
predeterminado:"None"
Una lista de IDs de reglas separada por comas.
​
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 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 cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
La cantidad de minutos de recuperación histórica 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 etiquetas de la Publicación.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente desde la cual se proporcionarán las etiquetas de la Publicación.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera y callbacks.

​
likes_compliance

Transmisión de datos de cumplimiento de Likes (streaming) Transmite todos los datos de cumplimiento relacionados con Likes de usuarios. 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 stream. La conexión se gestiona automáticamente con una lógica de reintento con backoff exponencial. Si el stream se desconecta, el SDK se reconectará automáticamente sin intervención del cliente.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
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 desde la cual se proporcionarán los eventos de cumplimiento de Likes.
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente desde la cual se proporcionarán los eventos de cumplimiento de Likes.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera y callbacks.

​
likes_firehose

Transmite todos los Likes (streaming) Transmite en tiempo real todos los Likes públicos. 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 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 para la cual se proporcionarán los Likes.
​
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.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 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.

​
likes_sample10

Likes muestreados del stream (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 van estando disponibles. Cada elemento entregado representa un único dato 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 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 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 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 reintento, tiempos de espera y callbacks.

​
posts

Transmitir Publicaciones filtradas (streaming) Transmite Publicaciones en tiempo real 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 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 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 que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se expandirá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 reintento, los tiempos de espera (timeouts) y los callbacks.

​
posts_compliance

Flujo de datos de cumplimiento de Publicaciones (streaming) Transmite todos los datos de cumplimiento relacionados con Publicaciones. 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 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 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 cual 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 cual se proporcionarán los eventos de cumplimiento de Publicaciones.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, los tiempos de espera (timeouts) y los callbacks.

​
posts_firehose

Transmitir todas las Publicaciones (streaming) Transmite todas las Publicaciones públicas en tiempo real. Este es un endpoint de streaming que proporciona datos en tiempo real a medida que están disponibles. Cada elemento emitido representa un único punto de datos 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"
AAAA-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"
AAAA-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 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 ubicación para mostrar.
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintento, los tiempos de espera y los callbacks.

​
posts_firehose_en

Transmisión de Publicaciones en inglés (streaming) Transmite en tiempo real todas las Publicaciones públicas en inglés. Este es un endpoint de streaming que entrega datos en tiempo real a medida que van estando disponibles. Cada elemento emitido 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 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 que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se van a expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios que se mostrarán.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuarios que se mostrarán.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares 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_ja

Transmitir Publicaciones en japonés (streaming) Transmite en tiempo real todas las Publicaciones públicas en idioma japoné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 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 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 expandirá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_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 van estando disponibles. Cada elemento emitido representa un dato individual 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 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 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 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 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 y callbacks.

​
posts_firehose_pt

Transmisión de Publicaciones en portugués (streaming) Transmite en tiempo real todas las Publicaciones públicas en portugués. 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 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 solicitado.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana 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 a 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 a mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll a mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User a mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place a 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 entregado representa un único punto de datos del stream. La conexión se gestiona automáticamente con lógica de reintento con backoff exponencial. Si el stream se desconecta, el SDK se volverá a conectar automáticamente sin intervención del Client.

​
Parámetros

​
path.backfill_minutes
int or None
predeterminado:"None"
El número de minutos de backfill solicitados.
​
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 deben 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 reintento, los tiempos de espera y los callbacks.

​
posts_sample10

Transmite un 10 % de Publicaciones muestreadas (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 Client.

​
Parámetros

​
path.partition
int
El número de partición.
​
path.backfill_minutes
int or None
predeterminado:"None"
La cantidad de minutos de recuperación 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 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 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, tiempos de espera y callbacks.

​
update_rules

Actualiza las reglas del stream Agrega o elimina reglas del conjunto de reglas activo para el stream filtrado.

​
Parámetros

​
body.body
UpdateRulesRequest
Cuerpo de la solicitud

​
users_compliance

Transmisión de datos de cumplimiento de usuarios (streaming) Transmite todos los datos de cumplimiento relacionados con usuarios. 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 individual 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 temprana a partir de la cual se proporcionarán los eventos de cumplimiento de usuario (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 cumplimiento de usuario (User Compliance).
​
path.stream_config
StreamConfig
StreamConfig opcional para personalizar el comportamiento de reintentos, tiempos de espera y callbacks.