Cómo buscar archivos y carpetas

En esta guía, se explica cómo la API de Google Drive admite varias formas de buscar archivos y carpetas.

Puedes usar el list método en el files recurso para mostrar todos o algunos de los archivos y carpetas de un usuario de Drive. El método list también se puede usar para recuperar el fileId que se requiere para algunos métodos de recursos (como el get método y el update) método.

Usa el parámetro fields

Si deseas especificar los campos que se mostrarán en la respuesta, puedes configurar el fields parámetro del sistema con cualquier método del recurso files. Si omites el parámetro fields, el servidor muestra un conjunto predeterminado de campos específicos del método. Por ejemplo, el list método muestra solo los campos kind, id, name, mimeType y resourceKey para cada archivo. Para mostrar diferentes campos, consulta Cómo mostrar campos específicos.

Obtén un archivo

Para obtener un archivo, usa el get método en el files recurso con el fileId parámetro de ruta de acceso. Si no conoces el ID del archivo, puedes enumerar todos los archivos con el list método.

El método muestra el archivo como una instancia de un recurso files. Si proporcionas el parámetro de consulta alt=media, la respuesta incluirá el contenido del archivo en el cuerpo de la respuesta. Para descargar o exportar el archivo, consulta Cómo descargar y exportar archivos.

Para reconocer el riesgo de descargar software malicioso conocido o cualquier otro abusivo archivo, establece el acknowledgeAbuse parámetro de consulta en true. Este campo solo se aplica cuando se establece el parámetro alt=media y el usuario es el propietario del archivo o un organizador de la unidad compartida en la que reside el archivo.

Busca todos los archivos y carpetas en Mi unidad del usuario actual

Usa el método list sin parámetros para mostrar todos los archivos y carpetas.

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

Busca archivos o carpetas específicos en Mi unidad del usuario actual

Para buscar un conjunto específico de archivos o carpetas, usa el campo de cadena de consulta q field con el list method para filtrar los archivos que se mostrarán combinando uno o más términos de búsqueda.

La sintaxis de la cadena de consulta contiene las siguientes tres partes:

query_term operator values

Donde:

• query_term es el término o campo de consulta en el que se realizará la búsqueda.

• operator especifica la condición del término de consulta.

• values son los valores específicos que deseas usar para filtrar los resultados de la búsqueda.

Por ejemplo, la siguiente cadena de consulta filtra la búsqueda para mostrar solo las carpetas configurando el tipo MIME:

q: mimeType = 'application/vnd.google-apps.folder'

Para ver todos los términos de consulta de archivos, consulta Términos de consulta específicos de archivos.

Para ver todos los operadores de consulta que puedes usar para crear una consulta, consulta Operadores deconsulta.

Ejemplos de cadenas de consulta

En la siguiente tabla, se enumeran ejemplos de algunas cadenas de consulta básicas. El código real difiere según la biblioteca cliente que uses para la búsqueda.

