SendGrid

El conector de SendGrid te permite realizar operaciones de inserción, eliminación, actualización y lectura en el conjunto de datos de SendGrid.

Antes de empezar

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

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • 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 crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. 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 la autenticación mediante una clave de API

  1. Ve a Configuración y selecciona Claves de API.
  2. Haz clic en Crear clave de API.
  3. Introduce un nombre para tu clave de API
  4. Selecciona una de las opciones: Acceso completo, Acceso restringido o Acceso de facturación.
  5. Selecciona Acceso restringido o Acceso de facturación y elige los permisos específicos de cada categoría.
  6. Haz clic en Crear y ver.
  7. Copia la clave de API y guárdala para usarla más adelante.

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 (Conectores de integración > 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, elige la ubicación de la conexión.
    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 SendGrid en la lista desplegable de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
    3. En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para 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 influyen los nodos en el precio de tu conector, 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. También puedes hacer clic en + AÑADIR ETIQUETA 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. Para obtener más información, consulta Configurar la autenticación. |
  6. Haz clic en SIGUIENTE.
  7. Revisar: revisa los detalles de la conexión y la autenticación.
  8. Haz clic en Crear.

Configurar la autenticación

  • Autenticación con clave de API
    • Clave de API: selecciona el secreto de Secret Manager de la clave de API.
    • Versión del secreto: selecciona la versión del secreto.
  • Ejemplos de configuración de conexiones

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

    Tipo de conexión web

    Nombre del campo Detalles
    Ubicación us-central1
    Conector Sendgrid
    Versión del conector 1
    Nombre de la conexión sendgrid-google-cloud-conn
    Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Número mínimo de nodos 2
    Número máximo de nodos 50
    Clave de API API_KEY
    Versión de secreto 1

    Entidades, operaciones y acciones

    Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

    • Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

      Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

    • Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

      Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

    • Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

    Limitaciones del sistema

    El conector SendGrid puede procesar 8 transacciones 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.

    Acciones

    En esta sección se enumeran algunas de las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

    Acción SendMail2

    Con esta acción se envía un correo con un archivo adjunto.

    Parámetros de entrada de la acción Enviar un correo

    Nombre del parámetro Tipo de datos Obligatorio Descripción
    Asunto Cadena El asunto del correo que se va a enviar.
    ContentValue Cadena No El contenido del correo que se va a enviar.
    ContentType Cadena No El tipo de contenido que se va a enviar. Los valores admitidos son text/plain y text/html.
    Contenido Cadena Agregación del objeto Content.
    SendAt Cadena No La fecha y la hora en las que quieres que se entregue el correo. No se pueden programar citas con más de 72 horas de antelación.
    FromEmail Cadena La dirección de correo del remitente.
    FromName Cadena No Nombre del remitente.
    ToEmail Cadena No Dirección de correo a la que se enviará el correo.
    ToName Cadena No Los nombres correspondientes de los correos a los que se enviará el correo.
    Para Cadena No El agregado de los destinatarios.
    ToCCEmail Cadena No Dirección de correo de los destinatarios que recibirán una copia de tu correo.
    ToCCName Cadena No Nombre de los destinatarios que recibirán una copia de tu correo.
    ToBCCName Cadena No Nombre de los destinatarios que recibirán una copia oculta de tu correo.
    ToBCC Cadena No Agregación de los destinatarios de ToBCC.
    ReplyToEmail Cadena No La dirección de correo de la persona a la que respondes.
    ReplyToName Cadena No El nombre de la persona a la que respondes.
    AttachmentPaths Cadena No Ruta del archivo que se adjuntará al correo que se va a enviar.
    TemplateId Cadena El ID de la plantilla que quieras enviar.
    DynamicTemplateData Cadena No Los datos de la plantilla dinámica.
    Personalizaciones Cadena Una matriz de mensajes y sus metadatos. Cada objeto de las personalizaciones se puede considerar como un sobre: define quién debe recibir un mensaje individual y cómo se debe gestionar ese mensaje.

    Parámetros de salida de la acción Enviar un correo

    Esta acción devuelve un mensaje de confirmación tanto si el correo se ha enviado correctamente como si no.

    Ejemplos de acciones

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

    Ejemplo: enviar un correo

    1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
    2. Seleccione la acción SendMail2 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:
      {
          "FromName": "Name",
          "FromEmail": "cloudysanfrancisco@gmail.com",
          "Subject": "[{\"value\": \"cymbalgroup.com\",\"type\": \"text/plain\"}]",
          "TemplateId": "d-c4bc730a0b094a3a9d9cabb7347b5edc",
          "Personalizations": "[{\"subject\": \"Test Subject3\",\"send_at\": 1698659820,\"from\": {\"name\": \"hi\",\"email\": \"email@gmail\"},\"to\":      
          [{\"email\": \"email@gmail.com\",\"name\": \"test\"}\n ]}]",
          "Content": "[{\"value\": \"abc@cdata.com\",\"type\": \"text/plain\"}]"
      }
    4. Esta acción devuelve un mensaje de confirmación. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea tendrá un valor similar al siguiente:

      [{
      "Success": "True"
      }]

    Ejemplos de operaciones de entidades

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

    Ejemplo: enumerar todos los contactos

    En este ejemplo se enumeran todos los contactos de la entidad NMCContacts.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCContacts en la lista Entity.
    3. Selecciona la operación List y, a continuación, haz clic en Hecho.
    4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. Por ejemplo, City='Bangalore'. También puede especificar varias condiciones de filtro mediante operadores lógicos. Por ejemplo, City='Bangalore' and region='asia-south2'.

    Ejemplo: obtener un registro

    En este ejemplo se obtiene un registro con el ID especificado de la entidad NMCSegments.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCSegments en la lista Entity.
    3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
    4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 en el campo Valor predeterminado.

      En este caso, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 es un valor de clave principal de la entidad NMCSegments.

    Ejemplo: crear un registro

    En este ejemplo, se crea un registro en la entidad NMCSenders.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCSenders en la lista Entity.
    3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
    4. 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:
      {
      "Nickname": "Test",
      "FromEmail": "test1@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test1@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}

      Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

      {
      "Id": 5360940.0
      }

    Ejemplo: crear un registro

    En este ejemplo, se crea un registro en la entidad NMCLists.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCLists en la lista Entity.
    3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
    4. 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:
      {
      "Name": "TEST_CON_LIST1699262238224",
      "ContactCount": 3.0}

      Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

      {
      "Id": "d927f128-b718-447a-affe-417f1a8b3abd"}

    Ejemplo: actualizar un registro

    En este ejemplo se actualiza un registro de la entidad NMCSenders.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCSenders en la lista Entity.
    3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
    4. 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:
      {
      "Nickname": "Test",
      "FromEmail": "test2@examplepetstore.com",
      "FromName": "testuser",   
      "ReplytoEmail": "test2@examplepetstore.com",  
      "Address": "NA", 
      "City": "NA", 
      "Country": "India"}
    5. Haga clic en entityId y, a continuación, introduzca 5360940.0 en el campo Valor predeterminado.

      Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

      {
      "Id":"5360940.0"
      }

    Ejemplo: eliminar un registro

    En este ejemplo se elimina el registro con el ID especificado de la entidad NMCSegments.

    1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
    2. Selecciona NMCSegments en la lista Entity.
    3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
    4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca c58b9151-7279-428a-bac2-12b4bf2b48b0 en el campo Valor predeterminado.

    Crear conexiones con Terraform

    Puedes usar el recurso de Terraform para crear una conexión.

    Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

    Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

    Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:

    Nombre del parámetro Tipo de datos Obligatorio Descripción

    Usar la conexión de SendGrid 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 Conectores en la integración de Apigee, consulta Tarea Conectores.
    • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

    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