SendGrid

O conetor do SendGrid permite-lhe realizar operações de inserção, eliminação, atualização e leitura no conjunto de dados do SendGrid.

Antes de começar

Antes de usar o conector do SendGrid, faça as seguintes tarefas:

• No seu projeto do Google Cloud:
  • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
  • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (API Connectors)

    Para saber como ativar serviços, consulte o artigo Ativar serviços.

  Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure a autenticação através da chave da API

1. Aceda a Definições e selecione Chaves de API.
2. Clique em Criar chave da API
3. Introduza um nome para a chave da API
4. Selecione uma das opções Acesso total, Acesso restrito ou Acesso à faturação
5. Selecione Acesso restrito ou Acesso à faturação e selecione as autorizações específicas para cada categoria.
6. Clique em Criar e ver.
7. Copie a chave da API e guarde-a para utilização posterior.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + CRIAR NOVO para abrir a página Criar associação.
3. Na secção Localização, escolha a localização para a ligação.
   1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

   2. Clique em SEGUINTE.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conector: selecione SendGrid na lista pendente de conectores disponíveis.
   2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
   3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   7. Opcionalmente, configure as definições do nó de associação:
      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   8. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   9. Clique em SEGUINTE.
5. Na secção Autenticação, introduza os detalhes de autenticação. Para mais informações, consulte o artigo Configure a autenticação. |
6. Clique em SEGUINTE.
7. Rever: reveja os detalhes da ligação e da autenticação.
8. Clique em Criar.

Configure a autenticação

Autenticação de chave de API

• Chave da API: selecione o segredo do Secret Manager da chave da API.
• Versão do Secret: selecione a versão do Secret.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a ligação do SendGrid.

Tipo de ligação Web

Nome do campo	Detalhes
Localização	us-central1
Conetor	Sendgrid
Versão do conetor	1
Nome da ligação	sendgrid-google-cloud-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós	2
Número máximo de nós	50
Chave de API	API_KEY
Versão do secret	1

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Nota: pode ver as entidades, as operações e as ações de um conector na tarefa Conectores.

• Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
  • Lista
  • Obter
  • Criar
  • Atualizar
  • Eliminar

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

• Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Nota: todas as entidades e ações têm um esquema associado. Por exemplo, um esquema de ação tem os detalhes dos parâmetros, como os nomes dos parâmetros e o respetivo tipo de dados. O esquema (metadados) para entidades e ações é obtido pela ligação em tempo de execução a partir do seu back-end. Se existirem atualizações ao esquema, estas não são refletidas automaticamente nas suas associações existentes. Tem de atualizar o esquema manualmente. Para atualizar o esquema de uma associação, abra a página Detalhes da associação da associação e, de seguida, clique em Atualizar esquema da associação.

Limitações do sistema

O conector do SendGrid pode processar 8 transações por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

• Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
• Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Ações

Esta secção apresenta algumas das ações suportadas pelo conetor. Para compreender como configurar as ações, consulte os exemplos de ações.

Nota: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta da tarefa ConnectorsconnectorOutputPayload após executar a integração.

Ação SendMail2

Esta ação envia um email com um anexo.

Introduza os parâmetros da ação Enviar um email

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
Assunto	String	Sim	O assunto do email a enviar.
ContentValue	String	Não	O conteúdo do email a enviar.
ContentType	String	Não	O tipo de conteúdo a enviar. Os valores suportados são text/plain e text/html.
Conteúdo	String	Sim	O agregado para o objeto Content.
SendAt	String	Não	A data e a hora em que quer que o email seja entregue. O agendamento com mais de 72 horas de antecedência é proibido.
FromEmail	String	Sim	O endereço de email do remetente.
FromName	String	Não	O nome do remetente.
ToEmail	String	Não	Endereço de email para o qual enviar o email.
ToName	String	Não	Os nomes dos respetivos emails para os quais enviar o email.
Para	String	Não	O total para destinatários.
ToCCEmail	String	Não	Endereço de email dos destinatários que vão receber uma cópia do seu email.
ToCCName	String	Não	Nome dos destinatários que vão receber uma cópia do seu email.
ToBCCName	String	Não	Nome dos destinatários que vão receber uma cópia oculta do seu email.
ToBCC	String	Não	O agregado para destinatários em CCO.
ReplyToEmail	String	Não	O endereço de email da pessoa à qual está a responder.
ReplyToName	String	Não	O nome da pessoa à qual está a responder.
AttachmentPaths	String	Não	Caminho do ficheiro a anexar ao email a enviar.
TemplateId	String	Sim	O ID do modelo que quer enviar.
DynamicTemplateData	String	Não	Os dados do modelo dinâmico.
Personalizações	String	Sim	Uma matriz de mensagens e os respetivos metadados. Cada objeto nas personalizações pode ser considerado um envelope: define quem deve receber uma mensagem individual e como essa mensagem deve ser processada.

Parâmetros de saída da ação Enviar um email

Esta ação devolve uma mensagem de confirmação, independentemente de o email ter sido enviado com êxito ou não.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: enviar um email

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação SendMail2 e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
       "FromName": "Name",
       "FromEmail": "[e-mail]",
       "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\": \"[e-mail]\",\"name\": \"test\"}\n ]}]",
       "Content": "[{\"value\": \"[e-mail]\",\"type\": \"text/plain\"}]"
   }

Esta ação devolve uma mensagem de confirmação. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa tem um valor semelhante ao seguinte:

[{
"Success": "True"
}]

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: listar todos os contactos

Este exemplo apresenta todos os contactos na entidade NMCContacts.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCContacts na lista Entity.
3. Selecione a operação List e, de seguida, clique em Concluído.
4. Opcionalmente, na secção Entrada de tarefas da tarefa Conectores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Por exemplo, City='Bangalore'. Também pode especificar várias condições de filtro através dos operadores lógicos. Por exemplo, City='Bangalore' and region='asia-south2'.

Exemplo: obter um registo

Este exemplo obtém um registo com o ID especificado da entidade NMCSegments.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCSegments na lista Entity.
3. Selecione a operação Get e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 no campo Valor predefinido.

   Aqui, 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 é um valor de chave principal na entidade NMCSegments.

Exemplo: crie um registo

Este exemplo cria um registo na entidade NMCSenders.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCSenders na lista Entity.
3. Selecione a operação Create e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

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

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

   {
   "Id": 5360940.0
   }

Exemplo: crie um registo

Este exemplo cria um registo na entidade NMCLists.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCLists na lista Entity.
3. Selecione a operação Create e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "Name": "TEST_CON_LIST1699262238224",
   "ContactCount": 3.0}

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

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

Exemplo: atualize um registo

Este exemplo atualiza um registo na entidade NMCSenders.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCSenders na lista Entity.
3. Selecione a operação Update e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

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

5. Clique em entityId e, de seguida, introduza 5360940.0 no campo Valor predefinido.

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

   {
   "Id":"5360940.0"
   }

Exemplo: elimine um registo

Este exemplo elimina o registo com o ID especificado na entidade NMCSegments.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione NMCSegments na lista Entity.
3. Selecione a operação Delete e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conectores, clique em entityId e, de seguida, introduza c58b9151-7279-428a-bac2-12b4bf2b48b0 no campo Valor predefinido.

Nota: se a sua entidade tiver uma chave primária composta, pode especificar uma cláusula de filtro.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição

Use a associação do SendGrid numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

• Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conetor.