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/v2/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 podmioty to default, domain, drive i allDrives. Zamiast allDrives preferuj default lub drive, aby zwiększyć wydajność.

corpus
(deprecated)

enum (Corpus)

Zastąpione: treść elementów (plików lub dokumentów), do których ma zastosowanie zapytanie. Zamiast tego użyj 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.

maxResults

integer

Maksymalna liczba plików do zwrócenia na stronę. Częściowe lub puste strony wyników mogą się pojawić jeszcze przed zakończeniem listy plików.

orderBy

string

Lista kluczy sortowania rozdzielona przecinkami. Prawidłowe klucze:

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

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,modifiedDate desc,title.

Pamiętaj, że obecnie istnieje ograniczenie dla użytkowników, którzy mają około miliona plików, w przypadku których żądana kolejność sortowania jest ignorowana.

pageToken

string

Token strony dla plików.

projection
(deprecated)

enum (Projection)

Wycofany: ten parametr nie ma żadnej funkcji.

q

string

Ciąg zapytania do wyszukiwania plików.

spaces

string

Lista przestrzeni, których dotyczy zapytanie, rozdzielona przecinkami. Obsługiwane wartości to driveappDataFolder.

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 wartość published.

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,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      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.

kind

string

Jest ona zawsze drive#fileList.

etag

string

ETag listy.

items[]

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/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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
DEFAULT Elementy, do których użytkownik uzyskał dostęp.
DOMAIN elementy udostępnione w domenie użytkownika.