Gmail

El conector de Gmail te permite realizar operaciones de lectura y eliminación en Gmail.

Versiones compatibles

Este conector es compatible con las APIs REST de Gmail.

Antes de empezar

Antes de usar el conector de Gmail, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Integration Connectors > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

  2. Haz clic en + CREAR NUEVA para abrir la página Crear conexión.
  3. En la sección Ubicación, haz lo siguiente:
    1. Región: selecciona una ubicación de la lista desplegable.

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Conector: selecciona Gmail en la lista de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista de versiones disponibles.
    3. En el campo Nombre de conexión, introduce un nombre para la instancia de conexión. El nombre de la conexión puede contener letras minúsculas, números o guiones. El nombre debe empezar por una letra y terminar con una letra o un número, y no puede superar los 49 caracteres.
    4. Descripción: escriba una descripción de la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo afectan los nodos a los precios de los conectores, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    8. + AÑADIR ETIQUETA: haz clic en esta opción para añadir una etiqueta a la conexión en forma de par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      La conexión de Gmail admite los siguientes tipos de autenticación:

      • Autenticación con cuenta de servicio
      • OAuth 2.0 - JWT Bearer
      • OAuth 2.0: código de autorización

      Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    2. Haz clic en Siguiente.
  6. Revisar: revisa los detalles de la conexión y la autenticación.
  7. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • Autenticación de cuenta de servicio: no es necesario configurar nada más para este tipo de autenticación. La cuenta de servicio que hayas seleccionado en la sección Detalles de la conexión se usará para la autenticación.
  • OAuth 2.0 - JWT Bearer
    • Certificado JWT: selecciona el certificado que quieras usar para la autenticación JWT.
    • Versión del secreto: introduce la versión del secreto del certificado JWT.
    • Asunto de JWT: introduce el asunto de JWT.
    • Habilitar anulación de autenticación: habilita esta opción para anular la autenticación.
  • OAuth 2.0 - Código de autorización
    • ID de cliente: introduce el ID de cliente que se va a usar para la autenticación de OAuth.
    • Permisos: introduce una lista de los permisos que quieras.
    • Secreto de cliente: el secreto de cliente que se va a usar para la autenticación de OAuth.
    • Versión del secreto: introduce la versión del secreto de cliente.
    • Habilitar anulación de autenticación: habilita esta opción para anular la autenticación.

Ejemplos de configuración de conexión

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión.

OAuth 2.0: tipo de conexión de token de portador JWT

Nombre del campo Detalles
Ubicación asia‑east1
Conector Gmail
Versión del conector 1
Nombre de la conexión gmail-jwt-conn
Habilitar Cloud Logging true
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Número mínimo de nodos 2
Número máximo de nodos 50
Autenticación OAuth 2.0 - JWT Bearer
Certificado JWT Certificado JWT
Versión de secreto 1

OAuth 2.0: tipo de conexión de código de autorización

Nombre del campo Detalles
Ubicación us-central1
Conector Gmail
Versión del conector 1
Nombre de la conexión gmail-auth-conn
Habilitar Cloud Logging Sí
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Número mínimo de nodos 2
Número máximo de nodos 50
Autenticación OAuth 2.0: código de autorización
ID de cliente 60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Ámbitos https://mail.google.com/
Secreto de cliente ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Versión de secreto 1

Limitaciones del sistema

El conector de Gmail puede procesar un máximo de una transacción por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Usar la conexión de Gmail en una integración

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea de conectores en Apigee Integration, consulta Tarea de conectores.
  • Para saber cómo crear y usar la tarea Connectors en Application Integration, consulta el artículo sobre la tarea Connectors.

Acciones

En esta sección se muestra cómo realizar algunas de las acciones de este conector.

Acción SendMailMessages

Esta acción envía un mensaje de Gmail.

Parámetros de entrada de la acción SendMailMessages

Nombre del parámetro Tipo de datos Obligatorio Descripción
Para Cadena Sí La dirección de correo del destinatario principal. Si quieres incluir varios destinatarios, usa una lista separada por comas.
AttachmentHasBytes Cadena No Asigna el valor true si el contenido del archivo adjunto se proporciona en AttachmentContentBytes (codificado en Base64) o false si el contenido se proporciona como una cadena en AttachmentContent. El valor predeterminado es "false".
AttachmentFileName Cadena No Nombre del archivo que se va a adjuntar. Este parámetro se usa cuando AttachmentHasBytes es false o no se proporciona.
Asunto Cadena Sí El asunto del correo.
AttachmentContent Cadena No El contenido de cadena del archivo que se va a adjuntar. Este parámetro se usa cuando AttachmentHasBytes tiene el valor "false" o no se proporciona.
BCC Cadena No La dirección de correo del destinatario en copia oculta. Si quieres incluir varios destinatarios, usa una lista separada por comas.
AttachmentContentBytes Cadena No El contenido de bytes codificado en Base64 del archivo que se va a adjuntar. Este parámetro se usa cuando AttachmentHasBytes tiene el valor "true".
CC Cadena No La dirección de correo del destinatario en copia. Si quieres incluir varios destinatarios, usa una lista separada por comas.
Contenido Cadena Sí El contenido principal del mensaje de correo.
AttachmentPath Cadena No Lista separada por comas de las rutas de los archivos locales que se adjuntarán al correo.

Para ver un ejemplo de cómo configurar la acción SendMailMessages, consulta Ejemplos.

Acción DownloadAttachment

Esta acción descarga un archivo adjunto de Gmail.

