Office365

O conector do Office365 permite que você se conecte a uma instância do Office365 e realize 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:

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"
Clique em + Criar novo para abrir a página Criar conexão.
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.
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 sendo usado para acessar os dados. Se não for especificado, o intent padrão vai ser usado.
8. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
9. Clique em Próxima.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  A conexão com o Office365 oferece suporte aos seguintes tipos de autenticação:
  - Concessão de código de autenticação do OAuth 2.0
2. Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação.
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 do cliente 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:
- List
- 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, 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 Office365 pode processar uma transação 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.

Observação:o número de nós dos conectores de integração será escalonado automaticamente 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. São necessários mais nós para processar mais transações para uma conexão. Por outro lado, menos nós serã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 de conexão.
Se você é um cliente de 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 melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

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.

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

Ação CancelEvent

Esta 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	Não	ID do usuário.
UserPrincipalName	String	Não	O nome de usuário para o qual a licença precisa ser atribuída.
Comentar	String	Não	Um comentário a ser incluído.

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

Ação MoveMail

Essa ação permite 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.

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

Ação AttributionLicense

Isso permite que você atribua uma licença.

Parâmetros de entrada da ação AttributionLicense

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

Para um exemplo sobre 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	ID do evento.
UserId	String	Não	ID do usuário.
UserPrincipalName	String	Não	O nome de usuário para o qual a licença precisa ser atribuída.
Comentar	String	Não	Um comentário a ser incluído.
ToRecipients	String	Sim	Uma lista de e-mails de destinatários separados por ponto e vírgula.

Para um exemplo sobre como configurar a ação ForwardEvent, consulte Exemplos de ação.

Ação "UploadFile"

Essa ação permite fazer 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	Não	Nome do arquivo para o qual você precisa fazer upload do conteúdo.
LocalFile	String	Não	Arquivo local com o conteúdo a ser enviado.
ContentStream	String	Não	O conteúdo como stream de entrada a ser enviado quando localpath ou folderpath não for especificado.
ParentId	String	Sim	ID da pasta em que o item atual se encontra.
Conteúdo	String	Não	Conteúdo do arquivo a ser enviado.

Para um exemplo sobre 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 transferir por download.
DownloadTo	String	Não	Onde armazenar o arquivo.
Codificação	String	Não	O tipo de codificação de entrada FileData. Os valores permitidos são NONE, BASE64 e o valor padrão é BASE64.
FileStream	String	Não	Uma instância de um stream de saída em que os dados do arquivo são gravados. Usado somente se DownloadTo não for especificado.

Para um exemplo sobre 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	Não	O ID da pasta em que o item atual se encontra.
FolderName	String	Sim	Nome da pasta a ser criada.

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

Ação "SendMail"

Isso 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	Não	Os destinatários para os quais o e-mail deve ser enviado.
Conteúdo	String	Não	Conteúdo do e-mail.
Assunto	String	Não	O assunto do e-mail.
ID	String	Não	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	Não	Os anexos do arquivo. Especifique anexos 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	Não	Os destinatários especificam destinatários na seguinte ordem.
LocalFile	String	Não	O arquivo com o conteúdo do anexo.
ContentBytes	String	Não	Conteúdo do anexo codificado para BASE64.
CCRecipients	String	Não	Valores separados por ponto e vírgula dos destinatários no campo CC.
SenderEmail	String	Não	O endereço de e-mail do destinatário precisa ser enviado. Defina essa opção se quiser enviar e-mails em nome da conta de outro usuário.
FromEmail	String	Não	O endereço de e-mail do usuário do qual o e-mail precisa ser enviado. Defina essa opção se quiser enviar e-mails da conta de outro usuário.
ContentType	String	Não	O tipo de conteúdo do corpo do e-mail.Os valores permitidos são texto e html. O valor padrão é texto.

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

Ação de encaminhamento de e-mail

Com isso, 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	Não	Conteúdo além da mensagem original.

Por exemplo, sobre 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 que você quer transferir por download.
Codificação	String	Não	O tipo de codificação de entrada de dados do arquivo.
DownloadTo	String	Não	Onde armazenar o arquivo.
FileStream	String	Não	Uma instância de um stream de saída em que os dados de arquivo devem ser gravados. Esse valor será usado somente se `DownloadTo` não for fornecido.

Por exemplo, sobre 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	Não	O tipo de codificação de entrada FileData. Os valores permitidos são NONE, BASE64.
DownloadTo	String	Não	Onde armazenar os anexos. Se não for especificado, ela retornará os bytes de conteúdo do anexo. Esse valor será obrigatório se `MessageId` for especificado.
AttachmentId	String	Não	ID do anexo do qual você quer fazer o download. Retorna todos os anexos do e-mail se não for especificado.
UserId	String	Não	ID do usuário. Isso só funcionará se o usuário autenticado tiver permissões de administrador.
FileStream	String	Não	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.

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

Exemplos de ação

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

Exemplo: cancelar um evento

Este exemplo cancela um evento com o ID especificado.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CancelEvent e clique em Concluído.

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"
}

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

[{
"Status": "Success"
}]

Exemplo: atribuir e remover uma licença

Neste exemplo, as licenças do usuário especificado são atribuídas e removidas.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação AssignLicense e clique em Concluído.

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"
}

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

[{
"Status": "Success"
}]

Exemplo: encaminhar um evento

Este exemplo encaminha um evento.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação ForwardEvent e clique em Concluído.

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"
}

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

[{
"Status": "Success"
}]

Exemplo: fazer upload de um arquivo

Este exemplo faz upload de um arquivo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação UploadFile e clique em Concluído.
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"
}
```

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

 [{
"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

Neste exemplo, fazemos o download de um arquivo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DownloadFile e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
}
```

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

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

Exemplo: criar uma pasta

Este exemplo cria uma pasta.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CreateFolder e clique em Concluído.
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"
}
```

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

[{
"Status": "Success"
}]

Exemplo: enviar um e-mail

Neste exemplo, um e-mail é enviado para os destinatários especificados.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SendMail e clique em Concluído.
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"
}
```

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

[{
"Status": "Success"
}]

Exemplo: encaminhar um e-mail

Este exemplo encaminha um e-mail.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação ForwardMail e clique em Concluído.

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"
}

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

[{
"Status": "Success"
}]

Exemplo: fazer o download de um e-mail

Neste exemplo, fazemos o download de um e-mail.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DownloadEmail e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}
```

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

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

Exemplo: fazer o download de anexos

Este exemplo faz o download de anexos.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DownloadAttachments e clique em Concluído.

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/"}
}

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

[{
"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 Office365 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

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