فایل ها و پوشه ها را جستجو کنید

از روش files.list برای بازگرداندن همه یا فقط برخی از فایل‌ها و پوشه‌های کاربر Drive استفاده کنید.

همچنین می‌توانید از روش files.list برای بازیابی fileId مورد نیاز برای برخی از روش‌های منبع (مانند files.get و files.update ) استفاده کنید.

همه فایل‌ها و پوشه‌ها را در My Drive کاربر فعلی جستجو کنید

از files.list بدون هیچ پارامتری برای برگرداندن همه فایل ها و پوشه ها استفاده کنید.

فایل‌ها یا پوشه‌های خاصی را در My Drive کاربر فعلی جستجو کنید

برای جستجوی مجموعه خاصی از فایل ها یا پوشه ها، از فیلد query string q با files.list استفاده کنید تا با ترکیب یک یا چند عبارت جستجو، فایل ها را برای بازگشت فیلتر کنید.

یک query string شامل سه بخش زیر است:

query_term operator values

جایی که:

  • query_term عبارت یا فیلدی است که باید در آن جستجو کرد. برای مشاهده عبارت‌های درخواستی که می‌توانند برای فیلتر کردن درایوهای مشترک استفاده شوند، به عبارت‌ها و عملگرهای عبارت جستجو مراجعه کنید.

  • operator شرط را برای عبارت پرس و جو مشخص می کند. برای مشاهده اینکه کدام عملگرها را می توانید با هر عبارت جستجو استفاده کنید، به عملگرهای Query مراجعه کنید.

  • values مقادیر خاصی هستند که می خواهید برای فیلتر کردن نتایج جستجوی خود استفاده کنید.

به عنوان مثال، رشته پرس و جو زیر جستجو را برای بازگرداندن پوشه ها فیلتر می کند:

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

مثال زیر نحوه استفاده از کتابخانه مشتری برای فیلتر کردن نتایج جستجو به نام فایل ها و شناسه فایل های JPEG را نشان می دهد. این مثال از عبارت query mimeType برای محدود کردن نتایج به فایل‌های نوع image/jpeg استفاده می‌کند. این مثال همچنین spaces برای drive تنظیم می‌کند تا جستجو را به فضای Drive محدودتر کند. وقتی nextPageToken null برگرداند، دیگر نتیجه ای وجود ندارد.

جاوا

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

پایتون

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

برای محدود کردن جستجو به پوشه‌ها، از رشته query برای تنظیم نوع MIME به q: mimeType = 'application/vnd.google-apps.folder'

برای اطلاعات بیشتر در مورد انواع MIME، به انواع MIME پشتیبانی شده Google Workspace و Google Drive مراجعه کنید.

نمونه های رشته پرس و جو

این جدول تعدادی از رشته های پرس و جو اولیه را نشان می دهد. کد واقعی بسته به کتابخانه مشتری که برای جستجوی خود استفاده می کنید متفاوت است.

چیزی که می خواهید پرس و جو کنید مثال
فایل هایی با نام "سلام" name = 'hello'
فایل هایی با نام حاوی کلمات "سلام" و "خداحافظ" name contains 'hello' and name contains 'goodbye'
فایل هایی با نامی که حاوی کلمه سلام نیست not name contains 'hello'
پوشه‌هایی که برنامه‌های Google هستند یا دارای نوع پوشه MIME هستند mimeType = 'application/vnd.google-apps.folder'
فایل هایی که پوشه نیستند mimeType != 'application/vnd.google-apps.folder'
فایل هایی که حاوی متن "مهم" و در سطل زباله هستند fullText contains 'important' and trashed = true
فایل هایی که حاوی کلمه سلام هستند fullText contains 'hello'
فایل هایی که کلمه سلام ندارند not fullText contains 'hello'
فایل هایی که حاوی عبارت دقیق "سلام جهان" هستند. fullText contains '"hello world"'
فایل‌هایی با پرس و جوی حاوی کاراکتر "\" (به عنوان مثال، "\authors") fullText contains '\\authors'
فایل های دارای شناسه در یک مجموعه، به عنوان مثال مجموعه parents '1234567' in parents
فایل ها در یک پوشه داده برنامه در یک مجموعه 'appDataFolder' in parents
فایل هایی که کاربر "test@example.org" مجوز نوشتن برای آنها دارد 'test@example.org' in writers
فایل هایی که اعضای گروه "group@example.org" مجوز نوشتن برای آنها دارند 'group@example.org' in writers
فایل‌ها پس از تاریخ معین اصلاح شده‌اند modifiedTime > '2012-06-04T12:00:00' // default time zone is UTC
فایل‌هایی که با کاربر مجاز به اشتراک گذاشته می‌شوند، در نام «سلام». sharedWithMe and name contains 'hello'
فایل‌هایی که با هیچ‌کس یا دامنه‌ای به اشتراک گذاشته نشده‌اند (فقط خصوصی، یا به اشتراک گذاشته شده با کاربران یا گروه‌های خاص) visibility = 'limited'
فایل‌های تصویری یا ویدیویی پس از یک تاریخ خاص اصلاح شده‌اند modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/')

فایل هایی با ویژگی فایل سفارشی را جستجو کنید

برای جستجوی فایل‌هایی با ویژگی فایل سفارشی، از عبارت جستجوی 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 '

برای اطلاعات بیشتر، به جستجوی فایل‌هایی با برچسب یا مقدار فیلد خاص مراجعه کنید.

بدنه ها را جستجو کنید

جستجوهایی که files.list را فراخوانی می کنند به طور پیش فرض از مجموعه user استفاده می کنند. برای جست‌وجوی سایر نهادها، مانند فایل‌های به اشتراک گذاشته شده با دامنهGoogle Workspace ، ​​از پارامتر corpora استفاده کنید.

ممکن است چندین مجموعه در یک جستار جستجو شوند، اگرچه اگر مجموعه ترکیبی بیش از حد بزرگ باشد، نتایج ناقص ممکن است برگردانده شوند. اگر نتیجه incompleteSearch true باشد، همه اسناد برگردانده نشده اند.