Method: files.list

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

string

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
(deprecated)

enum (Corpus)

Obsoleto: Es la fuente de los archivos que se van a enumerar. En su lugar, usa "corpora".

driveId

string

ID de la unidad compartida que se buscará.

includeItemsFromAllDrives

boolean

Indica si se deben incluir en los resultados los elementos de Mi unidad y de las unidades compartidas.

includeTeamDriveItems
(deprecated)

boolean

Obsoleto: Usa includeItemsFromAllDrives en su lugar.

orderBy

string

Una lista de claves de orden separadas por comas. Las claves válidas son las siguientes:

  • createdTime: Es la fecha en la que se creó el archivo.
  • folder: El ID de la carpeta. Este campo se ordena alfabéticamente.
  • modifiedByMeTime: La última vez que el usuario modificó el archivo.
  • modifiedTime: Es la última vez que alguien modificó el archivo.
  • name: Es el nombre del archivo. Este campo se ordena alfabéticamente, es decir, 1, 12, 2, 22.
  • name_natural: Es el nombre del archivo. Este campo se ordena de forma natural, por lo que se ordenan 1, 2, 12 y 22.
  • quotaBytesUsed: Es la cantidad de bytes de cuota de almacenamiento que usa el archivo.
  • recency: Es la marca de tiempo más reciente de los campos de fecha y hora del archivo.
  • sharedWithMeTime: Indica cuándo se compartió el archivo con el usuario, si corresponde.
  • starred: Indica si el usuario destacó el archivo.
  • viewedByMeTime: Es la última vez que el usuario vio el archivo.

Cada clave se ordena de forma ascendente de forma predeterminada, pero se puede invertir con el modificador "desc". Ejemplo de uso: ?orderBy=folder,modifiedTime desc,name.

pageSize

integer

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

string

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

string

Una consulta para filtrar los resultados de archivos. Consulta la sección "Buscar archivos y carpetas" para conocer la sintaxis compatible.

spaces

string

Es una lista separada por comas de espacios para consultar dentro de los corpus. Los valores admitidos son "drive" y "appDataFolder".

supportsAllDrives

boolean

Si la aplicación que realiza la solicitud admite tanto Mis unidades como unidades compartidas

supportsTeamDrives
(deprecated)

boolean

Obsoleto: Usa supportsAllDrives en su lugar.

teamDriveId
(deprecated)

string

Obsoleto: Usa driveId en su lugar.

includePermissionsForView

string

Especifica qué permisos de vista adicionales se incluirán en la respuesta. Solo se admite "publicado".

includeLabels

string

Es una lista separada por comas de los IDs de las etiquetas que se incluyen en la parte labelInfo de la respuesta.

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 (File)
    }
  ]
}
Campos
nextPageToken

string

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

string

Identifica qué tipo de recurso es. Valor: la cadena fija "drive#fileList"

files[]

object (File)

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