Modèle objet
Tweet
id, text et created_at. Les objets Tweet sont également l’objet « parent » de plusieurs objets enfants, notamment user, media, poll et place. Utilisez le paramètre tweet.fields pour demander ces champs de niveau racine sur l’objet Tweet.
L’objet Tweet peut être trouvé et développé (expanded) dans la ressource utilisateur. Des Tweets supplémentaires liés au Tweet demandé peuvent également être trouvés et développés dans la ressource Tweet. L’objet est disponible pour expansion avec ?expansions=pinned_tweet_id dans la ressource utilisateur ou ?expansions=referenced_tweets.id dans la ressource Tweet afin d’obtenir l’objet avec uniquement les champs par défaut. Utilisez l’expansion avec le paramètre de champ tweet.fields lors de la demande de champs supplémentaires pour compléter l’objet.
| Valeur du champ | Type | Description | Comment l’utiliser |
|---|---|---|---|
| id (par défaut) | string | L’identifiant unique du Tweet demandé. | Utilisez ceci pour récupérer par programmation un Tweet spécifique. |
| text (par défaut) | string | Le texte UTF-8 réel du Tweet. Voir twitter-text pour les détails sur les caractères valides. | Extraction de mots-clés et analyse/classification de sentiment. |
| edit_history_tweet_ids (par défaut) | object | Identifiants uniques indiquant toutes les versions d’un Tweet. Pour les Tweets sans modifications, il y aura un ID. Pour les Tweets avec un historique de modifications, il y aura plusieurs ID. | Utilisez cette information pour trouver l’historique de modification d’un Tweet. |
| article | object | Contient les métadonnées de l’Article présent dans ce Tweet. | Utilisez ceci pour obtenir le texte et les entités d’un Article. |
| attachments | object | Spécifie le type de pièces jointes (le cas échéant) présentes dans ce Tweet. | Comprendre les objets retournés pour les expansions demandées. |
| author_id | string | L’identifiant unique de l’utilisateur qui a publié ce Tweet. | Hydratation de l’objet utilisateur, partage de jeu de données pour révision par les pairs. |
| card_uri | string | L’URI de la carte présente dans ce tweet. | |
| community_id | string | L’identifiant unique de la communauté à laquelle appartient ce Post. | |
| context_annotations | array | Contient les annotations de contexte pour le Tweet. | Reconnaissance/extraction d’entités, analyse thématique. |
| conversation_id | string | L’ID du Tweet original de la conversation (qui inclut les réponses directes, les réponses aux réponses). | Utilisez ceci pour reconstituer la conversation à partir d’un Tweet. |
| created_at | date (ISO 8601) | Heure de création du Tweet. | Utile pour l’analyse de séries temporelles et comprendre quand un Tweet a été créé. |
| display_text_range | array | Un tableau contenant un index de début et de fin pour la portion de texte qui s’affiche. | Utile pour savoir quelle portion de texte est affichée par défaut pour les posts longs. |
| edit_controls | object | Indique combien de temps le Tweet peut encore être modifié et le nombre de modifications restantes. | Utilisez ceci pour déterminer si un Tweet est éligible à la modification. |
| entities | object | Entités qui ont été extraites du texte du Tweet. Voir entités dans les objets Twitter. | Fournit des informations supplémentaires sur les hashtags, URL, mentions, etc. |
| geo | object | Indique l’emplacement ou le lieu d’un Tweet géolocalisé. | Utilisez ceci pour déterminer l’emplacement d’un Tweet géolocalisé. |
| in_reply_to_user_id | string | Si le Tweet représenté est une réponse, ce champ contiendra l’ID de l’auteur du Tweet original. | Déterminer si un Tweet était en réponse à un autre Tweet. |
| lang | string | Langue du Tweet, si détectée par Twitter. | Classer les Tweets par langue parlée. |
| non_public_metrics | object | Métriques d’engagement non publiques pour le Tweet au moment de la demande. Nécessite une authentification de contexte utilisateur. | Déterminer le total des impressions générées pour le Tweet. |
| note_tweet | object | Contient le texte complet d’un Post pour les Posts longs (>280 caractères). | Obtenir le texte complet d’un post. |
| organic_metrics | object | Métriques d’engagement, suivies dans un contexte organique, pour le Tweet au moment de la demande. Nécessite une authentification de contexte utilisateur. | Mesurer l’engagement organique pour le Tweet. |
| possibly_sensitive | boolean | Indique si le contenu peut être reconnu comme sensible. | Étudier la circulation de certains types de contenu. |
| promoted_metrics | object | Métriques d’engagement, suivies dans un contexte promu, pour le Tweet au moment de la demande. Nécessite une authentification de contexte utilisateur. | Mesurer l’engagement pour le Tweet quand il était promu. |
| public_metrics | object | Métriques d’engagement publiques pour le Tweet au moment de la demande. | Mesurer l’engagement du Tweet. |
| referenced_tweets | array | Une liste de Tweets auxquels ce Tweet fait référence, tels que les Retweets, Tweets cités, ou réponses. | Comprendre les aspects conversationnels des retweets, etc. |
| reply_settings | string | Montre qui peut répondre à un Tweet donné. Les options sont “everyone”, “mentioned_users”, et “followers”. | Déterminer les paramètres de réponse de conversation pour le Tweet. |
| withheld | object | Contient les détails de rétention pour le contenu retenu. | |
| scopes | object | Contient les détails de portée pour le tweet. | Indique qui peut voir le post. Retourné uniquement pour les posts promus. |
| media_metadata | array | Contient les métadonnées pour les pièces jointes média du Tweet. | Obtenir des métadonnées supplémentaires comme le alt_text d’une pièce jointe média d’un Tweet’s. |
$BEARER_TOKEN par votre propre Jeton Bearer.
Utilisateur
user.fields.
L’objet utilisateur peut également apparaître comme objet enfant et être inclus dans l’objet Tweet via des expansions. L’objet est disponible avec ?expansions=author_id ou ?expansions=in_reply_to_user_id pour obtenir la version condensée avec uniquement les champs par défaut. Utilisez ces expansions avec le paramètre de champs user.fields lorsque vous demandez des champs supplémentaires afin de compléter l’objet.
| Valeur du champ | Type | Description | Utilisation possible |
|---|---|---|---|
| id (par défaut) | string | L’identifiant unique de cet utilisateur."id": "2244994945" | Utilisez ceci pour récupérer par programmation des informations sur un utilisateur X spécifique. |
| name (par défaut) | string | Le nom de l’utilisateur, tel qu’il l’a défini sur son profil. Il ne s’agit pas nécessairement du nom d’une personne. Généralement limité à 50 caractères, mais sujet à modification."name": "Twitter Dev" | |
| username (par défaut) | string | Le nom d’écran, le pseudo ou l’alias avec lequel cet utilisateur s’identifie sur X. Les noms d’utilisateur sont uniques mais peuvent changer. Généralement d’une longueur maximale de 15 caractères, mais certains comptes historiques peuvent avoir des noms plus longs."username": "TwitterDev" | |
| affiliation | object | Contient des détails sur l’affiliation d’un utilisateur. | Peut être utilisé pour obtenir le badge d’affiliation d’un utilisateur. |
| confirmed_email | string | L’adresse e-mail confirmée de l’utilisateur authentifié. | |
| connection_status | array | Fournit une liste des relations entre l’utilisateur authentifié et l’utilisateur recherché, telles que : suivi, suivi par, demande de suivi envoyée, demande de suivi reçue, blocage, mise en sourdine ”connection_status”: [ “follow_request_received”, “follow_request_sent”, “blocking”, “followed_by”, “following”, “muting” ] | Peut être utilisé pour déterminer le statut de la relation entre l’utilisateur authentifié et l’utilisateur recherché. |
| created_at | date (ISO 8601) | La date et l’heure UTC de création du compte utilisateur sur X."created_at": "2013-12-14T04:35:55.000Z" | Peut être utilisé pour déterminer depuis combien de temps quelqu’un utilise X |
| description | string | Le texte de la description du profil de cet utilisateur (également appelée bio), si l’utilisateur en a fourni une."description": "The voice of the X Dev team and your official source for updates, news, and events, related to the X API." | |
| entities | object | Contient des détails sur le texte ayant une signification particulière dans la description de l’utilisateur."entities": { <br/> "url": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> } <br/> ] <br/> }, <br/> "description": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> }, <br/> "hashtags": [ <br/> { <br/> "start": 23, <br/> "end": 30, <br/> "tag": "DevRel" <br/> }, <br/> { <br/> "start": 113, <br/> "end": 130, <br/> "tag": "BlackLivesMatter" <br/> }, <br/> "mentions": [ <br/> { <br/> "start": 0, <br/> "end": 10, <br/> "tag": "TwitterDev" <br/> }, <br/> "cashtags": [ <br/> { <br/> "start": 12, <br/> "end": 16, <br/> "tag": "twtr" <br/> } <br/> ] <br/> } <br/> } | Les entités sont des objets JSON qui fournissent des informations supplémentaires sur les hashtags, les URL, les mentions d’utilisateurs et les cashtags associés à la description. Consultez chaque entité respective pour plus de détails. Tous les indices start d’utilisateur sont inclusifs, tandis que tous les indices end d’utilisateur sont exclusifs. |
| is_identity_verified | boolean | Indique si l’utilisateur a une identité vérifiée. | |
| location | string | La localisation spécifiée dans le profil de l’utilisateur, si l’utilisateur en a fourni une. Comme il s’agit d’une valeur libre, elle peut ne pas indiquer une localisation valide, mais elle peut être évaluée de manière approximative lors de l’exécution de recherches avec des requêtes de localisation."location": "127.0.0.1" | |
| most_recent_tweet_id | string | Identifiant unique du Tweet le plus récent de cet utilisateur. | Permet de déterminer le Tweet le plus récent de l’utilisateur. |
| parody | boolean | Indique si ce compte utilisateur possède ou non le libellé Parodie. | |
| pinned_tweet_id | string | Identifiant unique du Tweet épinglé de cet utilisateur."pinned_tweet_id": "1255542774432063488" | Permet de déterminer le Tweet épinglé en haut du profil de l’utilisateur. Peut potentiellement être utilisé pour déterminer la langue de l’utilisateur. |
| profile_banner_url | string | L’URL de la bannière de profil pour cet utilisateur, telle qu’affichée sur le profil de l’utilisateur."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Peut être utilisé pour télécharger la bannière de profil de cet utilisateur. |
| profile_image_url | string | L’URL de l’image de profil pour cet utilisateur, telle qu’affichée sur le profil de l’utilisateur."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Peut être utilisé pour télécharger l’image de profil de cet utilisateur. |
| protected | boolean | Indique si cet utilisateur a choisi de protéger ses Tweets (autrement dit, si les Tweets de cet utilisateur sont privés)."protected": false | |
| public_metrics | object | Contient des détails sur l’activité de cet utilisateur."public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | Peut être utilisé pour déterminer la portée ou l’influence d’un utilisateur X, quantifier l’éventail de ses centres d’intérêt et son niveau d’engagement sur X. |
| receives_your_dm | boolean | Indique si cet utilisateur recevra ou non le message privé de l’utilisateur authentifié. | |
| subscription | object | Contient des détails indiquant si l’utilisateur est abonné ou non à l’utilisateur authentifié. | |
| subscription_type | string | Une chaîne représentant le type d’abonnement X Premium de l’utilisateur authentifié. Exemple : None, Basic, Premium, PremiumPlus. Retourne toujours None si l’utilisateur n’est pas l’utilisateur authentifié. | |
| url | string | L’URL spécifiée dans le profil de l’utilisateur, si elle est présente."url": "https://t.co/3ZX3TNiZCY" | Une URL fournie par un utilisateur X dans son profil. Il peut s’agir d’une page d’accueil, mais ce n’est pas toujours le cas. |
| verified | boolean | Indique si cet utilisateur est un utilisateur X vérifié."verified": true | Indique si cet utilisateur X possède ou non un compte vérifié. Un compte vérifié permet de savoir qu’un compte d’intérêt public est authentique. |
| verified_followers_count | string | Une chaîne représentant le nombre d’abonnés vérifiés d’un utilisateur. | |
| verified_type | string | Une chaîne représentant le type de vérification d’un utilisateur. Exemple : “blue”, “business”, “government” | |
| withheld | object | Contient les détails de rétention pour le contenu retenu, le cas échéant. |
$BEARER_TOKEN par votre propre Jeton Bearer généré.
Space
host_ids, creator_id, speaker_ids, mentioned_user_ids au paramètre de requête expansions.
Contrairement aux Tweets, les Spaces sont éphémères et deviennent indisponibles après leur fin ou lorsqu’ils sont annulés par leur créateur. Lorsque votre App traite des données de Spaces, vous êtes responsable de renvoyer les informations les plus à jour et devez supprimer les données qui ne sont plus disponibles sur la plateforme. Les endpoints de recherche Spaces peuvent vous aider à garantir le respect des attentes et de l’intention des utilisateurs.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | L’identifiant unique du Space demandé."id": "1zqKVXPQhvZJB" | Identifier de manière unique un Space renvoyé dans la réponse. |
| state (default) | string | Indique si le Space a commencé, va commencer ou s’est terminé."state": "live" | Filtrer les Spaces en direct ou programmés. |
| created_at | date (ISO 8601) | Heure de création de ce Space."created_at": "2021-07-04T23:12:08.000Z" | Déterminer quand un Space a été créé et trier par date. |
| creator_id | string | Identifiant unique du créateur du Space."creator_id": "2244994945" | |
| ended_at | date (ISO 8601) | Heure à laquelle le Space s’est terminé, le cas échéant."ended_at": "2021-07-04T00:11:44.000Z" | Déterminer quand un Space en direct s’est terminé pour la durée d’exécution. |
| host_ids | array | Identifiants uniques des hôtes du Space."host_ids": ["2244994945", "6253282"] | Étendre les objets utilisateur, comprendre l’engagement. |
| lang | string | Langue du Space, si détectée."lang": "en" | Classer les Spaces par langue. |
| is_ticketed | boolean | Indique s’il s’agit d’un Space payant (ticketed)."is_ticketed": false | Mettre en avant le contenu d’intérêt. |
| invited_user_ids | array | Liste des IDs d’utilisateurs invités comme intervenants."invited_user_ids": ["2244994945", "6253282"] | Étendre les objets utilisateur, comprendre l’engagement. |
| participant_count | integer | Nombre d’utilisateurs dans le Space, y compris les hôtes et les intervenants."participant_count": 420 | Comprendre l’engagement, créer des rapports. |
| subscriber_count | integer | Nombre de personnes ayant défini un rappel pour un Space."subscriber_count": 36 | Évaluer l’intérêt pour l’événement. |
| scheduled_start | date (ISO 8601) | Heure de début programmée du Space."scheduled_start": "2021-07-14T08:00:00.000Z" | S’intégrer aux notifications de calendrier. |
| speaker_ids | array | Liste des utilisateurs qui ont pris la parole à un moment donné."speaker_ids": ["2244994945", "6253282"] | Étendre les objets utilisateur, comprendre l’engagement. |
| started_at | date (ISO 8601) | Heure de début effective d’un Space."started_at": "2021-07-14T08:00:12.000Z" | Déterminer l’heure de début du Space. |
| title | string | Titre du Space."title": "Say hello to the Space data object!" | Comprendre les mots-clés, hashtags, mentions. |
| topic_ids | array | IDs des sujets sélectionnés par le créateur du Space."topic_ids": ["2244994945", "6253282"] | Comprendre les mots-clés, hashtags, mentions. |
| updated_at | date (ISO 8601) | Dernière mise à jour des metadata du Space."updated_at": "2021-07-11T14:44:44.000Z" | Maintenir les informations à jour. |
$BEARER_TOKEN par votre propre Jeton Bearer généré.
List
list.fields.
L’objet List n’apparaît pas comme enfant d’autres objets data. En revanche, des objets utilisateur peuvent être trouvés et étendus dans la ressource utilisateur. Ces objets sont disponibles pour extension en ajoutant owner_id au paramètre de query expansions. Utilisez cette expansion avec le paramètre de champ list.fields lorsque vous demandez des champs supplémentaires afin de compléter l’objet List principal, et user.fields pour compléter l’objet étendu.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | L’identifiant unique de cette List."id": "2244994945" | Utilisez ceci pour récupérer par programmation des informations sur une List spécifique. |
| name (default) | string | Le nom de la List, tel que défini lors de sa création."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | La date et l’heure UTC auxquelles la List a été créée."created_at": "2013-12-14T04:35:55.000Z" | Déterminez depuis combien de temps une List existe sur Twitter. |
| description | string | Une brève description pour informer les utilisateurs à propos de la List."description": "People that are active members of the Bay area cycling community on Twitter." | |
| follower_count | integer | Indique combien d’utilisateurs suivent cette List."follower_count": 198 | |
| member_count | integer | Indique combien de membres font partie de cette List."member_count": 60 | |
| private | boolean | Indique si la List est privée."private": false | |
| owner_id | string | Identifiant unique du propriétaire de cette List."owner_id": "1255542774432063488" | Peut être utilisé pour déterminer si cet utilisateur possède d’autres Lists et pour étendre des objets utilisateur. |
$BEARER_TOKEN par votre Jeton Bearer généré.
Médias
?expansions=attachments.media_keys pour obtenir l’objet condensé avec uniquement les champs par défaut. Utilisez cette extension avec le paramètre de champ media.fields lorsque vous demandez des champs supplémentaires pour compléter l’objet.
| Valeur du champ | Type | Description | Comment il peut être utilisé |
|---|---|---|---|
| media_key (par défaut) | string | Identifiant unique du contenu média étendu. "media_key": "13_1263145212760805376" | Peut être utilisé pour récupérer des médias par programmation |
| type (par défaut) | string | Type de contenu (animated_gif, photo, video). "type": "video" | Classer le média comme photo, GIF ou vidéo |
| url | string | Une URL directe vers le fichier média sur X. | Renvoie un objet Media avec un champ URL pour les photos |
| duration_ms | integer | Disponible lorsque le type est video. Durée de la vidéo en millisecondes. "duration_ms": 46947 | |
| height | integer | Hauteur de ce contenu en pixels. "height": 1080 | |
| non_public_metrics | object | Métriques d’engagement non publiques pour le contenu média au moment de la requête. Nécessite une authentification avec contexte utilisateur. "non_public_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183,} | Déterminer l’engagement vidéo : combien d’utilisateurs ont visionné chaque quart de la vidéo. |
| organic_metrics | object | Métriques d’engagement pour le contenu média, suivies dans un contexte organique, au moment de la requête. Nécessite une authentification avec contexte utilisateur. "organic_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183, "view_count": 629} | Déterminer l’engagement organique du média. |
| preview_image_url | string | URL de l’aperçu statique de remplacement de ce contenu. "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
| promoted_metrics | object | Métriques d’engagement pour le contenu média, suivies dans un contexte sponsorisé, au moment de la requête. Nécessite une authentification avec contexte utilisateur. "promoted_metrics": { "playback_0_count": 259, "playback_100_count": 15, "playback_25_count": 113, "playback_50_count": 57, "playback_75_count": 25, "view_count": 124} | Déterminer l’engagement du média lorsque le Tweet était sponsorisé. |
| public_metrics | object | Métriques d’engagement publiques pour le contenu média au moment de la requête. "public_metrics": { "view_count": 6865141} | Déterminer le nombre total de vues pour la vidéo jointe au Tweet. |
| width | integer | Largeur de ce contenu en pixels. "width": 1920 | |
| alt_text | string | Description d’une image pour favoriser l’accessibilité. Peut contenir jusqu’à 1000 caractères. Le texte alternatif ne peut être ajouté qu’aux images pour le moment. "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | Peut être utilisé pour fournir une description écrite d’une image si un utilisateur est malvoyant. |
| variants | array | Chaque objet media peut avoir plusieurs variantes d’affichage ou de lecture, avec différentes résolutions ou formats. "variants": [{ "bit_rate": 632000, "content_type": "video/mp4", "url": "https://video.twimg.com/ext_tw_video/1527322141724532740/pu/vid/320x568/lnBaR2hCqE-R_90a.mp4?tag=12"}] |
attachment.media_keys est requise. Veillez à remplacer $BEARER_TOKEN par votre propre Jeton Bearer généré.
Sondage
?expansions=attachments.poll_ids pour obtenir l’objet condensé avec uniquement les champs par défaut. Utilisez cette expansion avec le paramètre de champs poll.fields lorsque vous demandez des champs supplémentaires pour compléter l’objet.
| Valeur du champ | Type | Description |
|---|---|---|
| id (par défaut) | string | Identifiant unique du sondage développé. |
{"id": "1199786642791452673"} | ||
| options (par défaut) | array | Contient des objets décrivant chaque choix dans le sondage référencé. |
{"options": [ { "position": 1, "label": "“C Sharp”", "votes": 795 }, { "position": 2, "label": "“C Hashtag”", "votes": 156 } ]} | ||
| duration_minutes | integer | Indique la durée totale de ce sondage. |
{"duration_minutes": 1440} | ||
| end_datetime | date (ISO 8601) | Indique la date et l’heure de fin de ce sondage. |
{"end_datetime": "2019-11-28T20:26:41.000Z"} | ||
| voting_status | string | Indique si ce sondage est toujours actif et peut recevoir des votes, ou si le vote est désormais clôturé. |
{"voting_status": "closed"} |
attachments.poll_id est requise. Assurez-vous de remplacer $BEARER_TOKEN par votre Jeton Bearer généré.
Lieu
?expansions=geo.place_id pour obtenir l’objet condensé avec uniquement les champs par défaut. Utilisez l’expansion avec le paramètre de champs place.fields lorsque vous demandez des champs supplémentaires pour compléter l’objet.
| Valeur du champ | Type | Description | Utilisation possible |
|---|---|---|---|
| full_name (par défaut) | string | Un nom de lieu détaillé en version longue. | Classer un Tweet par un nom de lieu précis |
"full_name": "Manhattan, NY" | |||
| id (par défaut) | string | L’identifiant unique du lieu développé, s’il s’agit d’un point d’intérêt étiqueté dans le Tweet. | À utiliser pour récupérer un lieu par code |
"id": "01a9a39529b27f36" | |||
| contained_within | array | Renvoie les identifiants des lieux connus qui contiennent le lieu référencé. | |
| country | string | Le nom complet du pays auquel appartient ce lieu. | Classer un Tweet par nom de pays |
"country": "United States" | |||
| country_code | string | Le code pays ISO Alpha-2 auquel appartient ce lieu. | Classer un Tweet par code pays |
"country_code": "US" | |||
| geo | object | Contient les détails du lieu au format GeoJSON. | |
| `json | |||
| ”geo”: | |||
| “type”: “Feature”, | |||
| “bbox”: [ | |||
| -74.026675, | |||
| 40.683935, | |||
| -73.910408, | |||
| 40.877483 | |||
| ], | |||
| “properties”: | |||
| } | |||
| ` | |||
| name | string | Le nom court de ce lieu. | Classer un Tweet par un nom de lieu précis |
"name": "Manhattan" | |||
| place_type | string | Précise le type d’information représenté par ces données de lieu, comme un nom de ville ou un point d’intérêt. | Classer un Tweet par type de lieu spécifique |
"place_type": "city" |
geo.place_id est requise. Assurez-vous de remplacer $BEARER_TOKEN par votre propre Jeton Bearer généré.
Événements de Messages privés
- sender_id - L’id du compte qui a envoyé le message, ou qui a invité un participant à une conversation de groupe
- participant_ids - Un tableau d’id de comptes. Pour les événements ParticipantsJoin et ParticipantsLeave, ce tableau contiendra un seul id : celui du compte qui a créé l’événement
- attachments - Fournit les id de médias pour le contenu téléversé sur X par l’expéditeur
- referenced_tweets - Si une URL de Tweet est trouvée dans le champ text, l’id de ce Tweet est inclus dans la réponse
| Valeur du champ | Type | Description | Comment il peut être utilisé |
| id (par défaut) | string | Identifiant unique de l’événement. ”id”: “1050118621198921728” | Utilisez-le pour récupérer par programmation un événement de conversation spécifique (disponible avec les endpoints v1.1). |
| event_type (par défaut) | string | Décrit le type d’événement. Trois types sont actuellement pris en charge : * MessageCreate * ParticipantsJoin * ParticipantsLeave “event_type”: “MessageCreate” | Lors de la récupération de l’historique d’une conversation, permet de savoir quand les messages ont été créés et, pour les conversations de groupe, quand les participants ont rejoint et quitté. Toutes les méthodes GET prennent en charge le filtrage sur des types d’événements spécifiques avec le paramètre de requête event_type=. |
| text (par défaut) | string | Le texte UTF-8 du Message privé. ”text”: “Hello, just you!” | Avec des chatbots, ce champ peut servir à analyser le contenu des messages et à déterminer des réponses automatisées. Peut aussi être utilisé pour créer des fonctionnalités de recherche de conversations. |
| entities | object | Entités extraites du texte du Message privé. | Fournit des informations supplémentaires sur les hashtags, URL, mentions, etc. |
| sender_id | string | ID de l’utilisateur qui crée l’événement. Pour développer cet objet dans la réponse, incluez sender_id comme expansion et utilisez le paramètre de requête user.fields pour spécifier les attributs de l’objet utilisateur qui vous intéressent. ”sender_id”: “906948460078698496” | Récupérer l’objet utilisateur de la personne qui a créé l’événement MessageCreate ou ParticipantsJoin. |
| participant_ids | array (of strings) | IDs des participants rejoignant et quittant une conversation de groupe. Également utilisé lors de la création de nouvelles conversations de groupe. Pour développer cet objet dans la réponse, incluez participant_ids comme expansion et utilisez le paramètre de requête user.fields pour spécifier les attributs de l’objet utilisateur qui vous intéressent. ”participant_ids”: [ “906948460078698496” ] | Utilisé pour récupérer les objets utilisateur des participants rejoignant et quittant les conversations de groupe. |
| dm_conversation_id | string | Identifiant unique de la conversation à laquelle l’événement appartient. ”dm_conversation_id”: “1584988213961031680” | Utilisez-le pour récupérer par programmation des événements d’une conversation et y ajouter des Messages privés. |
| created_at | date (ISO 8601) | Heure de création (UTC) du Tweet. ”created_at”: “2019-06-04T23:12:08.000Z” | Ce champ peut servir à déterminer quand un Message privé a été créé ou quand des participants à la conversation ont rejoint ou quitté. |
| referenced_tweets | array | ID de tout Tweet mentionné dans le texte du Message privé. Pour développer cet objet dans la réponse, incluez referenced_tweets.id comme expansion et utilisez le paramètre de requête tweet.fields pour spécifier les attributs de l’objet Tweet qui vous intéressent. ”referenced_tweets”: [ “id”: “1578868150510456833” ] | Lorsque des Messages privés font référence à un Tweet, ces IDs peuvent servir à rechercher les détails du Tweet. |
| attachments | object | Pour les Messages privés avec média joint, fournit la clé média du contenu téléversé (photo, vidéo ou GIF). Pour développer cet objet dans la réponse, incluez attachments.media_keys comme expansion et utilisez le paramètre de requête media.fields pour spécifier les attributs de l’objet média qui vous intéressent. Actuellement, une seule pièce jointe est prise en charge. ”attachments”: “media_keys”: [ “3_1136048009270239232” ] | Permet de comprendre les objets média joints aux Messages privés. |
- Des attributs d’événement fondamentaux tels que sa date de création et la conversation dont il fait partie (dm_conversation).
- L’ID du compte et la description de l’expéditeur du Message privé.
- Le texte de tout Tweet référencé, et sa date de publication.
- L’ID du compte et la description de tout auteur de Tweet référencé.
?dm_event.fields=id,sender_id,text,created_at,dm_conversation_id&expansions=sender_id,referenced_tweets.id&tweet.fields=created_at,text,author_id&user.fields=description
Communauté
| Field value | Type | Description | |
|---|---|---|---|
| created_at | date (ISO 8601) | Date de création de la Communauté. | |
| id | string | L’identifiant unique de la Communauté. | |
| name | string | Le nom de la Communauté. | |
| description | string | Le texte de la description de la Communauté, le cas échéant. | |
| access | string | Le niveau d’accès de la Communauté. Peut être l’un des suivants : | |
- Public | |||
- Closed | |||
| join_policy | string | La politique d’adhésion de la Communauté. Peut être l’un des suivants : | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | Le nombre de membres ayant rejoint la Communauté. |
$BEARER_TOKEN par votre propre Jeton Bearer.
Comment utiliser fields et expansions
fields et expansions dans votre requête afin de recevoir des objets et des champs supplémentaires dans votre réponse.
Dans ce guide, nous demanderons plusieurs champs en nous basant sur la capture d’écran de Tweet suivante.
Demander des champs et objets supplémentaires.
- Identifiez les fields supplémentaires que vous souhaitez demander en utilisant notre modèle d’objet, ou en consultant la liste des fields dans les pages de référence de l’API des endpoints. Dans ce cas, nous demanderons les champs supplémentaires suivants : attachments, author_id, created_at, public_metrics.
-
Créez le paramètre de requête
tweet.fieldsen lui donnant pour valeur les champs ci‑dessus, sous forme de liste séparée par des virgules :?tweet.fields=attachments,author_id,created_at,public_metrics - Ajoutez le paramètre query à la requête GET /tweets que vous avez effectuée plus tôt.
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics' \ --header 'Authorization: Bearer $BEARER_TOKEN'
Réponse :
- Ensuite, nous allons demander les champs liés à la vidéo qui était incluse dans le Tweet. Pour ce faire, nous utiliserons le paramètre
expansionsavecattachments.media_keyscomme valeur, et nous l’ajouterons à la requête.
- Et enfin, nous allons récupérer le nombre de vues et la durée de la vidéo. Ces champs ne sont pas inclus par défaut, nous devons donc les demander explicitement. Utilisez le paramètre
media.fieldsavec les valeurs séparées par des virgules :public_metricsetduration_msdans votre requête.
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics&expansions=attachments.media_keys&media.fields=duration_ms,public_metrics' --header 'Authorization: Bearer $BEARER_TOKEN'
Réponse, qui inclut désormais toutes les données visibles dans la capture d’écran du Tweet :
- ids=1260294888811347969
- tweet.fields=attachments,author_id,created_at,public_metrics
- expansions=attachments.media_keys
- media.fields=public_metrics,duration_ms