Pré-lançamento

Este produto ou recurso está sujeito aos "Termos das Soluções Pré-GA" na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os produtos e recursos pré-GA estão disponíveis no estado em que se encontram e podem ter assistência limitada. Para mais informações, consulte as descrições das fases de lançamento.

Gmail

Com o conector do Gmail, é possível realizar operações de leitura e exclusão no Gmail.

Versões compatíveis

Esse conector é compatível com as APIs REST do Gmail.

Antes de começar

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

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

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, faça o seguinte:

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, faça o seguinte:
   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 Gmail na lista de conectores disponíveis.
   2. Versão do conector: selecione a versão do conector na lista de versões disponíveis.
   3. No campo Nome da conexão, insira um nome para a instância de conexão. O nome da conexão pode conter letras minúsculas, números ou hífens. O nome precisa começar com uma letra e terminar com uma letra ou um número, e não pode ter mais de 49 caracteres.
   4. Descriçã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. + ADICIONAR RÓTULO: clique aqui para adicionar um rótulo à conexão na forma de um par de chave-valor.
   9. Clique em Próxima.
5. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do Gmail:

      • Autenticação da conta de serviço
      • OAuth 2.0: portador JWT
      • Código de autorização OAuth 2.0

      Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em Next.
6. Revisão: revise os detalhes de conexão e autenticação.
7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• Autenticação de conta de serviço: nenhuma configuração adicional é necessária para esse tipo de autenticação. A conta de serviço selecionada na seção Detalhes da conexão será usada para autenticação.
• OAuth 2.0 - JWT Bearer
  • Certificado JWT: selecione o certificado a ser usado para autenticação JWT.
  • Versão do secret: insira a versão do secret do certificado JWT.
  • Assunto do JWT: insira o assunto do JWT.
  • Ativar substituição de autenticação: ative para substituir a autenticação.
• Código de autorização OAuth 2.0
  • ID do cliente: insira o ID do cliente a ser usado para autenticação OAuth.
  • Escopos: insira uma lista dos escopos desejados.
  • Chave secreta do cliente: a chave secreta do cliente a ser usada para autenticação OAuth.
  • Versão do secret: insira a versão do chave secreta do cliente.
  • Ativar substituição de autenticação: ative para substituir a autenticação.

Exemplos de configuração de conexão

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

Tipo de conexão de portador JWT do OAuth 2.0

Nome do campo	Detalhes
Local	asia-east1
Conector	Gmail
Versão do conector	1
Nome da conexão	gmail-jwt-conn
Ativar Cloud Logging	verdadeiro
Conta de serviço	[e-mail]
Número mínimo de nós	2
Número máximo de nós	50
Autenticação	OAuth 2.0: portador JWT
Certificado JWT	Certificado JWT
Versão do secret	1

OAuth 2.0: tipo de conexão de código de autorização

Nome do campo	Detalhes
Local	us-central1
Conector	Gmail
Versão do conector	1
Nome da conexão	gmail-auth-conn
Ativar Cloud Logging	Sim
Conta de serviço	[e-mail]
Número mínimo de nós	2
Número máximo de nós	50
Autenticação	Código de autorização OAuth 2.0
ID do cliente	60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Escopos	https://mail.google.com/
Chave secreta do cliente	ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Versão do secret	1

Limitações do sistema

O conector do Gmail pode processar no máximo uma transação por segundo, por nó, e limita as transações que excederem esse 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 do Integration Connectors será escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo 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 processar menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente de pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição da conexão.
• Se você for um cliente por 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 o número mínimo de nós para melhorar a capacidade de processamento, recomendamos que você verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

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

Depois de criar a conexão, ela fica disponível na integração da Apigee e no Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

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

Ações

Nesta seção, mostramos como realizar algumas das ações neste conector.

Ação SendMailMessages

Essa ação envia uma mensagem do Gmail.

Parâmetros de entrada da ação SendMailMessages

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Para	String	Sim	O endereço de e-mail do destinatário principal. Para vários destinatários, use uma lista separada por vírgulas.
AttachmentHasBytes	String	Não	Defina como "true" se o conteúdo do anexo for fornecido em "AttachmentContentBytes" (codificado em Base64) ou "false" se o conteúdo for fornecido como uma string em "AttachmentContent". O padrão é "falso".
AttachmentFileName	String	Não	O nome do arquivo a ser anexado. Esse parâmetro é usado quando "AttachmentHasBytes" é "false" ou não é fornecido.
Assunto	String	Sim	A linha de assunto do e-mail.
AttachmentContent	String	Não	O conteúdo da string do arquivo a ser anexado. Esse parâmetro é usado quando "AttachmentHasBytes" é definido como "false" ou não é fornecido.
BCC	String	Não	O endereço de e-mail do destinatário em cópia oculta. Para vários destinatários, use uma lista separada por vírgulas.
AttachmentContentBytes	String	Não	O conteúdo de bytes codificado em Base64 do arquivo a ser anexado. Esse parâmetro é usado quando "AttachmentHasBytes" está definido como "true".
CC	String	Não	O endereço de e-mail do destinatário em cópia. Para vários destinatários, use uma lista separada por vírgulas.
Conteúdo	String	Sim	O conteúdo principal da mensagem de e-mail.
AttachmentPath	String	Não	Uma lista separada por vírgulas de caminhos de arquivos locais a serem anexados ao e-mail.