También debes escapar los caracteres especiales en los nombres de los archivos para asegurarte de que la consulta funcione correctamente. Por ejemplo, si un nombre de archivo contiene un apóstrofe (') y un carácter de barra inversa ("\"), usa una barra inversa para escaparlos: name contains 'quinn\'s paper\\essay'.

Filtra los resultados de la búsqueda con una biblioteca cliente

En el siguiente ejemplo de código, se muestra cómo usar una biblioteca cliente para filtrar los resultados de la búsqueda a los nombres de archivo y los IDs de los archivos JPEG. En este ejemplo, se usa el término de consulta mimeType para limitar los resultados a los archivos de tipo image/jpeg. También se establece spaces en drive para limitar aún más la búsqueda al espacio de Drive . Cuando nextPageToken muestra null, no hay más resultados.

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.api.services.drive.model.File;
import com.google.api.services.drive.model.FileList;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/* Class to demonstrate use-case of search files. */
public class SearchFile {

  /**
   * Search for specific set of files.
   *
   * @return search result list.
   * @throws IOException if service account credentials file not found.
   */
  public static List<File> searchFile() throws IOException {
           /*Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
           guides on implementing OAuth2 for your application.*/
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();

    List<File> files = new ArrayList<File>();

    String pageToken = null;
    do {
      FileList result = service.files().list()
          .setQ("mimeType='image/jpeg'")
          .setSpaces("drive")
          .setFields("nextPageToken, files(id, title)")
          .setPageToken(pageToken)
          .execute();
      for (File file : result.getFiles()) {
        System.out.printf("Found file: %s (%s)\n",
            file.getName(), file.getId());
      }

      files.addAll(result.getFiles());

      pageToken = result.getNextPageToken();
    } while (pageToken != null);

    return files;
  }
}

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def search_file():
  """Search file in drive location

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)
    files = []
    page_token = None
    while True:
      # pylint: disable=maybe-no-member
      response = (
          service.files()
          .list(
              q="mimeType='image/jpeg'",
              spaces="drive",
              fields="nextPageToken, files(id, name)",
              pageToken=page_token,
          )
          .execute()
      )
      for file in response.get("files", []):
        # Process change
        print(f'Found file: {file.get("name")}, {file.get("id")}')
      files.extend(response.get("files", []))
      page_token = response.get("nextPageToken", None)
      if page_token is None:
        break

  except HttpError as error:
    print(f"An error occurred: {error}")
    files = None

  return files


if __name__ == "__main__":
  search_file()

import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Searches for files in Google Drive.
 * @return {Promise<object[]>} A list of files.
 */
async function searchFile() {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // Search for files with the specified query.
  const result = await service.files.list({
    q: "mimeType='image/jpeg'",
    fields: 'nextPageToken, files(id, name)',
    spaces: 'drive',
  });

  // Print the name and ID of each found file.
  (result.data.files ?? []).forEach((file) => {
    console.log('Found file:', file.name, file.id);
  });

  return result.data.files ?? [];
}

<?php
use Google\Client;
use Google\Service\Drive;
function searchFiles()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $files = array();
        $pageToken = null;
        do {
            $response = $driveService->files->listFiles(array(
                'q' => "mimeType='image/jpeg'",
                'spaces' => 'drive',
                'pageToken' => $pageToken,
                'fields' => 'nextPageToken, files(id, name)',
            ));
            foreach ($response->files as $file) {
                printf("Found file: %s (%s)\n", $file->name, $file->id);
            }
            array_push($files, $response->files);

            $pageToken = $response->pageToken;
        } while ($pageToken != null);
        return $files;
    } catch(Exception $e) {
       echo "Error Message: ".$e;
    }
}

Busca archivos con una propiedad de archivo personalizada

Para buscar archivos con una propiedad de archivo personalizada, usa el término de consulta properties o appProperties con una clave y un valor. Por ejemplo, para buscar una propiedad de archivo personalizada que sea privada para la app que realiza la solicitud llamada additionalID con un valor de 8e8aceg2af2ge72e78:

appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' }

Para obtener más información, consulta Agrega propiedades de archivo personalizadas.

Busca archivos con una etiqueta o un valor de campo específicos

Para buscar archivos con etiquetas específicas, usa el término de consulta labels con un ID de etiqueta específico. Por ejemplo: 'labels/LABEL_ID' in labels. Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene todas las instancias de archivo en las que se aplica la etiqueta.

Para buscar archivos sin un ID de etiqueta específico: Not 'labels/LABEL_ID' in labels.

También puedes buscar archivos según valores de campo específicos. Por ejemplo, para buscar archivos con un valor de texto: labels/LABEL_ID.text_field_id ='TEXT'.

Para obtener más información, consulta Busca archivos con una etiqueta o un valor de campo específicos.

Busca en los corpus

De forma predeterminada, la colección de elementos user se establece en el parámetro de consulta corpora cuando se usa el método list. Para buscar otras colecciones de elementos, como las que se comparten con un domain, debes establecer el parámetro corpora de forma explícita.

Puedes buscar varios corpus en una sola consulta. Sin embargo, si el corpus combinado es demasiado grande, la API podría mostrar resultados incompletos. Consulta el incompleteSearch campo en el cuerpo de la respuesta. Si es true, se omitieron algunos documentos. Para resolver este problema, limita el corpora para usar user o drive.

Cuando uses el orderBy parámetro de consulta en el método list, evita usar la clave createdTime para las consultas en colecciones de elementos grandes, ya que requiere procesamiento adicional y puede provocar tiempos de espera agotados o cualquier otro problema. Para la clasificación relacionada con el tiempo en colecciones de elementos grandes, puedes usar modifiedTime en su lugar, ya que está optimizado para controlar estas consultas. Por ejemplo, ?orderBy=modifiedTime.

Si omites el parámetro de consulta orderBy, no hay un orden de clasificación predeterminado y los elementos se muestran de forma arbitraria.

Temas relacionados

• Busca unidades compartidas
• Términos y operadores de consulta
• Tipos de MIME compatibles con Google Workspace y Google Drive
• Funciones y permisos
• Busca archivos con una etiqueta o un valor de campo específicos