Method: files.list

Wyświetla listę plików użytkownika.

Ta metoda akceptuje parametr q, czyli zapytanie łączące 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

jednostki elementów (plików/dokumentów), których dotyczy zapytanie; Obsługiwane treści to „user”, „domain”, „drive” i „allDrives”. W celu zwiększenia wydajności stosuj parametr „user” lub „drive” zamiast wartości „allDrives”. Domyślnie korpus ma wartość „użytkownik”. Może się to jednak zmienić w zależności od filtra ustawionego za pomocą parametru „q”.
corpus
(deprecated)

enum (Corpus)

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

string

Identyfikator dysku współdzielonego do przeszukania.
includeItemsFromAllDrives

boolean

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

boolean

Wycofane: użyj atrybutu includeItemsFromAllDrives.
orderBy

string

Rozdzielona przecinkami lista kluczy sortowania. Prawidłowe klucze to „createdTime”, „folder”, „modifiedByMeTime”, „modifiedTime”, „name”, „name_natural”, „quotaBytesUsed”, „recency”, „sharedWithMeTime”, „starred” i „viewedByMeTime”. Każdy klawisz domyślnie sortuje dane rosnąco, ale można to odwrócić, używając modyfikatora „malejąco”. Przykład użycia: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Maksymalna liczba plików zwracanych na stronę. Częściowe lub puste strony z wynikami mogą pojawiać się nawet przed osiągnięciem końca listy plików.
pageToken

string

Token kontynuujący poprzednie żądanie listy na następnej stronie. Powinna mieć wartość „nextPageToken” z poprzedniej odpowiedzi.
q

string

Zapytanie służące do filtrowania wyników w pliku. Informacje o obsługiwanej składni 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

Określa, czy aplikacja, której dotyczy prośba, obsługuje zarówno Mój dysk, jak i dyski współdzielone.
supportsTeamDrives
(deprecated)

boolean

Wycofane: użyj atrybutu 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ługiwane są tylko wartości „opublikowane”.
includeLabels

string

Rozdzielona przecinkami lista identyfikatorów etykiet, które mają zostać uwzględnione 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 dla następnej strony z plikami. Nie będzie on brakujący, jeśli dojdzie do końca listy plików. Jeśli token zostanie z jakiegokolwiek powodu odrzucony, należy go unieważnić, a podział na strony powinien rozpocząć się od nowa 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 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 protokołu 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 na temat 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;