Use o método files.list
para retornar todos ou
apenas alguns dos arquivos e das pastas de um usuário do Drive.
Também é possível usar o método files.list
para extrair o fileId
necessário para
alguns métodos de recursos, como
files.get
e
files.update
.
Pesquisar todos os arquivos e pastas no Meu Drive do usuário atual
Use files.list
sem nenhum parâmetro para retornar todos os arquivos e pastas.
Pesquisar arquivos ou pastas específicos no Meu Drive do usuário atual
Para pesquisar um conjunto específico de arquivos ou pastas, use o campo q
da string de consulta com files.list
para filtrar os arquivos a serem retornados combinando um ou mais termos de pesquisa.
Uma string de consulta contém estas três partes:
query_term operator values
Em que:
query_term
é o termo de consulta ou campo a ser pesquisado. Confira os termos de consulta que podem ser usados para filtrar drives compartilhados em Termos e operadores de consulta de pesquisa.operator
especifica a condição do termo de consulta. Para saber quais operadores podem ser usados com cada termo de consulta, acesse Operadores de consulta.values
são os valores específicos que você quer usar para filtrar os resultados da pesquisa.
Por exemplo, a string de consulta abaixo filtra a pesquisa para retornar apenas pastas:
q: mimeType = 'application/vnd.google-apps.folder'
O exemplo a seguir mostra como usar uma biblioteca de cliente para filtrar resultados da pesquisa por nomes de arquivo e IDs de arquivos JPEG. Neste exemplo, usamos o termo de consulta mimeType
para restringir os resultados aos arquivos do tipo image/jpeg
. Este exemplo também define spaces
como drive
para restringir ainda mais a pesquisa ao espaço do Drive. Quando nextPageToken
retorna null
, não há
mais resultados.
Java
Python
Node.js
PHP
Para restringir a pesquisa a pastas, use a string de consulta para definir o tipo MIME como
q: mimeType = 'application/vnd.google-apps.folder'
.
Para mais informações sobre os tipos MIME, consulte Tipos MIME compatíveis com o Google Workspace e o Google Drive.
Exemplos de string de consulta
Esta tabela mostra algumas strings de consulta básicas. O código real varia de acordo com a biblioteca de cliente usada na pesquisa.
O que você quer consultar | Exemplo |
---|---|
Arquivos com o nome "olá" | name = 'hello' |
Arquivos com as palavras "olá" e "tchau" | name contains 'hello' and name contains 'goodbye' |
Arquivos com um nome que não contém a palavra "hello" | not name contains 'hello' |
Pastas que são apps do Google ou têm o tipo MIME de pasta | mimeType = 'application/vnd.google-apps.folder' |
Arquivos que não são pastas | mimeType != 'application/vnd.google-apps.folder' |
Arquivos que contêm o texto "importante" e estão na lixeira | fullText contains 'important' and trashed = true |
Arquivos que contêm a palavra "hello" | fullText contains 'hello' |
Arquivos que não têm a palavra "hello" | not fullText contains 'hello' |
Arquivos que contêm a frase exata "hello world" | fullText contains '"hello world"' |
Arquivos com uma consulta que contenha o caractere "\" (por exemplo, "\authors") | fullText contains '\\authors' |
Arquivos com ID em uma coleção, por exemplo, a coleção parents |
'1234567' in parents |
Arquivos em uma pasta de dados do aplicativo em uma coleção | 'appDataFolder' in parents |
Arquivos em que o usuário "test@example.org" tem permissão de gravação | 'test@example.org' in writers |
Arquivos em que os membros do grupo "group@example.org" têm permissão de gravação | 'group@example.org' in writers |
Arquivos modificados após uma determinada data | modifiedTime > '2012-06-04T12:00:00' // default time zone is UTC |
Arquivos compartilhados com o usuário autorizado que contêm "hello" no nome | sharedWithMe and name contains 'hello' |
Arquivos que não foram compartilhados com ninguém nem com domínios (apenas particulares ou compartilhados com usuários ou grupos específicos) | visibility = 'limited' |
Arquivos de imagem ou vídeo modificados após uma data específica | modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/') |
Pesquisar arquivos com uma propriedade de arquivo personalizada
Para pesquisar arquivos com uma propriedade de arquivo personalizada, use o termo da consulta de pesquisa appProperties
com uma chave e um valor. Por exemplo, para pesquisar uma propriedade de arquivo
personalizada chamada additionalID
com um valor de 8e8aceg2af2ge72e78
:
appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' }
Para mais informações sobre propriedades de arquivo personalizadas, consulte Adicionar propriedades de arquivo personalizadas.
Pesquisar arquivos com um marcador ou valor de campo específico
Para pesquisar arquivos com marcadores específicos, use o termo da consulta de pesquisa labels
com um ID de rótulo específico. Por exemplo: 'labels/LABEL_ID'
in labels
Para pesquisar arquivos sem um ID de marcador específico: Not
'labels/LABEL_ID' in labels
Também é possível pesquisar arquivos com base em valores de campos específicos. Por exemplo, para
pesquisar arquivos com um valor de texto:
labels/LABEL_ID.text_field_id =
'TEXT'
Para saber mais, consulte Pesquisar arquivos com um marcador ou valor de campo específico.
Pesquisar no corpora
As pesquisas que chamam files.list
usam o
corpus user
por
padrão. Para pesquisar outros corpora, como arquivos compartilhados com um
domínioGoogle Workspace , use o parâmetro corpora
.
É possível pesquisar vários corpora em uma única consulta, embora resultados incompletos possam ser retornados se o corpus combinado for muito grande. Se o resultado incompleteSearch
for true
, nem todos os documentos foram retornados.