Implementar o suporte a drives compartilhados

Os drives compartilhados seguem modelos diferentes de organização, compartilhamento e propriedade do Meu Drive. Se o app criar e gerenciar arquivos em drives compartilhados, será necessário implementar a compatibilidade com esse recurso. A complexidade da implementação depende da funcionalidade do app.

Para começar, é necessário incluir o parâmetro de consulta supportsAllDrives=true nas solicitações quando o app executar as operações listadas abaixo:

API Drive v3

  • files.get
  • files.list
  • files.create
  • files.update
  • files.copy
  • files.delete
  • changes.list
  • changes.getStartPageToken
  • permissions.list
  • permissions.get
  • permissions.create
  • permissions.update
  • permissions.delete

API Drive v2

  • files.get
  • files.list
  • files.insert
  • files.update
  • files.patch
  • files.copy
  • files.trash
  • files.untrash
  • files.delete
  • files.touch
  • children.insert
  • parents.insert
  • changes.list
  • changes.getStartPageToken
  • changes.get
  • permissions.list
  • permissions.get
  • permissions.insert
  • permissions.update
  • permissions.patch
  • permissions.delete

O parâmetro supportsAllDrives=true informa ao Google Drive que o aplicativo foi projetado para processar arquivos em drives compartilhados.

Os aplicativos que leem ou modificam permissões, rastreiam alterações ou precisam pesquisar em vários corpora exigem uma funcionalidade extra de drive compartilhado. O restante deste documento destaca as mudanças necessárias para executar essas tarefas.

Pesquisar conteúdo em um drive compartilhado

Use o método files.list para pesquisar drives compartilhados. Nesta seção, abordamos campos específicos dos drives compartilhados no método files.list. Para pesquisar um drive compartilhado, consulte Pesquisar arquivos e pastas.

O método files.list contém os campos e modos de consulta específicos do drive compartilhado a seguir:

  • driveId: ID do drive compartilhado a ser pesquisado.

  • includeItemsFromAllDrives: se os itens do drive compartilhado precisam ser incluídos nos resultados. Se não estiver presente ou for definida como "false", os itens do drive compartilhado não serão retornados.

  • corpora: corpos de itens (arquivos/documentos) aos quais a consulta se aplica. Os corpos com suporte são user, domain, drive e allDrives. Prefira user ou drive a allDrives para aumentar a eficiência.

  • supportsAllDrives: se o aplicativo de solicitação é compatível com o Meu Drive e os drives compartilhados. Se for falso, os itens do drive compartilhado não serão incluídos na resposta.

Os seguintes modos de consulta são específicos para drives compartilhados:

includeItemsFromAllDrives corpora Descrição da consulta
true user Consulta os arquivos que o usuário acessou, incluindo os arquivos do drive compartilhado e do "Meu Drive".
true drive Consulta todos os itens no drive compartilhado especificado. O driveId precisa ser informado na solicitação.
true allDrives Consulta os arquivos que o usuário acessou e todos os drives compartilhados de que ele participa. Observe que a resposta pode incluir incompleteSearch : true, indicando que alguns corpora não foram pesquisados para essa solicitação.
true domain Consulta arquivos compartilhados com o domínio, inclusive os arquivos do drive compartilhado e do "Meu Drive".

Acompanhar alterações em um drive compartilhado

Use o método changes.list para acompanhar as alterações em um drive compartilhado. Nesta seção, abordamos campos específicos dos drives compartilhados no método changes.list. Veja mais informações em Acompanhar alterações de usuários e drives compartilhados. O método changes.list contém os campos e modos de consulta específicos do drive compartilhado a seguir:

  • driveId: o drive compartilhado de onde as alterações são retornadas. Se especificado, os IDs de mudança são referentes a mudanças no drive compartilhado, não a alterações nos arquivos mostrados ao usuário. Para se referir a uma mudança específica em um drive compartilhado, o ID do drive compartilhado e o da alteração precisam ser usados como um identificador.
  • supportsAllDrives: se o aplicativo de solicitação oferece suporte a drives compartilhados. Se for falso, os itens dos drives compartilhados, incluindo os drives compartilhados e os arquivos em um drive compartilhado, não serão retornados.
  • includeItemsFromAllDrives: se os arquivos ou alterações do drive compartilhado precisam ser incluídos na lista de alterações.

Os seguintes modos de consulta são específicos para drives compartilhados:

includeItemsFromAllDrives driveId Descrição da consulta
true Não Elas refletem as mudanças nos arquivos dentro ou fora dos drives compartilhados acessados pelo usuário e nos drives compartilhados de que o usuário participa.
true Sim As alterações refletem as mudanças no drive compartilhado especificado e nos itens dentro dele.

Para mais detalhes sobre o comportamento do registro de alterações, consulte Registros de alterações.

Ativar o suporte ao drive compartilhado na IU do Drive

Para acessar o conteúdo do drive compartilhado usando a IU do Drive, verifique se você marcou a opção "Suporte aos drives compartilhados" no Console de APIs do Google. Para mais informações, consulte Configurar uma integração com a IU do Drive.

Usar o seletor de arquivos com drives compartilhados

O seletor de arquivos permite selecionar itens em drives compartilhados. Saiba mais sobre como ativar o suporte a drives compartilhados e adicionar a visualização de drives compartilhados no seletor de arquivos em API Google Picker.

Próximas etapas

Acesse Gerenciar drives compartilhados se quiser ajuda para criar drives compartilhados e gerenciar as permissões deles.