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 com suporte são default, domain, drive e allDrives. Para eficiência, prefira default ou drive a allDrives.

corpus
(deprecated)

enum (Corpus)

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

Obsoleto: use includeItemsFromAllDrives.

maxResults

integer

O número máximo de arquivos a serem retornados por página. É possível exibir páginas de resultados parciais ou vazias mesmo antes de o fim da lista de arquivos ser alcançado.

orderBy

string

Uma lista de chaves de classificação separada por vírgulas. As chaves válidas são createdDate, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title e title_natural. Cada tecla é classificada em ordem crescente por padrão, mas pode ser invertida com o modificador desc. Exemplo de uso: ?orderBy=folder,optimizedDate desc,title. Observe que há uma limitação atual 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)

Obsoleto: este parâmetro não tem função.

q

string

String de consulta para pesquisar arquivos.

spaces

string

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

supportsAllDrives

boolean

Se o aplicativo que fez a solicitação é compatível com o Meu Drive e os drives compartilhados.

supportsTeamDrives
(deprecated)

boolean

Obsoleto: use supportsAllDrives.

teamDriveId
(deprecated)

string

Obsoleto: use driveId.

includePermissionsForView

string

Especifica as permissões de visualização extra que vão 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 de 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. Esse campo não será adicionado se o fim da lista de arquivos tiver sido atingido. 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)

Lista de arquivos. Se a nextPageToken for preenchida, 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 que sejam 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.