| Objeto | Descripción | Parámetro fields |
|---|---|---|
| Publicación (Tweet) | Publicaciones, respuestas, reposts, citas | tweet.fields |
| User | Perfiles de cuentas y metadatos | user.fields |
| Space | Conversaciones de audio en vivo | space.fields |
| List | Colecciones seleccionadas de cuentas | list.fields |
| Media | Imágenes, videos, GIFs | media.fields |
| Poll | Preguntas y opciones de encuestas | poll.fields |
| Place | Datos de ubicación y geográficos | place.fields |
Publicación (Tweet)
id, text, edit_history_tweet_ids
Utiliza tweet.fields para solicitar campos adicionales y expansions para incluir objetos relacionados.
Todos los campos de Publicación
| Valor del campo | Tipo | Descripción | Cómo se puede usar |
|---|---|---|---|
| id (por defecto) | string | El identificador único del Tweet solicitado. | Úsalo para recuperar de forma programática un Tweet específico. |
| text (valor predeterminado) | string | El texto UTF-8 del propio Tweet. Consulta twitter-text para ver más detalles sobre los caracteres válidos. | Extracción de palabras clave y análisis/clasificación de sentimiento. |
| edit_history_tweet_ids (predeterminado) | object | Identificadores únicos que indican todas las versiones de un Tweet. Para los Tweets sin ediciones habrá un ID. Para los Tweets con historial de edición habrá varios IDs. | Úsalo para encontrar el historial de edición de un Tweet. |
| article | object | Contiene metadatos del Article presente en este Tweet. | Úsalo para obtener el texto y las entidades de un Article. |
| attachments | object | Especifica el tipo de archivos adjuntos (si los hay) presentes en este Tweet. | Úsalo para comprender qué objetos se devuelven para las expansions solicitadas. |
| author_id | string | El identificador único del User que publicó este Tweet. | Hidratar el objeto User, compartir el conjunto de datos para revisión por pares. |
| card_uri | string | El URI de la Card presente en este Tweet. | |
| community_id | string | El identificador único de la Comunidad a la que pertenece esta Publicación. | |
| context_annotations | array | Contiene anotaciones de contexto para el Tweet. | Reconocimiento/extracción de entidades, análisis temático. |
| conversation_id | string | El ID de Tweet de la Publicación original de la conversación (incluye respuestas directas y respuestas a respuestas). | Úsalo para reconstruir la conversación a partir de un Tweet. |
| created_at | date (ISO 8601) | Momento de creación del Tweet. | Útil para el análisis de series temporales y para entender cuándo se creó un Tweet. |
| display_text_range | array | Un array que contiene un índice de inicio y otro de fin para la porción de texto que se muestra. | Útil para saber qué porción de texto se muestra de forma predeterminada en publicaciones largas. |
| edit_controls | object | Indica durante cuánto tiempo más se puede editar el Tweet y el número de ediciones restantes. | Úsalo para determinar si un Tweet es apto para edición. |
| entities | object | Entidades que se han extraído del texto del Tweet. Consulta entities en Objetos de Twitter. | Proporciona información adicional sobre hashtags, URL, menciones, etc. |
| geo | object | Indica la ubicación o el lugar de un Tweet con etiqueta geográfica. | Úsalo para determinar la ubicación de un Tweet con etiqueta geográfica. |
| in_reply_to_user_id | string | Si el Tweet representado es una respuesta, este campo contendrá el id del autor del Tweet original. | Determina si un Tweet fue una respuesta a otro Tweet. |
| lang | string | Idioma del Tweet, si es detectado por Twitter. | Clasifica los Tweets por idioma. |
| non_public_metrics | object | Métricas de interacción no públicas para el Tweet en el momento de la solicitud. Requiere autenticación en el contexto de un usuario. | Determina el número total de impresiones generadas para el Tweet. |
| note_tweet | object | Contiene el texto completo de una Publicación para Publicaciones de formato largo (>280 caracteres). | Obtén el texto completo de una Publicación. |
| organic_metrics | object | Métricas de interacción, registradas en un contexto orgánico, para el Tweet en el momento de la solicitud. Requiere autenticación en el contexto de un usuario. | Mide la interacción orgánica del Tweet. |
| possibly_sensitive | boolean | Indica si el contenido puede considerarse sensible. | Analiza la circulación de determinados tipos de contenido. |
| promoted_metrics | object | Métricas de interacción, registradas en un contexto promocionado, para el Tweet en el momento de la solicitud. Requiere autenticación en el contexto de un usuario. | Mide la interacción del Tweet cuando fue promocionado. |
| public_metrics | object | Métricas de interacción públicas para el Tweet en el momento de la solicitud. | Mide la interacción pública del Tweet. |
| referenced_tweets | array | Una lista de Tweets a los que hace referencia este Tweet, como Retweets, Tweets citados o respuestas. | Analiza los aspectos conversacionales de los Retweets, citas, respuestas, etc. |
| reply_settings | string | Muestra quién puede responder a un Tweet determinado. Las opciones posibles son “everyone”, “mentioned_users” y “followers”. | Determina la configuración de quién puede responder en la conversación para el Tweet. |
| withheld | object | Contiene detalles sobre la restricción de contenido restringido. | |
| scopes | object | Contiene los detalles del alcance (scope) del Tweet. | Indica quién puede ver la Publicación. Solo se devuelve para Publicaciones promocionadas. |
| media_metadata | array | Contiene metadatos sobre los archivos multimedia adjuntos al Tweet. | Obtén metadatos adicionales, como el alt_text del adjunto multimedia de un Tweet. |
$BEARER_TOKEN con tu propio Bearer Token generado.
User
user.fields.
El objeto user también se puede encontrar como un objeto hijo y expandido en el objeto Tweet. El objeto está disponible para expansión con ?expansions=author_id o ?expansions=in_reply_to_user_id para obtener el objeto resumido con solo los campos predeterminados. Usa la expansión junto con el parámetro de campos user.fields cuando solicites campos adicionales para completar el objeto.
| Valor del campo | Tipo | Descripción | Cómo se puede utilizar |
|---|---|---|---|
| id (predeterminado) | string | El identificador único de este usuario."id": "2244994945" | Puedes usarlo para recuperar de forma programática información sobre un usuario específico de Twitter. |
| name (predeterminado) | string | El nombre del usuario, tal como lo definió en su perfil. No necesariamente el nombre de una persona. Suele tener un límite de 50 caracteres, pero puede cambiar."name": "Twitter Dev" | |
| username (predeterminado) | string | El nombre en pantalla, handle o alias de Twitter con el que se identifica este usuario. Los nombres de usuario son únicos, pero pueden cambiar. Suelen tener un máximo de 15 caracteres, aunque algunas cuentas históricas pueden tener nombres más largos."username": "TwitterDev" | |
| affiliation | object | Contiene detalles sobre la afiliación de un usuario. | Se puede usar para obtener la insignia de afiliado de un usuario. |
| confirmed_email | string | La dirección de correo electrónico confirmada del usuario autenticado. | |
| connection_status | array | Proporciona una lista de relaciones entre el usuario autenticado y el usuario que se está consultando, como siguiendo, seguido por, solicitud de seguimiento enviada, solicitud de seguimiento recibida, bloqueo, silenciado ”connection_status”: [ “follow_request_received”, “follow_request_sent”, “blocking”, “followed_by”, “following”, “muting” ] | Se puede usar para determinar el estado de conexión entre el usuario autenticado y el usuario que se está consultando. |
| created_at | fecha (ISO 8601) | La fecha y hora UTC en la que se creó la cuenta de usuario en Twitter."created_at": "2013-12-14T04:35:55.000Z" | Se puede usar para determinar desde cuándo una persona ha estado usando Twitter. |
| description | string | El texto de la descripción del perfil de este usuario (también denominada biografía), en caso de que el usuario haya proporcionado una."description": "The voice of the X Dev team and your official source for updates, news, and events, related to the X API." | |
| entities | object | Contiene detalles sobre el texto que tiene un significado especial dentro de la descripción del usuario."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/> } | Las entidades son objetos JSON que proporcionan información adicional sobre hashtags, URLs, menciones de usuarios y cashtags de la descripción. Consulta cada entidad correspondiente para obtener más detalles. Todos los índices start de usuario son inclusivos, mientras que todos los índices end de usuario son exclusivos. |
| is_identity_verified | boolean | Indica si el usuario tiene verificación de identidad (ID). | |
| location | string | La ubicación especificada en el perfil del usuario, si el usuario proporcionó una. Como es un valor de texto libre, puede que no indique una ubicación válida, pero puede evaluarse de forma aproximada al realizar búsquedas con consultas de ubicación."location": "127.0.0.1" | |
| most_recent_tweet_id | string | Identificador único del Tweet más reciente de este usuario. | Se puede usar para determinar el Tweet más reciente del usuario. |
| parody | boolean | Indica si esta cuenta de usuario tiene la etiqueta «Parody». | |
| pinned_tweet_id | string | Identificador único del Tweet fijado de este usuario."pinned_tweet_id": "1255542774432063488" | Determina el Tweet fijado en la parte superior del perfil del usuario. Puede usarse potencialmente para determinar el idioma del usuario. |
| profile_banner_url | string | La URL del banner de perfil de este usuario, tal como aparece en su perfil."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Puede usarse para descargar el banner de perfil de este usuario. |
| profile_image_url | string | La URL de la imagen del perfil de este usuario, tal como aparece en su perfil."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Puede usarse para descargar la imagen de perfil de este usuario. |
| protected | boolean | Indica si este usuario ha decidido proteger sus Tweets (es decir, si los Tweets de este usuario son privados)."protected": false | |
| public_metrics | object | Contiene detalles sobre la actividad de este usuario."public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | Puede usarse potencialmente para determinar el alcance o la influencia de un usuario de Twitter, cuantificar la amplitud de los intereses del usuario y su nivel de interacción en Twitter. |
| receives_your_dm | boolean | Indica si este usuario recibirá o no el DM (mensaje directo) del usuario autenticado. | |
| subscription | object | Contiene información sobre si el usuario está suscrito o no al usuario autenticado. | |
| subscription_type | string | Cadena de texto que representa el type de suscripción a X Premium que tiene el usuario autenticado. Por ejemplo: None, Basic, Premium, PremiumPlus. Siempre devolverá None si el usuario no es el autenticado. | |
| url | string | La URL especificada en el perfil del usuario, si existe."url": "https://t.co/3ZX3TNiZCY" | Una URL proporcionada por un usuario de Twitter en su perfil. Puede ser una página principal, pero no necesariamente. |
| verified | boolean | Indica si este usuario está verificado en Twitter."verified": true | Indica si este usuario de Twitter tiene o no una cuenta verificada. Una cuenta verificada permite que las personas sepan que una cuenta de interés público es auténtica. |
| verified_followers_count | string | Una cadena que representa el número de seguidores verificados de un usuario. | |
| verified_type | string | Una cadena que representa el tipo de verificación que tiene un usuario. Por ejemplo: “blue”, “business”, “government” | |
| withheld | object | Contiene detalles sobre la retención de contenido retenido, si aplica. |
$BEARER_TOKEN con tu propio Bearer Token generado.
Space
host_ids, creator_id, speaker_ids, mentioned_user_ids al parámetro de consulta expansions.
A diferencia de los Tweets, los Spaces son efímeros y dejan de estar disponibles después de que terminan o cuando son cancelados por su creador. Cuando tu aplicación procese datos de Spaces, eres responsable de devolver la información más actualizada y debes eliminar los datos que ya no estén disponibles en la plataforma. Los endpoints de búsqueda de Spaces pueden ayudarte a garantizar que respetas las expectativas y la intención de los usuarios.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | El identificador único del Space solicitado."id": "1zqKVXPQhvZJB" | Identificar de forma única un Space devuelto en la respuesta. |
| state (default) | string | Indica si el Space ha comenzado, va a comenzar o ha finalizado."state": "live" | Filtrar Spaces en vivo o programados. |
| created_at | date (ISO 8601) | Hora de creación de este Space."created_at": "2021-07-04T23:12:08.000Z" | Comprender cuándo se creó un Space y ordenarlos por hora. |
| creator_id | string | Identificador único del creador del Space."creator_id": "2244994945" | |
| ended_at | date (ISO 8601) | Hora en que finalizó el Space, si corresponde."ended_at": "2021-07-04T00:11:44.000Z" | Determinar cuándo terminó un Space en vivo para conocer su duración. |
| host_ids | array | Identificadores únicos de los anfitriones del Space."host_ids": ["2244994945", "6253282"] | Expandir objetos User y comprender la participación. |
| lang | string | Idioma del Space, si se detecta."lang": "en" | Clasificar Spaces por idioma. |
| is_ticketed | boolean | Indica si se trata de un Space de pago."is_ticketed": false | Destacar contenido de interés. |
| invited_user_ids | array | Lista de IDs de usuario invitados como oradores."invited_user_ids": ["2244994945", "6253282"] | Expandir objetos User y comprender la participación. |
| participant_count | integer | Número de usuarios en el Space, incluidos los anfitriones y los oradores."participant_count": 420 | Comprender la participación y crear informes. |
| subscriber_count | integer | Número de personas que configuraron un recordatorio para un Space."subscriber_count": 36 | Comprender el interés en el evento. |
| scheduled_start | date (ISO 8601) | Hora de inicio programada del Space."scheduled_start": "2021-07-14T08:00:00.000Z" | Integrar con notificaciones de calendario. |
| speaker_ids | array | Lista de usuarios que hablaron en algún momento."speaker_ids": ["2244994945", "6253282"] | Expandir objetos User y comprender la participación. |
| started_at | date (ISO 8601) | Hora real de inicio de un Space."started_at": "2021-07-14T08:00:12.000Z" | Determinar la hora de inicio del Space. |
| title | string | Título del Space."title": "Say hello to the Space data object!" | Comprender palabras clave, hashtags y menciones. |
| topic_ids | array | IDs de los temas seleccionados por el creador del Space."topic_ids": ["2244994945", "6253282"] | Comprender palabras clave, hashtags y menciones. |
| updated_at | date (ISO 8601) | Última actualización de los metadatos del Space."updated_at": "2021-07-11T14:44:44.000Z" | Mantener la información actualizada. |
$BEARER_TOKEN por tu propio Bearer Token generado.
Lista
list.fields.
El objeto de Lista no se encuentra como hijo de otros objetos de datos. Sin embargo, los objetos de usuario se pueden encontrar y expandir en el recurso de usuario. Estos objetos están disponibles para su expansión añadiendo owner_id al parámetro de consulta expansions. Usa esta expansión con el parámetro de campos list.fields cuando solicites campos adicionales para completar el objeto de Lista principal y user.fields para completar el objeto expandido.
| Valor del campo | Tipo | Descripción | Cómo se puede usar |
|---|---|---|---|
| id (predeterminado) | string | El identificador único de esta Lista."id": "2244994945" | Úsalo para recuperar de forma programática información sobre una Lista específica. |
| name (predeterminado) | string | El nombre de la Lista, tal como se definió al crear la Lista."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | La fecha y hora en UTC en que se creó la Lista."created_at": "2013-12-14T04:35:55.000Z" | Determina cuánto tiempo ha estado una Lista en X. |
| description | string | Una breve descripción para informar a los usuarios sobre la Lista."description": "People that are active members of the Bay area cycling community on Twitter." | |
| follower_count | integer | Muestra cuántos usuarios siguen esta Lista."follower_count": 198 | |
| member_count | integer | Muestra cuántos miembros forman parte de esta Lista."member_count": 60 | |
| private | boolean | Indica si la Lista es privada."private": false | |
| owner_id | string | Identificador único del propietario de esta Lista."owner_id": "1255542774432063488" | Se puede usar para averiguar si este usuario es propietario de otras Listas y expandir objetos de usuario. |
$BEARER_TOKEN por tu Bearer Token generado.
Media
?expansions=attachments.media_keys para obtener el objeto simplificado solo con los campos predeterminados. Usa la expansión junto con el parámetro de campos: media.fields cuando solicites campos adicionales para completar el objeto.
| Field value | Type | Description | How it can be used |
|---|---|---|---|
| media_key (default) | string | Identificador único del contenido multimedia expandido. "media_key": "13_1263145212760805376" | Se puede usar para recuperar el contenido multimedia de forma programática |
| type (default) | string | Tipo de contenido (animated_gif, photo, video). "type": "video" | Clasifica el contenido multimedia como foto, GIF o video |
| url | string | URL directa al archivo multimedia en Twitter. | Devuelve un objeto Media con un campo URL para fotos |
| duration_ms | integer | Disponible cuando el type es video. Duración del video en milisegundos. "duration_ms": 46947 | |
| height | integer | Altura de este contenido en píxeles. "height": 1080 | |
| non_public_metrics | object | Métricas de interacción no públicas para el contenido multimedia en el momento de la solicitud. Requiere autenticación con contexto de usuario. "non_public_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183,} | Permite determinar la interacción con el video: cuántos usuarios lo reprodujeron hasta cada cuarto del video. |
| organic_metrics | object | Métricas de interacción para el contenido multimedia, registradas en un contexto orgánico, en el momento de la solicitud. Requiere autenticación con contexto de usuario. "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} | Permite determinar la interacción orgánica con el contenido multimedia. |
| preview_image_url | string | URL de la imagen estática de vista previa de este contenido. "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
| promoted_metrics | object | Métricas de interacción para el contenido multimedia, registradas en un contexto promocionado, en el momento de la solicitud. Requiere autenticación con contexto de usuario. "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} | Permite determinar la interacción con el contenido multimedia cuando el Tweet fue promocionado. |
| public_metrics | object | Métricas de interacción públicas para el contenido multimedia en el momento de la solicitud. "public_metrics": { "view_count": 6865141} | Permite determinar el número total de visualizaciones del video adjunto al Tweet. |
| width | integer | Ancho de este contenido en píxeles. "width": 1920 | |
| alt_text | string | Descripción de una imagen para habilitar y mejorar la accesibilidad. Puede tener hasta 1000 caracteres. Actualmente, el texto alternativo solo se puede agregar a imágenes. "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | Se puede usar para proporcionar una descripción escrita de una imagen en caso de que un usuario tenga discapacidad visual. |
| variants | array | Cada objeto de contenido multimedia puede tener múltiples variantes de visualización o reproducción, con diferentes resoluciones o formatos. "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"}] |
media adjunto al Tweet en el endpoint Tweet lookup. Dado que media es un objeto hijo de un Tweet, se requiere la expansión attachment.media_keys. Asegúrate de reemplazar $BEARER_TOKEN con tu propio Bearer Token generado.
Poll
?expansions=attachments.poll_ids y obtener así el objeto resumido solo con los campos predeterminados. Usa la expansión junto con el parámetro de campos: poll.fields cuando solicites campos adicionales para completar el objeto.
| Field value | Type | Description |
|---|---|---|
| id (default) | string | Identificador único de la encuesta expandida. |
{"id": "1199786642791452673"} | ||
| options (default) | array | Contiene objetos que describen cada opción de la encuesta referenciada. |
{"options": [ { "position": 1, "label": "“C Sharp”", "votes": 795 }, { "position": 2, "label": "“C Hashtag”", "votes": 156 } ]} | ||
| duration_minutes | integer | Especifica la duración total de esta encuesta. |
{"duration_minutes": 1440} | ||
| end_datetime | date (ISO 8601) | Especifica la fecha y hora de finalización de esta encuesta. |
{"end_datetime": "2019-11-28T20:26:41.000Z"} | ||
| voting_status | string | Indica si esta encuesta sigue activa y puede recibir votos, o si la votación ya está cerrada. |
{"voting_status": "closed"} |
attachments.poll_id. Asegúrate de reemplazar $BEARER_TOKEN con tu propio Bearer Token generado.
Lugar
?expansions=geo.place_id para obtener el objeto condensado solo con los campos predeterminados. Usa la expansión con el parámetro de campos: place.fields cuando solicites campos adicionales para completar el objeto.
| Field value | Type | Description | How it can be used |
|---|---|---|---|
| full_name (default) | string | A longer-form detailed place name. | Clasificar un Tweet por un nombre de lugar específico |
"full_name": "Manhattan, NY" | |||
| id (default) | string | The unique identifier of the expanded place, if this is a point of interest tagged in the Tweet. | Usa esto para recuperar un lugar de forma programática |
"id": "01a9a39529b27f36" | |||
| contained_within | array | Returns the identifiers of known places that contain the referenced place. | |
| country | string | The full-length name of the country this place belongs to. | Clasificar un Tweet por nombre de país |
"country": "United States" | |||
| country_code | string | The ISO Alpha-2 country code this place belongs to. | Clasificar un Tweet por código de país |
"country_code": "US" | |||
| geo | object | Contains place details in GeoJSON format. | |
| `json | |||
| ”geo”: | |||
| “type”: “Feature”, | |||
| “bbox”: [ | |||
| -74.026675, | |||
| 40.683935, | |||
| -73.910408, | |||
| 40.877483 | |||
| ], | |||
| “properties”: | |||
| } | |||
| ` | |||
| name | string | The short name of this place. | Clasificar un Tweet por un nombre de lugar específico |
"name": "Manhattan" | |||
| place_type | string | Specified the particular type of information represented by this place information, such as a city name, or a point of interest. | Clasificar un Tweet por un tipo específico de lugar |
"place_type": "city" |
place es un objeto secundario de un Tweet, se requiere la expansión geo.place_id. Asegúrate de reemplazar $BEARER_TOKEN con tu propio Bearer Token generado.
Eventos de Mensajes Directos
- sender_id - El ID de la cuenta que envió el mensaje o que invitó a un participante a una conversación de grupo
- partricipants_ids - Un array de ID de cuenta. Para los eventos ParticipantsJoin y ParticipantsLeave, este array contendrá un único ID de la cuenta que creó el evento
- attachments - Proporciona los ID de medios para contenido que ha sido subido a Twitter por el remitente
- referenced_tweets - Si se encuentra una URL de un Tweet en el campo text, el ID de ese Tweet se incluye en la respuesta
| Valor del campo | Tipo | Descripción | Cómo se puede usar |
| id (default) | string | El identificador único del evento. ”id”: “1050118621198921728” | Úsalo para recuperar mediante programación un evento de conversación específico (disponible con endpoints v1.1). |
| event_type (default) | string | Describe el tipo de evento. Actualmente se admiten tres tipos: * MessageCreate * ParticipantsJoin * ParticipantsLeave “event_type”: “MessageCreate” | Al recuperar el historial de una conversación, para entender cuándo se crearon los mensajes y, en el caso de conversaciones de grupo, para entender cuándo los participantes se unieron y se fueron. Todos los métodos GET admiten filtrar por tipos de evento específicos con el parámetro de consulta event_type=. |
| text (default) | string | El texto UTF-8 real del Mensaje Directo. “text”: “Hello, just you!” | Con chatbots, se puede usar para analizar el contenido del mensaje y determinar respuestas automatizadas. También se podría usar para crear funciones de búsqueda de conversaciones. |
| entities | object | Entidades que se han extraído del texto del Mensaje Directo. | Proporciona información adicional sobre hashtags, URL, menciones, etc. |
| sender_id | string | ID del Usuario que crea el evento. Para expandir este objeto en la respuesta, incluye sender_id como expansión y usa el parámetro de consulta user.fields para especificar los atributos del objeto User que te interesan. ”sender_id”: “906948460078698496” | Recuperar el objeto User de quien creó el evento MessageCreate o ParticipantsJoin. |
| participant_ids | array (of strings) | IDs de los participantes que se unen y abandonan una conversación de grupo. También se usan al crear nuevas conversaciones de grupo. Para expandir este objeto en la respuesta, incluye participant_ids como expansión y usa el parámetro de consulta user.fields para especificar los atributos del objeto User que te interesan. ”participant_ids”: [ “906948460078698496” ] | Se usa para recuperar objetos User de los participantes que se unen y abandonan conversaciones de grupo. |
| dm_conversation_id | string | El identificador único de la conversación de la que forma parte el evento. ”dm_conversation_id”: “1584988213961031680” | Úsalo para recuperar mediante programación eventos de una conversación y agregarle Mensajes Directos. |
| created_at | date (ISO 8601) | Hora de creación (UTC) del Tweet. ”created_at”: “2019-06-04T23:12:08.000Z” | Este campo se puede usar para entender cuándo se creó un Mensaje Directo o cuándo los participantes de la conversación se unieron o se fueron. |
| referenced_tweets | array | ID de cualquier Tweet mencionado en el texto del Mensaje Directo. Para expandir este objeto en la respuesta, incluye referenced_tweets.id como expansión y usa el parámetro de consulta tweet.fields para especificar los atributos del objeto Tweet que te interesan. ”referenced_tweets”: [ “id”: “1578868150510456833” ] | Cuando los Mensajes Directos hacen referencia a un Tweet, estos IDs se pueden usar para buscar los detalles del Tweet. |
| attachments | object | Para Mensajes Directos con contenido multimedia adjunto, proporciona la media key del contenido cargado (foto, video o GIF). Para expandir este objeto en la respuesta, incluye attachments.media_keys como expansión y usa el parámetro de consulta media.fields para especificar los atributos del objeto media que te interesan. Actualmente se admite un adjunto. “attachments”: “media_keys”: [ “3_1136048009270239232” ] | Permite comprender los objetos multimedia adjuntos a los Mensajes Directos. |
- Atributos fundamentales del evento, como cuándo se creó y de qué conversación forma parte (dm_conversation).
- El ID de la cuenta y la descripción de quien envió el Mensaje Directo.
- El texto de cualquier Tweet referenciado y cuándo se publicó.
- El ID de la cuenta y la descripción de cualquier autor de Tweet referenciado.
?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
Comunidad
| Field value | Type | Description | |
|---|---|---|---|
| created_at | date (ISO 8601) | Hora de creación de la Comunidad. | |
| id | string | El identificador único de la Comunidad. | |
| name | string | El nombre de la Comunidad. | |
| description | string | El texto de la descripción de la Comunidad, si se proporciona. | |
| access | string | El nivel de acceso de la Comunidad. Puede ser uno de: | |
- Public | |||
- Closed | |||
| join_policy | string | La política para unirse a la Comunidad. Puede ser una de: | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | El número de miembros que se han unido a la Comunidad. |
$BEARER_TOKEN con tu propio Bearer Token generado.
Cómo usar campos y expansions
fields y expansions en tu solicitud para recibir objetos y campos adicionales en tu respuesta.
En esta guía, solicitaremos varios campos del siguiente Tweet de la captura de pantalla.
Como puedes ver en la captura de pantalla, hay varios elementos de información visibles relacionados con el Tweet, incluido el autor del Tweet, las métricas del Tweet, la marca de tiempo de creación, el video y el número de reproducciones del video. También hay varios datos que no son visibles en la captura de pantalla, pero que siguen estando disponibles para solicitarlos.
Al hacer una solicitud a la API, la respuesta predeterminada es sencilla y contiene solo los campos de Tweet predeterminados (id y text). También solo recibirás el objeto principal que devuelve el endpoint que estás utilizando, y no ninguno de los objetos de datos asociados que puedan estar relacionados con el objeto principal.
Esta simplicidad, junto con los parámetros fields y expansions, te permite solicitar solo aquellos campos que necesitas, según tu caso de uso.
Solicitud de campos y objetos adicionales.
- Identifica los campos adicionales que quieras solicitar mediante nuestro modelo de objetos, o revisando la lista de campos en las páginas de referencia de la API de los endpoints. En este caso, solicitaremos los siguientes campos adicionales: attachments, author_id, created_at, public_metrics.
-
Crea el parámetro de consulta
tweet.fieldscon los campos anteriores como valor, usando una lista separada por comas:?tweet.fields=attachments,author_id,created_at,public_metrics - Agrega el parámetro de consulta a la solicitud GET /tweets que hiciste anteriormente.
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'
Respuesta:
- A continuación, solicitaremos campos relacionados con el video incluido en el Tweet. Para hacerlo, usaremos el parámetro
expansionsconattachments.media_keyscomo valor y lo agregaremos a la solicitud.
- Y finalmente, vamos a solicitar el número de visualizaciones y la duración del video. Estos no son campos predeterminados, por lo que tenemos que solicitarlos específicamente. Usa el parámetro
media.fieldscon los valores separados por comas,public_metricsyduration_msen tu solicitud.
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'
Respuesta que ahora incluye todos los datos que aparecen en la captura de pantalla del Tweet:
- ids=1260294888811347969
- tweet.fields=attachments,author_id,created_at,public_metrics
- expansions=attachments.media_keys
- media.fields=public_metrics,duration_ms