Parámetros de entrada de la acción DownloadAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
MessageId Cadena Sí El ID del correo.
DownloadLocation Cadena No La ubicación en la que se guardará el archivo adjunto.
FileStream Cadena No Una instancia de un flujo de salida en la que se escriben los datos del archivo.
AttachmentId Cadena No ID del archivo adjunto. Debe proporcionarse si se especifica FileStream.

Para ver un ejemplo de cómo configurar la acción DownloadAttachment, consulta Ejemplos.

Ejemplos de acciones

En esta sección se muestra cómo realizar algunas de las acciones de este conector.

Ejemplo: enviar un mensaje de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción SendMailMessages y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
  "To": "testbristleconeemail@gmail.com",
  "Subject": "Data MapperCheck",
  "Content": "Gmail",
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Id": "199334f660ff462a"
}]

Ejemplo: Enviar un mensaje de Gmail con un archivo adjunto JPG

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción SendMailMessages y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
     {
"To": "testbristleconeemail@gmail.com",
"Subject": "Data Mapper Email Sep10 JPG",
"Content": "Gmail",
"AttachmentFileName": "TestSep10.jpg",
"AttachmentContentBytes": "/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCANUBdwDAREAAhEBAxEB/8QAHgABAAAGAwEAAAAAAAAAAAAAAAEDBAcICQIFBgr/xABsEAABAwMCBAMFBQQHAwUJACMBAgMEAAURBgcIEiExCRNBChQiUWEVIzJxgUJSkaEWFzNicrHBJEPRNFOCkqIYJTlEY4O14fDxJmRzdXZ3k7PCNTY4haOytLYZN1RVV8NIVmV0eJSWpNLT4v/EAB0BAQABBAMBAAAAAAAAAAAAAAAHAQQFBgIDCAn/xABXEQABAwURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIv/Z",
"AttachmentHasBytes": true
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
  "Id": "199334f660ff462a"
}]

Ejemplo: enviar un mensaje de Gmail con un archivo PDF adjunto

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción SendMailMessages y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
  "To": "testbristleconeemail@gmail.com",
  "Subject": "Data Mapper Email Sep10",
  "Content": "Gmail",
  "AttachmentFileName": "TestSep10.pdf",
  "AttachmentContent": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXy",
  "AttachmentHasBytes": true
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
  "Id": "1993341d558d7b07"
}]

Ejemplo: Enviar un mensaje de Gmail con un archivo TXT adjunto

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción SendMailMessages y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
  "To": "testbristleconeemail@gmail.com",
  "Subject": "Data Mapper Email Sep10",
  "Content": "Gmail",
  "AttachmentFileName": "TestSep10.txt",
  "AttachmentContent": "TestingwithAttachment",
  "AttachmentHasBytes": true
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
    "Id": "1993341d558d7b07"
}]

Ejemplo: descargar un archivo adjunto de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción DownloadAttachment y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
  "MessageId": "198acdcde5c09ce5"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
    "Success": "true",
    "MessageId": "198acdcde5c09ce5",
    "AttachmentId": "1",
    "Size": "58005",
    "Data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoYWJvdXQ6YmxhbmspCi9DcmVhdG9yIChNb3ppbGxhLzUuMCBcKFgxMTsgTGludXggeDg2XzY0XCkgQXBwbGVXZWJLaXQvNTM3LjM2IFwoS0hUTUwsIGxpa2UgR2Vja29cKSBIZWFkbGVzc0Nocm9tZS8xMzguMC4wLjAgU2FmYXJpLzUzNy4zNikKL1Byb2R1Y2VyIChTa2lhL1BERiBtMTM4KQovQ3JlYXRpb25EYXRlIChEOjIwMjUwODE1MDgwMDE2KzAwJzAwJykKL01vZERhdGUgKEQ6MjAyNTA4MTUwODAwMTYrMDAnMDAnKT4-CmVuZG9iagozIDAgb2JqCjw8L2NhIDEKL0JNIC9Ob3JtYWw-PgplbmRvYmo",
    "Filename": "My_Store_404672162.pdf",
    "@isoutervalue": null
}]

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: Listar todos los mensajes de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Messages en la lista Entity.
  3. Selecciona la operación List y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, puede definir el filterClause según los requisitos del cliente.

    5. Debe usar comillas simples (") para incluir el valor de un filterClause. Puede usar filterClause para filtrar registros en función de las columnas.

Ejemplo: Obtener los detalles de un mensaje de Gmail de la bandeja de entrada

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Inbox en la lista Entity.
  3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
  4. Asigna el valor 1 a entityId, que es la clave que se va a transferir. Para definir el entityId, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 1 en el campo Valor de entrada y elija el entityId como variable local.

    5. El valor de entityId debe enviarse directamente, como "1". En este caso, "1" es el valor de clave principal único que se transfiere.

    En algunos casos, si se pasa un solo entityId, puede producirse un error porque la entidad tiene dos claves compuestas. En esos casos, puedes usar filterClause y transferir el valor, como id='1'.

Ejemplo: eliminar un mensaje de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Messages en la lista Entity.
  3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
  4. Asigna el valor 1 a entityId, que es la clave que se va a transferir.
  5. Para definir entityId, en la sección Asignación de datos de Data Mapper, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 1 en el campo Valor de entrada y elija entityId como variable local.

    Si la entidad tiene dos claves empresariales o primarias compuestas en lugar de especificar el entityId, también puede definir filterClause como id='1'.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos