Gmail

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

Versiones compatibles

Este conector admite las APIs de REST de Gmail.

Antes de comenzar

Antes de usar el conector de Gmail, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener 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 Crea una cuenta de servicio.

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

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, haz lo siguiente:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

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

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Gmail en la lista de conectores disponibles.
    2. Versión del conector: Selecciona la versión del conector de la lista de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa 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 comenzar con una letra y terminar con una letra o un número, y no debe superar los 49 caracteres.
    4. Descripción: Ingresa una descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    8. + AGREGAR ETIQUETA: Haz clic aquí para agregar una etiqueta a la conexión en forma de un par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

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

      • Autenticación de cuenta de servicio
      • OAuth 2.0, portador de JWT
      • Código de autorización de OAuth 2.0

      Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haz clic en Siguiente.
  6. Revisa: Revisa tus detalles de conexión y autenticación.
  7. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Autenticación de cuenta de servicio: No se requiere configuración adicional para este tipo de autenticación. La cuenta de servicio que seleccionaste en la sección Detalles de la conexión se usará para la autenticación.
  • OAuth 2.0, portador de JWT
    • Certificado JWT: Selecciona el certificado que se usará para la autenticación de JWT.
    • Versión del secreto: Ingresa la versión del secreto del certificado JWT.
    • Asunto del JWT: Ingresa el asunto del JWT.
    • Enable Authentication Override: Habilita la anulación de la autenticación.
  • Código de autorización de OAuth 2.0
    • ID de cliente: Ingresa el ID de cliente que se usará para la autenticación de OAuth.
    • Permisos: Ingresa una lista de los permisos deseados.
    • Secreto del cliente: Es el secreto del cliente que se usará para la autenticación de OAuth.
    • Versión del secreto: Ingresa la versión del secreto del secreto del cliente.
    • Enable Authentication Override: Habilita la anulación de la autenticación.

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra para los distintos campos que configuras cuando creas la conexión.

Tipo de conexión de portador de JWT de OAuth 2.0

Nombre del campo Detalles
Ubicación asia-east1
Conector Gmail
Versión del conector 1
Nombre de la conexión gmail-jwt-conn
Habilita Cloud Logging verdadero
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Autenticación OAuth 2.0, portador de JWT
Certificado JWT Certificado JWT
Versión del Secret 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
Habilita Cloud Logging Sí
Cuenta de servicio my-service-account@my-project.iam.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50
Autenticación Código de autorización de OAuth 2.0
ID de cliente 60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Permisos https://mail.google.com/
Secreto del cliente ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Versión del Secret 1

Limitaciones del sistema

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

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

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

Después de crear la conexión, estará disponible en la integración de Apigee y en Application Integration. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea de conectores en Apigee Integration, consulta Tarea de conectores.
  • Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta tarea Connectors.

Acciones

En esta sección, se muestra cómo realizar algunas de las acciones en 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
A String Sí Es la dirección de correo electrónico del destinatario principal. Si hay varios destinatarios, usa una lista separada por comas.
AttachmentHasBytes String No Establece este valor como verdadero si el contenido del adjunto se proporciona en AttachmentContentBytes (codificado en Base64) o como falso si el contenido se proporciona como una cadena en AttachmentContent. La configuración predeterminada es "false".
AttachmentFileName String No Nombre del archivo que se adjuntará. Este parámetro se usa cuando AttachmentHasBytes es falso o no se proporciona.
Asunto String Sí Es el asunto del correo electrónico.
AttachmentContent String No Es el contenido de cadena del archivo que se adjuntará. Este parámetro se usa cuando AttachmentHasBytes se establece como falso o no se proporciona.
CCO String No Es la dirección de correo electrónico del destinatario en copia oculta. Si hay varios destinatarios, usa una lista separada por comas.
AttachmentContentBytes String No Es el contenido de bytes del archivo adjunto codificado en Base64. Este parámetro se usa cuando AttachmentHasBytes se establece en verdadero.
CC String No Dirección de correo electrónico del destinatario en copia. Si hay varios destinatarios, usa una lista separada por comas.
Contenido String Sí Es el contenido principal del mensaje de correo electrónico.
AttachmentPath String No Es una lista separada por comas de las rutas de acceso a los archivos locales que se adjuntarán al correo electrónico.

Para ver un ejemplo sobre 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 String Sí Es el ID del correo electrónico.
DownloadLocation String No Ubicación en la que se guardará el archivo adjunto.
FileStream String No Es una instancia de una transmisión de salida en la que se escriben los datos del archivo.
AttachmentId String No Es el ID del adjunto. Se debe proporcionar si se especifica FileStream.

Para ver un ejemplo sobre 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 en este conector.

Ejemplo: Envía un mensaje de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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: Envía un mensaje de Gmail con un archivo adjunto JPG

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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: Envía un mensaje de Gmail con un archivo PDF adjunto

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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: Envía un mensaje de Gmail con un archivo TXT adjunto

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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: Descarga un archivo adjunto de Gmail

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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 la entidad en este conector.

Ejemplo: Enumera 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 haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según los requisitos del cliente.

    5. Debes usar comillas simples ("'") para incluir el valor de una filterClause. Puedes usar filterClause para filtrar registros según las columnas.

Ejemplo: Obtén los detalles de un mensaje de Gmail de la carpeta Recibidos

  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 haz clic en Listo.
  4. Establece entityId en 1, que es la clave que se pasará. Para establecer el entityId, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 1 en el campo Input Value y elige entityId como variable local.

    5. El valor de entityId debe pasarse directamente, como "1". Aquí, "1" es el valor de clave primaria único que se pasa.

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

Ejemplo: Borra 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 haz clic en Listo.
  4. Establece entityId en 1, que es la clave que se pasará.
  5. Para establecer el entityId, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 1 en el campo Input Value y elige entityId como variable local.

    Si la entidad tiene dos claves comerciales o principales compuestas, en lugar de especificar entityId, también puedes establecer filterClause en id='1'.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?