Modelo de objetos
Tweet
id, text y created_at. Los objetos Tweet también son el objeto “principal” de varios objetos secundarios, incluidos user, media, poll y place. Usa el parámetro de campos tweet.fields al solicitar estos campos de nivel raíz en el objeto Tweet.
El objeto Tweet puede encontrarse y ampliarse en el recurso de usuario. También pueden encontrarse y ampliarse en el recurso Tweet otros Tweets relacionados con el Tweet solicitado. El objeto está disponible para expansión con ?expansions=pinned_tweet_id en el recurso de usuario o con ?expansions=referenced_tweets.id en el recurso Tweet para obtener el objeto solo con los campos predeterminados. Usa esa expansión junto con el parámetro de campos tweet.fields al solicitar campos adicionales para completar el objeto.
| Valor del campo | media_key | Descripción | Cómo puede usarse |
|---|---|---|---|
| id (predeterminado) | cadena de texto | El identificador único del Tweet solicitado. | Usa esto para obtener mediante programación un Tweet específico. |
| texto (predeterminado) | cadena de texto | El texto real en UTF-8 del Tweet. Consultetwitter-textpara obtener más información sobre los caracteres válidos. | Extracción de palabras clave y análisis/clasificación de sentimientos. |
| edit_history_tweet_ids (predeterminado) | objeto | Identificadores únicos que indican todas las versiones de un Tweet. Para los Tweets sin ediciones, habrá un id. Para los Tweets con historial de ediciones, habrá varios id. | Usa esta información para consultar el historial de ediciones de un Tweet. |
| artículo | objeto | Contiene metadatos del artículo presente en este Tweet. | Úsalo para obtener el texto y las entidades de un artículo. |
| adjuntos | objeto | Especifica el tipo de archivos adjuntos (si los hay) presentes en este Tweet. | Comprender los objetos devueltos para las expansions solicitadas. |
| author_id | cadena de texto | El identificador único del usuario que publicó este Tweet. | Hidratando el objeto User y compartiendo el conjunto de datos para revisión por pares. |
| card_uri | cadena de texto | El URI de la Card presente en este Tweet. | |
| community_id | cadena de texto | El identificador único de la Comunidad a la que pertenece este Post. | |
| context_annotations | arreglo | Contiene anotaciones de contexto del Tweet. | Reconocimiento y extracción de entidades, análisis temático. |
| conversation_id | string | El id del Tweet del que parte la conversación (que incluye respuestas directas y respuestas a respuestas). | Utiliza esto para reconstruir la conversación a partir de un Tweet. |
| created_at | fecha (ISO 8601) | Fecha y hora 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 | matriz | Una matriz que contiene un índice de inicio y otro de final para la parte del texto que se muestra. | Útil para saber qué parte del texto se muestra de forma predeterminada en publicaciones largas. |
| controles_de_edición | objeto | Indica cuánto tiempo más puede editarse el Tweet y cuántas ediciones quedan. | Utiliza esto para determinar si un Tweet es apto para edición. |
| entidades | objeto | Entidades extraídas del texto del Tweet. Consulta las entidades en Twitter Objects. | Ofrece información adicional sobre hashtags, URL, menciones, etc. |
| geo | objeto | Indica la ubicación o el lugar de un Tweet geolocalizado. | Usa esto para determinar la ubicación de un Tweet con etiqueta geográfica. |
| in_reply_to_user_id | cadena de texto | Si el Tweet representado es una respuesta, este campo contendrá el id del autor del Tweet original. | Determina si un Tweet es una respuesta a otro Tweet. |
| lang | string | Idioma del Tweet, si X lo detecta. | Clasifica los Tweets por idioma de habla. |
| non_public_metrics | objeto | Métricas de interacción no públicas del Tweet en el momento de la petición. Requiere autenticación con contexto de usuario. | Determina el total de impresiones generadas para el Tweet. |
| nota_Tweet | objeto | Contiene el texto completo de un Post para los Posts de formato largo (>280 caracteres) (>280 caracteres). | Obtén el texto completo de un Post. |
| métricas_orgánicas | objeto | Métricas de interacción, registradas en un contexto orgánico, del Tweet en el momento de la solicitud. Requiere autenticación con contexto de usuario. | Mide la participación orgánica del Tweet. |
| posiblemente_sensible | booleano | Indica si el contenido puede considerarse sensible. | Estudiar la difusión de ciertos tipos de contenido. |
| promoted_metrics | objeto | Métricas de interacción, registradas en un contexto de promoción, para el Tweet en el momento de la solicitud. Requiere autenticación con contexto de usuario. | Mide la interacción del Tweet cuando estuvo promocionado. |
| public_metrics | objeto | Métricas públicas de interacción del Tweet en el momento de la solicitud. | Medir la interacción del Tweet |
| referenced_tweets | arreglo | Una lista de Tweets a los que hace referencia este Tweet, como Retweets, Tweets citados o respuestas. | Comprende los aspectos conversacionales de los Retweets, etc. |
| configuración_de_respuestas | cadena de texto | Muestra quién puede responder a un Tweet específico. Las opciones son”todos”,“mencionado_usuarios”, y”seguidores”. | Determina la configuración de respuestas de la conversación para el Tweet. |
| retenido | objeto | Contiene detalles de retenciones paracontenido retenido. | |
| scopes | objeto | Contiene detalles del alcance del Tweet. | Indica quién puede ver el Post. Solo se devuelve para Posts promocionados. |
| media_metadata | matriz | Contiene metadatos de los archivos multimedia adjuntos al Tweet. | Obtén metadatos adicionales como losalt_textde un Tweet’del archivo multimedia adjunto de la publicación. |
$BEARER_TOKEN por tu propio Bearer Token generado.
Usuario
user.fields.
El objeto de usuario también puede aparecer como objeto secundario y ampliarse dentro del objeto Tweet. Está disponible para ampliació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 al solicitar campos adicionales para completar el objeto.
| Valor de campo | media_key | Descripción | Cómo puede usarse |
|---|---|---|---|
| id (predeterminado) | cadena de texto | El identificador único de este usuario."id": "2244994945" | Utiliza esto para obtener de forma programática información sobre un usuario específico de Twitter. |
| name (predeterminado) | string | El nombre del usuario, tal como aparece en su perfil. No necesariamente corresponde al nombre de una persona. Por lo general, limitado a 50 caracteres, aunque puede cambiar."name": "Twitter Dev" | |
| nombre de usuario (predeterminado) | cadena de texto | El nombre visible, usuario o alias de Twitter con el que este usuario se identifica. Los nombres de usuario son únicos, pero pueden cambiar. Suelen tener un máximo de 15 caracteres, aunque existen cuentas históricas con nombres más largos."username": "TwitterDev" | |
| afiliación | objeto | Contiene información sobre un usuario’afiliación del usuario. | Puede usarse para obtener un usuario’la insignia de afiliación de un usuario. |
| confirmado_correo electrónico | string | El correo electrónico verificado del usuario autenticado. | |
| conexión_estado | matriz | Proporciona una lista de las relaciones entre el usuario autenticado y el usuario consultado, como sigue, lo sigue, solicitud de seguimiento enviada, solicitud de seguimiento recibida, bloqueo, silencio ”conexión_estado”: [ “seguir_solicitud_recibido”, “seguir_solicitud_enviado”, “bloqueo”, “seguidos_por”, “siguiendo”, “silenciar” ] | Se puede utilizar para determinar el estado de conexión entre el usuario autenticado y el usuario consultado. |
| creado_a | fecha (ISO 8601) | La fecha y hora en UTC en que se creó la cuenta de usuario en X."created_at": "2013-12-14T04:35:55.000Z" | Puede usarse para determinar cuánto tiempo lleva alguien usando Twitter |
| Descripción | cadena | El texto de este usuario’la descripción del perfil del usuario (también conocida como “bio”), si la proporcionó."description": "La voz del equipo de X Dev y tu fuente oficial de novedades, noticias y eventos relacionados con la X API." | |
| entidades | objeto | Contiene detalles sobre texto que tiene un significado especial para el usuario’descripción de s."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/> ], <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/> ], <br/> "mentions": [ <br/> { <br/> "start": 0, <br/> "end": 10, <br/> "tag": "TwitterDev" <br/> } <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, URL, menciones de usuarios y cashtags asociadas a la descripción. Consulta cada entidad correspondiente para obtener más detalles. Todos los usuariosiniciolos índices son inclusivos, mientras que todos los índices de usuario son exclusivosfinLos índices son exclusivos. |
| es_identidad_verificado | booleano | Indica si el usuario tiene la verificación de identidad. | |
| ubicación | cadena de texto | La ubicación especificada por el usuario’en el perfil del usuario, si el usuario proporcionó uno. Dado que es un valor libre, podría no corresponder a 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" | |
| la mayoría_recientes_Tweet_id | string | Identificador único de este usuario’el Tweet más reciente del usuario. | Determina el Tweet más reciente del usuario. |
| parodia | boolean | Indica si esta cuenta de usuario tiene o no la etiqueta Parody. | |
| anclado_Tweet_id | cadena de texto | Identificador único de este usuario’el Tweet fijado de s."pinned_tweet_id": "1255542774432063488" | Determina el Tweet fijado en la parte superior del perfil del usuario. Puede utilizarse para determinar el idioma del usuario. |
| perfil_banner_URL | cadena de texto | La URL del banner de perfil de este usuario, tal como aparece en el perfil del usuario’perfil."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Se puede usar para descargar a este usuario’del banner del perfil. |
| perfil_imagen_URL | cadena de texto | La URL de la imagen de perfil de este usuario, tal como aparece en el perfil del usuario’perfil de este usuario."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Se puede usar para descargar a este usuario’imagen de perfil de s. |
| protegido | boolean | Indica si este usuario ha decidido proteger sus Tweets (es decir, si los Tweets de este usuario son privados)‘s Tweets son privados)."protected": false | |
| público_métricas | objeto | Contiene detalles sobre la actividad de este usuario."public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | Puede utilizarse para determinar el alcance o la influencia de un usuario de Twitter, cuantificar la variedad de sus intereses y su nivel de interacción en Twitter. |
| recibe_tu_dm | boolean | Indica si este usuario recibirá el MD del usuario autenticado o no’sus MD. | |
| suscripción | objeto | Incluye detalles sobre si el usuario está suscrito al usuario autenticado o no. | |
| suscripción_media_key | string | Una cadena que representa el tipo de suscripción de X Premium que tiene el usuario autenticado. Ejemplo:Ninguno,Básico,Premium,PremiumPlus. Siempre devolveráNonesi el usuario no es el usuario autenticado. | |
| URL | string | La URL especificada por el usuario’el perfil del usuario, si existe."url": "https://t.co/3ZX3TNiZCY" | Una URL que un usuario de Twitter incluye en su perfil. Puede ser su página principal, aunque no siempre es así. |
| verificado | boolean | Indica si este usuario es un usuario verificado de Twitter."verified": true | Indica si este usuario de Twitter tiene o no una cuenta verificada. Una cuenta verificada informa a las personas que una cuenta de interés público es auténtica. |
| verificado_seguidores_recuento | cadena de texto | Una cadena que indica la cantidad de seguidores verificados de un usuario. | |
| verificado_media_key | string | Una cadena que indica el tipo de verificación que tiene un usuario. Ejemplo:“azul”,“negocio”,“gobierno” | |
| retenido | objeto | Contiene detalles de retenciones paracontenido retenido, si procede. |
$BEARER_TOKEN por 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 cuando terminan o cuando su creador los cancela. Cuando tu App gestione 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 e intención de los usuarios.
| Valor del campo | Tipo | Descripción | Cómo se puede usar |
|---|---|---|---|
| id (predeterminado) | string | Identificador único del Space solicitado."id": "1zqKVXPQhvZJB" | Identificar de forma única un Space devuelto en la respuesta. |
| state (predeterminado) | string | Indica si el Space ha empezado, empezará o ha terminado."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" | Entender cuándo se creó un Space y ordenar por tiempo. |
| 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 calcular su duración. |
| host_ids | array | Identificadores únicos de los anfitriones del Space."host_ids": ["2244994945", "6253282"] | Ampliar objetos de usuario y entender la interacción. |
| lang | string | Idioma del Space, si se detecta."lang": "en" | Clasificar Spaces por idioma. |
| is_ticketed | boolean | Indica si es un Space con entradas."is_ticketed": false | Destacar contenido de interés. |
| invited_user_ids | array | Lista de IDs de usuarios invitados como oradores."invited_user_ids": ["2244994945", "6253282"] | Ampliar objetos de usuario y entender la interacción. |
| participant_count | integer | Número de usuarios en el Space, incluidos anfitriones y oradores."participant_count": 420 | Entender la interacción y crear informes. |
| subscriber_count | integer | Número de personas que establecieron un recordatorio para un Space."subscriber_count": 36 | Entender 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"] | Ampliar objetos de usuario y entender la interacció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!" | Entender palabras clave, hashtags y menciones. |
| topic_ids | array | IDs de temas seleccionados por el creador del Space."topic_ids": ["2244994945", "6253282"] | Entender palabras clave, hashtags y menciones. |
| id | 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 List no aparece como hijo de otros objetos de datos. Sin embargo, los objetos de usuario pueden encontrarse y expandirse en el recurso de usuario. Estos objetos están disponibles para expansión añadiendo owner_id al parámetro de consulta expansions. Use esta expansión con el parámetro de campos list.fields cuando solicite campos adicionales para completar el objeto List principal y user.fields para completar el objeto expandido.
| Valor del campo | Tipo | Descripción | Cómo puede usarse |
|---|---|---|---|
| id (predeterminado) | string | El identificador único de esta Lista."id": "2244994945" | Úselo 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 crearla."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | La fecha y hora UTC en que se creó la Lista."created_at": "2013-12-14T04:35:55.000Z" | Determine cuánto tiempo lleva una Lista en Twitter. |
| 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" | Puede usarse para averiguar si este usuario posee otras Listas y para expandir objetos de usuario. |
$BEARER_TOKEN por su Bearer Token generado.
Media
?expansions=attachments.media_keys para obtener el objeto condensado con solo los campos predeterminados. Use la expansión junto con el parámetro de campos: media.fields cuando solicite 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" | Puede usarse para recuperar contenido multimedia de forma programática |
| type (default) | string | Tipo de contenido (animated_gif, photo, video). "type": "video" | Clasificar el contenido 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 tipo 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 del 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,} | Determinar la interacción con el video: cuántos usuarios reprodujeron cada cuarto del video. |
| organic_metrics | object | Métricas de interacción del 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} | Determinar la interacción orgánica con el contenido multimedia. |
| preview_image_url | string | URL de la vista previa estática de este contenido. "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
| promoted_metrics | object | Métricas de interacción del 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} | Determinar la interacción con el contenido cuando el Tweet fue promocionado. |
| public_metrics | object | Métricas públicas de interacción del contenido multimedia en el momento de la solicitud. "public_metrics": { "view_count": 6865141} | 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 respaldar la accesibilidad. Puede tener hasta 1000 caracteres. Por el momento, el texto alternativo solo puede agregarse a imágenes. "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | Puede usarse para proporcionar una descripción escrita de una imagen en caso de que un usuario tenga una discapacidad visual. |
| variants | array | Cada objeto 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"}] |
attachment.media_keys. Asegúrate de reemplazar $BEARER_TOKEN por tu propio Bearer Token generado.
Encuesta
?expansions=attachments.poll_ids para obtener el objeto resumido con solo los campos predeterminados. Usa la expansión junto con el parámetro de campos: poll.fields cuando solicites campos adicionales para completar el objeto.
| Valor del campo | Tipo | Descripción |
|---|---|---|
| id (predeterminado) | string | Identificador único de la encuesta expandida. |
{"id": "1199786642791452673"} | ||
| options (predeterminado) | 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 aún está 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 por tu propio Bearer Token generado.
Lugar
?expansions=geo.place_id para obtener el objeto condensado con solo los campos predeterminados. Usa la expansión con el parámetro de campos: place.fields al solicitar campos adicionales para completar el objeto.
| Valor del campo | Tipo | Descripción | Cómo se puede usar |
|---|---|---|---|
| full_name (predeterminado) | string | Nombre de lugar detallado y de mayor longitud. | Clasificar un Tweet por un nombre de lugar específico |
"full_name": "Manhattan, NY" | |||
| id (predeterminado) | string | El identificador único del lugar expandido, si se trata de un punto de interés etiquetado en el Tweet. | Úsalo para recuperar un lugar mediante programación |
"id": "01a9a39529b27f36" | |||
| contained_within | array | Devuelve los identificadores de los lugares conocidos que contienen el lugar de referencia. | |
| country | string | El nombre completo del país al que pertenece este lugar. | Clasificar un Tweet por nombre de país |
"country": "United States" | |||
| country_code | string | El código de país ISO Alpha-2 al que pertenece este lugar. | Clasificar un Tweet por código de país |
"country_code": "US" | |||
| geo | object | Contiene detalles del lugar en formato GeoJSON. | |
| `json | |||
| ”geo”: | |||
| “type”: “Feature”, | |||
| “bbox”: [ | |||
| -74.026675, | |||
| 40.683935, | |||
| -73.910408, | |||
| 40.877483 | |||
| ], | |||
| “properties”: | |||
| } | |||
| ` | |||
| name | string | El nombre corto de este lugar. | Clasificar un Tweet por un nombre de lugar específico |
"name": "Manhattan" | |||
| place_type | string | Especifica el tipo particular de información representada por este lugar, como el nombre de una ciudad o un punto de interés. | Clasificar un Tweet por un tipo específico de lugar |
"place_type": "city" |
geo.place_id. Asegúrate de reemplazar $BEARER_TOKEN con tu propio Bearer Token generado.
Eventos de Mensaje Directo
- sender_id - El ID de la cuenta que envió el mensaje o que invitó a un participante a una conversación de grupo
- participant_ids - Una matriz de ID de cuenta. Para los eventos ParticipantsJoin y ParticipantsLeave, esta matriz contendrá un único ID de la cuenta que creó el evento
- attachments - Proporciona ID de medios para contenido que el remitente ha subido a X
- 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 (predeterminado) | string | El identificador único del evento. ”id”: “1050118621198921728” | Use esto para recuperar mediante programación un evento de conversación específico (disponible con endpoints v1.1). |
| event_type (predeterminado) | 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 comprender cuándo se crearon los mensajes y, en conversaciones grupales, cuándo los participantes se unieron y cuándo se fueron. Todos los métodos GET admiten el filtrado por tipos de evento específicos con el parámetro de consulta event_type=. |
| text (predeterminado) | string | El texto UTF-8 del Mensaje Directo. ”text”: “Hello, just you!” | Con chatbots, esto puede usarse para analizar el contenido de los mensajes y determinar respuestas automatizadas. También puede usarse para crear funciones de búsqueda de conversaciones. |
| entities | object | Entidades extraídas del texto del MD. | 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, incluya sender_id como una expansión y use el parámetro de consulta user.fields para especificar los atributos del objeto User de interés. ”sender_id”: “906948460078698496” | Recupere el objeto User de quien creó el evento MessageCreate o ParticipantsJoin. |
| participant_ids | array (of strings) | IDs de los participantes que se unen y salen de una conversación grupal. También se utiliza al crear nuevas conversaciones grupales. Para expandir este objeto en la respuesta, incluya participant_ids como una expansión y use el parámetro de consulta user.fields para especificar los atributos del objeto User de interés. ”participant_ids”: [ “906948460078698496” ] | Se utiliza para recuperar objetos User de los participantes que se unen y salen de conversaciones grupales. |
| dm_conversation_id | string | El identificador único de la conversación de la que forma parte el evento. ”dm_conversation_id”: “1584988213961031680” | Use esto para recuperar mediante programación eventos de una conversación y agregar Mensajes Directos a ella. |
| created_at | date (ISO 8601) | Hora de creación (UTC) del Tweet. ”created_at”: “2019-06-04T23:12:08.000Z” | Este campo puede usarse para comprender 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, incluya referenced_tweets.id como una expansión y use el parámetro de consulta tweet.fields para especificar los atributos del objeto Tweet de interés. ”referenced_tweets”: [ “id”: “1578868150510456833” ] | Cuando los Mensajes Directos hacen referencia a un Tweet, estos IDs pueden usarse para consultar 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, incluya attachments.media_keys como una expansión y use el parámetro de consulta media.fields para especificar los atributos del objeto media de interés. Actualmente se admite un adjunto. ”attachments”: “media_keys”: [ “3_1136048009270239232” ] | Para 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
| Valor del campo | Tipo | Descripción | |
|---|---|---|---|
| created_at | date (ISO 8601) | Fecha 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 de incorporación de la Comunidad. Puede ser una de: | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | La cantidad de miembros que se han unido a la Comunidad. |
$BEARER_TOKEN por tu propio Bearer Token generado.
Cómo usar fields y expansions
fields y expansions en su solicitud para recibir objetos y campos adicionales en su respuesta.
En esta guía, solicitaremos varios campos presentes en la siguiente captura de pantalla de un Tweet.
Como puede ver en la captura, hay varias piezas de información visibles relacionadas con el Tweet, incluido el autor del Tweet, las métricas del Tweet, la marca de tiempo de creación, el video y el recuento de visualizaciones del video. También hay varios datos que no son visibles en la captura, pero que igualmente se pueden solicitar.
Al realizar una solicitud a la API, la respuesta predeterminada es simple y contiene solo los campos predeterminados del Tweet (id y text). Además, únicamente recibirá el objeto principal que devuelve el endpoint que está utilizando, y no los objetos de datos asociados que puedan estar relacionados con el objeto principal.
Esta simplicidad, junto con los parámetros fields y expansions, le permite solicitar únicamente los campos que necesita, según su caso de uso.
Solicitud de campos y objetos adicionales.
- Identifica los campos adicionales que deseas solicitar usando 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.
-
Cree 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 realizaste 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'
Response:
- A continuación, vamos a solicitar campos relacionados con el video que se incluyó en el Tweet. Para ello, utilizaremos el parámetro
expansionsconattachments.media_keyscomo valor, y lo agregaremos a la solicitud.
- Y finalmente, vamos a solicitar el recuento 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 comaspublic_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 visibles 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