Method: files.list

Wyświetla listę plików użytkownika. Więcej informacji znajdziesz w artykule Wyszukiwanie plików i folderów.

Ta metoda akceptuje parametr q, który jest zapytaniem wyszukiwania łączącym co najmniej 1 wyszukiwane hasło.

Ta metoda domyślnie zwraca wszystkie pliki, w tym pliki w koszu. Jeśli nie chcesz, aby usunięte pliki pojawiały się na liście, użyj parametru zapytania trashed=false, aby usunąć je z wyników.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
corpora

string

treści elementów (plików lub dokumentów), do których odnosi się zapytanie; Obsługiwane korpusy:

  • user
  • domain
  • drive
  • allDrives

Aby oszczędzać energię, wybieraj user lub drive zamiast allDrives. Domyślnie korpusy są ustawione na user. Może się to jednak zmienić w zależności od filtra ustawionego za pomocą parametru q. Więcej informacji znajdziesz w sekcji Organizacja plików.
corpus
(deprecated)

enum (Corpus)

Wycofano: źródło plików do wyświetlenia. Zamiast niej używaj zasady corpora.
driveId

string

Identyfikator dysku współdzielonego, na którym ma być przeprowadzone wyszukiwanie.
includeItemsFromAllDrives

boolean

Czy w wynikach mają być uwzględniane elementy z Mojego dysku i dysków współdzielonych.
includeTeamDriveItems
(deprecated)

boolean

Wycofana: zamiast niej używaj zasady includeItemsFromAllDrives.
orderBy

string

Lista kluczy sortowania rozdzielonych przecinkami. Prawidłowe klucze to:

  • createdTime: kiedy plik został utworzony.
  • folder: identyfikator folderu. To pole jest posortowane alfabetycznie.
  • modifiedByMeTime: ostatnia modyfikacja pliku przez użytkownika.
  • modifiedTime: ostatnia modyfikacja pliku przez dowolną osobę.
  • name: nazwa pliku. To pole jest sortowane alfabetycznie, więc 1, 12, 2, 22.
  • name_natural: nazwa pliku. To pole jest sortowane w kolejności naturalnej, czyli 1, 2, 12, 22.
  • quotaBytesUsed: liczba bajtów limitu miejsca na dane wykorzystanych przez plik.
  • recency: najnowsza sygnatura czasowa z pól daty i godziny w pliku.
  • sharedWithMeTime: data udostępnienia pliku użytkownikowi (jeśli dotyczy).
  • starred: czy użytkownik oznaczył plik gwiazdką.
  • viewedByMeTime: data ostatniego wyświetlenia pliku przez użytkownika.

Każdy klucz jest domyślnie sortowany rosnąco, ale można to odwrócić za pomocą modyfikatora desc. Przykłady użycia: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Maksymalna liczba plików do zwrócenia na stronę. Niepełne lub puste strony wyników mogą się pojawić jeszcze przed osiągnięciem końca listy plików.
pageToken

string

Token umożliwiający kontynuowanie poprzedniego żądania listy na następnej stronie. Powinna być ustawiona na wartość nextPageToken z poprzedniej odpowiedzi.
q

string

Zapytanie służące do filtrowania wyników dotyczących plików. Obsługiwaną składnię znajdziesz w artykule Wyszukiwanie plików i folderów.
spaces

string

Lista rozdzielonych przecinkami przestrzeni, w których chcesz wyszukiwać w korpusach. Obsługiwane wartości to drive i appDataFolder. Więcej informacji znajdziesz w sekcji Organizacja plików.
supportsAllDrives

boolean

Czy aplikacja wysyłająca żądanie obsługuje zarówno Mój dysk, jak i dyski współdzielone.
supportsTeamDrives
(deprecated)

boolean

Wycofana: zamiast niej używaj zasady supportsAllDrives.
teamDriveId
(deprecated)

string

Wycofana: zamiast niej używaj zasady driveId.
includePermissionsForView

string

Określa, które uprawnienia do dodatkowego widoku mają być uwzględnione w odpowiedzi. Obsługiwana jest tylko wartość published.
includeLabels

string

Lista identyfikatorów etykiet rozdzielona przecinkami, które mają być uwzględnione w części labelInfo odpowiedzi.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Lista plików.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Pola
files[]

object (File)

Lista plików. Jeśli pole nextPageToken jest wypełnione, ta lista może być niekompletna i należy pobrać dodatkową stronę wyników.
nextPageToken

string

Token strony z następną stroną plików. Jeśli osiągnięto koniec listy plików, ten element nie będzie widoczny. Jeśli token zostanie odrzucony z jakiegokolwiek powodu, należy go odrzucić, a stronicowanie należy rozpocząć od pierwszej strony wyników. Token strony jest zwykle ważny przez kilka godzin. Jeśli jednak dodasz lub usuniesz nowe produkty, oczekiwane wyniki mogą się różnić.
kind

string

Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "drive#fileList".

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

Niektóre zakresy są ograniczone i wymagają oceny bezpieczeństwa, aby aplikacja mogła ich używać. Więcej informacji znajdziesz w przewodniku po autoryzacji.

Korpus

Wartości w polu enum
user pliki należące do użytkownika lub mu udostępnione;
domain Pliki udostępnione w domenie użytkownika.