Menelusuri file dan folder

Gunakan metode files.list untuk menampilkan semua atau hanya beberapa file dan folder pengguna Drive.

Anda juga dapat menggunakan metode files.list untuk mengambil fileId yang diperlukan untuk beberapa metode resource (seperti files.get dan files.update).

Telusuri semua file dan folder di Drive Saya pengguna saat ini

Gunakan files.list tanpa parameter apa pun untuk menampilkan semua file dan folder.

Menelusuri file atau folder tertentu di Drive Saya milik pengguna saat ini

Untuk menelusuri kumpulan file atau folder tertentu, gunakan kolom string kueri q dengan files.list untuk memfilter file yang akan ditampilkan dengan menggabungkan satu atau beberapa istilah penelusuran.

String kueri berisi tiga bagian berikut:

query_term operator values

Dengan keterangan:

• query_term adalah istilah atau kolom kueri untuk ditelusuri. Untuk melihat istilah kueri yang dapat digunakan untuk memfilter drive bersama, lihat Operator dan istilah kueri penelusuran.

• operator menentukan kondisi untuk istilah kueri. Untuk melihat operator yang dapat Anda gunakan dengan setiap istilah kueri, lihat Operator kueri.

• values adalah nilai spesifik yang ingin Anda gunakan untuk memfilter hasil penelusuran.

Misalnya, string kueri berikut memfilter penelusuran agar hanya menampilkan folder:

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

Contoh berikut menunjukkan cara menggunakan library klien untuk memfilter hasil penelusuran ke nama file dan ID file JPEG. Contoh ini menggunakan istilah kueri mimeType untuk mempersempit hasil ke file berjenis image/jpeg. Contoh ini juga menetapkan spaces ke drive untuk lebih mempersempit penelusuran ke ruang Drive. Saat nextPageToken menampilkan null, tidak ada lagi hasil.

Catatan: Jika menggunakan Drive API v2 versi lama, Anda dapat menemukan contoh kode di GitHub. Pelajari cara bermigrasi ke Drive API v3.

Java

drive/snippets/drive_v3/src/main/java/SearchFile.java

Lihat di GitHub

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

Lihat di GitHub

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

Lihat di GitHub

/**
 * 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

Lihat di GitHub

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

Untuk membatasi penelusuran ke folder, gunakan string kueri untuk menetapkan jenis MIME ke q: mimeType = 'application/vnd.google-apps.folder'

Untuk mengetahui informasi lebih lanjut tentang jenis MIME, lihat Jenis MIME yang didukung Google Workspace dan Google Drive.

Contoh string kueri

Tabel ini menunjukkan beberapa {i>string<i} kueri dasar. Kode aktual berbeda-beda, tergantung pada library klien yang Anda gunakan untuk pencarian Anda.

Penting: Istilah kueri berikut menggunakan kolom dari Drive API v3. Beberapa kolom resource berubah antara v2 dan v3. Misalnya, files.name menggantikan files.title. Jika Anda menggunakan Drive API v2, sesuaikan kueri ini untuk menggunakan kolom v2. Untuk informasi selengkapnya, lihat Referensi perbandingan Drive API v2 dan v3.

Catatan: Contoh ini menggunakan parameter q yang tidak dienkode, dengan name = 'hello' dienkode sebagai name+%3d+%27hello%27. Library klien menangani encoding ini secara otomatis.

Hal yang ingin Anda pertanyakan	Contoh
File dengan nama "hello"	name = 'hello'
File dengan nama yang berisi kata "halo" dan "selamat tinggal"	name contains 'hello' and name contains 'goodbye'
File dengan nama yang tidak berisi kata "halo"	not name contains 'hello'
Folder yang merupakan aplikasi Google atau memiliki jenis MIME folder	mimeType = 'application/vnd.google-apps.folder'
File yang bukan folder	mimeType != 'application/vnd.google-apps.folder'
File yang berisi teks "penting" dan ada di sampah	fullText contains 'important' and trashed = true
File yang berisi kata "halo"	fullText contains 'hello'
File yang tidak berisi kata "halo"	not fullText contains 'hello'
File yang berisi frasa yang sama persis dengan "halo dunia"	fullText contains '"hello world"'
File dengan kueri yang berisi karakter "\" (mis., "\authors")	fullText contains '\\authors'
File dengan ID dalam koleksi, misalnya koleksi parents	'1234567' in parents
File dalam folder data aplikasi dalam koleksi	'appDataFolder' in parents
File yang izin tulisnya dimiliki pengguna "[e-mail]"	'[e-mail]' in writers
File yang izin tulisnya dimiliki anggota grup "[e-mail]"	'[e-mail]' in writers
File yang diubah setelah tanggal tertentu	modifiedTime > '2012-06-04T12:00:00' // default time zone is UTC
File yang dibagikan kepada pengguna yang diberi otorisasi dengan kata "halo" pada namanya	sharedWithMe and name contains 'hello'
File yang belum dibagikan kepada siapa pun atau domain (hanya pribadi, atau dibagikan kepada pengguna atau grup tertentu)	visibility = 'limited'
File gambar atau video yang diubah setelah tanggal tertentu	modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/')

Menelusuri file dengan properti file kustom

Untuk menelusuri file dengan properti file kustom, gunakan istilah kueri penelusuran appProperties dengan kunci dan nilai. Misalnya, untuk menelusuri properti file kustom yang disebut additionalID dengan nilai 8e8aceg2af2ge72e78:

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

Untuk informasi selengkapnya tentang properti file kustom, lihat Menambahkan properti file kustom.

Menelusuri file dengan label atau nilai kolom tertentu

Untuk menelusuri file dengan label tertentu, gunakan istilah kueri penelusuran labels dengan ID label tertentu. Misalnya: 'labels/LABEL_ID' in labels.

Untuk menelusuri file tanpa ID label tertentu: Not 'labels/LABEL_ID' in labels

Anda juga dapat menelusuri file berdasarkan nilai kolom tertentu. Misalnya, untuk menelusuri file dengan nilai teks: labels/LABEL_ID.text_field_id = 'TEXT'

Untuk mengetahui informasi selengkapnya, lihat Menelusuri file dengan label atau nilai kolom tertentu.

Telusuri korpora

Penelusuran yang memanggil files.list menggunakan user korpus secara default. Untuk menelusuri korpora lain, seperti file yang dibagikan dengan domainGoogle Workspace , gunakan parameter corpora.

Beberapa korpora dapat ditelusuri dalam satu kueri, meskipun hasil yang tidak lengkap mungkin ditampilkan jika korpus gabungan terlalu besar. Jika hasil incompleteSearch adalah true, tidak semua dokumen ditampilkan.