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) aos quais a consulta se aplica. Os corpos compatíveis são "user", "domain", "drive" e "allDrives". Prefira "user" ou "drive" a "allDrives" para aumentar a eficiência. Por padrão, o corpora é definido como "user". No entanto, isso pode mudar, dependendo do filtro definido por meio do parâmetro "q".
corpus
(deprecated)

enum (Corpus)

Obsoleto: a origem dos arquivos a serem listados. Use "corpora".
driveId

string

ID do drive compartilhado que será pesquisado.
includeItemsFromAllDrives

boolean

Indica se os itens em "Meu Drive" e nos drives compartilhados devem ser incluídos nos resultados.
includeTeamDriveItems
(deprecated)

boolean

Obsoleto: use includeItemsFromAllDrives.
orderBy

string

Uma lista de chaves de classificação separadas por vírgulas. As chaves válidas são 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' e 'viewedByMeTime'. Cada chave é classificada em ordem crescente por padrão, mas pode ser revertida 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. Páginas de resultados parciais ou vazias são possíveis antes mesmo do fim da lista de arquivos.
pageToken

string

O token para continuar uma solicitação de lista anterior na próxima página. Deve 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 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 drives compartilhados.
supportsTeamDrives
(deprecated)

boolean

Obsoleto: use supportsAllDrives.
teamDriveId
(deprecated)

string

Obsoleto: use driveId.
includePermissionsForView

string

Especifica quais permissões da visualização adicional devem ser incluídas na resposta. Somente "publicado" é suportado.
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. Ele estará ausente se o final 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 a partir da 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".
files[]

object (File)

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

Escopos de autorização

Requer um dos seguintes escopos de 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.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
user Arquivos que pertencem ao usuário ou foram compartilhados com ele.
domain Arquivos compartilhados com o domínio do usuário