SharePoint

Com o conector do SharePoint, é possível gerenciar arquivos, pastas e anexos no SharePoint.

Versões compatíveis

Esse conector é compatível com o Windows SharePoint Services 3.0, o Microsoft Office SharePoint Server 2007 e versões mais recentes e o SharePoint Online.

Antes de começar

No seu projeto do Google Cloud, faça o seguinte:

  • Verifique se a conectividade de rede está configurada. Para mais informações, consulte Conectividade de rede.
  • Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Conceda os papéis do IAM roles/secretmanager.viewer e roles/secretmanager.secretAccessor à conta de serviço que você quer usar para o conector:
  • Ative secretmanager.googleapis.com (API Secret Manager) e connectors.googleapis.com (API Connectors). Para mais informações, consulte Como ativar serviços.

Criar uma conexão do SharePoint

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, selecione um local na lista Região e clique em Próxima.

    Para conferir a lista de todas as regiões com suporte, consulte Locais.

  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Selecione SharePoint na lista de conectores.
    2. Selecione uma versão do conector na lista Versão do conector.
    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. Como opçã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. No campo Conta de serviço, selecione uma conta 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.

    8. Outra opção é 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 Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar e clique em Próxima.
  6. No campo Tipo de destino, selecione uma opção. Por exemplo, o endereço do host é https://<SITE_NAME>.sharepoint.com.

    • Para especificar o nome do host ou o endereço IP de destino, selecione Endereço do host e insira o endereço no campo Host 1.
    • Para estabelecer uma conexão particular, selecione Anexo de endpoint e escolha o anexo necessário na lista Anexo de endpoint.

    Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

    Para inserir outros destinos, clique em + Adicionar destino.

  7. 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 SharePoint:

      • Credenciais do Windows. Selecione essa opção se você usa a edição local do SharePoint.
      • AzureAD. Selecione essa opção se você usa a edição on-line do SharePoint.
      • Credenciais do cliente OAuth 2.0 com portador JWT. Selecione essa opção se você usar credenciais de cliente OAuth 2.0 com portador JWT para autenticação.
      • Credenciais do cliente OAuth 2.0 com chave secreta do cliente. Selecione essa opção se você usar credenciais de cliente do OAuth 2.0 com chave secreta do cliente para autenticação.
    2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    3. Clique em Próxima.
  8. Na seção Revisão, revise os detalhes de conexão e autenticação.
  9. Clique em Criar.

Configurar a autenticação

O conector do SharePoint é compatível com os seguintes tipos de autenticação:

Tipo de autenticação de credenciais do Windows

Para ativar o tipo de autenticação de credenciais do Windows, siga estas etapas:

  1. Configure o PSC e crie um anexo de endpoint.
  2. Especifique as credenciais em Google Cloud.

Configurar o PSC e criar um anexo de endpoint

  1. Crie um grupo de instâncias com o IP em que o SharePoint está hospedado.
  2. Crie um balanceador de carga de rede de passagem interna e use o grupo de instâncias criado como back-end. O balanceador de carga TCP interno precisa ter o acesso global ativado.
  3. Publique o balanceador de carga no Private Service Connect. Um anexo de serviço é gerado depois que o balanceador de carga é publicado.
  4. Publique o serviço e especifique o balanceador de carga que você criou.
  5. Use o anexo de serviço para criar um anexo de endpoint.
  6. Depois de criar o anexo de endpoint, crie uma conexão do SharePoint com o IP do anexo.
  7. Para mais informações sobre como criar um anexo de endpoint, consulte Criar um anexo de endpoint.

Especifique os detalhes das credenciais do Windows em Google Cloud

Ao criar a conexão no Integration Connectors , especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do Windows como o tipo de autenticação e insira os seguintes detalhes:

  • Nome de usuário: digite o nome de usuário.
  • Senha: selecione a senha.
  • Versão do secret: insira a versão do secret.

Tipo de conexão de credenciais do Windows

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de credenciais do Windows.

Nome do campo Detalhes
Região us-central1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-staging-psc
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://192.0.2.0
porta 1 24
Autenticação Credenciais do Windows
Nome de usuário USER_NAME
Senha SENHA
Versão do secret 1

Tipo de autenticação do Azure AD

