Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais do Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Gmail

O conector do Gmail permite-lhe realizar operações de leitura e eliminação no Gmail.

Versões suportadas

Este conetor suporta as APIs REST do Gmail.

Antes de começar

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

• No seu projeto do Google Cloud:
  • 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. Para mais informações, consulte o artigo Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (API Secret Manager)
    • 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 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, conclua o seguinte:
   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. Clicar em Seguinte.
4. Na secção Detalhes da associação, conclua 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 associação, introduza um nome para a instância da associação. O nome da associação pode conter letras minúsculas, números ou hífenes. O nome tem de começar com uma letra e terminar com uma letra ou um número, e não pode exceder 49 carateres.
   4. Descrição: 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 por utilização.
   8. + ADICIONAR ETIQUETA: clique nesta opção para adicionar uma etiqueta à associação sob a forma de um par de chave-valor.
   9. Clicar em Seguinte.
5. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do Gmail:

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

      Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clicar em Seguinte.
6. Rever: reveja os detalhes da ligação e da autenticação.
7. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

• Autenticação da conta de serviço: não é necessária nenhuma configuração adicional para este tipo de autenticação. A conta de serviço que selecionou na secção Detalhes da ligação vai ser usada para autenticação.
• OAuth 2.0 – JWT Bearer
  • Certificado JWT: selecione o certificado a usar para a autenticação JWT.
  • Versão do Secret: introduza a versão do Secret do certificado JWT.
  • Assunto do JWT: introduza o assunto do JWT.
  • Ativar substituição da autenticação: ative esta opção para substituir a autenticação.
• OAuth 2.0 – Código de autorização
  • ID do cliente: introduza o ID do cliente a usar para a autenticação OAuth.
  • Âmbitos: introduza uma lista dos âmbitos pretendidos.
  • Segredo do cliente: o segredo do cliente a usar para a autenticação OAuth.
  • Versão do Secret: introduza a versão do Secret do segredo do cliente.
  • Ativar substituição da autenticação: ative esta opção para substituir a autenticação.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo dos vários campos que configura quando cria a associação.

OAuth 2.0 – Tipo de ligação de portador JWT

Nome do campo	Detalhes
Localização	asia-east1
Conetor	Gmail
Versão do conetor	1
Nome da ligação	gmail-jwt-conn
Ative o 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 de JWT
Certificado JWT	Certificado JWT
Versão do Secret	1

OAuth 2.0 – Tipo de ligação de código de autorização

Nome do campo	Detalhes
Localização	us-central1
Conetor	Gmail
Versão do conetor	1
Nome da ligação	gmail-auth-conn
Ative o 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	OAuth 2.0 – Código de autorização
ID do cliente	60875425788659-mt0cm1tguyiagvst468fvaw7.apps.googleusercontent.com
Âmbitos	https://mail.google.com/
Segredo do cliente	ygdruoX-Rtyah9gzkdZc-7CB0Eng9hyaufD0VD
Versão do Secret	1

Limitações do sistema

O conector do Gmail pode processar um máximo de 1 transação 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.

Use a ligação do Gmail numa integração

Depois de criar a associaçã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 de conetores na Apigee Integration, consulte o artigo Tarefa de conetores.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Ações

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

Ação SendMailMessages

Esta ação envia uma mensagem do Gmail.

Parâmetros de entrada da ação SendMailMessages

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
Para	String	Sim	O endereço de email do destinatário principal. Para vários destinatários, use uma lista separada por vírgulas.
AttachmentHasBytes	String	Não	Defina como verdadeiro se o conteúdo do anexo for fornecido em AttachmentContentBytes (codificado em Base64) ou como falso se o conteúdo for fornecido como uma string em AttachmentContent. A predefinição é false.
AttachmentFileName	String	Não	O nome do ficheiro a anexar. Este parâmetro é usado quando AttachmentHasBytes é falso ou não é fornecido.
Assunto	String	Sim	A linha de assunto do email.
AttachmentContent	String	Não	O conteúdo de string do ficheiro a anexar. Este parâmetro é usado quando AttachmentHasBytes está definido como false ou não é fornecido.
BCC	String	Não	O endereço de email do destinatário em CCO. 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 ficheiro a anexar. Este parâmetro é usado quando AttachmentHasBytes está definido como verdadeiro.
CC	String	Não	O endereço de email do destinatário em cc. Para vários destinatários, use uma lista separada por vírgulas.
Conteúdo	String	Sim	O conteúdo principal da mensagem de email.
AttachmentPath	String	Não	Uma lista de caminhos de ficheiros locais separados por vírgulas para anexar ao email.

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

Ação DownloadAttachment

Esta ação transfere um anexo do Gmail.

Introduza os parâmetros da ação DownloadAttachment

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
MessageId	String	Sim	O ID do email.
DownloadLocation	String	Não	A localização onde o anexo vai ser guardado.
FileStream	String	Não	Uma instância de uma stream de saída na qual os dados dos ficheiros são escritos.
AttachmentId	String	Não	O ID do anexo. Tem de ser fornecido se o FileStream for especificado.

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

Exemplos de ações

Esta secção mostra 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

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

Exemplo: envie 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

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

Exemplo: envie uma mensagem do Gmail com um anexo PDF

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação SendMailMessages e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

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

Exemplo: envie 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, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

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

Exemplo: transfira um anexo do Gmail

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

   {
     "MessageId": "198acdcde5c09ce5"
   }
   

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

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

Exemplos de operações de entidades

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

Exemplo: lista 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, pode definir a filterClause de acordo com o requisito do cliente.

Tem de usar aspas simples (') para incluir o valor de uma filterClause. Pode usar o elemento filterClause para filtrar registos com base nas colunas.

Exemplo: obtenha os detalhes de uma mensagem do Gmail a partir da 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, de seguida, clique em Concluído.
4. Defina o entityId como 1, que é a chave a ser transmitida. Para definir o entityId, na secção Data Mapper de Data Mapping, clique em Open Data Mapping Editor e, em seguida, introduza 1 no campo Input Value e escolha o entityId como variável local.

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

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

Exemplo: elimine 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, de seguida, clique em Concluído.
4. Defina o entityId como 1, que é a chave a ser transmitida.
5. Para definir o entityId, na secção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e, de seguida, introduza 1 no campo Valor de entrada e escolha o entityId como variável local.

   Se a entidade tiver duas chaves empresariais ou principais compostas em vez de especificar o entityId, também pode definir o filterClause como id='1'.

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 conector.