Method: files.list

Wyświetla listę plików 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

jednostki elementów (plików/dokumentów), których dotyczy zapytanie; Obsługiwane obiekty to „user”, „domain”, „drive” i „allDrives”. Ze względu na wydajność lepiej użyć opcji „user” (użytkownik) lub „drive” (dysk) zamiast „allDrives” (wszystkie dyski). Domyślnie korpus ma wartość „użytkownik”. Może się to jednak zmieniać w zależności od filtra ustawionego za pomocą parametru „q”.
corpus
(deprecated)

enum (Corpus)

Wycofane: źródło plików do wyświetlenia. Użyj elementu „corpora” .
driveId

string

Identyfikator dysku współdzielonego do przeszukania.
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

Rozdzielona przecinkami lista kluczy sortowania. Prawidłowe klucze to:

  • createdTime: data utworzenia pliku.
  • folder: identyfikator folderu. To pole jest sortowane w kolejności alfabetycznej.
  • 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 przy użyciu naturalnej kolejności sortowania, 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 pliku.
  • sharedWithMeTime: data udostępnienia pliku użytkownikowi (jeśli dotyczy).
  • starred: czy użytkownik oznaczył plik gwiazdką.
  • viewedByMeTime: czas ostatniego wyświetlenia pliku przez użytkownika.

Każdy klucz domyślnie sortuje sortowanie rosnąco, ale można to odwrócić za pomocą polecenia „malejąco” modyfikator. Przykład użycia: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Maksymalna liczba plików zwracanych na stronę. Częściowe lub puste strony wyników mogą występować nawet przed dotarciem do końca listy plików.
pageToken

string

Token do kontynuowania poprzedniego żądania listy na następnej stronie. Należy ustawić wartość „nextPageToken” niż w przypadku poprzedniej odpowiedzi.
q

string

Zapytanie służące do filtrowania wyników dotyczących pliku. Informacje o obsługiwanych składniach znajdziesz w przewodniku „Wyszukiwanie plików i folderów”.
spaces

string

Rozdzielona przecinkami lista spacji, na które ma zostać wysłane zapytanie w obrębie korpusów. 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 atrybutu driveId.
includePermissionsForView

string

Określa uprawnienia dodatkowego widoku danych, które mają być uwzględnione w odpowiedzi. Obsługiwana jest tylko opcja „opublikowano”.
includeLabels

string

Lista identyfikatorów etykiet rozdzielonych 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ć podział na strony, zaczynając 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 pole nextPageToken jest wypełnione, ta lista może być niekompletna i powinna zostać pobrana dodatkowa strona z wynikami.

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. Aby można było z nich korzystać, aplikacja musi przeprowadzić ocenę zabezpieczeń. 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;