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 compatíveis são default, domain, drive e allDrives. Use default ou drive em vez de allDrives para aumentar a eficiência.

corpus
(deprecated)

enum (Corpus)

Obsoleto: o corpo de itens (arquivos/documentos) ao qual a consulta se aplica. 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.

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 antes mesmo do fim da lista de arquivos.

orderBy

string

Uma lista de chaves de classificação separadas por vírgulas. As chaves válidas são createdDate, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title e title_natural. 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. No momento, 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 de arquivos.

projection
(deprecated)

enum (Projection)

Obsoleto: 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

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

kind

string

É sempre drive#fileList.

etag

string

A ETag da lista.

items[]

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