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.
- Ative os seguintes serviços:
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.
- Clique em + Criar novo para abrir a página Criar conexão.
- Na seção Local, escolha o local da conexão.
- Região: selecione um local na lista suspensa.
Veja abaixo as regiões compatíveis com o conector:
Para conferir a lista de todas as regiões com suporte, consulte Locais.
- Clique em Next.
- Região: selecione um local na lista suspensa.
- Na seção Detalhes da conexão, faça o seguinte:
- Conector: selecione Office365 na lista suspensa de conectores disponíveis.
- Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
- 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.
- Como opção, insira uma Descrição para a instância de conexão.
- Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
- 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.
- 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.
- Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
- Clique em Next.
-
Na seção Autenticação, insira os detalhes da autenticação.
- 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
- Clique em Next.
Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
- 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 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 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.
Limitações do sistema
O conector do Office365 pode processar uma transação por segundo, por nó, e limita 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.
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.
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 | Não | ID do usuário. |
UserPrincipalName | String | Não | O nome de usuário a que a licença precisa ser atribuída. |
Comentário | String | Não | Um comentário a incluir. |
Por exemplo, sobre como configurar a ação CancelEvent
,
consulte 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. |
Por exemplo, sobre como configurar a ação MoveMail
,
consulte 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 | 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 a que 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írgulas para planos que foram desativados. |
RemoveLicenses | String | Não | Um conjunto de IDs separados por vírgulas que identificam as licenças a serem removidas. |
Por 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 | O ID do evento. |
UserId | String | Não | ID do usuário. |
UserPrincipalName | String | Não | O nome de usuário ao qual a licença precisa ser atribuída. |
Comentário | String | Não | Um comentário a incluir. |
ToRecipients | String | Sim | Uma lista de e-mails de destinatários separados por ponto e vírgula. |
Por exemplo, sobre 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 | Não | Nome do arquivo para o qual você precisa fazer o 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 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 | Não | Conteúdo do arquivo a ser enviado. |
Por 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 baixar. |
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 os 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 apenas se DownloadTo não especificado. |
Por 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 está. |
FolderName | String | Sim | Nome da pasta a ser criada. |
Por exemplo, sobre como configurar o
CreateFolder
, consulte os 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 | 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 use um ID de e-mail existente ou envie um novo e-mail preenchendo o outro campos. |
Anexos | String | Não | Os anexos do arquivo. Especifique anexos de arquivo no seguinte formato:
|
FileName | String | Não | Os Destinatários especificam os destinatários na ordem a seguir. |
LocalFile | String | Não | O arquivo que contém o conteúdo do anexo. |
ContentBytes | String | Não | Conteúdo do anexo codificado para BASE64. |
CCRecipients | String | Não | Um ponto e vírgula separou os valores dos destinatários em Cc. |
SenderEmail | String | Não | O endereço de e-mail do usuário precisa ser enviado. Defina esta opção se você desejar enviar e-mails em nome da conta de outro usuário. |
FromEmail | String | Não | O endereço de e-mail do usuário a partir do qual o e-mail precisa ser enviado. Definir isto se você 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, html. O valor padrão é texto. |
Por exemplo, sobre como configurar o
SendMail
, consulte os 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. |
Comentário | String | Não | Conteúdo além da mensagem original. |
Por exemplo, sobre como configurar o
ForwardMail
, consulte os 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 | 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 do arquivo devem ser gravados. Esse valor é
usado apenas se DownloadTo não for fornecido. |
Por exemplo, sobre como configurar o
DownloadMail
, consulte os 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, retornará os bytes de conteúdo do anexo. Esse valor será obrigatório se MessageId for especificado. |
AttachmentId | String | Não | ID do anexo de que você quer fazer o download. Retorna todos os anexos do e-mail se nada for especificado. |
UserId | String | Não | ID do usuário. Isso funcionará apenas 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 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.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
CancelEvent
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=", "Comment": "Canceled due to rain" }
Se a ação for bem-sucedida, o
CancelEvent
resposta da tarefa connectorOutputPayload
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.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
AssignLicense
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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, a resposta connectorOutputPayload
da tarefa AssignLicense
terá um valor semelhante ao seguinte:
[{ "Status": "Success" }]
Exemplo: encaminhar um evento
Este exemplo encaminha um evento.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
ForwardEvent
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=", "Comment": "forwarded due to rain", "ToRecipients": "test99@example.com" }
Se a ação for bem-sucedida, o
ForwardEvent
resposta da tarefa connectorOutputPayload
terá um valor semelhante ao seguinte:
[{ "Status": "Success" }]
Exemplo: fazer upload de um arquivo
Neste exemplo, fazemos upload de um arquivo.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
UploadFile
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "FileName": "Document1234.docx", "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ", "Content": "test" }
Se a ação for bem-sucedida, o
UploadFile
resposta da tarefa connectorOutputPayload
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.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
DownloadFile
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP" }
Se a ação for bem-sucedida, o
DownloadFile
resposta da tarefa connectorOutputPayload
terá um valor semelhante ao seguinte:
[{ "Status": "Success", "FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J" }]
Exemplo: criar uma pasta
Este exemplo cria uma pasta.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
CreateFolder
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ", "FolderName": "outbox1234" }
Se a ação for bem-sucedida, o
CreateFolder
resposta da tarefa connectorOutputPayload
terá um valor semelhante ao seguinte:
[{ "Status": "Success" }]
Exemplo: enviar um e-mail
Este exemplo envia um e-mail para os destinatários especificados.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
SendMail
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "ToRecipients": "test097@example.com", "Content": "Testing", "Subject": "Test subject", "FileName": "Google" }
Se a ação for bem-sucedida, o
SendMail
resposta da tarefa connectorOutputPayload
terá um valor semelhante ao seguinte:
[{ "Status": "Success" }]
Exemplo: encaminhar um e-mail
Este exemplo encaminha um e-mail.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
ForwardMail
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=", "ToRecipients": "test097@example.com", "Comment": "forwarded message" }
Se a ação for bem-sucedida, o
ForwardMail
resposta da tarefa connectorOutputPayload
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.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
DownloadEmail
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA=" }
Se a ação for bem-sucedida, o
DownloadEmail
resposta da tarefa connectorOutputPayload
terá um valor semelhante ao seguinte:
[{ "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 emActions
. - Selecione a ação
DownloadAttachments
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ {"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=", "DownloadTo": "My files/Office355/reports/"} }
Se a ação for bem-sucedida, o
DownloadAttachments
resposta da tarefa connectorOutputPayload
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 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.