Para ver um exemplo de como configurar a ação SendMailMessages, consulte Exemplos.

Ação DownloadAttachment

Essa ação baixa um anexo do Gmail.

Parâmetros de entrada da ação DownloadAttachment

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
MessageId	String	Sim	O ID do e-mail.
DownloadLocation	String	Não	O local em que o anexo será salvo.
FileStream	String	Não	Uma instância de um fluxo de saída em que os dados do arquivo são gravados.
AttachmentId	String	Não	O ID do anexo. Ele precisa ser fornecido se o FileStream for especificado.

Para ver um exemplo de como configurar a ação DownloadAttachment, consulte Exemplos.

Exemplos de ações

Nesta seção, mostramos como realizar algumas das ações neste conector.

Exemplo: enviar uma mensagem do Gmail

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

   {
     "To": "[e-mail]",
     "Subject": "Data MapperCheck",
     "Content": "Gmail",
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
"Id": "199334f660ff462a"
}]

Exemplo: enviar uma mensagem do Gmail com um anexo JPG

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

    {
   "To": "[e-mail]",
   "Subject": "Data Mapper Email Sep10 JPG",
   "Content": "Gmail",
   "AttachmentFileName": "TestSep10.jpg",
   "AttachmentContentBytes": "/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCANUBdwDAREAAhEBAxEB/8QAHgABAAAGAwEAAAAAAAAAAAAAAAEDBAcICQIFBgr/xABsEAABAwMCBAMFBQQHAwUJACMBAgMEAAURBgcIEiExCRNBChQiUWEVIzJxgUJSkaEWFzNicrHBJEPRNFOCkqIYJTlEY4O14fDxJmRzdXZ3k7PCNTY4haOytLYZN1RVV8NIVmV0eJSWpNLT4v/EAB0BAQABBAMBAAAAAAAAAAAAAAAHAQQFBgIDCAn/xABXEQABAwURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIlESiJREoiURKIv/Z",
   "AttachmentHasBytes": true
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
  "Id": "199334f660ff462a"
}]

Exemplo: enviar uma mensagem do Gmail com um anexo em PDF

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

   {
     "To": "[e-mail]",
     "Subject": "Data Mapper Email Sep10",
     "Content": "Gmail",
     "AttachmentFileName": "TestSep10.pdf",
     "AttachmentContent": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXy",
     "AttachmentHasBytes": true
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
  "Id": "1993341d558d7b07"
}]

Exemplo: enviar uma mensagem do Gmail com um anexo TXT

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

   {
     "To": "[e-mail]",
     "Subject": "Data Mapper Email Sep10",
     "Content": "Gmail",
     "AttachmentFileName": "TestSep10.txt",
     "AttachmentContent": "TestingwithAttachment",
     "AttachmentHasBytes": true
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
    "Id": "1993341d558d7b07"
}]

Exemplo: baixar um anexo do Gmail

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

   {
     "MessageId": "198acdcde5c09ce5"
   }
   

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

[{
    "Success": "true",
    "MessageId": "198acdcde5c09ce5",
    "AttachmentId": "1",
    "Size": "58005",
    "Data": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoYWJvdXQ6YmxhbmspCi9DcmVhdG9yIChNb3ppbGxhLzUuMCBcKFgxMTsgTGludXggeDg2XzY0XCkgQXBwbGVXZWJLaXQvNTM3LjM2IFwoS0hUTUwsIGxpa2UgR2Vja29cKSBIZWFkbGVzc0Nocm9tZS8xMzguMC4wLjAgU2FmYXJpLzUzNy4zNikKL1Byb2R1Y2VyIChTa2lhL1BERiBtMTM4KQovQ3JlYXRpb25EYXRlIChEOjIwMjUwODE1MDgwMDE2KzAwJzAwJykKL01vZERhdGUgKEQ6MjAyNTA4MTUwODAwMTYrMDAnMDAnKT4-CmVuZG9iagozIDAgb2JqCjw8L2NhIDEKL0JNIC9Ob3JtYWw-PgplbmRvYmo",
    "Filename": "My_Store_404672162.pdf",
    "@isoutervalue": null
}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar todas as mensagens do Gmail

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Messages na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause de acordo com a exigência do cliente.

Use aspas simples (') para incluir o valor de uma filterClause. Use a filterClause para filtrar registros com base nas colunas.

Exemplo: receber detalhes de uma mensagem do Gmail na caixa de entrada

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Inbox na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o entityId como 1, que é a chave a ser transmitida. Para definir o entityId, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira 1 no campo Input Value. Depois, escolha o entityId como variável local.

O valor de entityId precisa ser transmitido diretamente, como "1". Aqui, "1" é o valor exclusivo da chave primária, que é transmitido.

Em alguns casos, transmitir um único entityId pode causar um erro porque a entidade tem duas chaves compostas. Nesses casos, use a filterClause e transmita o valor, como id='1'.

Exemplo: excluir uma mensagem do Gmail

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Messages na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o entityId como 1, que é a chave a ser transmitida.
5. Para definir o entityId, na seção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e insira 1 no campo Valor de entrada. Depois, escolha entityId como variável local.

   Se a entidade tiver duas chaves primárias ou de negócios compostas em vez de especificar o entityId, você também poderá definir a filterClause como id='1'.

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 ver os registros do conector.