- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Corpus
- Pruébala
Muestra una lista de 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 |
Son los cuerpos de los elementos (archivos o documentos) a los que se aplica la consulta. Los cuerpos compatibles son 'user', 'domain', 'drive' y 'allDrives'. Se prefiere "user" o "drive" en lugar de "allDrives" para mejorar la eficiencia. La configuración predeterminada es "usuario". Sin embargo, esto puede cambiar en función del filtro establecido mediante el parámetro "q". |
corpus |
Obsoleto: la fuente de los archivos que se van a enumerar. En su lugar, use "corpora". |
driveId |
ID de la unidad compartida para buscar. |
includeItemsFromAllDrives |
Indica si se deben incluir elementos de Mi unidad y 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', 'ModifiedByMeTime', 'ModifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' y 'viewedByMeTime'. Cada clave ordena de forma predeterminada, pero se puede revertir con el modificador "desc". Ejemplo de uso: ?Fix=folder,modifyTime desc,name. |
pageSize |
La cantidad máxima de archivos que se mostrarán por página. Es posible que haya 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. Debe establecerse en el valor de "nextPageToken" de la respuesta anterior. |
q |
Una consulta para filtrar los resultados del archivo. Consulta la guía "Buscar archivos y carpetas" para conocer la sintaxis. |
spaces |
Una lista de espacios separados por comas para consultar dentro de la empresa. Los valores admitidos son “drive” y “appDataFolder”. |
supportsAllDrives |
Si la aplicación que realiza la solicitud admite tanto mis unidades como unidades compartidas. |
supportsTeamDrives |
Obsoleto: Usa |
teamDriveId |
Obsoleto: Usa |
includePermissionsForView |
Especifica qué permisos adicionales de la vista debe incluir en la respuesta. Solo se admite el estado "publicada". |
includeLabels |
Una lista separada por comas de los ID de las etiquetas que se deben incluir 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 página para la página siguiente de archivos. Estará ausente si se alcanzó el final de la lista de archivos. Si el token se rechaza por algún motivo, 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 durante varias horas. Sin embargo, si se agregan o quitan elementos nuevos, los resultados esperados pueden ser diferentes. |
kind |
Identifica qué tipo de recurso es este. Valor: la string fija |
incompleteSearch |
Indica si el proceso de búsqueda estaba incompleto. Si es verdadero, 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 con el nombre “allDrives”, pero no se pudieron buscar todos. Cuando esto sucede, se sugiere que los clientes limiten su consulta mediante la elección de un corpus diferente, como "usuario" o "unidad". |
files[] |
Es la lista de archivos. Si se propaga el elemento nextPageToken, es posible que la lista esté incompleta y se debería obtener una página de resultados adicional. |
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 pertenecen al usuario o que se comparten con él |
domain |
Archivos compartidos con el dominio del usuario |