Passer au contenu principal

​
Sous-modules

​
Contenu du module

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

​
class xdk.posts.PostsClient

Client pour les opérations liées aux Publications

​
Paramètres

​
path.client
Client

​
__init__

​
Paramètres

​
path.client
Client

​
create

Créer ou modifier une Publication Crée une nouvelle Publication pour l’utilisateur authentifié, ou modifie une Publication existante lorsque edit_options sont fournies. body : corps de la requête :returns: données de la réponse :rtype: CreateResponse

​
Paramètres

​
body.body
CreateRequest

​
delete

Supprimer une publication Supprime une publication spécifique par son identifiant, si elle appartient à l’utilisateur authentifié.

​
Paramètres

​
path.id
Any
L’identifiant de la Publication à supprimer.

​
Valeur de retour

DeleteResponse - Données de la réponse

​
get_analytics

Obtenir les statistiques de Publication Récupère les données analytiques pour les Publications spécifiées sur un intervalle de temps défini.

​
Paramètres

​
path.ids
List
Une liste d’identifiants de Publications séparés par des virgules. Jusqu’à 100 sont autorisés dans une seule requête.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant la fin de l’intervalle de temps.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant le début de l’intervalle de temps.
​
path.granularity
str
La granularité des résultats de comptage de la recherche.
​
path.analytics_fields
List or None
défaut:"None"
Une liste de champs Analytics à afficher, séparés par des virgules.

​
Valeur de retour

GetAnalyticsResponse - Données renvoyées

​
get_by_id

Obtenir une Publication par identifiant Récupère les détails d’une Publication spécifique à partir de son identifiant.

​
Paramètres

​
path.id
Any
Un seul id de Publication.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs 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.

​
Renvoie

GetByIdResponse - Données de réponse

​
get_by_ids

Obtenir des Publications par identifiants Renvoie les détails de plusieurs Publications correspondant aux identifiants fournis.

​
Paramètres

​
path.ids
List
Une liste d’identifiants de Publication séparés par des virgules. Jusqu’à 100 sont autorisés par requête.
​
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 à étendre.
​
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.

​
Retourne

GetByIdsResponse - Données de réponse

​
get_counts_all

Obtenir le nombre de Publications Récupère le nombre de Publications correspondant à une requête de recherche depuis l’archive complète.

​
Paramètres

​
path.query
str
Une requête/une règle/un filtre permettant de faire correspondre des Publications. Reportez-vous à https://t.co/rulelength pour déterminer la longueur maximale d’une requête.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien (parmi les 7 derniers jours) à partir duquel les Publications seront fournies. L’horodatage est exprimé à la seconde et est inclusif (c’est‑à‑dire que 12:00:01 inclut la première seconde de la minute).
​
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. L’horodatage est exprimé à la seconde et est exclusif (c’est‑à‑dire que 12:00:01 exclut la première seconde de la minute).
​
path.since_id
Any or None
défaut:"None"
Renvoie les résultats avec un ID de Publication supérieur (c’est‑à‑dire plus récent) à l’ID spécifié.
​
path.until_id
Any or None
défaut:"None"
Renvoie les résultats avec un ID de Publication inférieur (c’est‑à‑dire plus ancien) à l’ID spécifié.
​
path.next_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.granularity
str or None
défaut:"None"
La granularité des résultats de comptage pour la recherche.
​
path.search_count_fields
List or None
défaut:"None"
Une liste de champs SearchCount, séparés par des virgules, à afficher.

​
Renvoie

IteratorGetCountsAllResponse

​
get_counts_recent

Obtenir le nombre de publications récentes Récupère le nombre de publications au cours des 7 derniers jours correspondant à une requête de recherche.

​
Paramètres

​
path.query
str
Une requête, règle ou filtre pour faire correspondre des Publications. Consultez https://t.co/rulelength pour déterminer la longueur maximale de la requête.
​
path.start_time
str or None
défaut:"None"
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien (sur les 7 derniers jours) à partir duquel les Publications seront renvoyées. L’horodatage est exprimé à la seconde près et est inclusif (c’est‑à‑dire que 12:00:01 inclut la première seconde de la minute).
​
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 renvoyées. L’horodatage est exprimé à la seconde près et est exclusif (c’est‑à‑dire que 12:00:01 exclut la première seconde de la minute).
​
path.since_id
Any or None
défaut:"None"
Renvoie des résultats avec un ID de Publication supérieur (c’est‑à‑dire plus récent) à l’ID spécifié.
​
path.until_id
Any or None
défaut:"None"
Renvoie des résultats avec un ID de Publication inférieur (c’est‑à‑dire plus ancien) à l’ID spécifié.
​
path.next_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.granularity
str or None
défaut:"None"
La granularité des résultats de comptage de recherche.
​
path.search_count_fields
List or None
défaut:"None"
Une liste de champs SearchCount, séparés par des virgules, à afficher.

​
Renvoie

IteratorGetCountsRecentResponse

​
get_insights28hr

Obtenir les insights sur 28 heures pour les Publications Récupère les métriques d’engagement pour les Publications spécifiées au cours des 28 dernières heures.

​
Paramètres

​
path.tweet_ids
List
Liste d’id de Publications pour les métriques sur 28 h.
​
path.granularity
str
Granularité des métriques dans la réponse.
​
path.requested_metrics
List
Métriques à demander pour la requête historique.
​
path.engagement_fields
List or None
défaut:"None"
Une liste de champs d’engagement, séparés par des virgules, à afficher.

​
Renvoie

GetInsights28hrResponse - Données de réponse

​
get_insights_historical

Obtenir des statistiques historiques sur les Publications Récupère les métriques d’engagement historiques pour les Publications spécifiées sur une période donnée.

