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 la guía Cómo buscar archivos y carpetas.

Solicitud HTTP

GET https://www.googleapis.com/drive/v2/files

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
corpora

string

Los cuerpos de los elementos (archivos o documentos) a los que se aplica la consulta Los cuerpos admitidos son default, domain, drive y allDrives. Para mejorar la eficiencia, prefiere default o drive en lugar de allDrives.

corpus
(deprecated)

enum (Corpus)

Obsoleto: Es el cuerpo de los elementos (archivos o documentos) a los que se aplica la consulta. Usa corpora en su lugar.

driveId

string

Es el ID de la unidad compartida en la que se realizará la búsqueda.

includeItemsFromAllDrives

boolean

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.

maxResults

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.

orderBy

string

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

  • createdDate: Es la fecha en la que se creó el archivo.
  • folder: El ID de la carpeta. Este campo se ordena de forma alfabética.
  • lastViewedByMeDate: Es la última vez que el usuario vio el archivo.
  • modifiedByMeDate: Es la última vez que el usuario modificó el archivo.
  • modifiedDate: Es la última vez que alguien modificó el archivo.
  • 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.
  • sharedWithMeDate: Indica cuándo se compartió el archivo con el usuario, si corresponde.
  • starred: Indica si el usuario destacó el archivo.
  • title: Es el título del archivo. Este campo se ordena de forma alfabética, por lo que 1, 12, 2 y 22.
  • title_natural: Es el título del archivo. Este campo se ordena de forma natural, por lo que se ordenan 1, 2, 12 y 22.

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

Ten en cuenta que actualmente existe una limitación para los usuarios que tienen aproximadamente un millón de archivos en los que se ignora el orden de clasificación solicitado.

pageToken

string

Es el token de página para los archivos.

projection
(deprecated)

enum (Projection)

Obsoleto: Este parámetro no tiene ninguna función.

q

string

Cadena de consulta para buscar archivos.

spaces

string

Una lista de espacios separados por comas para consultar. Los valores admitidos son drive y appDataFolder.

supportsAllDrives

boolean

Si la aplicación solicitante admite Mi unidad y 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 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,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
Campos
nextPageToken

string

Es el token de página de la siguiente página 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.

kind

string

Siempre es drive#fileList.

etag

string

Es la ETag de la lista.

items[]

object (File)

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.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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 los use. Para obtener más información, consulta la Guía de autorización.

Corpus

Enumeraciones
DEFAULT Los elementos a los que accedió el usuario
DOMAIN Elementos compartidos con el dominio del usuario