Method: files.list

Enumera 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

Son los cuerpos de los elementos (archivos o documentos) a los que se aplica la búsqueda. Los cuerpos admitidos son default, domain, drive y allDrives. Prefiere default o drive en lugar de allDrives para ahorrar energía.

corpus
(deprecated)

enum (Corpus)

Obsoleto: Es el cuerpo de los elementos (archivos o documentos) a los que se aplica la búsqueda. 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.

maxResults

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.

orderBy

string

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

  • createdDate: Fecha y hora en que se creó el archivo.
  • folder: Es el ID de la carpeta. Este campo se ordena alfabéticamente.
  • 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: Fecha y hora en que 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 alfabéticamente, por lo que se muestra 1, 12, 2, 22.
  • title_natural: Es el título del archivo. Este campo se ordena con el ordenamiento natural, por lo que se muestra 1, 2, 12, 22.

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

Ten en cuenta que existe una limitación actual para los usuarios con aproximadamente un millón de archivos, en la 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

Es la cadena de consulta para buscar archivos.

spaces

string

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

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 vistas adicionales se deben incluir 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
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
Campos
items[]

object (File)

Es la lista de archivos. Si se propagó 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.

kind

string

Siempre es drive#fileList.

etag

string

Es la ETag de la lista.

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 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
DEFAULT Son los elementos a los que accedió el usuario.
DOMAIN Son los elementos que se comparten con el dominio del usuario.