Para ativar o tipo de autenticação do Azure AD, siga estas etapas:

  1. Registre o app e receba o OAuthClientId e o OAuthClientSecret.
  2. Especifique as credenciais em Google Cloud.
  3. Autorize a conexão em Google Cloud.
  4. Adicione o URL de redirecionamento ao seu app.

Registre o app e receba o OAuthClientId e o OAuthClientSecret

Para registrar seu app e receber o OAuthClientId e o OAuthClientSecret dele, faça o seguinte:

  1. Faça login no Portal do Azure.
  2. Em Serviços do Azure, selecione Registros de app e Novo registro.
  3. Insira um nome de aplicativo e selecione Qualquer locatário do Microsoft Entra ID – multilocatário.
  4. Clique em Registrar.
  5. Depois de criar o app, navegue até a seção Certificados e chaves secretas, crie uma chave secreta do cliente para o aplicativo e salve o valor dela.
  6. Em Permissões da API, selecione as permissões de aplicativo e delegadas necessárias. Para que a conexão fique ativa, é necessário conceder a seguinte permissão mínima:Sites.Read.All.

    A tabela a seguir lista as permissões necessárias para realizar operações no aplicativo.

    Permissões delegadas Permissões do aplicativo
    ConsentRequest.Read.All AllSites.FullControl
    ConsentRequest.ReadWrite.All AllSites.Manage
    DelegatedAdminRelationship.Read.All AllSites.Read
    DelegatedAdminRelationship.ReadWrite.All AllSites.Write
    DelegatedPermissionGrant.Read.All EnterpriseResource.Read
    DelegatedPermissionGrant.ReadWrite.All EnterpriseResource.Write
    Files.Read.All MyFiles.Read
    Files.ReadWrite.All MyFiles.Write
    Group.Create Project.Read
    Group.Read.All Project.Write
    Group.ReadWrite.All ProjectWebApp.FullControl
    Sites.FullControl.All ProjectWebAppReporting.Read
    Sites.FullControl.All Sites.FullControl.All
    Sites.Manage.All Sites.Manage.All
    Sites.Read.All Sites.Read.All
    Sites.ReadWrite.All Sites.ReadWrite.All
    Sites.Selected Sites.Search.All
    User.Export.All Sites.Selected
    User.Read TaskStatus.Submit
    User.Read.All TermStore.Read.All
    User.ReadWrite.All TermStore.Read.All
    TermStore.ReadWrite.All
    TermStore.ReadWrite.All
    User.Read.All
    User.Read.All
    User.ReadWrite.All
    User.ReadWrite.All
  7. Salve as alterações.
  8. Se você selecionou o uso de permissões que exigem o consentimento do administrador, é possível concedê-las no locatário atual na página Permissões da API.
  9. Para adicionar o escopo, acesse a seção Expor uma API, adicione escopos AllSites.Manage, Sites.FullControl.All e selecione quem pode controlar (administradores e usuários).
  10. Clique em Salvar.

Especifique as credenciais em Google Cloud.

Ao criar a conexão no Integration Connectors , especifique os seguintes detalhes:

Na seção Autenticação, selecione AzureAD como o tipo de autenticação e insira os seguintes detalhes:

  • ID do cliente: insira o ID do cliente usado para solicitar tokens de acesso.
  • Escopos: insira uma lista separada por vírgulas dos escopos desejados. Por exemplo, Sites.FullControl.All
  • Chave secreta do cliente: insira o secret que contém a chave secreta do cliente para o app conectado que você criou.
  • Versão do secret: a versão do secret selecionado acima.
  • URL de autorização: o URL de autorização gerado ao criar um cliente OAuth. Insira o URL no seguinte formato: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Por exemplo, https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent.

Autorize a conexão em Google Cloud

  1. Na página "Conexões", localiza a conexão recém-criada.

    O Status do novo conector será Autorização necessária.

  2. Clique em Autorização necessária.

    O painel Editar autorização é exibido.

  3. Copie o valor de URI de redirecionamento para seu aplicativo externo. Para mais informações, consulte Adicionar o URL de redirecionamento ao app.
  4. Verifique os detalhes da autorização.
  5. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Adicione o URL de redirecionamento ao seu app

  1. No portal do Azure, clique em Serviços do Azure > Registros de aplicativos.
  2. Clique no nome do app.
  3. Clique em "Adicionar URI de redirecionamento".
  4. Clique em Adicionar uma plataforma.
  5. Na caixa de diálogo Web, cole o URI de redirecionamento que você copiou ao autorizar a conexão no Google Cloud.

