- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Corpus
- Pruébalo
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 el artículo 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". Preferir "usuario" o "drive" a "allDrives" para lograr una mayor eficiencia. De forma predeterminada, corpora se establece en "user". Sin embargo, esto puede cambiar según el filtro establecido a través del parámetro "q". |
corpus |
Obsoleto: Es la fuente de los archivos que se van a enumerar. En su lugar, usa "corpora". |
driveId |
ID de la unidad compartida que se buscará. |
includeItemsFromAllDrives |
Indica si se deben incluir en los resultados los elementos de Mi unidad y de las unidades compartidas. |
includeTeamDriveItems |
Obsoleto: Usa |
orderBy |
Una lista de claves de orden separadas por comas. Las claves válidas son las siguientes:
Cada clave se ordena de forma ascendente de forma predeterminada, pero se puede invertir con el modificador "desc". Ejemplo de uso: |
pageSize |
Es la cantidad máxima de archivos que se mostrarán por página. Es posible que las páginas de resultados sean parciales o estén vacías incluso antes de llegar al final de la lista de archivos. |
pageToken |
Es el token para continuar una solicitud de lista anterior en la página siguiente. Se debe establecer con el valor “nextPageToken”. a partir de la respuesta anterior. |
q |
Una consulta para filtrar los resultados de archivos. Consulta la sección "Buscar archivos y carpetas" para conocer la sintaxis compatible. |
spaces |
Es una lista separada por comas de espacios para consultar dentro de los corpus. 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 de vista adicionales se incluirán en la respuesta. Solo se admite "publicado". |
includeLabels |
Es una lista separada por comas de los IDs de las etiquetas que se incluyen 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 para la página siguiente de archivos. No estará presente 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. El token de la página suele ser válido durante varias horas. Sin embargo, si se agregan o quitan elementos nuevos, es posible que los resultados esperados difieran. |
kind |
Identifica qué tipo de recurso es. Valor: la cadena fija |
incompleteSearch |
Si el proceso de búsqueda estuvo incompleto. Si es "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 con el parámetro “allDrives” pero no se pudieron buscar todos los corpus. Cuando esto sucede, se sugiere que los clientes reduzcan su consulta eligiendo un corpus diferente, como “usuario” o "drive". |
files[] |
Es la lista de archivos. Si se propaga nextPageToken, es posible que esta lista esté incompleta y se deba recuperar una página de resultados adicional. |
Alcances de autorización
Se necesita uno de los siguientes permisos 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.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
Algunos permisos están restringidos y requieren una evaluación de seguridad para que tu app pueda usarlos. Para obtener más información, consulta la Guía de autorización.
Corpus
Enumeraciones | |
---|---|
user |
Archivos que pertenecen al usuario o que se comparten con él |
domain |
Archivos compartidos con el dominio del usuario |