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/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 consulta. Los cuerpos compatibles son 'user', 'domain', 'drive' y 'allDrives'. Se prefiere "user" o "drive" en lugar de "allDrives" para mejorar la eficiencia. La configuración predeterminada es "usuario". Sin embargo, esto puede cambiar en función del filtro establecido mediante el parámetro "q".

corpus
(deprecated)

enum (Corpus)

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

driveId

string

ID de la unidad compartida para buscar.

includeItemsFromAllDrives

boolean

Indica si se deben incluir elementos de Mi unidad y de la unidad compartida en los resultados.

includeTeamDriveItems
(deprecated)

boolean

Obsoleto: Usa includeItemsFromAllDrives en su lugar.

orderBy

string

Una lista separada por comas de claves de orden. Las claves válidas son 'CreateTime', 'folder', 'ModifiedByMeTime', 'ModifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' y 'viewedByMeTime'. Cada clave ordena de forma predeterminada, pero se puede revertir con el modificador "desc". Ejemplo de uso: ?Fix=folder,modifyTime desc,name.

pageSize

integer

La cantidad máxima de archivos que se mostrarán por página. Es posible que haya páginas de resultados parciales o vacías incluso antes de llegar al final de la lista de archivos.

pageToken

string

El token para continuar una solicitud de lista anterior en la página siguiente. Debe establecerse en el valor de "nextPageToken" de la respuesta anterior.

q

string

Una consulta para filtrar los resultados del archivo. Consulta la guía "Buscar archivos y carpetas" para conocer la sintaxis.

spaces

string

Una lista de espacios separados por comas para consultar dentro de la empresa. 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 adicionales de la vista debe incluir en la respuesta. Solo se admite el estado "publicada".

includeLabels

string

Una lista separada por comas de los ID de las etiquetas que se deben incluir en la parte labelInfo de la respuesta.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

Una lista de archivos

Representación JSON
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
Campos
nextPageToken

string

El token de página para la página siguiente de archivos. Estará ausente 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. Por lo general, el token de la página es válido durante varias horas. Sin embargo, si se agregan o quitan elementos nuevos, los resultados esperados pueden ser diferentes.

kind

string

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

files[]

object (File)

Es la lista de archivos. Si se propaga el elemento nextPageToken, es posible que la lista esté incompleta y se debería obtener una página de resultados adicional.

Permisos de autorización

Se necesita uno de los siguientes alcances 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.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

Enumeradores
user Archivos que pertenecen al usuario o que se comparten con él
domain Archivos compartidos con el dominio del usuario