Office365

O conector do Office365 permite que você se conecte a uma instância do Office365 e execute as operações compatíveis.

Antes de começar

Antes de usar o conector do Office365, execute as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • 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.

    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.

      Veja abaixo as regiões com suporte com o conector:

      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 Office365 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. Locatário do Azure: o locatário do Microsoft Online usado para acessar dados. Se não for especificado, sua tentativa padrão será usada.
    8. Também é possível clicar em + Adicionar rótulo 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 com o Office365:

      • Concessão de código de autenticação OAuth 2.0

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

    2. Clique em Próxima.
  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.

  • Concessão de código de autenticação do OAuth 2.0
    • Token de acesso: o token de acesso usado para autenticar solicitações com conexões baseadas em fluxo de código de autenticação.
    • ID do cliente: o ID usado para solicitar tokens de acesso.
    • Chave secreta do cliente: usada para solicitar tokens de acesso.

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 for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de 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 e de saída. 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 Office365 pode processar uma transação por segundo, por nó, e limita qualquer transação 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.

Ações

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

Ação CancelEvent

Essa ação permite cancelar um evento.

Parâmetros de entrada da ação CancelEvent

Nome do parâmetro Tipo de dados Obrigatório Descrição
EventId String Sim ID do evento.
UserId String No ID do usuário.
UserPrincipalName String No O nome de usuário a que a licença precisa ser atribuída.
Comentar String No Um comentário a incluir.

Para ver como configurar a ação CancelEvent, consulte os Exemplos de ação.

Ação MoveMail

Assim, você pode mover um e-mail.

Parâmetros de entrada da ação MoveMail

Nome do parâmetro Tipo de dados Obrigatório Descrição
MessageId String Sim O ID do e-mail.
DestinationId String Sim ID da pasta de destino para onde o e-mail será movido.

Para ver como configurar a ação MoveMail, consulte os Exemplos de ação.

Ação "AtribuirLicença"

Essa ação permite atribuir uma licença.

Parâmetros de entrada da açãoAssignLicense

Nome do parâmetro Tipo de dados Obrigatório Descrição
UserId String No O ID do usuário ao qual a licença precisa ser atribuída.
UserPrincipalName String No O nome de usuário a que a licença precisa ser atribuída.
AddLicenseSkuId String No O identificador exclusivo da SKU.
DisabledPlans String No Um conjunto de identificadores exclusivos separados por vírgulas para planos que foram desativados.
RemoveLicenses String No Um conjunto de IDs separados por vírgulas que identificam as licenças a serem removidas.

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

Ação ForwardEvent

Essa ação permite que você encaminhe um evento.

Parâmetros de entrada da ação ForwardEvent

Nome do parâmetro Tipo de dados Obrigatório Descrição
EventId String Sim O ID do evento.
UserId String No ID do usuário.
UserPrincipalName String No O nome de usuário ao qual a licença precisa ser atribuída.
Comentar String No Um comentário a incluir.
ToRecipients String Sim Uma lista de e-mails de destinatários separados por ponto e vírgula.

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

Ação UploadFile

Essa ação permite que você faça upload de um arquivo.

Parâmetros de entrada da ação UploadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileName String No Nome do arquivo para o qual você precisa fazer o upload do conteúdo.
LocalFile String No Arquivo local com o conteúdo a ser enviado.
ContentStream String No O conteúdo como stream de entrada que será enviado quando o caminho local ou caminho da pasta não for especificado.
ParentId String Sim ID da pasta em que o item atual está.
Conteúdo String No Conteúdo do arquivo a ser enviado.

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

Ação DownloadFile

Essa ação permite fazer o download de um arquivo.

Parâmetros de entrada da ação DownloadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileId String Sim O ID do arquivo que você quer baixar.
DownloadTo String No Onde armazenar o arquivo.
Codificação String No O tipo de codificação de entrada FileData. Os valores permitidos são NONE, BASE64, e o valor padrão é BASE64.
FileStream String No Uma instância de um stream de saída em que os dados do arquivo são gravados. Usado apenas se DownloadTo não especificado.

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

Ação CreateFolder

Essa ação permite criar uma pasta.

Parâmetros de entrada da ação CreateFolder

Nome do parâmetro Tipo de dados Obrigatório Descrição
ParentId String No O ID da pasta em que o item atual está.
FolderName String Sim Nome da pasta a ser criada.

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

Ação SendMail

Essa ação permite que você envie um e-mail.

Parâmetros de entrada da ação SendMail

Nome do parâmetro Tipo de dados Obrigatório Descrição
ToRecipients String No Os destinatários para os quais o e-mail deve ser enviado.
Conteúdo String No Conteúdo do e-mail.
Matéria String No O assunto do e-mail.
ID String No O ID da mensagem a ser enviada (opcional). O usuário pode usar um ID de e-mail atual ou enviar um novo e-mail preenchendo os outros campos.
Anexos String No Os anexos do arquivo. Especifique anexos de arquivo no seguinte formato:

