Method: files.list

Lista os arquivos do usuário. Para mais informações, consulte Pesquisar arquivos e pastas.

Esse método aceita o parâmetro q, que é uma consulta de pesquisa que combina um ou mais termos de pesquisa.

Esse método retorna todos os arquivos por padrão, incluindo os que estão na lixeira. Se você não quiser que os arquivos na lixeira apareçam na lista, use o parâmetro de consulta trashed=false para remover os arquivos da lixeira dos resultados.

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

Especifica uma coleção de itens (arquivos ou documentos) a que a consulta se aplica. Os itens aceitos incluem:

  • user
  • domain
  • drive
  • allDrives

Prefira user ou drive a allDrives para maior eficiência. Por padrão, o corpus é definido como user. No entanto, isso pode mudar dependendo do filtro definido pelo parâmetro q. Para mais informações, consulte Organização de arquivos.
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

Indica se os itens do Meu Drive e do drive compartilhado precisam ser incluídos nos resultados.
includeTeamDriveItems
(deprecated)

boolean

Descontinuado: use includeItemsFromAllDrives.
orderBy

string

Uma lista de chaves de classificação separadas por vírgulas. As chaves válidas são:

  • createdTime: quando o arquivo foi criado. Evite usar essa chave para consultas em grandes coleções de itens, porque isso pode resultar em tempos limite ou outros problemas. Para classificação relacionada ao tempo em grandes coleções de itens, use modifiedTime desc.
  • 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 em ordem alfabética, por exemplo, 1, 12, 2, 22.
  • name_natural: o nome do arquivo. Esse campo é classificado usando a ordem de classificação natural, por exemplo, 1, 2, 12, 22.
  • quotaBytesUsed: o número de bytes de cota de armazenamento usados pelo arquivo.
  • recency: o carimbo de data/hora mais recente dos campos de data e hora do arquivo.
  • sharedWithMeTime: quando o arquivo foi compartilhado com o usuário, se aplicável.
  • starred: indica 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. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo 100 arquivos serão retornados para drives compartilhados e a lista completa de arquivos para drives não compartilhados.

O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
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. Para ver a sintaxe aceita, consulte Pesquisar arquivos e pastas.
spaces

string

Uma lista separada por vírgulas de espaços para consulta em corpora. Os valores aceitos são drive e appDataFolder. Para mais informações, consulte Organização de arquivos.
supportsAllDrives

boolean

Indica se o aplicativo solicitante aceita o Meu Drive e os drives compartilhados.
supportsTeamDrives
(deprecated)

boolean

Descontinuado: use supportsAllDrives.
teamDriveId
(deprecated)

string

Descontinuado: use driveId.
includePermissionsForView

string

Especifica quais permissões de visualização adicionais serão incluídas na resposta. Somente published é 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 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Campos
files[]

object (File)

A lista de arquivos. Se nextPageToken estiver preenchido, essa lista poderá estar incompleta e uma página adicional de resultados precisará ser buscada.
nextPageToken

string

O token de página para a próxima página de arquivos. Ele estará ausente se o final da lista de arquivos tiver sido atingido. Se o token for rejeitado por qualquer motivo, ele precisará ser descartado, e a paginação precisará ser reiniciada na primeira página de resultados. O token de página normalmente é 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".

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

Alguns escopos são restritos e exigem uma avaliação de segurança para que o app os use. Para mais informações, consulte o guia de autorização.

Corpus

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