Tipo de conexão do Azure AD

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão do Azure AD:

Nome do campo Detalhes
Região us-central1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-google-cloud-con
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
Autenticação AzureAD
ID do cliente CLIENT_ID
Escopos Sites.FullControl.All
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1
URL de autorização https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0: credenciais do cliente com tipo de autenticação de portador JWT

Para ativar o OAuth 2.0: credenciais do cliente com o tipo de autenticação JWT Bearer, siga estas etapas:

  1. Crie um certificado.
  2. Faça upload do certificado para o portal do Azure.
  3. Extraia uma chave privada.
  4. Conclua a configuração.
  5. Especifique as credenciais de portador JWT do OAuth 2.0 em Google Cloud.

Criar um certificado

  1. Crie uma pasta vazia no computador.
  2. Crie um arquivo de texto na pasta.
  3. Copie o script do PowerShell da página Conceder acesso usando apenas o app do Azure AD e cole no arquivo de texto.
  4. Renomeie o arquivo de texto para: Create-SelfSignedCertificate.ps1.
  5. Execute o Windows PowerShell na pasta.
  6. Acesse o diretório que contém o arquivo de texto.
  7. Copie o seguinte comando: .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    Insira um nome exclusivo para CERTIFICATE_NAME. Mude a StartDate para a data atual e a EndDate para uma data de sua escolha.

  8. Cole o comando copiado com as mudanças no Windows PowerShell e pressione Enter.

    O Windows PowerShell pede para inserir a senha para proteger a chave privada. Salve a senha para usar depois.

    O Windows PowerShell cria dois arquivos: MyCertificate.pfx e MyCertificate.cer.

Fazer upload do certificado para o portal do Azure

  1. Faça login no portal do Azure e registre um novo aplicativo especificando os seguintes detalhes:
    • Nome: digite um nome para o aplicativo.
    • Tipos de conta compatíveis: selecione Somente contas neste diretório organizacional (somente nome da conta – tenant único).
  2. Acesse Permissões da API > Adicionar permissão > Solicitar permissões da API > SharePoint.
  3. Selecione Permissões do aplicativo e adicione as permissões necessárias.
  4. Selecione Conceder consentimento de administrador e clique em Sim.
  5. Depois de criar o app, navegue até a seção Certificados e chaves secretas.
  6. Selecione Fazer upload do certificado e envie o certificado CER do seu computador. Depois que o upload terminar, selecione Adicionar.

    Não adicione chaves secretas do cliente no app, porque isso interfere no fluxo de autenticação baseada em certificado.

  7. Acesse "Manifest", encontre "KeyCredentials" e copie o "customKeyIdentifier" como a impressão digital. Você vai usar isso mais tarde. Agora você registrou o app e vinculou o certificado.

Extrair uma chave privada

É possível converter o arquivo PFX em um arquivo PEM usando o OpenSSL para obter uma chave privada.

  1. No prompt de comando, acesse a pasta com o arquivo PFX e execute o seguinte comando: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Insira a senha PFX usada no processo de criação do certificado.
  3. Abra o arquivo PEM em um editor de texto e copie todo o texto, que é sua chave privada.

Concluir a configuração

  1. Copie o ID do cliente e o ID do locatário do app recém-registrado no portal do Azure.
  2. Faça login com a autenticação do principal de serviço da lista do SharePoint usando as seguintes credenciais:
    • ID do cliente
    • Código do locatário
    • Chave privada
    • Impressão digital (senha da chave privada)

Especifique as credenciais de portador JWT do OAuth 2.0 em Google Cloud

Ao criar a conexão no Integration Connectors , especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do cliente OAuth 2.0 com portador JWT como o tipo de autenticação e insira os seguintes detalhes:

  • No campo ID do cliente, insira o ID usado para solicitar tokens de acesso. Essa é a chave de consumidor gerada quando você registrou o app no portal do Azure.
  • No campo Chave privada, selecione o secret do Secret Manager que contém o conteúdo do arquivo de chave privada no formato PEM. A chave privada deve corresponder à chave pública/certificado fornecido ao conector.
  • No campo Versão do secret, selecione a versão do secret selecionado acima.
  • No campo Senha da chave privada, selecione o secret do Secret Manager que contém a senha (parafraseada) do arquivo da chave privada. Use a mesma senha definida para proteger a chave privada ao criar o certificado.
  • No campo Versão do secret, selecione a versão do secret selecionado acima.
  • No campo Locatário do Azure, insira o locatário on-line da Microsoft usado para acessar os dados.

