Passer au contenu principal

​
Sous-modules

​
Contenu du module

Ce module fournit un accès aux endpoints Spaces de X API et constitue le point d’entrée principal pour toutes les fonctionnalités liées aux Spaces.

​
class xdk.spaces.SpacesClient

Client pour les opérations sur les Spaces

​
Paramètres

​
path.client
Client

​
__init__

​
Paramètres

​
path.client
Client

​
get_buyers

Récupérer les acheteurs de billets d’un Space Récupère une liste d’utilisateurs ayant acheté des billets pour un Space spécifique, identifié par son id.

​
Paramètres

​
path.id
str
L’identifiant du Space à récupérer.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir une « page » spécifique de résultats.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs User, 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.tweet_fields
List or None
défaut:"None"
Une liste de champs Tweet, séparés par des virgules, à afficher.

​
Renvoie

IteratorGetBuyersResponse

​
get_by_creator_ids

Obtenir des Spaces par identifiants de créateur Renvoie les détails des Spaces créés par les utilisateurs dont les identifiants sont spécifiés.

​
Paramètres

​
path.user_ids
List
Les identifiants des utilisateurs à parcourir.
​
path.space_fields
List or None
défaut:"None"
Une liste de champs Space à 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.user_fields
List or None
défaut:"None"
Une liste de champs User à afficher, séparés par des virgules.
​
path.topic_fields
List or None
défaut:"None"
Une liste de champs Topic à afficher, séparés par des virgules.

​
Renvoie

GetByCreatorIdsResponse - Données de la réponse

​
get_by_id

Obtenir un Space par ID Récupère les détails d’un Space spécifique par son ID.

​
Paramètres

​
path.id
str
L’identifiant du Space à récupérer.
​
path.space_fields
List or None
défaut:"None"
Liste de champs de Space à afficher, séparés par des virgules.
​
path.expansions
List or None
défaut:"None"
Liste de champs à étendre, séparés par des virgules.
​
path.user_fields
List or None
défaut:"None"
Liste de champs d’utilisateur à afficher, séparés par des virgules.
​
path.topic_fields
List or None
défaut:"None"
Liste de champs de sujet à afficher, séparés par des virgules.

​
Valeur de retour

GetByIdResponse - Données de la réponse

​
get_by_ids

Obtenir des Spaces par leurs identifiants Récupère les détails de plusieurs Spaces à partir de leurs identifiants.

​
Paramètres

​
path.ids
List
La liste des identifiants de Space à retourner.
​
path.space_fields
List or None
défaut:"None"
Une liste de champs Space 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.user_fields
List or None
défaut:"None"
Une liste de champs User séparés par des virgules à afficher.
​
path.topic_fields
List or None
défaut:"None"
Une liste de champs Topic séparés par des virgules à afficher.

​
Renvoie

GetByIdsResponse - Données de réponse

​
get_posts

Récupérer les Publications d’un Space Récupère la liste des Publications partagées dans un Space spécifique à partir de son identifiant.

​
Paramètres

​
path.id
str
L’identifiant du Space à récupérer.
​
path.max_results
int or None
défaut:"None"
Le nombre de Publications à récupérer à partir du Space fourni. S’il n’est pas renseigné, la valeur par défaut sera 100 (le maximum).
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs 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.

​
Renvoie

GetPostsResponse - Données de la réponse Recherche de Spaces Renvoie une liste de Spaces correspondant à la requête de recherche spécifiée.

​
Paramètres

​
path.query
str
La requête de recherche.
​
path.state
str or None
défaut:"None"
L’état des Spaces à rechercher.
​
path.max_results
int or None
défaut:"None"
Le nombre de résultats à retourner.
​
path.space_fields
List or None
défaut:"None"
Une liste de champs Space, 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.user_fields
List or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
​
path.topic_fields
List or None
défaut:"None"
Une liste de champs Topic, séparés par des virgules, à afficher.

​
Renvoie

SearchResponse - Données renvoyées