Method: files.list

Wyświetla pliki 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.

Domyślnie ta metoda zwraca wszystkie pliki, w tym pliki w koszu. Jeśli nie chcesz, aby pliki w koszu 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

Określa kolekcję elementów (plików lub dokumentów), do których ma zastosowanie zapytanie. Obsługiwane elementy:

  • user
  • domain
  • drive
  • allDrives

Aby zwiększyć wydajność, używaj user lub drive zamiast allDrives. Domyślnie parametr corpora jest ustawiony na user. Może się to jednak zmienić w zależności od filtra ustawionego za pomocą parametru q. Więcej informacji znajdziesz w artykule Organizowanie plików.
corpus
(deprecated)

enum (Corpus)

Wycofane: źródło plików do wyświetlenia. Zamiast tego użyj parametru corpora.
driveId

string

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

boolean

Informacja, czy w wynikach mają się znaleźć elementy z Mojego dysku i dysków współdzielonych.
includeTeamDriveItems
(deprecated)

boolean

Wycofane: zamiast tego użyj parametru includeItemsFromAllDrives.
orderBy

string

Lista kluczy sortowania rozdzielona przecinkami. Prawidłowe klucze:

  • createdTime: data utworzenia pliku. Unikaj używania tego klucza w przypadku zapytań dotyczących dużych kolekcji elementów, ponieważ może to spowodować przekroczenie limitu czasu lub inne problemy. W przypadku sortowania według czasu w dużych kolekcjach elementów użyj zamiast tego parametru modifiedTime desc.
  • folder: identyfikator folderu. To pole jest sortowane alfabetycznie.
  • modifiedByMeTime: data ostatniej modyfikacji pliku przez użytkownika.
  • modifiedTime: data ostatniej modyfikacji pliku przez dowolną osobę.
  • name: nazwa pliku. To pole jest sortowane alfabetycznie, czyli 1, 12, 2, 22.
  • name_natural: nazwa pliku. To pole jest sortowane naturalnie, 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: informacja, czy użytkownik oznaczył plik gwiazdką.
  • viewedByMeTime: data ostatniego wyświetlenia pliku przez użytkownika.

Każdy klucz domyślnie sortuje rosnąco, 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 stronie. Strony mogą być częściowe lub puste, nawet zanim dotrzesz do końca listy plików.

Jeśli nie określisz tej wartości, w przypadku dysków współdzielonych zostanie zwróconych co najwyżej 100 plików, a w przypadku dysków niewspółdzielonych – cała lista plików.

Maksymalna wartość to 100. Wartości powyżej 100 są zmieniane na 100.
pageToken

string

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

string

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

string

Lista przestrzeni rozdzielona przecinkami, w których ma być wyszukiwane w ramach korpusu. Obsługiwane wartości to drive i appDataFolder. Więcej informacji znajdziesz w artykule Organizowanie plików.
supportsAllDrives

boolean

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

boolean

Wycofane: zamiast tego użyj parametru supportsAllDrives.
teamDriveId
(deprecated)

string

Wycofane: zamiast tego użyj parametru driveId.
includePermissionsForView

string

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

string

Lista identyfikatorów etykiet rozdzielonych 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 dla następnej strony plików. Będzie on nieobecny, jeśli osiągnięto koniec listy plików. Jeśli token zostanie odrzucony z jakiegokolwiek powodu, należy go odrzucić i ponownie rozpocząć paginację od pierwszej strony wyników. Token strony jest zwykle ważny przez kilka godzin. Jeśli jednak zostaną dodane lub usunięte nowe elementy, 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 aplikacji. 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 domenie użytkownika.