filename1,filecontent1;filename2,filecontent2. O conteúdo de cada arquivo pode ser um dado BASE64 ou o caminho de um arquivo local com o caractere @ antes dele.
FileName String No Os Destinatários especificam os destinatários na ordem a seguir.
LocalFile String No O arquivo que contém o conteúdo do anexo.
ContentBytes String No Conteúdo do anexo codificado para BASE64.
CCRecipients String No Um ponto e vírgula separou os valores dos destinatários em Cc.
SenderEmail String No O endereço de e-mail do usuário precisa ser enviado. Defina essa opção se você quiser enviar e-mails em nome da conta de outro usuário.
FromEmail String No O endereço de e-mail do usuário a partir do qual o e-mail precisa ser enviado. Defina essa opção se você quiser enviar e-mails da conta de outro usuário.
ContentType String No O tipo de conteúdo do corpo do e-mail.Os valores permitidos são texto, html. O valor padrão é texto.

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

Ação de ForwardMail

Assim, você pode encaminhar um e-mail.

Parâmetros de entrada da ação ForwardMail

Nome do parâmetro Tipo de dados Obrigatório Descrição
MessageId String Sim ID do e-mail.
ToRecipients String Sim Uma lista de e-mails de destinatários separados por ponto e vírgula.
Comentar String No Conteúdo além da mensagem original.

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

Ação DownloadEmail

Essa ação permite fazer o download de um e-mail.

Parâmetros de entrada da ação DownloadEmail

Nome do parâmetro Tipo de dados Obrigatório Descrição
MessageId String Sim ID da mensagem da qual você quer fazer o download.
Codificação String No O tipo de codificação de entrada de dados do arquivo.
DownloadTo String No Onde armazenar o arquivo.
FileStream String No Uma instância de um stream de saída em que os dados do arquivo devem ser gravados. Esse valor será usado somente se DownloadTo não for fornecido.

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

Ação DownloadAttachments

Essa ação permite fazer o download dos anexos de um e-mail.

Parâmetros de entrada da ação DownloadAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
MessageId String Sim Código do e-mail do qual você quer receber os anexos.
Codificação String No O tipo de codificação de entrada FileData. Os valores permitidos são NONE, BASE64.
DownloadTo String No Onde armazenar os anexos. Se não for especificado, retornará os bytes de conteúdo do anexo. Esse valor será obrigatório se MessageId for especificado.
AttachmentId String No ID do anexo de que você quer fazer o download. Retorna todos os anexos do e-mail se nada for especificado.
UserId String No ID do usuário. Isso funcionará apenas se o usuário autenticado tiver permissões de administrador.
FileStream String No Uma instância de um stream de saída em que os dados do arquivo são gravados. Usado apenas se DownloadTo não for fornecido.

Para ver como configurar a ação DownloadAttachments, consulte os Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: cancelar um evento

Este exemplo cancela um evento com o ID especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CancelEvent 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: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
"Comment": "Canceled due to rain"
}

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

    [{
"Status": "Success"
}]

Exemplo: atribuir e remover uma licença

Este exemplo atribui e remove licenças do usuário especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AssignLicense 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: 
    {
"UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
"AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
"RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
}

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

    [{
"Status": "Success"
}]

Exemplo: encaminhar um evento

Este exemplo encaminha um evento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ForwardEvent 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: 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
"Comment": "forwarded due to rain",   
"ToRecipients": "test99@example.com"
}

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

    [{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo

Neste exemplo, fazemos upload de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadFile 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: 
    {
"FileName": "Document1234.docx",   
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"Content": "test"
}

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

     [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"Status": "Success"
}]

Exemplo: fazer o download de um arquivo

Este exemplo faz o download de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadFile 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: 
    {
"FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
}

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

    [{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

Exemplo: criar uma pasta

Este exemplo cria uma pasta.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateFolder 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: 
    {
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"FolderName": "outbox1234"
}

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

    [{
"Status": "Success"
}]

Exemplo: enviar um e-mail

Este exemplo envia um e-mail para os destinatários especificados.

  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: 
    {
"ToRecipients": "test097@example.com",   
"Content": "Testing",   
"Subject": "Test subject",   
"FileName": "Google"
}

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

    [{
"Status": "Success"
}]

Exemplo: encaminhar um e-mail

Este exemplo encaminha um e-mail.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ForwardMail 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: 
    {
"MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
"ToRecipients": "test097@example.com",   
"Comment": "forwarded message"
}

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

    [{
"Status": "Success"
}]

Exemplo: fazer o download de um e-mail

Este exemplo faz o download de um e-mail.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadEmail 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: 
    {
"MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}

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

    [{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

Exemplo: fazer o download de anexos

Este exemplo faz o download de anexos.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadAttachments 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: 
    {
{"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
"DownloadTo": "My files/Office355/reports/"}
}

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

    [{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]

Usar a conexão com o Office 365 em uma integração

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar 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 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