Method: files.list

Enumera los archivos del usuario. Para obtener más información, consulta Cómo buscar archivos y carpetas.

Este método acepta el parámetro q, que es una búsqueda que combina uno o más términos de búsqueda.

De forma predeterminada, este método devuelve todos los archivos, incluidos los que están en la papelera. Si no quieres que los archivos en la papelera aparezcan en la lista, usa el parámetro de consulta trashed=false para quitarlos de los resultados.

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

Son los cuerpos de los elementos (archivos o documentos) a los que se aplica la búsqueda. Los cuerpos admitidos son los siguientes:

  • user
  • domain
  • drive
  • allDrives

Se prefiere user o drive por sobre allDrives para ahorrar energía. De forma predeterminada, los corpus se establecen en user. Sin embargo, esto puede cambiar según el filtro establecido a través del parámetro q. Para obtener más información, consulta Organización de archivos.
corpus
(deprecated)

enum (Corpus)

Obsoleto: Es la fuente de los archivos que se enumerarán. Usa corpora en su lugar.
driveId

string

ID de la unidad compartida en la que se realizará la búsqueda.
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

Es una lista de claves de ordenamiento separadas por comas. Las claves válidas son las siguientes:

  • createdTime: Fecha y hora en que se creó el archivo.
  • folder: Es el ID de la carpeta. Este campo se ordena alfabéticamente.
  • modifiedByMeTime: Es 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, por lo que se muestra 1, 12, 2, 22.
  • name_natural: Es el nombre del archivo. Este campo se ordena con el ordenamiento natural, por lo que se muestra 1, 2, 12, 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: Fecha y hora en que 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 devolverán por página. Es posible que las páginas de resultados estén vacías o incompletas incluso antes de que se llegue al final de la lista de archivos.
pageToken

string

Es el token para continuar una solicitud de lista anterior en la página siguiente. Este campo debe establecerse en el valor de nextPageToken de la respuesta anterior.
q

string

Es una consulta para filtrar los resultados de los archivos. Para conocer la sintaxis admitida, consulta Cómo buscar archivos y carpetas.
spaces

string

Es una lista separada por comas de los espacios para consultar dentro de los corpus. Los valores admitidos son drive y appDataFolder. Para obtener más información, consulta Organización de archivos.
supportsAllDrives

boolean

Indica si la aplicación solicitante admite tanto Mi unidad como las 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 published.
includeLabels

string

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es una lista de archivos.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Campos
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 adicional de resultados.
nextPageToken

string

Es el token de página para la siguiente página de archivos. Este campo no estará presente si se llegó al final de la lista de archivos. Si se rechaza el token 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 página es 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 este. El valor es la cadena fija "drive#fileList".

Permisos 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 alcances 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

Enumeraciones
user Archivos que pertenecen al usuario o que se compartieron con él.
domain Archivos compartidos con el dominio del usuario.