Tipo de conexão do certificado de portador JWT

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão "Certificado de portador JWT OAuth 2.0".

Nome do campo Detalhes
Região europe-west1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-jwt-certificate
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
porta 1 ****
Autenticação Credenciais do cliente OAuth 2.0 com portador JWT
ID do cliente OAuth CLIENT_ID
Chave privada CHAVE
Versão do secret 1
Senha de chave privada SENHA
Versão do secret 1
Locatário do Azure AZURE_TENANT_ID

OAuth 2.0: tipo de conexão de chave secreta do cliente

Para ativar o tipo de conexão de chave secreta do cliente OAuth 2.0, siga estas etapas:

  1. Registre o complemento.
  2. Conceda permissões ao complemento.
  3. Especifique as credenciais do cliente OAuth 2.0 em Google Cloud
  4. Reautorização do código de autorização

Registrar o complemento

  1. Acesse a página Registrar complemento usando o seguinte URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. Na seção Informações do app, gere o ID e a chave secreta do cliente.
  3. Especifique valores para "Título", "Domínio do app" e "URI de redirecionamento".
  4. Clique em Criar.O complemento será registrado, e o app do SharePoint vai mostrar as informações criadas.

Conceder permissões ao complemento

  1. Acesse o site do SharePoint usando o seguinte URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Você será redirecionado para a página Conceder permissão.
  2. No campo ID do app, insira o ID do cliente gerado anteriormente e clique em Pesquisar. Os valores de "Título", "Domínio do app" e "URL de redirecionamento" são preenchidos.
  3. Insira a seguinte solicitação de permissão no formato XML:
          <AppPermissionRequests AllowAppOnlyPolicy="true">
          <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
          </AppPermissionRequests>
            
  4. Clique em Criar. O app do SharePoint mostra uma caixa de diálogo de consentimento de permissão.
  5. Clique em Confiar.

Especifique as credenciais do cliente OAuth 2.0 em Google Cloud

Ao criar a conexão no Integration Connectors, especifique os seguintes detalhes:

Na seção Autenticação, selecione Credenciais do cliente OAuth 2.0 com chave secreta do cliente como o tipo de autenticação e insira os seguintes detalhes:

  • No campo ID do cliente, insira o ID do cliente fornecido pelo conector para o app que você criou.
  • No campo Chave secreta do cliente, selecione o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
  • No campo Versão do secret, selecione a versão da chave secreta do cliente.

Reautorização do código de autorização

Se você usa o tipo de autenticação Authorization code e fez mudanças de configuração no aplicativo SharePoint, é necessário autorizar novamente a conexão do SharePoint. Para reautorizar uma conexão, siga estas etapas:

  1. Clique na conexão desejada na página "Conexões".

    A página de detalhes da conexão será aberta.

  2. Clique em Editar para mudar os detalhes da conexão.
  3. Verifique os detalhes do Código de autorização do OAuth 2.0 na seção Autenticação.

    Se necessário, faça as mudanças necessárias.

  4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
  5. Clique em Editar autorização na seção Autenticação. O painel Autorizar é exibido.
  6. Clique em Autorizar.

    Se a autorização for concluída, o status da conexão será definido como Ativo na página "Conexões".

Tipo de conexão de credencial do cliente

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de credenciais de cliente OAuth 2.0.

Nome do campo Detalhes
Região europe-west1
Conector SharePoint
Versão do conector 1
Nome da conexão sharepoint-client-credentials
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
host 1 http://z8**.sharepoint.com
porta 1 ****
Autenticação Credenciais do cliente OAuth 2.0 com chave secreta do cliente
ID do cliente CLIENT_ID
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1

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

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

Ações

Esta seção lista algumas das ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação DeleteAttachment

Essa ação exclui um anexo.

Parâmetros de entrada da ação DeleteAttachment

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Título do item da lista.
ItemId String Sim ID do item da lista.
FileName String Sim Nome do arquivo a ser excluído da biblioteca de documentos.

Ação CheckInDocument

Essa ação permite fazer check-in em um documento.

Parâmetros de entrada da ação CheckInDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo a ser feito check-in.
Comentar String Não Uma mensagem de check-in opcional.

