Cómo buscar archivos y carpetas

Usa el método files.list para mostrar todos los archivos y carpetas de un usuario de Drive o algunos de ellos.

También puedes usar el método files.list a fin de recuperar el fileId requerido para algunos métodos de recursos (como files.get y files.update).

Buscar todos los archivos y carpetas en la sección Mi unidad del usuario actual

Usa files.list sin ningún parámetro para mostrar todos los archivos y carpetas.

Buscar carpetas o archivos específicos en la sección Mi unidad del usuario actual

Si quieres buscar un conjunto específico de archivos o carpetas, usa el campo q de la cadena de consulta con files.list para filtrar los archivos que se mostrarán mediante la combinación de uno o más términos de búsqueda.

Una cadena de consulta contiene las siguientes tres partes:

query_term operator values

Donde:

  • query_term es el término o campo de búsqueda. Si quieres ver los términos de búsqueda que se pueden usar para filtrar unidades compartidas, consulta Operadores y términos de búsqueda de búsqueda.

  • operator especifica la condición del término de búsqueda. A fin de ver qué operadores puedes usar con cada término de consulta, consulta Operadores de consulta.

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

Por ejemplo, la siguiente cadena de consulta filtra la búsqueda para que solo muestre carpetas:

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

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

Java

drive/snippets/drive_v3/src/main/java/SearchFile.java
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, items(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;
  }
}

Python

drive/snippets/drive-v3/file_snippet/search_file.py
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()

Node.js

drive/snippets/drive_v3/file_snippets/search_file.js
/**
 * Search file in drive location
 * @return{obj} data file
 * */
async function searchFile() {
  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});
  const files = [];
  try {
    const res = await service.files.list({
      q: 'mimeType=\'image/jpeg\'',
      fields: 'nextPageToken, files(id, name)',
      spaces: 'drive',
    });
    Array.prototype.push.apply(files, res.files);
    res.data.files.forEach(function(file) {
      console.log('Found file:', file.name, file.id);
    });
    return res.data.files;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveSearchFiles.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;
    }
}

Para restringir la búsqueda a carpetas, usa la cadena de consulta para establecer el tipo de MIME en q: mimeType = 'application/vnd.google-apps.folder'.

Para obtener más información sobre los tipos de MIME, consulta Tipos de MIME compatibles con Google Workspace y Google Drive.

Ejemplos de cadenas de consulta

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

Qué deseas consultar Ejemplo
Archivos con el nombre "hello" name = 'hello'
Archivos con un nombre que contiene las palabras "hola" y "adiós" name contains 'hello' and name contains 'goodbye'
Archivos con un nombre que no contiene la palabra "hello" not name contains 'hello'
Carpetas que son apps de Google o que tienen el tipo de MIME de carpeta mimeType = 'application/vnd.google-apps.folder'
Archivos que no son carpetas mimeType != 'application/vnd.google-apps.folder'
Archivos que contienen el texto "importante" y en la papelera fullText contains 'important' and trashed = true
Archivos que contengan la palabra "hello" fullText contains 'hello'
Archivos que no tienen la palabra "hello" not fullText contains 'hello'
Archivos que contienen la frase exacta "hello world" fullText contains '"hello world"'
Archivos con una consulta que contiene el carácter "\" (p.ej., "\autores") fullText contains '\\authors'
Archivos con ID dentro de una colección, p.ej., colección parents '1234567' in parents
Archivos en una carpeta de datos de la aplicación en una colección 'appDataFolder' in parents
Archivos para los que el usuario "test@example.org" tiene permiso de escritura 'test@example.org' in writers
Archivos para los que los miembros del grupo "group@example.org" tienen permiso de escritura 'group@example.org' in writers
Archivos modificados después de una fecha determinada modifiedTime > '2012-06-04T12:00:00' // default time zone is UTC
Archivos compartidos con el usuario autorizado que contengan la palabra "hello" en el nombre sharedWithMe and name contains 'hello'
Archivos que no se compartieron con nadie ni dominios (solo privados o compartidos con usuarios o grupos específicos) visibility = 'limited'
Archivos de imagen o video modificados después de una fecha específica modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/')

Cómo buscar archivos con una propiedad de archivo personalizada

Para buscar archivos con una propiedad de archivo personalizada, usa el término de búsqueda appProperties con una clave y un valor. Por ejemplo, para buscar una propiedad de archivo personalizada llamada additionalID con un valor de 8e8aceg2af2ge72e78, haz lo siguiente:

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

Si deseas obtener más información sobre las propiedades personalizadas de los archivos, consulta Cómo agregar propiedades de archivos personalizadas.

Cómo buscar archivos con una etiqueta o un valor de campo específicos

Para buscar archivos con etiquetas específicas, usa el término de búsqueda labels con un ID de etiqueta específico. Por ejemplo: 'labels/LABEL_ID' in labels.

Para buscar archivos sin un ID de etiqueta específico, haz lo siguiente: Not 'labels/LABEL_ID' in labels

También puedes buscar archivos en función de 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.

Buscar en corpus

Las búsquedas que llaman a files.list usan el corpus user de forma predeterminada. Para buscar en otro corpus, como archivos compartidos con un dominioGoogle Workspace , usa el parámetro corpora.

Se pueden buscar varios corpus en una sola consulta, aunque es posible que se muestren resultados incompletos si el corpus combinado es demasiado grande. Si el resultado de incompleteSearch es true, no se muestran todos los documentos.