Listar etiquetas en Gmail, con una API
Lista las etiquetas del buzón: las del sistema, como INBOX, SENT, DRAFT, UNREAD, STARRED y SPAM, y las creadas por el usuario. El id de cada una es lo que reciben labelIds, addLabelIds y removeLabelIds.
- Identificador
- gmail_list_labels
La llamada
POST https://connect.reportei.com/api/tools/gmail_list_labels/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Esta tool no recibe argumentos.
Conexiones posibles
Tu cliente conecta su cuenta de Gmail una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/gmail, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/gmail_list_labels. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Gmail
- Listar mensajesGETLista los mensajes del buzón que coinciden con q y labelIds. Cada elemento tiene solo id y threadId: lee el contenido con Get message. Envía nextPageToken como pageToken para leer la página siguiente.
- Leer mensajeGETObtiene un mensaje con threadId, labelIds y snippet. Con format full, el valor por defecto, payload trae los headers (From, To, Subject, Date, Message-ID) y las partes del cuerpo, cuyo data viene en base64url. Los adjuntos vienen solo como attachmentId y no se descargan.
- Leer conversaciónGETObtiene una conversación con todos sus mensajes. Cada mensaje tiene id, labelIds, snippet y, con format full, el valor por defecto, el payload con los headers y las partes del cuerpo en base64url.
- Enviar mensajePOSTEnvía un email de inmediato a los destinatarios de los headers To, Cc y Bcc de raw y devuelve el mensaje enviado con id, threadId y labelIds. Para responder dentro de una conversación, pasa su threadId, mantén el mismo Subject y define In-Reply-To y References con el Message-ID del mensaje respondido, que Get message devuelve en payload.headers.
- Actualizar etiquetas del mensajePOSTAñade y quita etiquetas de un mensaje y devuelve sus labelIds. Quita UNREAD para marcarlo como leído, quita INBOX para archivarlo, añade STARRED para destacarlo con estrella o añade TRASH para moverlo a la papelera.
- Crear etiquetaPOSTCrea una etiqueta y la devuelve con su id, para aplicar con Update message labels. El nombre no puede ser el de una etiqueta del sistema ni el de una etiqueta existente.
- Listar borradoresGETLista los borradores del buzón. Cada elemento tiene el id del borrador y un message con id y threadId: lee el contenido con Get message usando message.id. Envía nextPageToken como pageToken para leer la página siguiente.
- Crear borradorPOSTGuarda un email como borrador sin enviarlo y devuelve el id del borrador y su message con id y threadId. Envíalo después con Send draft.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
