- 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 a seção Pesquisar arquivos e de pastas principais (em inglês).
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". Prefira "user" ou "drive" para "allDrives" para eficiência. Por padrão, o corpora é definido como "usuário". No entanto, isso pode mudar dependendo do filtro definido por meio da tecla "q" . |
corpus |
Obsoleto: a origem dos arquivos a serem listados. Usar "corpora" como alternativa. |
driveId |
ID do drive compartilhado a ser pesquisado. |
includeItemsFromAllDrives |
Define se os itens do Meu Drive e do drive compartilhado devem ser incluídos nos resultados. |
includeTeamDriveItems |
Obsoleto: use |
orderBy |
Uma lista separada por vírgulas de chaves de classificação. As chaves válidas são "createdTime", "folder", "modifyByMeTime", "modifyTime", "name", 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' e 'viewedByMeTime'. Cada chave é classificada de forma crescente por padrão, mas pode ser invertida pela chave . Exemplo de uso: ?orderBy=folder,modifyTime desc,name. |
pageSize |
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. |
pageToken |
O token para continuar uma solicitação de lista anterior na próxima página. Ele deve ser definido como o valor de "nextPageToken". da resposta anterior. |
q |
Uma consulta para filtrar os resultados do arquivo. Consulte a seção "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 |
Indica se o aplicativo solicitante oferece suporte ao Meu Drive e aos drives compartilhados. |
supportsTeamDrives |
Obsoleto: use |
teamDriveId |
Obsoleto: use |
includePermissionsForView |
Especifica quais permissões de visualização adicionais serão incluídas na resposta. Somente "Publicado" é suportado. |
includeLabels |
Uma lista separada por vírgulas de IDs de rótulos a serem incluídos na parte |
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 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 deverá ser descartado e a paginação deverá ser reiniciada na primeira página de resultados. O token de página costuma ser 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 faltando, já que nem todos os documentos foram pesquisados. Isso pode ocorrer ao pesquisar vários percursos com a tag "allDrives" corpora, mas não foi possível pesquisar todos os corpora. Quando isso acontece, é recomendável que os clientes restrinjam a consulta escolhendo um corpus diferente, como "usuário" ou "drive". |
files[] |
A lista de arquivos. Se nextPageToken for preenchida, essa lista poderá estar incompleta, e outra página de resultados deverá ser buscada. |
Escopos de autorização
Requer um dos seguintes escopos do 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.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 | |
---|---|
user |
Arquivos que pertencem ou foram compartilhados com o usuário. |
domain |
Arquivos compartilhados com o domínio do usuário |