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

Google Drive API では、ファイルやフォルダの検索に複数の方法がサポートされています。

files.list メソッドを使用して、次を返すことができます。 ドライブ ユーザーのファイルやフォルダの全体または一部へのアクセスを制御できます。files.list メソッドを使用して、リソースに必要な fileId を取得することもできます。 メソッド(files.getfiles.update)。

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

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

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

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

特定のファイルまたはフォルダのセットを検索するには、クエリ文字列の q フィールドを使用します。 これは files.list メソッドで、 複数の検索キーワードを組み合わせて返すことができます。

クエリ文字列は、次の 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」という単語を含むファイル「さようなら」 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 に変更して、検索をさらに ドライブに絞り込む できますnextPageTokennull を返すと、 これ以上結果はありません。

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

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

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

特定のラベルの付いたファイルを検索するには、labels 検索クエリを使用します 関連付けられます。例: 'labels/LABEL_ID' in labels。成功した場合、レスポンスの本文には、terraform plan または terraform apply の 適用しました。

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

特定のフィールド値に基づいてファイルを検索することもできます。たとえば、 text 値でファイルを検索する: labels/LABEL_ID.text_field_id ='TEXT'

詳しくは、特定のラベルまたはフィールドを持つファイルを検索する あります

コーパスを検索

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

1 つのクエリで複数のコーパスが検索される可能性があるが、結果は不完全である 結合されたコーパスが大きすぎる場合は、返されることがあります。incompleteSearchtrue を返す場合、すべてのドキュメントが返されませんでした。もし 次のような別のコーパスを選択してクエリを絞り込む必要があります。 user または drive