- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Corpus (em inglês)
- Faça um teste
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 |
Corpos de itens (arquivos/documentos) aos quais a consulta se aplica. Os corpos aceitos são "user", "domain", "drive" e "allDrives". Prefere "user" ou "drive" a "allDrives" para eficiência. Por padrão, o corpora é definido como "usuário". No entanto, isso pode mudar dependendo do filtro definido pelo parâmetro "q". |
corpus |
Obsoleto: a origem dos arquivos a serem listados. Use "corpora". |
driveId |
ID do drive compartilhado a ser pesquisado. |
includeItemsFromAllDrives |
Se os itens do Meu Drive e do drive compartilhado devem ser incluídos nos resultados. |
includeTeamDriveItems |
Obsoleto: use |
orderBy |
Uma lista de chaves de classificação separada por vírgulas. As chaves válidas são "createdTime", "folder", "'ModifiedByMeTime', 'modifyTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency", "sharedWithMeTime", "starred" e "viewedByMeTime". Cada tecla é classificada em ordem crescente por padrão, mas pode ser invertida com o modificador "desc". Exemplo de uso: ?orderBy=folder,createdTime desc,name. |
pageSize |
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. |
pageToken |
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 |
Uma consulta para filtrar os resultados do arquivo. Consulte o guia "Pesquisar arquivos e pastas" para conferir a sintaxe compatível. |
spaces |
Uma lista separada por vírgulas de espaços para consulta em corpora. Os valores aceitos são "drive" e "appDataFolder". |
supportsAllDrives |
Se o aplicativo que fez a solicitação é compatível com o Meu Drive e os drives compartilhados. |
supportsTeamDrives |
Obsoleto: use |
teamDriveId |
Obsoleto: use |
includePermissionsForView |
Especifica as permissões de visualização extra que vão ser incluídas na resposta. Somente "Publicado" é compatível. |
includeLabels |
Uma lista separada por vírgulas de IDs de rótulos a serem incluídos na parte de |
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 ( |
Campos | |
---|---|
nextPageToken |
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. 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 |
Identifica o tipo de recurso. Valor: a string fixa |
incompleteSearch |
Se o processo de pesquisa estava incompleto. Se verdadeiro, alguns resultados da pesquisa podem estar ausentes, já que nem todos os documentos foram pesquisados. Isso pode ocorrer ao pesquisar em vários drives com o corpora "allDrives", mas não foi possível pesquisar todos eles. Quando isso acontece, sugerimos que os clientes restrinjam a consulta escolhendo um corpus diferente, como "user" ou "drive". |
files[] |
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/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 que sejam 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 |
Os arquivos compartilhados com o domínio do usuário |