Method: files.list

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) a que a consulta se aplica. Os corpos aceitos são "user", "domain", "drive" e "allDrives". Prefira "user" ou "drive" em vez de "allDrives" para ter mais eficiência. Por padrão, o valor é "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 do drive compartilhado devem ser incluídos nos resultados.
includeTeamDriveItems
(deprecated)

boolean

Descontinuado: use includeItemsFromAllDrives.
orderBy

string

Uma lista de chaves de classificaçã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 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, 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 e 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 ter páginas de resultados parciais ou vazias mesmo antes de chegar ao fim da lista de arquivos.
pageToken

string

O token para continuar uma solicitação de lista anterior na próxima página. Defina esse valor como o de "nextPageToken" da resposta anterior.
q

string

Uma consulta para filtrar os resultados do arquivo. Consulte o guia "Pesquisar arquivos e pastas" para ver 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

Se o aplicativo solicitante é compatível com 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ção 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 
{
  "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 da próxima página de arquivos. Esse campo não vai aparecer se o fim da lista de arquivos for alcançado. Se o token for rejeitado por qualquer motivo, ele deverá ser descartado, e a paginação precisará ser reiniciada na primeira página de resultados. O token de 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".

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