Ação CheckOutDocument

Essa ação permite fazer check-out de um arquivo.

Parâmetros de entrada da ação CheckOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo a ser verificado.

Ação DiscardCheckOutDocument

Essa ação permite desfazer um check-out de arquivo.

Parâmetros de entrada da ação DiscardCheckOutDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RelativeURL String Sim URL relativo da pasta.
DocumentName String Sim Nome do arquivo em que o check-out precisa ser desfeito.

Ação CopyDocument

Essa ação permite copiar um arquivo de um local para outro.

Parâmetros de entrada da ação CopyDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileRelativeUrl String Sim URL relativo do arquivo de origem.
DestFileRelativeUrl String Sim URL relativo do arquivo de destino.

Ação UploadDocument

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

Parâmetros de entrada da ação UploadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileName String Sim Nome do arquivo a ser enviado.
RelativeUrl String Sim URL relativo da pasta.
Conteúdo String Não Conteúdo a ser enviado como um arquivo.
ContentBytes String Não Conteúdo de bytes (como uma string Base64) para upload como um arquivo. Use isso para fazer upload de dados binários.
HasBytes Booleano Não Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

Ação DownloadDocument

Essa ação permite baixar um arquivo.

Parâmetros de entrada da ação DownloadDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL completo do arquivo para download.
Biblioteca String Sim Nome da biblioteca no servidor do SharePoint.
HasBytes Booleano Não Especifica se o conteúdo deve ser baixado como bytes. O valor padrão é false.

Ação MoveAttachmentOrDocument

Com essa ação, você pode mover um arquivo de uma pasta para outra.

Parâmetros de entrada da ação MoveAttachmentOrDocument

Nome do parâmetro Tipo de dados Obrigatório Descrição
SourceFileURL String Sim URL do arquivo de origem que precisa ser movido.
DestinationFolderURL String Sim URL da pasta de destino.

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
RelativeURL String Sim URL relativo da pasta.
FolderName String Sim Nome da pasta a ser criada.

Ação AddAttachments

Essa ação permite adicionar um anexo.

Parâmetros de entrada da ação AddAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
ListTitle String Sim Nome da lista de anexos.
FileName String Sim Nome do arquivo anexado.
ItemId String Sim ID do anexo a ser adicionado.
Conteúdo String Sim Conteúdo do anexo.
ContentBytes String Não Conteúdo de bytes (como uma string Base64) para upload como anexo. Use isso para fazer upload de dados binários.
HasBytes Booleano Não Especifica se o conteúdo a ser enviado é binário. O valor padrão é false.

Ação DownloadAttachments

Com essa ação, você pode baixar anexos.

Parâmetros de entrada da ação DownloadAttachments

Nome do parâmetro Tipo de dados Obrigatório Descrição
RemoteFile String Sim URL relativo do arquivo.
HasBytes Booleano Não Especifica se o conteúdo a ser baixado é binário. O valor padrão é false.

Exemplos de ações

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

Exemplo: excluir um anexo

