| Objet | Description | Paramètre fields |
|---|---|---|
| Post (Tweet) | Publications, réponses, republications, citations | tweet.fields |
| User | Profils de compte et métadonnées | user.fields |
| Space | Conversations audio en direct | space.fields |
| List | Ensembles de comptes sélectionnés | list.fields |
| Media | Images, vidéos, GIFs | media.fields |
| Poll | Questions de sondage et options | poll.fields |
| Place | Données de localisation et géographiques | place.fields |
Publication (Tweet)
id, text, edit_history_tweet_ids
Utilisez tweet.fields pour demander des champs supplémentaires et expansions pour inclure des objets associés.
Tous les champs de Publication
| Valeur du champ | Type | Description | Utilisation |
|---|---|---|---|
| id (par défaut) | string | Identifiant unique du Tweet demandé. | Utilisez-le pour récupérer par programmation un Tweet spécifique. |
| text (par défaut) | string | Le texte UTF-8 proprement dit du Tweet. Consultez twitter-text pour plus de détails sur les caractères valides. | Extraction de mots-clés, analyse et classification des sentiments. |
| edit_history_tweet_ids (default) | object | Identifiants uniques indiquant toutes les versions d’un Tweet. Pour les Tweets sans modification, il n’y aura qu’un seul ID. Pour les Tweets avec un historique de modifications, il y aura plusieurs ID. | Utilisez ces informations pour retrouver l’historique des modifications d’un Tweet. |
| article | object | Contient les métadonnées de l’Article présent dans ce Tweet. | Utilisez-le pour obtenir le texte et les entités d’un Article. |
| attachments | object | Spécifie le type des éventuelles pièces jointes présentes dans ce Tweet. | Comprendre les objets renvoyés pour les expansions demandées. |
| author_id | string | Identifiant unique de l’utilisateur qui a publié ce Tweet. | Hydratation de l’objet utilisateur, partage d’un jeu de données pour relecture par des pairs. |
| card_uri | string | L’URI de la Carte présente dans ce Tweet. | |
| community_id | string | Identifiant unique de la Communauté à laquelle cette Publication appartient. | |
| context_annotations | array | Contient les annotations de contexte associées au Tweet. | Reconnaissance/extraction d’entités, analyse thématique. |
| conversation_id | string | L’ID du Tweet d’origine de la conversation (qui inclut les réponses directes et les réponses aux réponses). | Utilisez-le 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 pour comprendre quand un Tweet a été créé. |
| display_text_range | array | Tableau contenant des indices de début et de fin pour la portion de texte affichée. | Utile pour savoir quelle portion de texte est affichée par défaut pour les publications longues. |
| edit_controls | object | Indique pendant combien de temps le Tweet peut encore être modifié et le nombre de modifications restantes. | Utilisez-le pour déterminer si un Tweet est éligible à la modification. |
| entities | object | Entités qui ont été extraites du texte du Tweet. Voir les entités dans les objets Twitter. | Fournit des informations supplémentaires sur les hashtags, les URL, les mentions, etc. |
| geo | object | Indique l’emplacement ou le lieu d’un Tweet géolocalisé. | Utilisez ce champ 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 contient l’id de l’auteur du Tweet original. | Permet de déterminer si un Tweet est une réponse à un autre Tweet. |
| lang | string | Langue du Tweet, si elle est détectée par X. | Classer les Tweets par langue utilisée. |
| non_public_metrics | object | Mesures d’engagement non publiques pour le Tweet au moment de la requête. Nécessite une authentification en contexte utilisateur. | Déterminer le nombre total d’impressions générées pour le Tweet. |
| note_tweet | object | Contient le texte complet d’une Publication pour les Publications longues (> 280 caractères). | Récupérer le texte complet d’une Publication. |
| organic_metrics | object | Mesures d’engagement, suivies dans un contexte organique, pour le Tweet au moment de la requête. Nécessite une authentification en contexte utilisateur. | Mesurer l’engagement organique pour le Tweet. |
| possibly_sensitive | boolean | Indique si le contenu peut être considéré comme sensible. | Analyser la diffusion de certains types de contenu. |
| promoted_metrics | object | Mesures d’engagement, suivies dans un contexte promotionnel, pour le Tweet au moment de la requête. Nécessite une authentification en contexte utilisateur. | Mesurer l’engagement pour le Tweet lorsqu’il a été promu. |
| public_metrics | object | Mesures d’engagement publiques pour le Tweet au moment de la requête. | Mesurer l’engagement généré par le Tweet. |
| referenced_tweets | array | Liste des Tweets auxquels ce Tweet fait référence, comme les Retweets, les Tweets cités ou les réponses. | Comprendre les aspects conversationnels des Retweets, des Tweets cités et des réponses. |
| reply_settings | string | Indique qui peut répondre à un Tweet donné. Les options sont « everyone », « mentioned_users » et « followers ». | Déterminer les paramètres de réponse à la conversation pour le Tweet. |
| withheld | object | Contient les informations relatives aux restrictions appliquées au contenu soumis à des restrictions. | |
| scopes | object | Contient les détails de la portée (scope) pour le Tweet. | Indique qui peut voir la Publication. Uniquement renvoyé pour les Publications promues. |
| media_metadata | tableau | Contient les métadonnées des pièces jointes média associées au Tweet. | Obtenir des métadonnées supplémentaires, comme le alt_text de la pièce jointe média d’un Tweet. |
$BEARER_TOKEN par votre propre Jeton Bearer que vous avez généré.
Utilisateur
user.fields.
L’objet user peut également apparaître comme objet enfant et être étendu dans l’objet Tweet. L’objet peut être obtenu via l’extension ?expansions=author_id ou ?expansions=in_reply_to_user_id pour récupérer l’objet condensé avec uniquement les champs par défaut. Utilisez cette extension avec le paramètre user.fields lorsque vous demandez des champs supplémentaires pour compléter l’objet.
| Valeur du champ | Type | Description | Utilisations possibles |
|---|---|---|---|
| id (par défaut) | chaîne de caractères | L’identifiant unique de cet utilisateur."id": "2244994945" | Pour récupérer par programmation des informations sur un utilisateur Twitter spécifique. |
| name (par défaut) | chaîne de caractères | Le nom de l’utilisateur, tel qu’il apparaît sur son profil. Pas nécessairement un nom de personne. En général limité à 50 caractères, mais cette limite peut évoluer."name": "Twitter Dev" | |
| username (par défaut) | chaîne de caractères | Le nom d’écran, handle ou alias Twitter que cet utilisateur utilise pour s’identifier. Les noms d’utilisateur sont uniques, mais peuvent être modifiés. En règle générale, ils comportent au maximum 15 caractères, mais certains comptes historiques peuvent avoir des noms plus longs."username": "TwitterDev" | |
| affiliation | objet | Contient des détails sur l’affiliation d’un utilisateur. | Peut être utilisé pour obtenir le badge d’affilié d’un utilisateur. |
| confirmed_email | chaîne de caractères | L’adresse e‑mail confirmée de l’utilisateur authentifié. | |
| connection_status | tableau | Fournit une liste des relations entre l’utilisateur authentifié et l’utilisateur consulté, telles que : suit, suivi par, demande d’abonnement envoyée, demande d’abonnement 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 l’état de connexion entre l’utilisateur authentifié et l’utilisateur recherché. |
| created_at | date (ISO 8601) | La date et l’heure UTC de création du compte de l’utilisateur sur Twitter."created_at": "2013-12-14T04:35:55.000Z" | Peut être utilisé pour déterminer depuis combien de temps une personne utilise Twitter. |
| description | chaîne de caractères | Texte de la description de profil de cet utilisateur (également appelée « bio »), si l’utilisateur en a fourni une."description": "La voix de l'équipe X Dev et votre source officielle pour les mises à jour, les actualités et les événements liés à la X API." | |
| entities | objet | Contient des détails sur les éléments de texte ayant une signification particulière dans la description du profil 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’utilisateur et les cashtags associés à la description. Consultez chaque entité correspondante pour plus de détails. Tous les indices utilisateur start sont inclusifs, tandis que tous les indices utilisateur end sont exclusifs. |
| is_identity_verified | booléen | Indique si l’utilisateur est vérifié par pièce d’identité. | |
| location | chaîne de caractères | Le lieu indiqué dans le profil de l’utilisateur, si l’utilisateur en a fourni un. Comme il s’agit d’une valeur librement saisie, il se peut qu’il ne corresponde pas à un lieu valide, mais il peut être évalué de manière approximative lors de recherches avec des requêtes de localisation."location": "127.0.0.1" | |
| most_recent_tweet_id | chaîne de caractères | 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 | booléen | Indique si ce compte utilisateur possède ou non le label « Parody ». | |
| pinned_tweet_id | chaîne de caractères | Identifiant unique du Tweet épinglé de cet utilisateur."pinned_tweet_id": "1255542774432063488" | Identifie le Tweet épinglé en haut du profil de l’utilisateur. Peut également être utilisé pour déterminer la langue de l’utilisateur. |
| profile_banner_url | chaîne de caractères | URL de la bannière de profil de cet utilisateur, telle qu’elle apparaît sur son profil."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Permet de télécharger la bannière de profil de cet utilisateur. |
| profile_image_url | chaîne de caractères | L’URL de l’image de profil de cet utilisateur, telle qu’elle apparaît sur le profil de cet utilisateur."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Permet de télécharger l’image de profil de cet utilisateur. |
| protected | booléen | Indique si cet utilisateur a choisi de protéger ses Tweets (c’est-à-dire si ses Tweets sont privés)."protected": false | |
| public_metrics | objet | 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 estimer la portée ou l’influence d’un utilisateur sur X, ainsi que pour quantifier l’ampleur de ses centres d’intérêt et son niveau d’engagement sur X. |
| receives_your_dm | booléen | Indique si cet utilisateur recevra le DM de l’utilisateur authentifié. | |
| subscription | objet | Contient des informations indiquant si l’utilisateur est abonné ou non à l’utilisateur authentifié. | |
| subscription_type | chaîne de caractères | Une chaîne de caractères indiquant le type d’abonnement X Premium de l’utilisateur authentifié. Exemple : None, Basic, Premium, PremiumPlus. La valeur sera toujours None si l’utilisateur n’est pas l’utilisateur authentifié. | |
| url | chaîne de caractères | L’URL indiquée dans le profil de l’utilisateur, le cas échéant."url": "https://t.co/3ZX3TNiZCY" | URL fournie par un utilisateur dans son profil. Il peut s’agir d’une page d’accueil, mais pas nécessairement. |
| verified | booléen | Indique si cet utilisateur est un utilisateur vérifié sur Twitter."verified": true | Indique si cet utilisateur possède un compte X vérifié. Un compte vérifié permet d’indiquer qu’un compte d’intérêt public est authentique. |
| verified_followers_count | chaîne de caractères | Chaîne de caractères représentant le nombre d’abonnés vérifiés d’un utilisateur. | |
| verified_type | chaîne de caractères | Chaîne de caractères représentant le type de vérification dont dispose un utilisateur. Exemple : « blue », « business », « government » | |
| withheld | objet | Contient les détails de restriction pour le contenu restreint, le cas échéant. |
$BEARER_TOKEN par votre propre Jeton Bearer.
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 application gère des données de Spaces, vous êtes responsable de renvoyer les informations les plus récentes et devez supprimer les données qui ne sont plus disponibles sur la plateforme. Les endpoints de recherche de Spaces peuvent vous aider à vous assurer que vous respectez les attentes et 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" | Savoir quand un Space a été créé et trier par heure. |
| 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é afin de calculer sa durée. |
| host_ids | array | Identifiants uniques des hôtes du Space."host_ids": ["2244994945", "6253282"] | Étendre les objets User, comprendre l’engagement. |
| lang | string | Langue du Space, si elle est 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 intéressant. |
| invited_user_ids | array | Liste des identifiants des utilisateurs invités comme speakers."invited_user_ids": ["2244994945", "6253282"] | Étendre les objets User, comprendre l’engagement. |
| participant_count | integer | Nombre d’utilisateurs dans le Space, y compris les hôtes et les speakers."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 | Comprendre 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 User, comprendre l’engagement. |
| started_at | date (ISO 8601) | Heure de début réelle 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 | Identifiants 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 métadonnées du Space."updated_at": "2021-07-11T14:44:44.000Z" | Garder les informations à jour. |
$BEARER_TOKEN par votre propre Jeton Bearer que vous aurez généré.
Liste
list.fields.
L’objet Liste ne se trouve pas comme enfant d’autres objets de données. En revanche, les objets utilisateur peuvent être trouvés et développés dans la ressource user. Ces objets peuvent être inclus via expansion en ajoutant owner_id au paramètre de requête expansions. Utilisez cette expansion avec le paramètre de champs list.fields lorsque vous demandez des champs supplémentaires afin de compléter l’objet Liste principal, et user.fields pour compléter l’objet d’extension.
| Valeur du champ | Type | Description | Comment il peut être utilisé |
|---|---|---|---|
| id (par défaut) | string | L’identifiant unique de cette Liste."id": "2244994945" | Utilisez-le pour récupérer par programmation des informations sur une Liste spécifique. |
| name (par défaut) | string | Le nom de la Liste, tel que défini lors de la création de la Liste."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | La date et l’heure UTC auxquelles la Liste a été créée."created_at": "2013-12-14T04:35:55.000Z" | Déterminez depuis combien de temps une Liste existe sur Twitter. |
| description | string | Une brève description pour informer les utilisateurs sur la Liste."description": "People that are active members of the Bay area cycling community on Twitter." | |
| follower_count | integer | Indique combien d’utilisateurs suivent cette Liste."follower_count": 198 | |
| member_count | integer | Indique combien de membres font partie de cette Liste."member_count": 60 | |
| private | boolean | Indique si la Liste est privée."private": false | |
| owner_id | string | Identifiant unique du propriétaire de cette Liste."owner_id": "1255542774432063488" | Peut être utilisé pour savoir si cet utilisateur possède d’autres Listes et pour développer les 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 ce paramètre avec le paramètre de champs media.fields lorsque vous demandez des champs supplémentaires pour compléter l’objet.
| Field value | Type | Description | How it can be used |
|---|---|---|---|
| media_key (default) | string | Identifiant unique du contenu média étendu. "media_key": "13_1263145212760805376" | Peut être utilisé pour récupérer le média de façon programmatique |
| type (default) | string | Type de contenu (animated_gif, photo, video). "type": "video" | Classer le média comme photo, GIF ou vidéo |
| url | string | URL directe vers le fichier média sur Twitter. | Retourne un objet Media avec un champ URL pour les photos |
| duration_ms | integer | Disponible lorsque type vaut 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 lu la vidéo jusqu’à chaque quart. |
| 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 sur le média. |
| preview_image_url | string | URL de l’aperçu statique 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 promotionnel, 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 sur le média lorsque le Tweet a été promu. |
| 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 afin d’améliorer l’accessibilité. Peut contenir jusqu’à 1000 caractères. Le texte alternatif ne peut pour l’instant être ajouté qu’aux images. "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 dans le cas où un utilisateur est malvoyant. |
| variants | array | Chaque objet média peut avoir plusieurs variantes d’affichage ou de lecture, avec des résolutions ou des formats différents. "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. Assurez-vous de remplacer $BEARER_TOKEN par votre propre Jeton Bearer que vous avez généré.
Sondage
?expansions=attachments.poll_ids afin d’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 | Spécifie la durée totale de ce sondage. |
{"duration_minutes": 1440} | ||
| end_datetime | date (ISO 8601) | Spécifie 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. Veillez à remplacer $BEARER_TOKEN par votre propre Jeton Bearer généré.
Lieu
?expansions=geo.place_id afin d’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 | Comment il peut être utilisé |
|---|---|---|---|
| full_name (par défaut) | string | Un nom de lieu détaillé sous une forme plus longue. | Classer un Tweet par nom de lieu spécifique |
"full_name": "Manhattan, NY" | |||
| id (par défaut) | string | L’identifiant unique du lieu étendu, s’il s’agit d’un point d’intérêt tagué dans le Tweet. | Utilisez-le pour récupérer un lieu par programmation |
"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 de 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 nom de lieu spécifique |
"name": "Manhattan" | |||
| place_type | string | Précise le type particulier d’information représenté par ce lieu, comme un nom de ville ou un point d’intérêt. | Classer un Tweet par type spécifique de lieu |
"place_type": "city" |
geo.place_id est requise. Veillez à remplacer $BEARER_TOKEN par votre propre Jeton Bearer généré.
Événements de Direct Message
- sender_id - L’identifiant du compte qui a envoyé le message ou qui a invité un participant à une conversation de groupe
- participant_ids - Un tableau d’identifiants de comptes. Pour les événements ParticipantsJoin et ParticipantsLeave, ce tableau contient un seul identifiant : celui du compte qui a créé l’événement
- attachments - Fournit les identifiants de médias pour le contenu qui a été téléversé sur Twitter par l’expéditeur
- referenced_tweets - Si une URL de Tweet est trouvée dans le champ text, l’identifiant de ce Tweet est inclus dans la réponse
| Valeur du champ | Type | Description | Utilisation possible |
| id (default) | string | L’identifiant unique de l’événement. ”id”: “1050118621198921728” | Utilisez‑le pour récupérer par programme un événement de conversation spécifique (disponible avec les endpoints v1.1). |
| event_type (default) | 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 comprendre quand les messages ont été créés et, pour les conversations de groupe, quand les participants ont rejoint et quitté la conversation. 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 (default) | string | Le texte UTF‑8 du message privé (Direct Message). “text”: “Hello, just you!” | Avec des chatbots, ceci peut être utilisé pour analyser le contenu des messages et déterminer des réponses automatisées. Peut servir à créer des fonctionnalités de recherche dans les conversations. |
| entities | object | Entités extraites du texte du DM. | 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 étendre 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 User qui vous intéressent. ”sender_id”: “906948460078698496” | Permet de récupérer l’objet User de l’auteur de l’événement MessageCreate ou ParticipantsJoin. |
| participant_ids | array (of strings) | IDs des participants qui rejoignent ou quittent une conversation de groupe. Également utilisé lors de la création de nouvelles conversations de groupe. Pour étendre 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 User qui vous intéressent. ”participant_ids”: [ “906948460078698496” ] | Utilisé pour récupérer les objets User des participants qui rejoignent ou quittent des conversations de groupe. |
| dm_conversation_id | string | L’identifiant unique de la conversation à laquelle l’événement appartient. ”dm_conversation_id”: “1584988213961031680” | Utilisez‑le pour récupérer par programme des événements d’une conversation et y ajouter des Direct Messages. |
| created_at | date (ISO 8601) | Heure de création (UTC) du Tweet. ”created_at”: “2019-06-04T23:12:08.000Z” | Ce champ peut être utilisé pour savoir quand un Direct Message a été créé ou quand les participants à la conversation ont rejoint ou quitté celle‑ci. |
| referenced_tweets | array | ID de tout Tweet mentionné dans le texte du Direct Message. Pour étendre 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 Direct Messages font référence à un Tweet, ces IDs peuvent être utilisés pour rechercher les détails du Tweet. |
| attachments | object | Pour les Direct Messages avec média joint, fournit la clé média du contenu téléversé (photo, vidéo ou GIF). Pour étendre 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 media qui vous intéressent. Actuellement, une seule pièce jointe est prise en charge. “attachments”: “media_keys”: [ “3_1136048009270239232” ] | Permet de comprendre les objets media joints aux Direct Messages. |
- Des attributs fondamentaux de l’événement, comme le moment de sa création et la conversation dont il fait partie (dm_conversation).
- L’identifiant de compte et la description de l’expéditeur du Direct Message.
- Le texte de tout Tweet référencé, et le moment où il a été publié.
- L’identifiant de 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 et heure 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é, si elle est fourni. | |
| access | string | Le niveau d’accès de la communauté. Peut prendre l’une des valeurs suivantes : | |
- Public | |||
- Closed | |||
| join_policy | string | La politique d’adhésion à la communauté. Peut prendre l’une des valeurs suivantes : | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | Le nombre de membres qui ont rejoint la communauté. |
$BEARER_TOKEN par votre propre Jeton Bearer.
Comment utiliser les champs et les expansions
fields et expansions dans votre requête pour recevoir des objets et des champs supplémentaires dans votre réponse.
Dans ce guide, nous allons demander plusieurs champs présents dans la capture d’écran du Tweet suivante.
Comme vous pouvez le voir sur la capture d’écran, plusieurs éléments d’information visibles sont liés au Tweet, notamment l’auteur du Tweet, les métriques du Tweet, l’horodatage de création, la vidéo et le nombre de vues de la vidéo. Il existe également plusieurs éléments de données qui ne sont pas visibles dans la capture d’écran, mais qui restent néanmoins disponibles sur demande via l’API.
Lorsque vous effectuez une requête vers l’API, la réponse par défaut est simple et ne contient que les champs de Tweet par défaut (id et text). Vous ne recevrez alors que l’objet principal renvoyé par l’endpoint que vous utilisez, et non les objets de données associés pouvant être liés à l’objet principal.
Cette simplicité, associée aux paramètres de requête fields et expansions, vous permet de demander uniquement les champs dont vous avez besoin, en fonction de votre cas d’usage.
Demande de champs et d’objets supplémentaires.
- Identifiez les champs supplémentaires que vous souhaitez demander en vous appuyant sur notre modèle d’objet ou en consultant la liste des champs figurant dans les pages de Référence de l’API des points de terminaison. 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 utilisant les champs ci-dessus comme valeur, sous la forme d’une liste séparée par des virgules :?tweet.fields=attachments,author_id,created_at,public_metrics - Ajoutez le paramètre de requête à la requête GET /tweets que vous avez envoyé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 des champs liés à la vidéo incluse dans le Tweet. Pour ce faire, nous utiliserons le paramètre
expansionsavec la valeurattachments.media_keys, que nous ajouterons à la requête.
- Enfin, nous allons récupérer le nombre de vues et la durée de la vidéo. Ces champs ne sont pas retournés par défaut, il faut donc les demander explicitement. Utilisez le paramètre
media.fieldsavec les valeurs séparées par des virgulespublic_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'
La réponse, qui contient désormais l’ensemble des 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