​
Paramètres

​
path.tweet_ids
List
Liste de PostIds pour les mesures historiques.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant la fin de l’intervalle de temps.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant le début de l’intervalle de temps.
​
path.granularity
str
Granularité de la réponse de mesures.
​
path.requested_metrics
List
Mesures demandées pour la requête historique.
​
path.engagement_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs d’engagement à afficher.

​
Renvoie

GetInsightsHistoricalResponse - Données de la réponse

​
get_liking_users

Récupérer les utilisateurs ayant aimé Récupère une liste d’utilisateurs qui ont aimé une Publication spécifique à partir de son identifiant.

​
Paramètres

​
path.id
Any
Un seul ID de Publication.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir la « page » suivante de résultats.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs User à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs à étendre.
​
path.tweet_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, de champs Tweet à afficher.

​
Renvoie

IteratorGetLikingUsersResponse

​
get_quoted

Récupérer les Publications citées Renvoie une liste de Publications qui citent une Publication donnée, identifiée par son identifiant.

​
Paramètres

​
path.id
Any
Un seul ID de Publication.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats à retourner.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir une « page » spécifique de résultats.
​
path.exclude
List or None
défaut:"None"
L’ensemble des entités à exclure (par exemple « replies » ou « retweets »).
​
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 à développer.
​
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 Poll à afficher.
​
path.user_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs User à afficher.
​
path.place_fields
List or None
défaut:"None"
Une liste, séparée par des virgules, des champs Place à afficher.

​
Renvoie

IteratorGetQuotedResponse

​
get_reposted_by

Obtenir les utilisateurs ayant reposté Récupère la liste des utilisateurs qui ont reposté une publication spécifique à partir de son id.

​
Paramètres

​
path.id
Any
Un seul ID de Publication.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir la « page » suivante de résultats.
​
path.user_fields
List or None
défaut:"None"
Une liste de champs d’utilisateur, séparés par des virgules, à afficher.
​
path.expansions
List or None
défaut:"None"
Une liste de champs à étendre (expansions), séparés par des virgules.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs de Tweet, séparés par des virgules, à afficher.

​
Retourne

IteratorGetRepostedByResponse

​
get_reposts

Obtenir les republications Récupère une liste de Publications qui republient une Publication donnée à partir de son identifiant (id).

​
Paramètres

​
path.id
Any
Un seul ID de Publication.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir la « page » suivante de résultats.
​
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 de média 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.

​
Renvoie

IteratorGetRepostsResponse

​
hide_reply

Masquer la réponse Masque ou rétablit l’affichage d’une réponse dans une conversation appartenant à l’utilisateur authentifié.

​
Paramètres

​
path.tweet_id
Any
L’identifiant de la réponse que vous souhaitez masquer ou réafficher.
​
body.body
HideReplyRequest
Corps de la requête

​
search_all

Rechercher dans toutes les Publications Récupère les Publications de l’archive complète qui correspondent à une requête de recherche.

​
Parameters

​
path.query
str
Une requête/règle/filtre pour faire correspondre des Publications. Consultez https://t.co/rulelength pour connaître la longueur maximale de la requête.
​
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. L’horodatage a une granularité à la seconde et est inclusif (c’est-à-dire que 12:00:01 inclut la première seconde de la minute).
​
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. L’horodatage a une granularité à la seconde et est exclusif (c’est-à-dire que 12:00:01 exclut la première seconde de la minute).
​
path.since_id
Any or None
défaut:"None"
Retourne des résultats avec un id de Publication supérieur (c’est-à-dire plus récent) à l’id spécifié.
​
path.until_id
Any or None
défaut:"None"
Retourne des résultats avec un id de Publication inférieur (c’est-à-dire plus ancien) à l’id spécifié.
​
path.max_results
int or None
défaut:"None"
Nombre maximal de résultats de recherche à renvoyer pour une requête.
​
path.next_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.sort_order
str or None
défaut:"None"
Ordre dans lequel les résultats sont renvoyés.
​
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.

​
Renvoie

IteratorSearchAllResponse

​
search_recent

Rechercher des Publications récentes Récupère les Publications des 7 derniers jours qui correspondent à une requête de recherche.

​
Paramètres

​
path.query
str
Une requête/règle/filtre pour faire correspondre des Publications. Consultez https://t.co/rulelength pour déterminer la longueur maximale de la requête.
​
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. L’horodatage est à la seconde près et est inclusif (c’est‑à‑dire que 12:00:01 inclut la première seconde de la minute).
​
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. L’horodatage est à la seconde près et est exclusif (c’est‑à‑dire que 12:00:01 exclut la première seconde de la minute).
​
path.since_id
Any or None
défaut:"None"
Renvoie des résultats dont l’ID de Publication est supérieur (c’est‑à‑dire plus récent) à l’ID spécifié.
​
path.until_id
Any or None
défaut:"None"
Renvoie des résultats dont l’ID de Publication est inférieur (c’est‑à‑dire plus ancien) à l’ID spécifié.
​
path.max_results
int or None
défaut:"None"
Le nombre maximal de résultats de recherche à renvoyer par requête.
​
path.next_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir la « page » suivante de résultats. La valeur utilisée pour ce paramètre est directement extraite de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.pagination_token
Any or None
défaut:"None"
Ce paramètre permet d’obtenir la « page » suivante de résultats. La valeur utilisée pour ce paramètre est directement extraite de la réponse fournie par l’API et ne doit pas être modifiée.
​
path.sort_order
str or None
défaut:"None"
Ordre dans lequel les résultats sont renvoyés.
​
path.tweet_fields
List or None
défaut:"None"
Une liste de champs 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 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.

​
Renvoie

IteratorSearchRecentResponse