SendGrid

Com o conector do SendGrid, é possível executar operações de inserção, exclusã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, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

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

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acesse a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Cockroachdb na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    8. Clique em PRÓXIMA.
  5. Na seção Autenticação, insira os detalhes de autenticação. Saiba mais em Configurar a autenticação. |
  6. Clique em PRÓXIMA.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

  • Autenticação de chave de API
    • Chave de API: selecione o secret do Secret Manager referente à chave de API.
    • Versão do secret: selecione a versão do secret.
    •

    Entidades, operações e ações

    Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

    • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

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

    • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

      Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, essas operações não serão listadas na lista Operations.

    • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

    Limitações do sistema

    O conector do SendGrid pode processar oito transações por segundo, por nó, e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

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

    Ações

    Esta seção lista algumas das ações suportadas pelo conector. Para entender como configurar as ações, consulte Exemplos de ação.

    Ação "SendMail"

    Esta ação envia um e-mail com o anexo.

    Parâmetros de entrada da ação SendMail

    Nome do parâmetro Tipo de dados Obrigatório Descrição
    Assunto String Sim O assunto do e-mail a ser enviado.
    ContentValue String No O conteúdo do e-mail a ser enviado.
    ContentType String No O tipo de conteúdo a ser enviado. Os valores aceitos são texto/simples e texto/html.
    Conteúdo String Sim A agregação do objeto de conteúdo.
    SendAt String No A data e a hora em que você quer que seu e-mail seja entregue. É proibido programar com mais de 72 horas de antecedência.
    FromEmail String Sim O endereço de e-mail do remetente.
    FromName String No O nome do remetente.
    ToEmail String No Endereço de e-mail para o qual o e-mail será enviado.
    ToName String No Os respectivos nomes do e-mail para o qual o e-mail será enviado.
    Para String No A agregação dos destinatários Para.
    ToCCEmail String No Os endereços de e-mail dos destinatários que receberão uma cópia do seu e-mail.
    ToCCName String No Nome dos destinatários que vão receber uma cópia do seu e-mail.
    ToBCCName String No Nome dos destinatários que receberão uma cópia carbono oculta do seu e-mail.
    ToBCC String No A agregação dos destinatários do ToBCC.
    ReplyToEmail String No O endereço de e-mail da pessoa para quem você está respondendo.
    ReplyToName String No O nome da pessoa para quem você está respondendo.
    AttachmentPaths String No Caminho do arquivo a ser anexado ao e-mail a ser enviado.
    TemplateId String No O ID do modelo que você pode enviar.
    DynamicTemplateData String No Os dados do modelo dinâmico.
    Personalizações String Sim Uma matriz de mensagens e os respectivos metadados. Cada objeto nas personalizações pode ser considerado um envelope. Ele define quem deve receber uma mensagem individual e como ela deve ser tratada.

    Parâmetros de saída da ação SendMail

    Esta ação retorna uma mensagem de confirmação, mesmo que o e-mail não tenha sido enviado com êxito por SendMail.

    Exemplos de ação

    Nesta seção, descrevemos como executar algumas das ações nesse conector.

    Exemplo: enviar um e-mail

    1. Na caixa de diálogo Configure connector task, clique em Actions.
    2. Selecione a ação SendMail e clique em Concluído.
    3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
      {
"Personalizations": "[{"subject": "Test Subject2",
"send_at": 1698659820,
"from": {"name": "hi","email": "testmail@test.com"},
"to": [{"email": "xyz@test.com","name": "test"}]
}]",   
"FromName": "SampleName",   
"FromEmail": "testmail@test.com",   
"Subject": "SubjectAdded",   
"Content": "[{"value": "abc@test1.com","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]" 
}

      4. Esta ação retorna uma mensagem de confirmação do SendMail. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa terá um valor semelhante ao seguinte:

      [{
"Status": "True"
}]

    Exemplos de operação de entidade

    Esta seção mostra como executar algumas das operações da entidade no conector.

    Exemplo: listar todos os contatos

    Neste exemplo, listamos todos os contatos na entidade NMCContacts.

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

    Exemplo: acessar um registro

    Este exemplo recebe um registro com o ID especificado da entidade NMCSegments.

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione NMCSegments na lista de Entity.
    3. Selecione a operação Get e clique em Concluído.
    4. Na seção Task Input da tarefa Connectors, clique em EntityId e insira 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 no campo Valor padrão.

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

    Exemplo: criar um registro

    Este exemplo cria um registro na entidade NMCSenders.

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione NMCSenders na lista de Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
      {
"Nickname": "Test",
"FromEmail": "test1@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test1@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}

      Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

      {
"Id": 5360940.0
}

    Exemplo: criar um registro

    Este exemplo cria um registro na entidade NMCLists.

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione NMCLists na lista de Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira 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 terá um valor semelhante a este:

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

    Exemplo: atualizar um registro

    Este exemplo atualiza um registro na entidade NMCSenders.

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione NMCSenders na lista de Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
      {
"Nickname": "Test",
"FromEmail": "test2@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test2@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}
    5. Clique em entityId e, em seguida, insira 5360940.0 no campo Valor padrão.

      Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

      {
"Id":"5360940.0"
}

    Exemplo: excluir um registro

    Este exemplo exclui o registro com o ID especificado na entidade NMCSegments.

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

    Usar o Terraform para criar conexões

    Use o recurso do Terraform (em inglês) para criar uma nova conexão.

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

    Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

    Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

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

    Usar a conexão do SendGrid em uma integração

    Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

    • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte Tarefa Conectores.
    • Para entender como criar e usar a tarefa de conectores na Application Integration, consulte Tarefa "Conectores".

    Receber ajuda da comunidade do Google Cloud

    Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

    A seguir