Wyszukiwanie plików i folderów

Z tego przewodnika dowiesz się, jak Google Drive API obsługuje kilka sposobów wyszukiwania plików i folderów.

Aby zwrócić wszystkie lub niektóre pliki i foldery użytkownika Dysku, możesz użyć metody list w zasobie files. Metody list można też używać do pobierania parametru fileId wymaganego w przypadku niektórych metod zasobów (np. metody get i update).

Używanie parametru fields

Jeśli chcesz określić pola, które mają być zwracane w odpowiedzi, możesz ustawić fields parametr systemowy w dowolnej metodzie zasobu files. Jeśli pominiesz parametr fields, serwer zwróci domyślny zestaw pól właściwy dla danej metody. Na przykład metoda list zwraca tylko pola kind, id, name, mimeType i resourceKey dla każdego pliku. Aby zwrócić inne pola, przeczytaj artykuł Zwracanie określonych pól.

Pobieranie pliku

Aby pobrać plik, użyj metody get w zasobie files z parametrem ścieżki fileId. Jeśli nie znasz identyfikatora pliku, możesz wyświetlić listę wszystkich plików za pomocą list metody.

Metoda zwraca plik jako instancję zasobu files. Jeśli podasz parametr alt=media, odpowiedź będzie zawierać treść pliku w treści odpowiedzi. Aby pobrać plik blob, przeczytaj artykuł Pobieranie treści pliku blob.

Aby potwierdzić ryzyko pobrania znanego złośliwego oprogramowania lub innych szkodliwych plików, ustaw acknowledgeAbuse parametr zapytania na true. To pole ma zastosowanie tylko wtedy, gdy ustawiony jest parametr alt=media, a użytkownik jest właścicielem pliku lub organizatorem dysku współdzielonego, na którym znajduje się plik.

Wyszukiwanie wszystkich plików i folderów na Moim dysku bieżącego użytkownika

Aby zwrócić wszystkie pliki i foldery, użyj metody list bez żadnych parametrów.

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

Wyszukiwanie określonych plików lub folderów na Moim dysku bieżącego użytkownika

Aby wyszukać określony zestaw plików lub folderów, użyj pola ciągu zapytania q field z metodą list, aby filtrować pliki do zwrócenia przez połączenie co najmniej 1 wyszukiwanego hasła.

Składnia ciągu zapytania składa się z tych 3 części:

query_term operator values

Gdzie:

• query_term to wyszukiwane hasło lub pole.

• operator określa warunek wyszukiwanego hasła.

• values to konkretne wartości, których chcesz użyć do filtrowania wyników wyszukiwania.

Na przykład ten ciąg zapytania filtruje wyszukiwanie, aby zwracać tylko foldery, ustawiając typ MIME:

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

Aby wyświetlić wszystkie wyszukiwane hasła dotyczące plików, przeczytaj artykuł Wyszukiwane hasła dotyczące plików.

Aby wyświetlić wszystkie operatory zapytań, których możesz użyć do utworzenia zapytania, przeczytaj artykuł Operatory zapytań.

Przykłady ciągów zapytania

W tabeli poniżej znajdziesz przykłady podstawowych ciągów zapytania. Rzeczywisty kod różni się w zależności od biblioteki klienta używanej do wyszukiwania.

Aby zapytanie działało prawidłowo, musisz też poprzedzić znakiem ucieczki znaki specjalne w nazwach plików. Jeśli np. nazwa pliku zawiera zarówno apostrof ('), jak i ukośnik lewy ("\"), użyj ukośnika lewego, aby je poprzedzić znakiem ucieczki: name contains 'quinn\'s paper\\essay'.

Filtrowanie wyników wyszukiwania za pomocą biblioteki klienta

Ten przykładowy kod pokazuje, jak używać biblioteki klienta do filtrowania wyników wyszukiwania według nazw plików i identyfikatorów plików JPEG. Ten przykład używa wyszukiwanego hasła mimeType, aby zawęzić wyniki do plików typu image/jpeg. Ustawia też spaces na drive, aby dodatkowo zawęzić wyszukiwanie do miejsca na Dysku Dysku. Gdy nextPageToken zwraca null, nie ma więcej wyników.

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

Wyszukiwanie plików z niestandardową właściwością

Aby wyszukać pliki z niestandardową właściwością, użyj wyszukiwanego hasła properties lub appProperties z kluczem i wartością. Aby na przykład wyszukać niestandardową właściwość pliku, która jest prywatna dla aplikacji wysyłającej żądanie, o nazwie additionalID i wartości 8e8aceg2af2ge72e78:

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

Więcej informacji znajdziesz w artykule Dodawanie niestandardowych właściwości pliku.

Wyszukiwanie plików z określoną etykietą lub wartością pola

Aby wyszukać pliki z określonymi etykietami, użyj wyszukiwanego hasła labels z konkretnym identyfikatorem etykiety. Na przykład: 'labels/LABEL_ID' in labels. Jeśli operacja się uda, treść odpowiedzi będzie zawierała wszystkie instancje plików, do których zastosowano etykietę.

Aby wyszukać pliki bez określonego identyfikatora etykiety: Not 'labels/LABEL_ID' in labels.

Możesz też wyszukiwać pliki na podstawie konkretnych wartości pól. Aby na przykład wyszukać pliki z wartością tekstową: labels/LABEL_ID.text_field_id ='TEXT'.

Więcej informacji znajdziesz w artykule Wyszukiwanie plików z określoną etykietą lub wartością pola.

Przeszukiwanie korpusów

Domyślnie, gdy używana jest metoda list, w parametrze zapytania corpora ustawiana jest kolekcja elementów user. Aby przeszukać inne kolekcje elementów, np. udostępnione w domain, musisz wyraźnie ustawić parametr corpora.

W jednym zapytaniu możesz przeszukać wiele korpusów, ale jeśli połączone korpusy są zbyt duże, interfejs API może zwrócić niepełne wyniki. Sprawdź pole incompleteSearch w treści odpowiedzi. Jeśli ma wartość true, oznacza to, że pominięto niektóre dokumenty. Aby rozwiązać ten problem, zawęź parametr corpora, aby używać user lub drive.

Gdy używasz parametru zapytania orderBy w metodzie list, unikaj używania klucza createdTime w przypadku zapytań dotyczących dużych kolekcji elementów, ponieważ wymaga to dodatkowego przetwarzania i może powodować przekroczenie limitu czasu lub inne problemy. W przypadku sortowania według czasu w dużych kolekcjach elementów możesz użyć zamiast tego parametru modifiedTime, ponieważ jest on zoptymalizowany pod kątem obsługi tych zapytań. Na przykład ?orderBy=modifiedTime.

Jeśli pominiesz parametr zapytania orderBy, nie będzie domyślnego porządku sortowania, a elementy będą zwracane w dowolnej kolejności.

Powiązane artykuły

• Wyszukiwanie dysków współdzielonych
• Wyszukiwane hasła i operatory
• Obsługiwane typy MIME w Google Workspace i na Dysku Google
• Role i uprawnienia
• Wyszukiwanie plików z określoną etykietą lub wartością pola