Este exemplo exclui o arquivo especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteAttachment 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:
    {
    "ListTitle": "My lists",
    "ItemId": "1",
    "FileName": "sitepages.txt"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteAttachment terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: fazer check-in em um documento

Este exemplo faz check-in em um documento.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CheckInDocument 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:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.txt",
    "Comment": "Comment test"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CheckInDocument terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: conferir um arquivo

Este exemplo faz o check-out de um arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CheckOutDocument 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:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.txt"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CheckOutDocument terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: descartar um check-out

Este exemplo reverte um check-out de arquivo.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DiscardCheckOutDocument 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:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "DocumentName": "Document.docx"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DiscardCheckOutDocument terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: copiar um arquivo

Este exemplo copia um arquivo de um local para outro.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CopyDocument 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:
    {
    "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
    "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CopyDocument terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: fazer upload de um arquivo de texto

Este exemplo faz upload de um arquivo de texto para o local especificado.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadDocument 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:
    {
    "FileName": "test.txt",
    "RelativeUrl": "/Shared Documents/TestFolder",
    "Content": "abcd"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadDocument terá um valor semelhante a este:

    [{
    "Status": "Success"
    }]

Exemplo: fazer upload de um arquivo binário

Este exemplo faz upload de um arquivo binário para o local especificado. Ao fazer upload de um arquivo binário, especifique o conteúdo a ser enviado como uma string codificada em Base64.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadDocument 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:
    {
    "FileName": "test.txt",
    "RelativeUrl": "/Shared Documents/TestFolder",
    "ContentBytes": "SGVsbG8gd29ybGQK",
    "HasBytes": "true"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadDocument terá um valor semelhante a este:

    [{
    "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 DownloadDocument 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:
    {
    "RemoteFile": "/TestFolder/test.txt",
    "Library": "Shared Documents"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadDocument terá um valor semelhante a este:

    [{
    "Success": "True",
    "Content": "Test File",
    }]

Exemplo: fazer o download de um arquivo binário

Este exemplo faz o download de um arquivo binário.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadDocument 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:
    {
    "RemoteFile": "/TestFolder/test1.png",
    "Library": "Shared Documents"
    "HasBytes": "true"  
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadDocument terá um valor semelhante a este:

    [{
    "Success": "True",
    "ContentBytes": "VGVzdCBGaWxl",
    }]

Exemplo: baixar um arquivo de um site específico

Este exemplo faz o download de um arquivo de um site específico.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadDocument 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:
    {
      "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
      "Library": "Docs",
      "HasBytes": true
    }
    
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadDocument terá um valor semelhante a este:

    [
      {
        "Success": "True",
        "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
      }
    ]

    Para baixar um arquivo de um site específico, forneça o endereço completo do arquivo remoto.

Exemplo: mover um anexo

Este exemplo move um anexo de um local para outro.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação MoveAttachmentOrDocument 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:
    {
    "SourceFileURL": "/Shared Documents/test.txt",
    "DestinationFolderURL": "/Shared Documents/TestFolder"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MoveAttachmentOrDocument terá um valor semelhante a este:

    [{
    "Result": "Success"
    }]

Exemplo: criar uma pasta

Este exemplo cria uma pasta no local especificado.

  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 Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "RelativeURL": "/Shared Documents/TestFolder",
    "FolderName": "TestFolder123"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateFolder terá um valor semelhante a este:

    [{
    "Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
    "Status": "Success"
    }]

Exemplo: adicionar um anexo

Este exemplo adiciona um anexo à lista especificada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddAttachments 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:
    {
    "ListTitle": "My Lists",
    "FileName": "TestAttachment2",
    "Content": "abcd text",
    "ItemId": "1"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddAttachments terá um valor semelhante a este:

    [{
    "RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
    "Status": "Success"
    }]

Exemplo: adicionar um anexo binário

Este exemplo adiciona um anexo binário à lista especificada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddAttachments 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:
    {
    "ListTitle": "My Lists",
    "FileName": "TestAttachment3",
    "ContentBytes": "VGVzdCBGaWxl",
    "HasBytes": "true",  
    "ItemId": "1"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddAttachments terá um valor semelhante a este:

    [{
    "RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
    "Status": "Success"
    }]

Exemplo: baixar um anexo

Este exemplo faz o download de um anexo.

  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 Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "RemoteFile": "/Shared Documents/Document.txt"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments terá um valor semelhante a este:

    [{
    "Success": "True",
    "Content": "Test File",
    }]

Exemplo: fazer o download de um anexo binário

Este exemplo faz o download de um anexo binário.

  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 Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "RemoteFile": "/Shared Documents/Document.docx",
    "HasBytes": "true"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadAttachments terá um valor semelhante a este:

    [{
    "Success": "True",
    "ContentBytes": "VGVzdCBGaWxl",
    }]

Exemplos de operações de entidade

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

Exemplo: listar todos os arquivos

Este exemplo lista todos os arquivos na entidade Files.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Se quiser, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Também é possível especificar várias condições de filtro usando os operadores lógicos.

Exemplo: receber uma lista

Este exemplo recebe uma lista com o ID especificado da entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 3 no campo Valor padrão.

    Aqui, 3 é um valor de chave primária na entidade My Lists.

Exemplo: criar um registro

Este exemplo cria um registro na entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "AuthorId": 11.0, 
    "BaseName": "3_",
    "Attachments": false,
    "Title": "Created List New"
    }

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
    "ID": 3.0
    }]

Exemplo: excluir um registro

Este exemplo exclui o registro com o ID especificado na entidade My Lists.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione My Lists na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 2 no campo Valor padrão.
  • 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 "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