Поиск файлов и папок

В этом руководстве объясняется, как API Google Drive поддерживает несколько способов поиска файлов и папок.

Метод list ресурса files позволяет получить доступ ко всем или некоторым файлам и папкам пользователя Google Диска. Метод list также можно использовать для получения идентификатора fileId ), необходимого для некоторых методов ресурса (например, методов get и ` update ).

Используйте параметр fields.

Если вы хотите указать поля, которые должны быть возвращены в ответе, вы можете задать системный параметр fields с помощью любого метода ресурса files . Если вы опустите параметр fields , сервер вернет набор полей по умолчанию, специфичных для данного метода. Например, метод list возвращает только поля kind , id , name , mimeType и resourceKey для каждого файла. Чтобы вернуть другие поля, см. раздел «Возврат специфических полей» .

Получить файл

Чтобы получить доступ к файлу, используйте метод get ресурса files с параметром `path` ` fileId . Если идентификатор файла неизвестен, вы можете вывести список всех файлов с помощью метода list .

Метод возвращает файл в виде экземпляра ресурса files . Если вы укажете параметр запроса alt=media , то в теле ответа будет содержаться содержимое файла. Чтобы загрузить или экспортировать файл, см. раздел «Загрузка и экспорт файлов» .

Чтобы подтвердить риск загрузки известных вредоносных программ или других вредоносных файлов, установите параметр запроса acknowledgeAbuse в true . Это поле применимо только в том случае, если установлен параметр alt=media , и пользователь является либо владельцем файла, либо организатором общего диска, на котором находится файл.

Найдите все файлы и папки на диске «Мой диск» текущего пользователя.

Используйте метод list без параметров, чтобы получить все файлы и папки.

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

Найдите определенные файлы или папки в папке «Мой диск» текущего пользователя.

Для поиска определенного набора файлов или папок используйте поле запроса q с методом list , чтобы отфильтровать возвращаемые файлы, комбинируя один или несколько поисковых запросов.

Синтаксис строки запроса состоит из следующих трех частей:

query_term operator values

Где:

• query_term — это поисковый запрос или поле, по которому будет производиться поиск.

• operator задает условие для поискового запроса.

• values — это конкретные значения, которые вы хотите использовать для фильтрации результатов поиска.

Например, следующая строка запроса фильтрует поиск, чтобы возвращать только папки, задавая MIME-тип :

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

Чтобы просмотреть все поисковые запросы по файлам, см. раздел «Поисковые запросы по конкретным файлам» .

Чтобы просмотреть все операторы запросов, которые можно использовать для построения запроса, см. раздел «Операторы запросов» .

Примеры строк запроса

В таблице ниже приведены примеры некоторых базовых строк запроса. Фактический код может отличаться в зависимости от используемой вами клиентской библиотеки для поиска.

Для корректной работы запроса необходимо также экранировать специальные символы в именах файлов. Например, если имя файла содержит как апостроф ( ' ), так и обратную косую черту ( "\" ), используйте обратную косую черту для их экранирования: name contains 'quinn\'s paper\\essay' .

Фильтрация результатов поиска с помощью клиентской библиотеки

Приведённый ниже пример кода демонстрирует, как использовать клиентскую библиотеку для фильтрации результатов поиска по именам и идентификаторам файлов JPEG. В этом примере используется поисковый запрос mimeType для сужения результатов до файлов типа image/jpeg . Также устанавливаются spaces для drive , чтобы ещё больше сузить поиск до пространства Drive . Если nextPageToken возвращает null , результатов больше нет.

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;
    }
}

Поиск файлов с пользовательскими свойствами.

Для поиска файлов с пользовательскими свойствами используйте поисковый запрос ` properties или ` appProperties , указав ключ и значение. Например, для поиска пользовательского свойства файла, являющегося частным для запрашивающего приложения, с именем additionalID и значением ` 8e8aceg2af2ge72e78 :

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

Для получения дополнительной информации см. раздел «Добавление пользовательских свойств файла» .

Поиск файлов с определенной меткой или значением поля.

Для поиска файлов с определенными метками используйте поисковый запрос labels с конкретным идентификатором метки. Например: 'labels/ LABEL_ID ' in labels . В случае успеха в теле ответа будут содержаться все экземпляры файлов, к которым применена данная метка.

Для поиска файлов без конкретного идентификатора метки: Not 'labels/ LABEL_ID ' in labels .

Вы также можете искать файлы по определенным значениям полей. Например, чтобы найти файлы со значением "текст": labels/ LABEL_ID .text_field_id =' TEXT ' .

Для получения дополнительной информации см. раздел «Поиск файлов с определенной меткой или значением поля» .

Поиск в корпусах

По умолчанию коллекция элементов user задается в параметре запроса corpora при использовании метода list . Для поиска в других коллекциях элементов, например, общих для domain , необходимо явно указать параметр corpora .

Вы можете выполнять поиск по нескольким корпусам в одном запросе; однако, если объединенный корпус слишком велик, API может вернуть неполные результаты. Проверьте поле incompleteSearch в теле ответа. Если оно true , значит, некоторые документы были пропущены. Чтобы решить эту проблему, сузьте corpora , используя либо user , либо drive .

При использовании параметра запроса orderBy в методе list избегайте использования ключа createdTime для запросов к большим коллекциям элементов, поскольку это требует дополнительной обработки и может привести к таймаутам или другим проблемам. Для сортировки по времени в больших коллекциях элементов можно использовать modifiedTime , поскольку он оптимизирован для обработки таких запросов. Например, ?orderBy=modifiedTime .

Если опустить параметр запроса orderBy , порядок сортировки по умолчанию отсутствует, и элементы возвращаются произвольно.

Связанные темы

• Поиск общих дисков
• Поисковые запросы и операторы
• Google Workspace и Google Drive поддерживают типы MIME.
• Роли и права доступа
• Поиск файлов с определенной меткой или значением поля.