MailChimp

Com o conector do MailChimp, é possível executar operações de inserção, exclusão, atualização e leitura no conjunto de dados do MailChimp.

Antes de começar

Antes de usar o conector do MailChimp, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar 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.

Configuração do MailChimp

Configurar uma conta do MailChimp

Para mais informações sobre a configuração da conta do MailChimp, consulte Login da conta.

Configurar a autenticação

Chaves de API - tipo de autenticação

Para mais informações sobre como gerar uma chave de API do MailChimp, consulte Gerar chave de API.

1. Navegue até a seção de chaves de API da sua conta do MailChimp.
2. Clique em Criar nova chave e insira um nome descritivo.
3. Copie a chave gerada e armazene-a em um local seguro.Não será possível ver nem copiar a chave depois.

OAuth 2.0: tipo de autenticação

Para mais informações sobre como gerar credenciais do OAuth para a conta do MailChimp, consulte Criar credenciais do OAuth.

1. Navegue até a página "Aplicativos registrados" na sua conta do MailChimp.
2. Clique em Registrar um app.
3. Preencha o formulário "Registrar um app".
4. Clique em Criar.
5. Copie o ID e a chave secreta do cliente exibidos.

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.

   Acessar 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 conferir 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 MailChimp 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. Se quiser, ative o Cloud Logging. e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   7. 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   8. Datacenter: o data center usado para a conta do MailChimp.
   9. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   10. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
   11. Clique em PRÓXIMA.
5. Na seção Autenticação, insira os detalhes da autenticação.
   1. A conexão do MailChimp não requer autenticação.
   2. Clique em PRÓXIMA.
6. Revisão: revise os detalhes de conexão e autenticação.
7. Clique em Criar.

Exemplos de configuração de conexão

Esta seção lista os valores de amostra para os vários campos que você configura ao criar a conexão do MailChimp.

Chaves de API - tipo de conexão

Nome do campo	Detalhes
Local	us-central1
Conector	MailChimp
Versão do conector	1
Nome da conexão	google-cloud-mailchimp-api-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@serviceaccount
Número mínimo de nós	2
Número máximo de nós	50
Autenticação:não disponível	Verdadeiro
Chave de API	API_KEY
Versão do secret	1

OAuth 2: tipo de conexão

Nome do campo	Detalhes
Local	us-central1
Conector	MailChimp
Versão do conector	1
Nome da conexão	google-cloud-mailchimp-oauth-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@serviceaccount
Número mínimo de nós	2
Número máximo de nós	50
Authentication:OAuth 2.0 - Código de autorização	Verdadeiro
ID do cliente	CLIENT_ID
Chave secreta do cliente	CLIENT_SECRET
Versão do secret	1

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.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• 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:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  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, como as operações não estã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. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação : todas as entidades e ações têm um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como: os nomes do parâmetro e tipos de dados correspondentes. O esquema (metadados) de entidades e ações é buscado pela conexão em do seu back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. atualize manualmente o esquema. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector do MailChimp processa seis transações por segundo, por nó, e throttles as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Observação: o número de nós de Integration Connectors vai ser escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes aguardando o escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar o nó , faça o seguinte:

• Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
• Se você tiver uma assinatura entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para um melhor throughput, recomendamos verificar se os sistemas de back-end estão configurados de maneira ideal para processar o tráfego necessário.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para saber como configurar ações, consulte os Exemplos de ação.

Observação:os resultados de todas as ações estarão disponíveis como um Resposta JSON no connectorOutputPayload da tarefa Connectors depois de executar a integração.

Ação "CampaignTest"

Envie um e-mail de teste para uma campanha do MailChimp.

Parâmetros de entrada da ação CampaignTest

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
CampaignID	string	Verdadeiro	O ID da campanha a ser testada.
TestEmails	string	Verdadeiro	Uma lista separada por vírgulas de e-mails para enviar.
SendType	string	Verdadeiro	O tipo de e-mail de teste a ser enviado. HTML ou texto simples Os valores permitidos são html, texto simples. O valor padrão é html.

Por exemplo, sobre como configurar a ação CampaignTest, consulte Exemplos de ação.

Ação CampaignSend

Enviar uma campanha do MailChimp.

Parâmetros de entrada da ação CampaignSend

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
CampaignID	string	Verdadeiro	O ID da campanha a ser enviada.

Para saber como configurar a ação CampaignSend , consulte Exemplos de ação.

Ação CampaignPause

Pausa uma campanha RSS do MailChimp.

Parâmetros de entrada da ação CampaignPause

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
CampaignID	string	Verdadeiro	O ID da campanha a ser pausada.

Por exemplo, sobre como configurar a ação CampaignPause , consulte Exemplos de ação.

Ação CampaignResume

Retomar uma campanha RSS do MailChimp.

Parâmetros de entrada da ação CampaignResume

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
CampaignID	string	Verdadeiro	O ID da campanha a ser retomada.

Para saber como configurar a ação CampaignResume , consulte Exemplos de ação.

Exemplos de ação

Exemplo: CampaignTest

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

   {
   "CampaignID": "4bd7a9abac",
   "TestEmails": "[e-mail]",
   "SendType": "plaintext"
   }

Se a ação for bem-sucedida, o CampaignTest resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

{
"Success": "true"
}

Exemplo: CampaignSend

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

   {
   "CampaignID": "1699382f6d"
   } 

Se a ação for bem-sucedida, o CampaignSend resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

{
"Success": "true"
}

Exemplo: CampaignPause

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

   {
   "CampaignID": "4bd7a9abac"
   }

Se a ação for bem-sucedida, o CampaignPause resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

 {
"Success": "true"
}

Exemplo: CampaignResume

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

   {
   "CampaignID": "4bd7a9abac"
   }

Este exemplo mostrará os registros de Objeto específicos. Se a ação for bem-sucedida, o CampaignResume resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

{
"Success": "true"
}

Exemplos de operações de entidade

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

Exemplo: listar todas as campanhas

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Campanhas na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (').

Exemplo: receber uma única automação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Automations na lista 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 e insira 1ac204985e no campo Valor padrão.

   Aqui, 1ac204985e é um ID de registro exclusivo na entidade Automations.

Exemplo: excluir uma campanha

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Campaigns na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e e insira 06f20ace93 no campo Valor padrão.

Observação: se a entidade tiver uma chave primária composta, será possível especificar uma cláusula de filtro.

Exemplo: criar uma pasta de campanha

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

   {
   "Name": "CampaignFolderCreated1707812599459"
   }
   Running this example, returns a response similar to the following in the connector
   task's connectorOutputPayload output variable:
   {
   "Id": "650469bb07"
   }
   

Example - Update a file manager folder

1. In the Configure connector task dialog, click Entities.
2. Select FileManagerFolders from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {   
   "Name": "MyNewFolder9"
   }

5. Clique em entityId e insira 18159 no campo Valor padrão.

   A execução desse exemplo retorna uma resposta semelhante à seguinte no conector variável de saída connectorOutputPayload da tarefa:

   {   
   "Id": "18159"
   }

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

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

Para conferir um exemplo de modelo do Terraform para a criação de conexões, consulte Exemplo de modelo.

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
datacenter	ENUM	Falso	O data center usado para sua conta do MailChimp. Os valores aceitos são: nenhum, US1, US2, US3, US4, US5, US6, US7, US8, US9, US10, US11, US12, US13
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

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

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

• Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
• Para entender como criar e usar a tarefa Conectores no 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

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.