Objektmodell
Tweet
id, text und created_at. Tweet-Objekte sind außerdem das „übergeordnete“ Objekt für mehrere untergeordnete Objekte, darunter user, media, poll und place. Verwenden Sie den Feldparameter tweet.fields, wenn Sie diese Root-Level-Felder für das Tweet-Objekt anfordern.
Das Tweet-Objekt kann in der User-Ressource gefunden und über Expansions eingebunden werden. Zusätzliche, mit dem angeforderten Tweet verwandte Tweets können ebenfalls in der Tweet-Ressource gefunden und erweitert werden. Das Objekt steht für Expansions mit ?expansions=pinned_tweet_id in der User-Ressource oder ?expansions=referenced_tweets.id in der Tweet-Ressource zur Verfügung, um das Objekt zunächst nur mit Standardfeldern zu erhalten. Verwenden Sie diese Expansion zusammen mit dem Feldparameter tweet.fields, wenn Sie zusätzliche Felder anfordern, um das Objekt zu vervollständigen.
| Feldwert | Typ | Beschreibung | Verwendungsmöglichkeiten |
|---|---|---|---|
| id (Standard) | string | Die eindeutige Kennung des angeforderten Tweet. | Verwenden Sie dies, um einen bestimmten Tweet programmatisch abzurufen. |
| text (Standard) | string | Der tatsächliche UTF-8-Text des Tweet. Siehe twitter-text für Details zu gültigen Zeichen. | Schlüsselwort-Extraktion und Sentiment-Analyse/Klassifizierung. |
| edit_history_tweet_ids (Standard) | object | Eindeutige Kennungen, die alle Versionen eines Tweet anzeigen. Für Tweets ohne Bearbeitungen gibt es eine ID. Für Tweets mit Bearbeitungsverlauf gibt es mehrere IDs. | Verwenden Sie diese Information, um den Bearbeitungsverlauf eines Tweet zu finden. |
| article | object | Enthält Metadaten für den Artikel, der in diesem Tweet vorhanden ist. | Verwenden Sie dies, um den Text und die Entitäten eines Artikels zu erhalten. |
| attachments | object | Gibt den Typ der Anhänge (falls vorhanden) in diesem Tweet an. | Verstehen der zurückgegebenen Objekte für angeforderte Erweiterungen. |
| author_id | string | Die eindeutige Kennung des Nutzers, der diesen Tweet gepostet hat. | Hydratisierung des User-Objekts, Teilen von Datensätzen für Peer-Review. |
| card_uri | string | Die URI für die Karte, die in diesem Tweet vorhanden ist. | |
| community_id | string | Die eindeutige Kennung für die Community, zu der dieser Post gehört. | |
| context_annotations | array | Enthält Kontext-Annotationen für den Tweet. | Entitätserkennung/-extraktion, thematische Analyse. |
| conversation_id | string | Die Tweet-ID des ursprünglichen Tweet der Unterhaltung (einschließlich direkter Antworten, Antworten auf Antworten). | Verwenden Sie dies, um die Unterhaltung aus einem Tweet zu rekonstruieren. |
| created_at | date (ISO 8601) | Erstellungszeit des Tweet. | Nützlich für Zeitreihenanalysen und das Verstehen, wann ein Tweet erstellt wurde. |
| display_text_range | array | Ein Array mit Start- und Endindex für den Textbereich, der angezeigt wird. | Nützlich, um zu wissen, welcher Textbereich standardmäßig für lange Posts angezeigt wird. |
| edit_controls | object | Zeigt an, wie lange der Tweet noch bearbeitet werden kann und die Anzahl der verbleibenden Bearbeitungen. | Verwenden Sie dies, um zu bestimmen, ob ein Tweet zur Bearbeitung berechtigt ist. |
| entities | object | Entitäten, die aus dem Text des Tweet geparst wurden. Siehe Entitäten in Twitter-Objekten. | Bietet zusätzliche Informationen über Hashtags, URLs, Erwähnungen usw. |
| geo | object | Zeigt den Standort oder Ort eines geo-getaggten Tweet an. | Verwenden Sie dies, um den Standort eines geo-getaggten Tweet zu ermitteln. |
| in_reply_to_user_id | string | Wenn der dargestellte Tweet eine Antwort ist, enthält dieses Feld die Autor-ID des ursprünglichen Tweet. | Bestimmen Sie, ob ein Tweet eine Antwort auf einen anderen Tweet war. |
| lang | string | Sprache des Tweet, falls von Twitter erkannt. | Klassifizierung von Tweets nach gesprochener Sprache. |
| non_public_metrics | object | Nicht-öffentliche Engagement-Metriken für den Tweet zum Zeitpunkt der Anfrage. Erfordert Nutzerkontext-Authentifizierung. | Bestimmen Sie die Gesamtimpressionen, die für den Tweet generiert wurden. |
| note_tweet | object | Enthält den vollständigen Text eines Post für lange Posts (>280 Zeichen). | Erhalten Sie den vollständigen Text eines Posts. |
| organic_metrics | object | Engagement-Metriken, verfolgt in einem organischen Kontext, für den Tweet zum Zeitpunkt der Anfrage. Erfordert Nutzerkontext-Authentifizierung. | Messen Sie organisches Engagement für den Tweet. |
| possibly_sensitive | boolean | Zeigt an, ob der Inhalt als sensibel erkannt werden könnte. | Studium der Verbreitung bestimmter Inhaltstypen. |
| promoted_metrics | object | Engagement-Metriken, verfolgt in einem beworbenen Kontext, für den Tweet zum Zeitpunkt der Anfrage. Erfordert Nutzerkontext-Authentifizierung. | Messen Sie Engagement für den Tweet, wenn er beworben wurde. |
| public_metrics | object | Öffentliche Engagement-Metriken für den Tweet zum Zeitpunkt der Anfrage. | Messen Sie Tweet-Engagement. |
| referenced_tweets | array | Eine Liste von Tweets, auf die sich dieser Tweet bezieht, wie Retweets, zitierte Tweets oder Antworten. | Verstehen Sie Unterhaltungsaspekte von Retweets usw. |
| reply_settings | string | Zeigt, wer auf einen bestimmten Tweet antworten kann. Optionen sind “everyone”, “mentioned_users” und “followers”. | Bestimmen Sie die Antworteinstellungen für die Unterhaltung des Tweet. |
| withheld | object | Enthält Zurückhaltungsdetails für zurückgehaltene Inhalte. | |
| scopes | object | Enthält Bereichsdetails für den Tweet. | Zeigt an, wer den Post sehen kann. Wird nur für beworbene Posts zurückgegeben. |
| media_metadata | array | Enthält Metadaten für Medienanhänge des Tweet. | Erhalten Sie zusätzliche Metadaten wie den alt_text eines Tweet’s Medienanhangs. |
$BEARER_TOKEN durch Ihr eigenes, generiertes Bearer Token.
Nutzer
user.fields.
Das User-Objekt kann auch als untergeordnetes Objekt im Tweet-Objekt vorkommen und per Expansion eingebunden werden. Das Objekt kann mit ?expansions=author_id oder ?expansions=in_reply_to_user_id einbezogen werden, um die komprimierte Variante nur mit Standardfeldern zu erhalten. Verwenden Sie die Expansion in Kombination mit dem Parameter user.fields, wenn Sie zusätzliche Felder anfordern, um das Objekt zu vervollständigen.
| Feldwert | Typ | Beschreibung | Verwendungsmöglichkeiten |
|---|---|---|---|
| id (Standard) | string | Die eindeutige Kennung dieses Benutzers."id": "2244994945" | Verwenden Sie dies, um programmatisch Informationen über einen bestimmten Twitter-Benutzer abzurufen. |
| name (Standard) | string | Der Name des Benutzers, wie er ihn in seinem Profil definiert hat. Nicht zwangsläufig der Name einer Person. Normalerweise auf 50 Zeichen begrenzt, kann sich jedoch ändern."name": "Twitter Dev" | |
| username (Standard) | string | Der Twitter-Bildschirmname, Handle oder Alias, mit dem sich dieser Benutzer identifiziert. Benutzernamen sind eindeutig, können sich jedoch ändern. Normalerweise maximal 15 Zeichen lang, aber einige historische Konten können längere Namen haben."username": "TwitterDev" | |
| affiliation | object | Enthält Details über die Zugehörigkeit eines Benutzers. | Kann verwendet werden, um das Zugehörigkeitsabzeichen eines Benutzers zu erhalten. |
| confirmed_email | string | Die bestätigte E-Mail-Adresse des authentifizierten Benutzers. | |
| connection_status | array | Stellt eine Liste der Beziehungen zwischen dem authentifizierenden Benutzer und dem nachgeschlagenen Benutzer bereit, wie z. B. folgen, gefolgt, Folge-Anfrage gesendet, Folge-Anfrage erhalten, blockieren, stummschalten ”connection_status”: [ “follow_request_received”, “follow_request_sent”, “blocking”, “followed_by”, “following”, “muting” ] | Kann verwendet werden, um den Verbindungsstatus zwischen dem authentifizierenden Benutzer und dem nachgeschlagenen Benutzer zu bestimmen. |
| created_at | date (ISO 8601) | Der UTC-Zeitstempel, zu dem das Benutzerkonto auf Twitter erstellt wurde."created_at": "2013-12-14T04:35:55.000Z" | Kann verwendet werden, um zu bestimmen, wie lange jemand bereits Twitter nutzt |
| description | string | Der Text der Profilbeschreibung dieses Benutzers (auch als Bio bekannt), falls der Benutzer eine bereitgestellt hat."description": "The voice of the X Dev team and your official source for updates, news, and events, related to the X API." | |
| entities | object | Enthält Details über Text, der eine besondere Bedeutung in der Beschreibung des Benutzers hat."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/> } | Entities sind JSON-Objekte, die zusätzliche Informationen über Hashtags, URLs, Benutzererwähnungen und Cashtags bereitstellen, die mit der Beschreibung verknüpft sind. Weitere Details finden Sie in der jeweiligen Entity. Alle Benutzer-start-Indizes sind inklusiv, während alle Benutzer-end-Indizes exklusiv sind. |
| is_identity_verified | boolean | Gibt an, ob der Benutzer ID-verifiziert ist. | |
| location | string | Der im Profil des Benutzers angegebene Standort, falls der Benutzer einen bereitgestellt hat. Da dies ein Freitextwert ist, zeigt er möglicherweise keinen gültigen Standort an, kann aber bei der Durchführung von Suchen mit Standortabfragen unscharf ausgewertet werden."location": "127.0.0.1" | |
| most_recent_tweet_id | string | Eindeutige Kennung des neuesten Tweets dieses Benutzers. | Ermittelt den neuesten Tweet des Benutzers. |
| parody | boolean | Gibt an, ob dieses Benutzerkonto das Parodie-Label hat oder nicht. | |
| pinned_tweet_id | string | Eindeutige Kennung des angehefteten Tweets dieses Benutzers."pinned_tweet_id": "1255542774432063488" | Ermittelt den Tweet, der oben im Profil des Benutzers angeheftet ist. Kann möglicherweise verwendet werden, um die Sprache des Benutzers zu bestimmen. |
| profile_banner_url | string | Die URL zum Profilbanner für diesen Benutzer, wie es im Profil des Benutzers angezeigt wird."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Kann verwendet werden, um das Profilbanner dieses Benutzers herunterzuladen. |
| profile_image_url | string | Die URL zum Profilbild für diesen Benutzer, wie es im Profil des Benutzers angezeigt wird."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Kann verwendet werden, um das Profilbild dieses Benutzers herunterzuladen. |
| protected | boolean | Gibt an, ob dieser Benutzer sich dafür entschieden hat, seine Tweets zu schützen (mit anderen Worten, ob die Tweets dieses Benutzers privat sind)."protected": false | |
| public_metrics | object | Enthält Details über die Aktivität für diesen Nutzer."public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | Kann verwendet werden, um die Reichweite oder den Einfluss eines Twitter-Nutzers zu bestimmen, das Spektrum der Interessen des Nutzers zu quantifizieren und das Engagement-Level des Nutzers auf Twitter zu messen. |
| receives_your_dm | boolean | Gibt an, ob dieser Nutzer die DM des authentifizierten Nutzers erhalten wird oder nicht. | |
| subscription | object | Enthält Details darüber, ob der Nutzer den authentifizierten Nutzer abonniert hat oder nicht. | |
| subscription_type | string | Eine Zeichenkette, die den Typ des X Premium-Abonnements des authentifizierten Nutzers darstellt. Beispiel: None, Basic, Premium,PremiumPlus. Gibt immer None zurück, wenn der Nutzer nicht der authentifizierte Nutzer ist. | |
| url | string | Die im Profil des Nutzers angegebene URL, falls vorhanden."url": "https://t.co/3ZX3TNiZCY" | Eine URL, die von einem Twitter-Nutzer in seinem Profil angegeben wurde. Dies könnte eine Homepage sein, ist aber nicht immer der Fall. |
| verified | boolean | Gibt an, ob dieser Nutzer ein verifizierter Twitter-Nutzer ist."verified": true | Gibt an, ob dieser Twitter-Nutzer ein verifiziertes Konto hat oder nicht. Ein verifiziertes Konto zeigt den Nutzern, dass ein Konto von öffentlichem Interesse authentisch ist. |
| verified_followers_count | string | Eine Zeichenkette, die die Anzahl der verifizierten Follower eines Nutzers darstellt. | |
| verified_type | string | Eine Zeichenkette, die den Typ der Verifizierung eines Nutzers darstellt. Beispiel: „blue”, „business”, „government” | |
| withheld | object | Enthält Details zur Zurückhaltung für zurückgehaltene Inhalte, falls zutreffend. |
$BEARER_TOKEN durch Ihr eigenes, generiertes Bearer Token.
Space
host_ids, creator_id, speaker_ids, mentioned_user_ids zum Abfrageparameter expansions hinzugefügt wird.
Im Gegensatz zu Tweets sind Spaces vergänglich und nach ihrem Ende oder wenn sie von ihrem Ersteller abgesagt werden, nicht mehr verfügbar. Wenn Ihre App Spaces-Daten verarbeitet, sind Sie dafür verantwortlich, die aktuellsten Informationen zurückzugeben und Daten zu entfernen, die auf der Plattform nicht mehr verfügbar sind. Die Spaces lookup endpoints können Ihnen helfen sicherzustellen, dass Sie die Erwartungen und die Absicht der Nutzer respektieren.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | Der eindeutige Bezeichner des angeforderten Space."id": "1zqKVXPQhvZJB" | Eindeutige Identifizierung eines in der Antwort zurückgegebenen Space. |
| state (default) | string | Zeigt an, ob der Space gestartet ist, starten wird oder beendet wurde."state": "live" | Live- oder geplante Spaces filtern. |
| created_at | date (ISO 8601) | Erstellungszeit dieses Space."created_at": "2021-07-04T23:12:08.000Z" | Verstehen, wann ein Space erstellt wurde, und nach Zeit sortieren. |
| creator_id | string | Eindeutiger Bezeichner des Space-Erstellers."creator_id": "2244994945" | |
| ended_at | date (ISO 8601) | Zeitpunkt, zu dem der Space endete, falls zutreffend."ended_at": "2021-07-04T00:11:44.000Z" | Bestimmen, wann ein Live-Space endete, zur Bestimmung der Laufzeit. |
| host_ids | array | Eindeutige Bezeichner der Hosts des Space."host_ids": ["2244994945", "6253282"] | User-Objekte erweitern, Engagement verstehen. |
| lang | string | Sprache des Space, falls erkannt."lang": "en" | Spaces nach Sprache klassifizieren. |
| is_ticketed | boolean | Gibt an, ob es sich um einen Ticketed Space handelt."is_ticketed": false | Inhalte von Interesse hervorheben. |
| invited_user_ids | array | Liste der als Sprecher eingeladenen Nutzer-IDs."invited_user_ids": ["2244994945", "6253282"] | User-Objekte erweitern, Engagement verstehen. |
| participant_count | integer | Anzahl der Nutzer im Space, einschließlich Hosts und Sprecher."participant_count": 420 | Engagement verstehen, Berichte erstellen. |
| subscriber_count | integer | Anzahl der Personen, die eine Erinnerung für einen Space gesetzt haben."subscriber_count": 36 | Interesse am Event verstehen. |
| scheduled_start | date (ISO 8601) | Geplanter Startzeitpunkt des Space."scheduled_start": "2021-07-14T08:00:00.000Z" | Mit Kalenderbenachrichtigungen integrieren. |
| speaker_ids | array | Liste der Nutzer, die zu irgendeinem Zeitpunkt gesprochen haben."speaker_ids": ["2244994945", "6253282"] | User-Objekte erweitern, Engagement verstehen. |
| started_at | date (ISO 8601) | Tatsächlicher Startzeitpunkt eines Space."started_at": "2021-07-14T08:00:12.000Z" | Startzeit des Space bestimmen. |
| title | string | Titel des Space."title": "Say hello to the Space data object!" | Schlüsselwörter, Hashtags, Erwähnungen verstehen. |
| topic_ids | array | IDs der vom Space-Ersteller ausgewählten Themen."topic_ids": ["2244994945", "6253282"] | Schlüsselwörter, Hashtags, Erwähnungen verstehen. |
| updated_at | date (ISO 8601) | Letzte Aktualisierung der Space metadata."updated_at": "2021-07-11T14:44:44.000Z" | Informationen aktuell halten. |
$BEARER_TOKEN durch Ihr eigenes generiertes Bearer Token zu ersetzen.
List
list.fields.
Das List-Objekt ist kein untergeordnetes Element anderer data-Objekte. Allerdings können User-Objekte in der user-Ressource gefunden und erweitert werden. Diese Objekte können durch Hinzufügen von owner_id zum expansions query-Parameter einbezogen werden. Verwenden Sie diese Expansion zusammen mit dem fields-Parameter list.fields, wenn Sie zusätzliche fields anfordern, um das primäre List-Objekt zu vervollständigen, und user.fields, um das Erweiterungsobjekt zu vervollständigen.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | Der eindeutige Bezeichner dieser List."id": "2244994945" | Verwenden Sie dies, um programmgesteuert Informationen über eine bestimmte List abzurufen. |
| name (default) | string | Der Name der List, wie beim Erstellen der List festgelegt."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | Das UTC-Datum und die Uhrzeit, zu der die List erstellt wurde."created_at": "2013-12-14T04:35:55.000Z" | Bestimmen Sie, wie lange eine List auf X existiert. |
| description | string | Eine kurze Beschreibung, die Nutzer über die List informiert."description": "People that are active members of the Bay area cycling community on Twitter." | |
| follower_count | integer | Zeigt, wie viele Nutzer dieser List folgen."follower_count": 198 | |
| member_count | integer | Zeigt, wie viele Mitglieder Teil dieser List sind."member_count": 60 | |
| private | boolean | Gibt an, ob die List privat ist."private": false | |
| owner_id | string | Eindeutiger Bezeichner des Besitzers dieser List."owner_id": "1255542774432063488" | Kann verwendet werden, um zu ermitteln, ob dieser Nutzer weitere Lists besitzt, und um User-Objekte zu erweitern. |
$BEARER_TOKEN durch Ihr generiertes Bearer Token.
Medien
?expansions=attachments.media_keys erweiterbar, um das komprimierte Objekt nur mit Standardfeldern zu erhalten. Verwenden Sie die Expansion zusammen mit dem Feld-Parameter media.fields, wenn Sie zusätzliche Felder anfordern, um das Objekt zu vervollständigen.
| Feldwert | Typ | Beschreibung | Verwendung |
|---|---|---|---|
| media_key (default) | string | Eindeutiger Bezeichner des eingebundenen Medieninhalts. "media_key": "13_1263145212760805376" | Kann verwendet werden, um Medien programmgesteuert abzurufen |
| type (default) | string | Inhaltstyp (animated_gif, photo, video). "type": "video" | Medien als Foto, GIF oder Video klassifizieren |
| url | string | Direkte URL zur Mediendatei auf X. | Liefert ein Media-Objekt mit einem URL-Feld für Fotos |
| duration_ms | integer | Verfügbar, wenn type „video“ ist. Dauer des Videos in Millisekunden. "duration_ms": 46947 | |
| height | integer | Höhe dieses Inhalts in Pixeln. "height": 1080 | |
| non_public_metrics | object | Nicht öffentliche Engagement-metrics für den Medieninhalt zum Zeitpunkt der Anfrage. Erfordert Authentifizierung im Benutzerkontext. "non_public_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183,} | Videointeraktion bestimmen: wie viele Nutzer jeden Viertelabschnitt des Videos abgespielt haben. |
| organic_metrics | object | Engagement-metrics für den Medieninhalt, im organischen Kontext erfasst, zum Zeitpunkt der Anfrage. Erfordert Authentifizierung im Benutzerkontext. "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} | Organisches Medien-Engagement ermitteln. |
| preview_image_url | string | URL zur statischen Platzhaltervorschau dieses Inhalts. "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
| promoted_metrics | object | Engagement-metrics für den Medieninhalt, im beworbenen Kontext erfasst, zum Zeitpunkt der Anfrage. Erfordert Authentifizierung im Benutzerkontext. "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} | Medien-Engagement bestimmen, wenn der Tweet beworben wurde. |
| public_metrics | object | Öffentliche Engagement-metrics für den Medieninhalt zum Zeitpunkt der Anfrage. "public_metrics": { "view_count": 6865141} | Gesamtzahl der Aufrufe für das dem Tweet angehängte Video ermitteln. |
| width | integer | Breite dieses Inhalts in Pixeln. "width": 1920 | |
| alt_text | string | Eine Bildbeschreibung zur Unterstützung der Barrierefreiheit. Kann bis zu 1000 Zeichen lang sein. Alt-Text kann derzeit nur zu Bildern hinzugefügt werden. "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | Kann verwendet werden, um eine schriftliche Beschreibung eines Bildes bereitzustellen, falls ein Nutzer sehbehindert ist. |
| variants | array | Jedes Medienobjekt kann mehrere Anzeige- oder Wiedergabevarianten mit unterschiedlichen Auflösungen oder Formaten haben. "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 erforderlich. Achten Sie darauf, $BEARER_TOKEN durch Ihr eigenes, generiertes Bearer Token zu ersetzen.
Umfrage
?expansions=attachments.poll_ids erweitert werden, um das komprimierte Objekt nur mit Standardfeldern zu erhalten. Verwenden Sie die expansions zusammen mit dem Feld-Parameter poll.fields, wenn Sie zusätzliche Felder anfordern, um das Objekt zu vervollständigen.
| Feldwert | Type | Beschreibung |
|---|---|---|
| id (Standard) | string | Eindeutiger Bezeichner der erweiterten Umfrage. |
{"id": "1199786642791452673"} | ||
| options (Standard) | array | Enthält Objekte, die jede Auswahlmöglichkeit in der referenzierten Umfrage beschreiben. |
{"options": [ { "position": 1, "label": "“C Sharp”", "votes": 795 }, { "position": 2, "label": "“C Hashtag”", "votes": 156 } ]} | ||
| duration_minutes | integer | Gibt die Gesamtdauer dieser Umfrage an. |
{"duration_minutes": 1440} | ||
| end_datetime | date (ISO 8601) | Gibt das Enddatum und die Endzeit für diese Umfrage an. |
{"end_datetime": "2019-11-28T20:26:41.000Z"} | ||
| voting_status | string | Gibt an, ob diese Umfrage noch aktiv ist und Stimmen erhalten kann oder ob die Abstimmung bereits geschlossen ist. |
{"voting_status": "closed"} |
attachments.poll_id erforderlich. Stellen Sie sicher, dass Sie $BEARER_TOKEN durch Ihr eigenes generiertes Bearer Token ersetzen.
Ort
?expansions=geo.place_id einbezogen werden, um das komprimierte Objekt nur mit Standard-fields zu erhalten. Verwenden Sie die Expansion zusammen mit dem Feld-Parameter place.fields, wenn Sie zusätzliche fields anfordern, um das Objekt zu vervollständigen.
| Feldwert | Typ | Beschreibung | Verwendung |
|---|---|---|---|
| full_name (Standard) | string | Ein ausführlicher, detaillierter Ortsname. | Einen Tweet nach einem bestimmten Ortsnamen klassifizieren |
"full_name": "Manhattan, NY" | |||
| id (Standard) | string | Der eindeutige Bezeichner des erweiterten Orts, wenn es sich um einen im Tweet getaggten Point of Interest handelt. | Zum programmatischen Abrufen eines Orts verwenden |
"id": "01a9a39529b27f36" | |||
| contained_within | array | Gibt die Bezeichner bekannter Orte zurück, die den referenzierten Ort enthalten. | |
| country | string | Der ausgeschriebene Name des Landes, zu dem dieser Ort gehört. | Einen Tweet nach Ländernamen klassifizieren |
"country": "United States" | |||
| country_code | string | Der ISO-Alpha-2-Ländercode, zu dem dieser Ort gehört. | Einen Tweet nach Ländercode klassifizieren |
"country_code": "US" | |||
| geo | object | Enthält Ortsdetails im GeoJSON-Format. | |
| `json | |||
| ”geo”: | |||
| “type”: “Feature”, | |||
| “bbox”: [ | |||
| -74.026675, | |||
| 40.683935, | |||
| -73.910408, | |||
| 40.877483 | |||
| ], | |||
| “properties”: | |||
| } | |||
| ` | |||
| name | string | Der Kurzname dieses Ortes. | Einen Tweet nach einem bestimmten Ortsnamen klassifizieren |
"name": "Manhattan" | |||
| place_type | string | Gibt den speziellen Typ der durch diese Ortsinformation dargestellten Information an, beispielsweise einen Stadtnamen oder einen Point of Interest. | Einen Tweet nach einem bestimmten Ortstyp klassifizieren |
"place_type": "city" |
geo.place_id-Expansion erforderlich. Ersetzen Sie $BEARER_TOKEN unbedingt durch Ihren eigenen generierten Bearer Token.
Direct-Message-Ereignisse
- sender_id - Die ID des Accounts, der die Nachricht gesendet hat oder der eine Teilnehmerin bzw. einen Teilnehmer zu einer Gruppenunterhaltung eingeladen hat
- participant_ids - Ein Array von Account-IDs. Bei ParticipantsJoin- und ParticipantsLeave-Ereignissen enthält dieses Array die einzelne ID des Accounts, der das Ereignis erstellt hat
- attachments - Liefert Media-IDs für Inhalte, die vom Absender auf X hochgeladen wurden
- referenced_tweets - Wenn im Feld text eine Tweet-URL gefunden wird, ist die ID dieses Tweets in der Antwort enthalten
| Feldwert | Typ | Beschreibung | Verwendungszweck |
| id (default) | string | Der eindeutige Bezeichner des Ereignisses. ”id”: “1050118621198921728” | Verwenden Sie dies, um programmgesteuert ein bestimmtes Konversationsereignis abzurufen (verfügbar mit v1.1 endpoints). |
| event_type (default) | string | Beschreibt den Ereignistyp. Derzeit werden drei Typen unterstützt: * MessageCreate * ParticipantsJoin * ParticipantsLeave “event_type”: “MessageCreate” | Beim Abrufen des Konversationsverlaufs: nachvollziehen, wann Nachrichten erstellt wurden, und bei Gruppenkonversationen erkennen, wann Teilnehmende beigetreten oder ausgetreten sind. Alle GET-Methoden unterstützen das Filtern nach spezifischen Ereignistypen mit dem Abfrageparameter event_type=. |
| text (default) | string | Der UTF-8-Text der Direct Message. “text”: “Hello, just you!” | Bei Chatbots kann dies zur Analyse von Nachrichteninhalten und zur Bestimmung automatisierter Antworten verwendet werden. Eignet sich auch zum Aufbau von Suchfunktionen für Konversationen. |
| entities | object | Entitäten, die aus dem Text der DM extrahiert wurden. | Liefert zusätzliche Informationen zu Hashtags, URLs, Erwähnungen usw. |
| sender_id | string | ID des Users, der das Ereignis erstellt. Um dieses Objekt in der Antwort zu erweitern, fügen Sie sender_id als expansion hinzu und verwenden Sie den Abfrageparameter user.fields, um gewünschte Attribute des User-Objekts anzugeben. ”sender_id”: “906948460078698496” | Ruft das User-Objekt der Person ab, die das Ereignis MessageCreate oder ParticipantsJoin erstellt hat. |
| participant_ids | array (of strings) | IDs der Teilnehmenden, die einer Gruppenkonversation beitreten bzw. sie verlassen. Wird auch beim Erstellen neuer Gruppenkonversationen verwendet. Um dieses Objekt in der Antwort zu erweitern, fügen Sie participant_ids als expansion hinzu und verwenden Sie den Abfrageparameter user.fields, um gewünschte Attribute des User-Objekts anzugeben. ”participant_ids”: [ “906948460078698496” ] | Dient zum Abrufen von User-Objekten für Teilnehmende, die Gruppenkonversationen beitreten oder sie verlassen. |
| dm_conversation_id | string | Der eindeutige Bezeichner der Konversation, zu der das Ereignis gehört. ”dm_conversation_id”: “1584988213961031680” | Verwenden Sie dies, um programmgesteuert Ereignisse aus einer Konversation abzurufen und Direct Messages hinzuzufügen. |
| created_at | date (ISO 8601) | Erstellungszeit (UTC) des Tweets. ”created_at”: “2019-06-04T23:12:08.000Z” | Dieses Feld kann verwendet werden, um nachzuvollziehen, wann eine Direct Message erstellt wurde oder wann Konversationsteilnehmende beigetreten oder ausgetreten sind. |
| referenced_tweets | array | ID für jeden Tweet, der im Text der Direct Message erwähnt wird. Um dieses Objekt in der Antwort zu erweitern, fügen Sie referenced_tweets.id als expansion hinzu und verwenden Sie den Abfrageparameter tweet.fields, um gewünschte Attribute des Tweet-Objekts anzugeben. ”referenced_tweets”: [ “id”: “1578868150510456833” ] | Wenn Direct Messages auf einen Tweet verweisen, können diese IDs verwendet werden, um die Details des Tweets nachzuschlagen. |
| attachments | object | Bei Direct Messages mit angehängten Medien enthält dies den media key des hochgeladenen Inhalts (Foto, Video oder GIF). Um dieses Objekt in der Antwort zu erweitern, fügen Sie attachments.media_keys als expansion hinzu und verwenden Sie den Abfrageparameter media.fields, um gewünschte Attribute des Medienobjekts anzugeben. Derzeit wird ein Anhang unterstützt. “attachments”: “media_keys”: [ “3_1136048009270239232” ] | Zum Verständnis der an Direct Messages angehängten Medienobjekte. |
- Grundlegende Ereignisattribute wie den Zeitpunkt der Erstellung und zu welcher Konversation es gehört (dm_conversation).
- Die Konto-ID und die Beschreibung der Person, die die Direct Message gesendet hat.
- Den Text eines referenzierten Tweets und wann er gepostet wurde.
- Die Konto-ID und die Beschreibung einer referenzierten Tweet-Autorin bzw. eines referenzierten Tweet-Autors.
?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
Community
| Field value | Type | Description | |
|---|---|---|---|
| created_at | date (ISO 8601) | Erstellungszeitpunkt der Community. | |
| id | string | Der eindeutige Bezeichner der Community. | |
| name | string | Der Name der Community. | |
| description | string | Der Beschreibungstext der Community, falls vorhanden. | |
| access | string | Die Zugriffsebene der Community. Kann eines der folgenden sein: | |
- Public | |||
- Closed | |||
| join_policy | string | Die Beitrittsrichtlinie der Community. Kann eines der folgenden sein: | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | Anzahl der Mitglieder, die der Community beigetreten sind. |
$BEARER_TOKEN durch dein eigenes, generiertes Bearer Token.
So verwenden Sie fields und expansions
fields und expansions in Ihrer Anfrage verwenden, um zusätzliche Objekte und Felder in Ihrer Antwort zu erhalten.
In diesem Leitfaden fordern wir mehrere Felder im folgenden Tweet-Screenshot an.
Anfordern zusätzlicher Fields und Objekte.
- Ermitteln Sie die zusätzlichen fields, die Sie anfordern möchten, indem Sie unser Objektmodell verwenden oder die Liste der fields in den API-Referenzseiten der endpoint‑s überprüfen. In diesem Fall fordern wir die folgenden zusätzlichen fields an: attachments, author_id, created_at, public_metrics.
-
Erstellen Sie den Abfrageparameter
tweet.fields, wobei Sie die oben genannten fields als Wert in einer durch Kommas getrennten Liste angeben:?tweet.fields=attachments,author_id,created_at,public_metrics - Fügen Sie den Abfrageparameter query zur zuvor gesendeten GET-/tweets-Anfrage hinzu.
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'
Antwort:
- Als Nächstes werden wir Felder anfordern, die sich auf das Video beziehen, das in dem Tweet enthalten war. Dazu verwenden wir den
expansions-Parameter mitattachments.media_keysals Wert und fügen dies zur Anfrage hinzu.
- Und schließlich werden wir die Anzahl der Aufrufe und die Dauer des Videos anfordern. Diese sind keine Standardfelder, daher müssen wir sie explizit anfordern. Verwenden Sie den Parameter
media.fieldsmit den durch Kommas getrennten Wertenpublic_metricsundduration_msin Ihrer Anfrage.
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'
Antwort, die nun alle im Tweet-Screenshot sichtbaren Daten enthält:
- ids=1260294888811347969
- tweet.fields=attachments,author_id,created_at,public_metrics
- expansions=attachments.media_keys
- media.fields=public_metrics,duration_ms