Method: files.list

Wyświetla pliki użytkownika.

Ta metoda akceptuje parametr q, który jest zapytaniem wyszukiwania zawierającym co najmniej 1 wyszukiwane hasło. Więcej informacji znajdziesz w przewodniku Wyszukiwanie plików i folderó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ść elementów (plików/dokumentów), których dotyczy zapytanie. Obsługiwane obiekty to „user”, „domain”, „drive” i „allDrives”. Zamiast opcji „allDrives” (wszystkie dyski) wybierz opcję „user” (użytkownik) lub „drive” (dysk), aby zwiększyć wydajność. Domyślnie wartość corpora jest ustawiona na „user”. Może się to jednak zmienić w zależności od filtra ustawionego za pomocą parametru „q”.
corpus
(deprecated)

enum (Corpus)

Wycofano: źródło plików do wyświetlenia. Zamiast tego użyj słowa „corpora”.
driveId

string

Identyfikator dysku współdzielonego, który chcesz przeszukać.
includeItemsFromAllDrives

boolean

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

boolean

Wycofane: użyj w zastępstwie tego includeItemsFromAllDrives.
orderBy

string

Lista kluczy sortowania rozdzielona przecinkami. Prawidłowe klucze:

  • createdTime: data utworzenia pliku.
  • folder: identyfikator folderu. To pole jest sortowane alfabetycznie.
  • modifiedByMeTime: czas ostatniej modyfikacji pliku przez użytkownika.
  • modifiedTime: data ostatniej modyfikacji pliku przez dowolną osobę.
  • name: nazwa pliku. To pole jest posortowane alfabetycznie: 1, 12, 2, 22.
  • name_natural: nazwa pliku. To pole jest sortowane według naturalnego porządku sortowania, czyli 1, 2, 12, 22.
  • quotaBytesUsed: liczba bajtów limitu miejsca na dane wykorzystanych przez plik.
  • recency: najnowsza sygnatura czasowa z polów daty i godziny w pliku.
  • sharedWithMeTime: data udostępnienia pliku użytkownikowi (jeśli to możliwe).
  • starred: czy użytkownik oznaczył plik gwiazdką.
  • viewedByMeTime: ostatni czas wyświetlenia pliku przez użytkownika.

Każdy klucz jest domyślnie sortowany w kolejności rosnącej, ale można to zmienić za pomocą modyfikatora „desc”. Przykład użycia: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Maksymalna liczba plików do zwrócenia na stronę. Częściowe lub puste strony wyników mogą występować nawet przed zakończeniem wyświetlania listy plików.
pageToken

string

Token do kontynuowania poprzedniego żądania listy na następnej stronie. Wartość tego parametru powinna być taka sama jak wartość parametru „nextPageToken” z poprzedniej odpowiedzi.
q

string

Zapytanie służące do filtrowania wyników dotyczących pliku. Więcej informacji o obsługiwanej składni znajdziesz w przewodniku „Wyszukiwanie plików i folderów”.
spaces

string

Lista rozdzielana przecinkami przestrzeni, których dotyczy zapytanie w korpusach. Obsługiwane wartości to „drive” i „appDataFolder”.
supportsAllDrives

boolean

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

boolean

Wycofane: użyj w zastępstwie tego supportsAllDrives.
teamDriveId
(deprecated)

string

Wycofane: użyj w zastępstwie tego driveId.
includePermissionsForView

string

Określa, które uprawnienia dodatkowego widoku należy uwzględnić w odpowiedzi. Obsługiwana jest tylko opcja „opublikowano”.
includeLabels

string

Lista identyfikatorów etykiet rozdzielona przecinkami, które mają być uwzględnione w sekcji 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 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
Pola
nextPageToken

string

Token strony dla następnej strony z plikami. Jeśli dotarliśmy do końca listy plików, nie będzie ona dostępna. Jeśli token zostanie odrzucony z jakiegokolwiek powodu, należy go odrzucić i ponowić pobieranie stron od pierwszej strony wyników. Token strony jest zwykle ważny przez kilka godzin. Jeśli jednak dodasz lub usuniesz nowe elementy, oczekiwane wyniki mogą się różnić.
kind

string

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

object (File)

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

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 z nich korzystać. Więcej informacji znajdziesz w przewodniku dotyczącym 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.