ファイルやフォルダを検索する

Google Drive API では、ファイルとフォルダを検索する方法がいくつかサポートされています。

files.list メソッドを使用して、ドライブ ユーザーのファイルとフォルダの一部またはすべてを返すことができます。files.list メソッドを使用して、一部のリソース メソッド（files.get や files.update など）に必要な fileId を取得することもできます。

現在のユーザーのマイドライブ内のすべてのファイルとフォルダを検索する

パラメータなしで files.list メソッドを使用すると、すべてのファイルとフォルダが返されます。

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

現在のユーザーのマイドライブで特定のファイルまたはフォルダを検索する

特定のファイルまたはフォルダのセットを検索するには、クエリ文字列 q フィールドと files.list メソッドを使用して、1 つ以上の検索語句を組み合わせて返されるファイルをフィルタします。

クエリ文字列は、次の 3 つの部分で構成されています。

query_term operator values

ここで

  • query_term は、検索するクエリキーワードまたはフィールドです。

  • operator は、検索語句の条件を指定します。

  • values は、検索結果のフィルタに使用する特定の値です。

ファイルとフォルダのフィルタに使用できるクエリキーワードと演算子については、検索クエリのキーワードと演算子をご覧ください。

たとえば、次のクエリ文字列は、MIME タイプを設定してフォルダのみを返すように検索をフィルタします。

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

MIME タイプの詳細については、Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。

クエリ文字列の例

次の表に、基本的なクエリ文字列の例を示します。実際のコードは、検索に使用するクライアント ライブラリによって異なります。

また、クエリが正しく機能するように、ファイル名の特殊文字をエスケープする必要があります。たとえば、ファイル名にアポストロフィ（'）とバックスラッシュ（"\"）の両方が含まれている場合は、バックスラッシュを使用してエスケープします（name contains 'quinn\'s paper\\essay'）。

クエリの対象 例
「hello」という名前のファイル name = 'hello'
ファイル名に「hello」と「goodbye」という単語が含まれているファイル name contains 'hello' and name contains 'goodbye'
ファイル名に「hello」という単語が含まれていないファイル not name contains 'hello'
「重要」というテキストを含むファイルで、ゴミ箱に入っている fullText contains 'important' and trashed = true
「hello」という単語を含むファイル fullText contains 'hello'
「hello」という単語が含まれていないファイル not fullText contains 'hello'
「hello world」というフレーズが完全に一致するファイル fullText contains '"hello world"'
「&」文字を含むクエリを含むファイル（「\authors」など） fullText contains '\\authors'
フォルダであるファイル mimeType = 'application/vnd.google-apps.folder'
フォルダ以外のファイル mimeType != 'application/vnd.google-apps.folder'
指定した日付以降に変更されたファイル（デフォルトのタイムゾーンは UTC） modifiedTime > '2012-06-04T12:00:00'
特定の日付以降に変更された画像ファイルまたは動画ファイル modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/')
スター付きのファイル starred = true
コレクション内のファイル（parents コレクションのフォルダ ID など） '1234567' in parents
コレクション内のアプリケーション データ フォルダ内のファイル 'appDataFolder' in parents
ユーザー「test@example.org」が所有するファイル 'test@example.org' in owners
ユーザー「test@example.org」が書き込み権限を持つファイル 'test@example.org' in writers
グループ「group@example.org」のメンバーが書き込み権限を持つファイル 'group@example.org' in writers
承認済みユーザーと共有され、名前に「hello」が含まれているファイル sharedWithMe and name contains 'hello'
すべてのアプリに表示されるカスタム ファイル プロパティを持つファイル properties has { key='mass' and value='1.3kg' }
リクエスト元のアプリに限定公開されているカスタム ファイル プロパティを含むファイル appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' }
誰ともドメインとも共有されていないファイル（非公開のみ、または特定のユーザーまたはグループと共有） visibility = 'limited'

クライアント ライブラリを使用して検索結果をフィルタする

次のコードサンプルは、クライアント ライブラリを使用して検索結果を JPEG ファイルのファイル名と ID にフィルタする方法を示しています。このサンプルでは、mimeType クエリ語句を使用して、結果を image/jpeg タイプのファイルに絞り込んでいます。また、spaces を drive に設定して、検索を ドライブ スペースにさらに絞り込みます。nextPageToken が null を返すと、それ以上結果はありません。

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

カスタム ファイル プロパティを持つファイルを検索する

カスタム ファイル プロパティを持つファイルを検索するには、キーと値を指定して properties または appProperties 検索クエリ語句を使用します。たとえば、リクエスト元のアプリに固有のカスタム ファイル プロパティ（additionalID という名前で値が 8e8aceg2af2ge72e78 のもの）を検索するには、次のようにします。

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

詳細については、カスタム ファイル プロパティを追加するをご覧ください。

特定のラベルまたはフィールド値を含むファイルを検索する

特定のラベルを持つファイルを検索するには、特定のラベル ID を指定して labels 検索クエリ語句を使用します。例: 'labels/LABEL_ID' in labels。成功した場合、レスポンスの本文にはラベルが適用されているすべてのファイル インスタンスが含まれます。

特定のラベル ID のないファイルを検索するには、Not 'labels/LABEL_ID' in labels を使用します。

特定のフィールド値に基づいてファイルを検索することもできます。たとえば、テキスト値 labels/LABEL_ID.text_field_id ='TEXT' のファイルを検索するには、次のコマンドを使用します。

詳細については、特定のラベルまたはフィールド値を持つファイルを検索するをご覧ください。

コーパスを検索する

files.list を呼び出す検索では、デフォルトで user の corpora が使用されます。domain で共有されているファイルなど、他のコーパスを検索するには、corpora パラメータを設定します。

1 つのクエリで複数のコーパスを検索できますが、結合されたコーパスが大きすぎると、不完全な結果が返されることがあります。レスポンス本文で incompleteSearch が true の場合、すべてのドキュメントが返されませんでした。この場合は、user や drive などの別のコーパスを選択してクエリを絞り込む必要があります。