- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Corpus
- Pruébalo
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/v3/files
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros | |
---|---|
corpora |
Son los cuerpos de los elementos (archivos o documentos) a los que se aplica la búsqueda. Los cuerpos admitidos son "user", "domain", "drive" y "allDrives". Prefiere "user" o "drive" a "allDrives" para mayor eficiencia. 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". |
corpus |
Obsoleto: Es la fuente de los archivos que se enumerarán. Usa "corpus" en su lugar. |
driveId |
ID de la unidad compartida en la que se realizará la búsqueda. |
includeItemsFromAllDrives |
Indica si se deben incluir en los resultados los elementos de Mi unidad y de las unidades compartidas. |
includeTeamDriveItems |
Obsoleto: Usa |
orderBy |
Es una lista de claves de ordenamiento separadas por comas. Las claves válidas son las siguientes:
De forma predeterminada, cada clave se ordena de forma ascendente, pero se puede invertir con el modificador "desc". Ejemplo de uso: |
pageSize |
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 |
Es el token para continuar una solicitud de lista anterior en la página siguiente. Este parámetro debe establecerse en el valor de "nextPageToken" de la respuesta anterior. |
q |
Es una consulta para filtrar los resultados de los archivos. Consulta la guía "Cómo buscar archivos y carpetas" para conocer la sintaxis admitida. |
spaces |
Es una lista separada por comas de los espacios para consultar dentro de los corpus. Los valores admitidos son "drive" y "appDataFolder". |
supportsAllDrives |
Indica si la aplicación solicitante admite tanto Mi unidad como las unidades compartidas. |
supportsTeamDrives |
Obsoleto: Usa |
teamDriveId |
Obsoleto: Usa |
includePermissionsForView |
Especifica qué permisos de vistas adicionales se deben incluir en la respuesta. Solo se admite "published". |
includeLabels |
Es una lista separada por comas de los IDs de las etiquetas que se incluirán en la parte |
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 ( |
Campos | |
---|---|
files[] |
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 |
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 |
Identifica qué tipo de recurso es este. El valor es la cadena fija |
incompleteSearch |
Indica si el proceso de búsqueda estuvo incompleto. Si es verdadero, es posible que falten algunos resultados de la búsqueda, ya que no se buscaron todos los documentos. Esto puede ocurrir cuando se buscan varias unidades con los corpus "allDrives", pero no se pudieron buscar todos los corpus. Cuando esto sucede, se sugiere que los clientes reduzcan su búsqueda eligiendo un corpus diferente, como "user" o "drive". |
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. |