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 artykule Wyszukiwanie plików .

Żądanie HTTP

GET https://www.googleapis.com/drive/v2/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 default, domain, drive i allDrives. Ze względu na wydajność preferuj default lub drive: allDrives.

corpus
(deprecated)

enum (Corpus)

Wycofane: treść elementów (plików/dokumentów), których dotyczy 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 elementy z Mojego dysku i dysku współdzielonego.

includeTeamDriveItems
(deprecated)

boolean

Wycofane: użyj atrybutu includeItemsFromAllDrives.

maxResults

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.

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 klucz domyślnie sortuje dane rosnąco, ale można to zmienić, używając modyfikatora desc. Przykład użycia: ?orderBy=folder,modifiedDate desc,title. Pamiętaj, że aktualnie obowiązuje ograniczenie dotyczące użytkowników liczących około miliona plików, w przypadku których wymagana kolejność sortowania jest ignorowana.

pageToken

string

Token strony dla plików.

projection
(deprecated)

enum (Projection)

Wycofano: ten parametr nie ma funkcji.

q

string

Ciąg zapytania do wyszukania plików.

spaces

string

Rozdzielona przecinkami lista spacji, na które ma zostać wysłane zapytanie. 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ługiwana jest tylko wartość published.

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

kind

string

To zawsze drive#fileList.

etag

string

Identyfikator ETag listy.

items[]

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