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/v2/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 default, domain, drive e allDrives. Para otimizar a eficiência, dê preferência a default ou drive em vez de allDrives.
corpus
(deprecated)

enum (Corpus)

Obsoleto: o corpo dos itens (arquivos/documentos) aos quais a consulta se aplica. Use corpora
driveId

string

ID do drive compartilhado a ser pesquisado.
includeItemsFromAllDrives

boolean

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

boolean

Obsoleto: use includeItemsFromAllDrives.
maxResults

integer

O número máximo de arquivos a serem retornados por página. Páginas de resultados parciais ou vazias são possíveis mesmo antes do final da lista de arquivos ser alcançado.
orderBy

string

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

  • createdDate: quando o arquivo foi criado.
  • folder: o ID da pasta. Esse campo é classificado em ordem alfabética.
  • lastViewedByMeDate: a última vez que o arquivo foi visualizado pelo usuário.
  • modifiedByMeDate: a última vez que o arquivo foi modificado pelo usuário.
  • modifiedDate: a última vez que o arquivo foi modificado por alguém.
  • 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.
  • sharedWithMeDate: quando o arquivo foi compartilhado com o usuário, se aplicável.
  • starred: se o usuário marcou o arquivo com estrela.
  • title: o título do arquivo. Esse campo é classificado em ordem alfabética, portanto, 1, 12, 2, 22.
  • title_natural: o título do arquivo. Esse campo é classificado usando a ordenação natural, ou seja, 1, 2, 12, 22.

Cada chave é classificada em ordem crescente por padrão, mas pode ser invertida com o modificador "desc". Exemplo de uso: ?orderBy=folder,modifiedDate desc,title.

Observe que há uma limitação para usuários com aproximadamente um milhão de arquivos em que a ordem de classificação solicitada é ignorada.
pageToken

string

Token da página para arquivos.
projection
(deprecated)

enum (Projection)

Desativado: esse parâmetro não tem função.
q

string

String de consulta para pesquisar arquivos.
spaces

string

Uma lista separada por vírgulas de espaços para consulta. Os valores aceitos são drive e appDataFolder.
supportsAllDrives

boolean

Indica se o aplicativo solicitante oferece suporte ao Meu Drive e aos drives compartilhados.
supportsTeamDrives
(deprecated)

boolean

Descontinuado: use supportsAllDrives.
teamDriveId
(deprecated)

string

Obsoleto: use driveId.
includePermissionsForView

string

Especifica quais permissões de visualizações adicionais incluir 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 
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
Campos
nextPageToken

string

O token da próxima página de arquivos. Ele não será exibido se o fim da lista de arquivos for atingido. Se o token for rejeitado por qualquer motivo, ele será descartado e a paginação será reiniciada na primeira página de resultados.
kind

string

É sempre drive#fileList.
etag

string

A ETag da lista.
items[]

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.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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 serem usados pelo app. Para mais informações, consulte o Guia de autorização.

Corpus

Enums
DEFAULT Os itens que o usuário acessou.
DOMAIN Itens compartilhados com o domínio do usuário.