Saltar al contenido principal

Submódulos

Contenido del módulo

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

class xdk.spaces.SpacesClient

Cliente para realizar operaciones con Spaces

Parámetros

path.client
Client

__init__

Parámetros

path.client
Client

get_buyers

Obtiene los compradores de entradas de un Space Obtiene una lista de usuarios que compraron entradas para un Space específico mediante su ID.

Parámetros

path.id
str
El id del Space que se va a recuperar.
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener una «página» específica de resultados.
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuario separados por comas para mostrar.
path.expansions
List or None
predeterminado:"None"
Una lista de campos separados por comas para expandir.
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet separados por comas para mostrar.

Devuelve

IteratorGetBuyersResponse

get_by_creator_ids

Obtener Spaces por id de creadores Recupera los detalles de los Spaces creados por las id de usuario especificadas.

Parámetros

path.user_ids
List
Los identificadores de usuarios en los que buscar.
path.space_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Espacios 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.topic_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de tema para mostrar.

Devuelve

GetByCreatorIdsResponse - Datos de respuesta

get_by_id

Obtener un espacio por id Recupera los detalles de un espacio específico por su id.

Parámetros

path.id
str
El ID del Space que se va a recuperar.
path.space_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Space 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.topic_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de tema para mostrar.

Devuelve

GetByIdResponse - Datos de respuesta

get_by_ids

Obtener Spaces por ids Recupera los detalles de varios Spaces a partir de sus ids.

Parámetros

path.ids
List
La lista de IDs de Space que se devolverán.
path.space_fields
List or None
predeterminado:"None"
Una lista de campos de Space, separados por comas, que se mostrarán.
path.expansions
List or None
predeterminado:"None"
Una lista de campos, separados por comas, que se expandirán.
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de User, separados por comas, que se mostrarán.
path.topic_fields
List or None
predeterminado:"None"
Una lista de campos de Topic, separados por comas, que se mostrarán.

Devuelve

GetByIdsResponse - Datos de la respuesta

get_posts

Obtener Publicaciones de un Espacio Obtiene una lista de Publicaciones compartidas en un Espacio específico mediante su id.

Parámetros

path.id
str
El identificador del Space que se va a recuperar.
path.max_results
int or None
predeterminado:"None"
El número de Publicaciones que se obtendrán del Space proporcionado. Si no se especifica, el valor se establecerá en el máximo de 100.
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.

Devuelve

GetPostsResponse - Datos de respuesta Buscar Spaces Obtiene una lista de Spaces que coinciden con la consulta de búsqueda especificada.

Parámetros

path.query
str
La consulta de búsqueda.
path.state
str or None
predeterminado:"None"
El estado de los Spaces que se van a buscar.
path.max_results
int or None
predeterminado:"None"
El número de resultados que se devolverán.
path.space_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Space para mostrar.
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se van a expandir.
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
path.topic_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de tema para mostrar.

Devuelve

SearchResponse - Datos de la respuesta