Method: files.list

사용자의 파일을 나열합니다. 자세한 내용은 파일 및 폴더 검색을 참고하세요.

이 메서드는 하나 이상의 검색어를 결합한 검색 쿼리인 q 매개변수를 허용합니다.

이 메서드는 기본적으로 휴지통에 있는 파일을 포함하여 모든 파일을 반환합니다. 휴지통에 있는 파일이 목록에 표시되지 않도록 하려면 trashed=false 쿼리 매개변수를 사용하여 결과에서 휴지통에 있는 파일을 삭제하세요.

HTTP 요청

GET https://www.googleapis.com/drive/v3/files

URL은 gRPC 트랜스코딩 문법을 사용합니다.

쿼리 매개변수

매개변수
corpora

string

쿼리가 적용되는 항목 (파일 또는 문서)의 컬렉션을 지정합니다. 지원되는 항목은 다음과 같습니다.

  • user
  • domain
  • drive
  • allDrives

효율성을 위해 allDrives 대신 user 또는 drive를 사용하는 것이 좋습니다. 기본적으로 코퍼스는 user로 설정됩니다. 하지만 q 매개변수를 통해 설정된 필터에 따라 변경될 수 있습니다. 자세한 내용은 파일 구성을 참고하세요.

corpus
(deprecated)

enum (Corpus)

지원 중단됨: 나열할 파일의 소스입니다. 대신 corpora를 사용하세요.

driveId

string

검색할 공유 드라이브의 ID입니다.

includeItemsFromAllDrives

boolean

내 드라이브와 공유 드라이브 항목을 모두 결과에 포함할지 여부입니다.

includeTeamDriveItems
(deprecated)

boolean

지원 중단됨: 대신 includeItemsFromAllDrives를 사용하세요.

orderBy

string

쉼표로 구분된 정렬 키 목록입니다. 유효한 키는 다음과 같습니다.

  • createdTime: 파일이 생성된 시간입니다. 이 키를 대규모 항목 컬렉션에 대한 쿼리에 사용하면 시간 초과 또는 기타 문제가 발생할 수 있으므로 사용하지 않는 것이 좋습니다. 대규모 항목 컬렉션에서 시간 관련 정렬을 하려면 대신 modifiedTime desc를 사용하세요.
  • folder: 폴더 ID입니다. 이 필드는 알파벳순으로 정렬됩니다.
  • modifiedByMeTime: 사용자가 파일을 마지막으로 수정한 시간입니다.
  • modifiedTime: 파일을 마지막으로 수정한 시간입니다.
  • name: 파일의 이름입니다. 이 필드는 알파벳순으로 정렬되므로 1, 12, 2, 22가 됩니다.
  • name_natural: 파일의 이름입니다. 이 필드는 자연 정렬 순서로 정렬되므로 1, 2, 12, 22가 됩니다.
  • quotaBytesUsed: 파일에서 사용한 스토리지 할당량 바이트 수입니다.
  • recency: 파일의 날짜/시간 필드에서 가장 최근의 타임스탬프입니다.
  • sharedWithMeTime: 파일이 사용자와 공유된 시간입니다(해당하는 경우).
  • starred: 사용자가 파일에 별표표시했는지 여부입니다.
  • viewedByMeTime: 사용자가 파일을 마지막으로 본 시간입니다.

각 키는 기본적으로 오름차순으로 정렬되지만 desc 수정자를 사용하여 반전할 수 있습니다. 사용 예시: ?orderBy=folder,modifiedTime desc,name.

pageSize

integer

반환할 파일의 최대 개수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 공유 드라이브의 경우 최대 100개의 파일이 반환되고, 비공유 드라이브의 경우 전체 파일 목록이 반환됩니다.

최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다.

pageToken

string

다음 페이지에서 이전 목록 요청을 계속하기 위한 토큰입니다. 이전 응답의 nextPageToken 값으로 설정해야 합니다.

q

string

파일 결과를 필터링하기 위한 쿼리입니다. 지원되는 구문은 파일 및 폴더 검색을 참고하세요.

spaces

string

코퍼스 내에서 쿼리할 공백의 쉼표로 구분된 목록입니다. 지원되는 값은 driveappDataFolder입니다. 자세한 내용은 파일 구성을 참고하세요.

supportsAllDrives

boolean

요청하는 애플리케이션에서 내 드라이브와 공유 드라이브를 모두 지원하는지 여부입니다.

supportsTeamDrives
(deprecated)

boolean

지원 중단됨: 대신 supportsAllDrives를 사용하세요.

teamDriveId
(deprecated)

string

지원 중단됨: 대신 driveId를 사용하세요.

includePermissionsForView

string

응답에 포함할 추가 뷰의 권한을 지정합니다. published만 지원됩니다.

includeLabels

string

응답의 labelInfo 부분에 포함할 라벨 ID의 쉼표로 구분된 목록입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

파일 목록입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
필드
files[]

object (File)

파일 목록입니다. nextPageToken이 채워져 있으면 이 목록이 불완전할 수 있으며 결과의 추가 페이지를 가져와야 합니다.

nextPageToken

string

파일의 다음 페이지를 위한 페이지 토큰입니다. 파일 목록의 끝에 도달하면 이 토큰이 없습니다. 어떤 이유로든 토큰이 거부되면 토큰을 삭제하고 결과의 첫 번째 페이지부터 페이지로 나누기를 다시 시작해야 합니다. 페이지 토큰은 일반적으로 몇 시간 동안 유효합니다. 하지만 새 항목이 추가되거나 삭제되면 예상 결과가 달라질 수 있습니다.

kind

string

리소스 종류를 식별합니다. 값: 고정 문자열 "drive#fileList".

승인 범위

다음 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

일부 범위는 제한되어 있으며 앱에서 이러한 범위를 사용하려면 보안 평가가 필요합니다. 자세한 내용은 승인 가이드를 참고하세요.

코퍼스

열거형
user 사용자가 소유하거나 공유한 파일입니다.
domain 사용자의 도메인과 공유된 파일입니다.