Saltar al contenido principal

Introducción al endpoint de búsqueda de archivo completo

Esta guía de inicio rápido le ayudará a realizar su primera solicitud al endpoint de búsqueda de archivo completo con un conjunto de fields especificados usando Postman. Si desea ver código de ejemplo en diferentes lenguajes, visite nuestro repositorio de GitHub X API v2 sample code.

Requisitos previos

El endpoint de búsqueda de archivo completo está disponible actualmente solo como parte de los accesos Pro y Empresarial. Para usar este endpoint, debe actualizar al acceso Pro o solicitar el nivel de acceso Empresarial.Además de contar con la aprobación de acceso, necesitará un conjunto de keys and tokens para autenticar su solicitud. Puede generar estas keys and tokens siguiendo estos pasos:
  • Vaya a su Project con acceso Empresarial o Pro en el Portal de desarrolladores y asegúrese de tener una developer App asociada dentro de ese Project.
  • Vaya a la página “Keys and tokens” de su App para generar las credenciales requeridas. Asegúrese de guardar todas las credenciales en un lugar seguro.

Pasos para crear una solicitud de búsqueda de archivo completo

Paso uno: comienza con una herramienta o biblioteca Hay varias herramientas, ejemplos de código y bibliotecas que puedes usar para hacer una solicitud a este endpoint, pero aquí vamos a usar la herramienta Postman para simplificar el proceso. Para cargar en tu entorno la colección de Postman de X API v2, haz clic en el siguiente botón: Una vez que tengas cargada la colección de X API v2 en Postman, navega a Search Posts > Full-archive search request. Paso dos: autentica tu solicitud Para realizar correctamente una solicitud a la X API, debes verificar que tienes permiso. Para hacerlo con este endpoint, debes autenticar tu solicitud con los métodos de Autenticación OAuth 2.0 App-Only. Debes agregar tus claves y tokens, específicamente el App Access Token (también conocido como App-only Bearer Token) en Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus claves y tokens en los campos “initial value” y “current value” (haciendo clic en el ícono de ojo junto al menú desplegable del entorno). Esta variable se incorporará automáticamente en la pestaña de autorización de la solicitud si lo has hecho correctamente.   Paso tres: crea una consulta de búsqueda Cada solicitud de búsqueda de archivo completo requiere una única consulta. En este ejemplo, usaremos una consulta que coincida con Posts publicados por la cuenta @XDevelopers. Para esta consulta usamos el operador from y lo establecemos en XDevelopers (no distingue mayúsculas y minúsculas): from:XDevelopers En Postman, navega a la pestaña “Params” e ingresa este id, o una cadena de ids de Post separados por comas, en la columna “Value” del parámetro ids.  
KeyValueDescription
queryfrom:XDevelopersConsulta de búsqueda para enviar al endpoint de búsqueda de archivo completo
Paso cuatro: identifica y especifica qué fields quieres recuperar Si haces clic en el botón “Send” después del paso tres, recibirás los fields predeterminados del Post object en tu respuesta: id, text y edit_history_tweet_ids. Ten en cuenta que si recibes Posts anteriores a la compatibilidad con edición, no se proporcionará el campo edit_history_tweet_ids. No se realizó una carga retrospectiva para este campo. Si deseas recibir fields adicionales más allá de estos predeterminados, deberás especificarlos en tu solicitud con los parámetros fields y/o expansions. Para este ejercicio, solicitaremos cuatro conjuntos diferentes de fields de distintos objetos:
  1. Los fields predeterminados del Post object
  2. El field adicional tweet.created_at en los objetos de usuario principales
  3. Los fields predeterminados del user object de los autores asociados para los Posts devueltos
  4. El field adicional user.description en los objetos de usuario asociados  
En Postman, navega a la pestaña “Params” y agrega el siguiente par key:value a la tabla “Query Params”:
KeyValueReturned fields
tweet.fieldscreated_attweets.created_at
expansionsauthor_idincludes.users.id, includes.users.name, includes.users.username
user.fieldsdescriptionincludes.users.description
Ahora deberías ver la siguiente URL junto al botón “Send”: https://api.x.com/2/tweets/search/all?query=from:XDevelopers&tweet.fields=created_at&expansions=author_id&user.fields=created_at
Ten en cuentaDe forma predeterminada, solo se devolverán los 10 Posts más recientes. Si quieres más de 10 Posts por solicitud, puedes usar el parámetro max_results y establecerlo en un máximo de 500 Posts por solicitud. De manera similar, de forma predeterminada se devolverán Posts de los últimos 30 días. Si quieres obtener Posts con más de 30 días de antigüedad, puedes usar los parámetros start_time y end_time en tu llamada a la API.
Paso cinco: Haz tu solicitud y revisa la respuesta Cuando tengas todo listo, haz clic en el botón “Send” y recibirás una respuesta similar a la siguiente:
{
   "data": [
       {
           "author_id": "2244994945",
           "created_at": "2020-06-11T16:05:06.000Z",
           "id": "1271111223220809728",
           "text": "Sintoniza esta noche y mira cómo @jessicagarson nos guía en la ejecución de tu paquete favorito de Python en R. 🍿\n\nAprende a usar dos lenguajes de programación potentes para ciencia de datos en conjunto, y mira un ejemplo en vivo que utiliza el endpoint de búsqueda reciente de los Developer Labs de Twitter. https://t.co/v178oUZNuj"
       },
       {
           "author_id": "2244994945",
           "created_at": "2020-06-10T19:25:24.000Z",
           "id": "1270799243071062016",
           "text": "Mientras trabajamos en la construcción de la nueva API de Twitter, hemos extendido el cronograma de desaprobación para varios endpoints de Labs v1. Más información 📖 https://t.co/rRWaJYJgKk"
       },
       {
           "author_id": "2244994945",
           "created_at": "2020-06-09T18:08:47.000Z",
           "id": "1270417572001976322",
           "text": "Las anotaciones te ayudan a aprender más sobre un Tweet — incluso pueden ayudarte a encontrar temas de interés. 🔬\n\nEn este tutorial, @suhemparack nos muestra cómo encontrar Tweets relacionados con COVID-19 usando anotaciones + el endpoint de transmisión filtrada.\n\nAprende cómo tú también puedes. ⤵️\nhttps://t.co/qwVOgw0zSV"
       }
   ],
   "includes": {
       "users": [
           {
               "description": "La voz del equipo de #DevRel de Twitter, y tu fuente oficial de actualizaciones, noticias y eventos sobre la API de Twitter. \n\n#BlackLivesMatter",
               "id": "2244994945",
               "name": "Twitter Dev",
               "username": "TwitterDev"
           }
       ]
   },
   "meta": {
       "newest_id": "1271111223220809728",
       "oldest_id": "1270417572001976322",
       "result_count": 3
   }
}
En este ejemplo, usamos una consulta muy simple. Si desea ver guías más detalladas, visite los recursos que se indican a continuación.  Próximos pasos Personalice su solicitud con la Referencia de la API Consulte la lista completa de operadores de consulta Utilice código de ejemplo para estos endpoints