- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Corpus
- Pruébala
Enumera los archivos del usuario.
Este método acepta el parámetro q
, que es una búsqueda que combina uno o más términos de búsqueda. Para obtener más información, consulta la guía Cómo buscar archivos y carpetas.
Solicitud HTTP
GET https://www.googleapis.com/drive/v3/files
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros | |
---|---|
corpora |
Cuerpos de elementos (archivos/documentos) a los que se aplica la consulta Los cuerpos admitidos son "user", "domain", "drive" y "allDrives". Para mayor eficiencia, elige "usuario" o "conducir" en lugar de "allDrives". De forma predeterminada, corpus está configurado como “usuario”. Sin embargo, esto puede cambiar según el filtro configurado a través del parámetro "q". |
corpus |
Obsoleto: Es la fuente de los archivos que se van a enumerar. En su lugar, use “corpora”. |
driveId |
ID de la unidad compartida que se buscará. |
includeItemsFromAllDrives |
Indica si se deben incluir tanto los elementos de Mi unidad como los de la unidad compartida en los resultados. |
includeTeamDriveItems |
Obsoleto: usa |
orderBy |
Una lista separada por comas de claves de orden. Las claves válidas son 'createTime', 'folder', 'personalizedByMeTime', 'personalizedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' y 'viewedByMeTime'. De forma predeterminada, cada tecla ordena de forma ascendente, pero se puede invertir con el modificador "desc". Ejemplo de uso: ?orderBy=folder,podTime desc,name. |
pageSize |
La cantidad máxima de archivos que se muestran por página. Es posible que se muestren páginas de resultados parciales o vacías incluso antes de llegar al final de la lista de archivos. |
pageToken |
El token para continuar una solicitud de lista anterior en la página siguiente. Se debe configurar con el valor de "nextPageToken" de la respuesta anterior. |
q |
Una consulta para filtrar los resultados del archivo. Consulta la guía "Cómo buscar archivos y carpetas" para conocer la sintaxis compatible. |
spaces |
Una lista separada por comas de espacios para consultar dentro del corpus. Los valores admitidos son "drive" y "appDataFolder". |
supportsAllDrives |
Indica si la aplicación solicitante admite Mi unidad y las unidades compartidas. |
supportsTeamDrives |
Obsoleto: usa |
teamDriveId |
Obsoleto: usa |
includePermissionsForView |
Especifica qué permisos de vistas adicionales se deben incluir en la respuesta. Solo se admite “publicado”. |
includeLabels |
Una lista separada por comas de los IDs de las etiquetas que se incluirán en la parte |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Una lista de archivos.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
Campos | |
---|---|
nextPageToken |
El token de la página de la siguiente página de archivos. Estará ausente si se llega al final de la lista de archivos. Si por algún motivo se rechaza el token, se debe descartar y se debe reiniciar la paginación desde la primera página de resultados. Por lo general, el token de la página es válido por varias horas. Sin embargo, si se agregan o quitan nuevos elementos, los resultados esperados podrían variar. |
kind |
Identifica qué tipo de recurso es este. Valor: la cadena fija |
incompleteSearch |
Si el proceso de búsqueda estaba incompleto. Si esta preferencia se establece como "true", es posible que falten algunos resultados de la búsqueda, ya que no se buscaron todos los documentos. Esto puede ocurrir cuando se buscan varias unidades en el corpus "allDrives", pero no se pudo buscar en todos los corpus. Cuando esto sucede, se sugiere que los clientes acotan su búsqueda eligiendo un corpus diferente, como "usuario" o "conducir". |
files[] |
Es la lista de archivos. Si se propaga nextPageToken, es posible que esta lista esté incompleta y se deba recuperar una página adicional de resultados. |
Permisos de autorización
Se necesita uno de los siguientes alcances 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
Algunos permisos están restringidos y requieren una evaluación de seguridad para que tu app los use. Para obtener más información, consulta la guía de autorización.
Corpus
Enumeradores | |
---|---|
user |
Archivos que son propiedad del usuario o que se comparten con él |
domain |
Archivos compartidos con el dominio del usuario |