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/v2/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 ciała to default, domain, drive i allDrives. Ze względu na wydajność wybieraj default lub drive zamiast allDrives.

corpus
(deprecated)

enum (Corpus)

Wycofane: treść elementów (plików/dokumentów), do których odnosi się zapytanie. Użyj w zamian zasady 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.

maxResults

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.

orderBy

string

Rozdzielona przecinkami lista kluczy sortowania. Prawidłowe klucze to createdDate, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title i title_natural. Każdy klawisz domyślnie sortuje się rosnąco, ale można to zmienić za pomocą modyfikatora desc. Przykład użycia: ?orderBy=folder,modifiedDate desc,title. Obecnie obowiązuje ograniczenie dla użytkowników posiadających około miliona plików, w których żądana kolejność sortowania jest ignorowana.

pageToken

string

Token strony na pliki.

projection
(deprecated)

enum (Projection)

Wycofany: ten parametr nie ma funkcji.

q

string

Ciąg zapytania do wyszukiwania plików.

spaces

string

Rozdzielona przecinkami lista spacji, których dotyczy zapytanie. 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ść published.

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

kind

string

Jest to zawsze drive#fileList.

etag

string

Wartość ETag listy.

items[]

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/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.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
DEFAULT Elementy, do których użytkownik uzyskał dostęp.
DOMAIN Elementy udostępnione w domenie użytkownika.