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 comenzar

Antes de usar el conector de SendGrid, 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

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). 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, sigue estos pasos:

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, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

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

   2. Haga clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona SendGrid en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   6. 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.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   7. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   8. Haga clic en SIGUIENTE.
5. En la sección Autenticación, ingresa los detalles de autenticación. Para obtener más información, consulta Configura la autenticación. |
6. Haga clic en SIGUIENTE.
7. Revisa: Revisa tus detalles de conexión y autenticación.
8. Haz clic en Crear.

Configurar autenticación

Autenticación de la clave de API

• Clave de API: Selecciona el secreto de Secret Manager correspondiente a la clave de API.
• Versión del secreto: Selecciona la versión del secreto.

Nota: La clave de API que creaste en Sendgrid debe tener el permiso user.email.read.

Entidades, operaciones y acciones

Todos los Integration Connectors 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 expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

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

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se enumeran en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, 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.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. El esquema (metadatos) para entidades y acciones se recupera mediante la conexión en el entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, esas actualizaciones no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualizar esquema de conexión.

Limitaciones del sistema

El conector de SendGrid puede procesar 8 transacciones por segundo, por nodo, y limita cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

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

Nota: La cantidad de nodos de Integration Connectors ajustará la escala de forma automática y dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin esperar el ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Se requieren más nodos a fin de procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres un cliente de pago por uso, configura el valor mínimo y máximo de nodos en la página de edición de conexiones.
• Si eres un cliente basado en una suscripción, comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar dependen de varios factores. Por lo tanto, antes de ajustar la cantidad mínima de nodos para mejorar la capacidad de procesamiento, te recomendamos que verifiques si los sistemas de backend están configurados de manera óptima para manejar el tráfico requerido.

Acciones

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

Nota: Los resultados de todas las acciones estarán disponibles como una respuesta JSON en el parámetro de respuesta connectorOutputPayload de la tarea Connectors después de que ejecutes la integración.

Acción SendMail

Esta acción envía un correo electrónico con el archivo adjunto.

Parámetros de entrada de la acción SendMail

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
Asunto	String	Sí	El asunto del correo electrónico que se enviará.
ContentValue	String	No	El contenido del correo que se enviará.
ContentType	String	No	El tipo de contenido que se enviará. Los valores admitidos son text/plain y text/html.
Contenido	String	Sí	El agregado del objeto de contenido.
SendAt	String	No	La fecha y hora en que quieres que se entregue tu correo electrónico. No se permiten programar citas con más de 72 horas de anticipación.
FromEmail	String	Sí	Es la dirección de correo electrónico del remitente.
FromName	String	No	Indica el nombre del remitente.
ToEmail	String	No	Dirección de correo electrónico a la que se enviará el correo electrónico.
ToName	String	No	Los nombres respectivos del correo electrónico al que se enviará el correo.
Hasta el	String	No	El agregado de los destinatarios en Para.
ToCCEmail	String	No	Dirección de correo electrónico de los destinatarios que recibirán una copia de tu mensaje.
ToCCName	String	No	Nombre de los destinatarios que recibirán una copia de tu correo electrónico.
ToBCCName	String	No	Nombre de los destinatarios que recibirán una copia a ciegas de tu correo electrónico.
ToBCC	String	No	El agregado de destinatarios de ToBCC.
ReplyToEmail	String	No	La dirección de correo electrónico de la persona a la que le respondes.
ReplyToName	String	No	El nombre de la persona a la que le respondes.
AttachmentPaths	String	No	Ruta del archivo que se adjuntará al correo que se enviará.
TemplateId	String	No	El ID de la plantilla que deseas enviar.
DynamicTemplateData	String	No	Los datos de la plantilla dinámica.
Personalizaciones	String	Sí	Un array de mensajes y sus metadatos. Cada objeto de las personalizaciones puede considerarse como un sobre, que define quién debe recibir un mensaje individual y cómo se debe manejar ese mensaje.

Parámetros de salida de la acción SendMail

Esta acción devuelve un mensaje de confirmación si el correo electrónico se envió correctamente o no desde SendMail.

Ejemplos de acciones

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

Ejemplo: Enviar un correo electrónico

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción SendMail 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:

   {
   "Personalizations": "[{"subject": "Test Subject2",
   "send_at": 1698659820,
   "from": {"name": "hi","email": "[e-mail]"},
   "to": [{"email": "[e-mail]","name": "test"}]
   }]",   
   "FromName": "SampleName",   
   "FromEmail": "[e-mail]",   
   "Subject": "SubjectAdded",   
   "Content": "[{"value": "[e-mail]","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]" 
   }

Esta acción devuelve el mensaje de confirmación del SendMail. Si la acción se ejecuta correctamente, el parámetro de respuesta connectorOutputPayload de la tarea tendrá un valor similar al siguiente:

[{
"Status": "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: enumera 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 de la lista Entity.
3. Selecciona la operación List y haz clic en Listo.
4. De manera opcional, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Por ejemplo, City='Bangalore'. También puedes especificar varias condiciones de filtro con los operadores lógicos. Por ejemplo, City='Bangalore' and region='asia-south2'.

Ejemplo: obtén 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 de la lista Entity.
3. Selecciona la operación Get y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId y, luego, ingresa 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 en el campo Valor predeterminado.

   Aquí, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 es un valor de clave primaria en la entidad NMCSegments.

Ejemplo: crea 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 de la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. 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:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "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: crea 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 de la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. 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:

   {
   "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: Actualiza un registro

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

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona NMCSenders de la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. 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:

   {
   "Nickname": "Test",
   "FromEmail": "[e-mail]",
   "FromName": "testuser",   
   "ReplytoEmail": "[e-mail]",  
   "Address": "NA", 
   "City": "NA", 
   "Country": "India"}

5. Haz clic en entityId y, luego, ingresa 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: Borra un registro

En este ejemplo, se borra el registro con el ID especificado en la entidad NMCSegments.

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

Nota: Si tu entidad tiene una clave primaria compuesta, puedes especificar una cláusula de filtro.

Usar Terraform para crear conexiones

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

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

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

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

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

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

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?

• Obtén información sobre cómo suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Aprende a ver los registros del conector.