Method: files.list

Zawiera listę plików użytkownika.

Ta metoda akceptuje parametr q, który jest zapytaniem łączącym co najmniej jedno 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

ciała elementów (plików/dokumentów), których dotyczy zapytanie. Obsługiwane treści to „user”, „domain”, „drive” i „allDrives”. Aby zwiększyć wydajność, wybieraj „user” lub „drive” (dysk) do „allDrives”. Domyślnie korpus ma ustawienie „użytkownik”. Może się to jednak zmienić w zależności od filtra ustawionego w parametrze „q”.
corpus
(deprecated)

enum (Corpus)

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

string

Identyfikator dysku współdzielonego do przeszukania.
includeItemsFromAllDrives

boolean

Określa, czy w wynikach mają być uwzględnione zarówno elementy z Mojego dysku, jak i dysku współdzielonego.
includeTeamDriveItems
(deprecated)

boolean

Wycofane: zamiast tego użyj elementu includeItemsFromAllDrives.
orderBy

string

Rozdzielona przecinkami lista kluczy sortowania. Prawidłowe klucze to „createTime”, „folder”, „modifiedByMeTime”, „modifiedTime”, „name”, „name_natural”, „quotaBytesUsed”, „recency”, „sharedWithMeTime”, „starred” i „viewedByMeTime”. Każdy klawisz 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ą zostać wyświetlone jeszcze przed osiągnięciem końca listy plików.
pageToken

string

Token kontynuacji poprzedniego żądania listy na następnej stronie. Należy ustawić wartość „nextPageToken” z poprzedniej odpowiedzi.
q

string

Zapytanie do filtrowania wyników pliku. Informacje o obsługiwanej składni znajdziesz w przewodniku „Wyszukiwanie plików i folderów”.
spaces

string

Rozdzielona przecinkami lista spacji, do których należy wysłać zapytanie w korpusie. Obsługiwane wartości to „drive” i „appDataFolder”.
supportsAllDrives

boolean

Określa, czy aplikacja żądająca obsługuje zarówno Mój dysk, jak i dyski współdzielone.
supportsTeamDrives
(deprecated)

boolean

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

string

Wycofane: zamiast tego użyj elementu driveId.
includePermissionsForView

string

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

string

Rozdzielona przecinkami lista identyfikatorów etykiet do uwzględnienia w części labelInfo odpowiedzi.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Listę 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 następnej strony plików. Będzie jej brakować po osiągnięciu końca listy plików. Jeśli token zostanie z jakiegokolwiek powodu odrzucony, należy go odrzucić i uruchomić ponownie podział na strony na pierwszej stronie 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 wartość NextPageToken jest wypełniona, ta lista może być niekompletna i należy pobrać dodatkową 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.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ą objęte ograniczeniami, a aplikacja może z nich korzystać dopiero po sprawdzeniu zabezpieczeń. 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.