Method: files.list  |  Google Drive  |  Google for Developers (original) (raw)

Method: files.list

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Lista os arquivos do usuário.

Esse método aceita o parâmetro q, que é uma consulta de pesquisa que combina um ou mais termos de pesquisa. Para mais informações, consulte o guia Pesquisar arquivos e pastas.

Solicitação HTTP

GET https://www.googleapis.com/drive/v3/files

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
corpora string Corpos de itens (arquivos/documentos) aos quais a consulta se aplica. Os corpos aceitos são "user", "domain", "drive" e "allDrives". Para maior eficiência, prefira "user" ou "drive" em vez de "allDrives". Por padrão, o corpora é definido como "user". No entanto, isso pode mudar dependendo do filtro definido pelo parâmetro "q".
corpus**(deprecated)** enum (Corpus) Descontinuado: a origem dos arquivos a serem listados. Use "corpora".
driveId string ID do drive compartilhado a ser pesquisado.
includeItemsFromAllDrives boolean Se os itens do Meu Drive e dos drives compartilhados precisam ser incluídos nos resultados.
includeTeamDriveItems**(deprecated)** boolean Descontinuado: use includeItemsFromAllDrives.
orderBy string Uma lista de chaves de ordenação separada por vírgulas. As chaves válidas são: createdTime: quando o arquivo foi criado. folder: o ID da pasta. Esse campo é classificado em ordem alfabética. modifiedByMeTime: a última vez que o arquivo foi modificado pelo usuário. modifiedTime: a última vez que o arquivo foi modificado por alguém. name: o nome do arquivo. Esse campo é classificado usando a ordem alfabética, ou seja, 1, 12, 2, 22. name_natural: o nome do arquivo. Esse campo é classificado usando a ordenação natural, ou seja, 1, 2, 12, 22. quotaBytesUsed: o número de bytes da cota de armazenamento usados pelo arquivo. recency: o carimbo de data/hora mais recente dos campos de data/hora do arquivo. sharedWithMeTime: quando o arquivo foi compartilhado com o usuário, se aplicável. starred: se o usuário marcou o arquivo com estrela. viewedByMeTime: a última vez que o arquivo foi visualizado pelo usuário. Cada chave é classificada em ordem crescente por padrão, mas pode ser invertida com o modificador "desc". Exemplo de uso: ?orderBy=folder,modifiedTime desc,name.
pageSize integer O número máximo de arquivos a serem retornados por página. É possível que páginas de resultados parciais ou vazias sejam exibidas antes mesmo de a lista de arquivos ser concluída.
pageToken string O token para continuar uma solicitação de lista anterior na próxima página. Ele precisa ser definido como o valor de "nextPageToken" da resposta anterior.
q string Uma consulta para filtrar os resultados do arquivo. Consulte o guia "Pesquisar arquivos e pastas" para saber qual é a sintaxe compatível.
spaces string Uma lista separada por vírgulas de espaços para consulta em corpora. Os valores aceitos são "drive" e "appDataFolder".
supportsAllDrives boolean Indica se o aplicativo solicitante é compatível com o Meu Drive e com os drives compartilhados.
supportsTeamDrives**(deprecated)** boolean Descontinuado: use supportsAllDrives.
teamDriveId**(deprecated)** string Descontinuado: use driveId.
includePermissionsForView string Especifica quais permissões de visualizações adicionais incluir na resposta. Somente "publicado" é aceito.
includeLabels string Uma lista separada por vírgulas de IDs de rótulos a serem incluídos na parte labelInfo da resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma lista de arquivos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{ "nextPageToken": string, "kind": string, "incompleteSearch": boolean, "files": [ { object (File) } ] }
Campos
nextPageToken string O token de página para a próxima página de arquivos. Isso não vai aparecer se o fim da lista de arquivos tiver sido alcançado. Se o token for rejeitado por qualquer motivo, ele será descartado e a paginação será reiniciada na primeira página de resultados. O token da página geralmente é válido por várias horas. No entanto, se novos itens forem adicionados ou removidos, os resultados esperados poderão ser diferentes.
kind string Identifica o tipo de recurso. Valor: a string fixa "drive#fileList".
incompleteSearch boolean Se o processo de pesquisa foi incompleto. Se for verdadeiro, alguns resultados da pesquisa podem estar ausentes, já que nem todos os documentos foram pesquisados. Isso pode ocorrer ao pesquisar vários drives com os corpora "allDrives", mas não foi possível pesquisar todos os corpora. Quando isso acontece, sugerimos que os clientes restrinjam a consulta escolhendo um corpus diferente, como "user" ou "drive".
files[] object (File) A lista de arquivos. Se nextPageToken estiver preenchido, a lista poderá estar incompleta e uma página adicional de resultados precisará ser buscada.

Requer um dos seguintes escopos do OAuth:

Alguns escopos são restritos e exigem uma avaliação de segurança para que o app possa usá-los. Para mais informações, consulte o guia de autorização.

Corpus

Enums
user Arquivos que pertencem ao usuário ou foram compartilhados com ele.
domain Arquivos compartilhados com o domínio do usuário.