파일의 특정 필드 반환하기

필요한 필드를 정확히 반환하고 성능을 개선하려면 fields를 사용합니다. 쿼리 매개변수를 지정합니다.

기본적으로 서버는 액세스 중인 리소스와 관련된 필드 세트를 반환하며, 있습니다. 예를 들면 다음과 같습니다. files.get 메서드는 다음과 같이 id, name, mimeType만 반환할 수 있습니다. files 리소스 이 permissions.get 메서드는 다양한 기본 필드 집합으로 permissions 리소스

서버가 fields 쿼리가 포함된 유효한 요청을 처리한 후 매개변수가 있으면 요청된 응답과 함께 HTTP 200 OK 상태 코드를 데이터입니다. 필드 쿼리 매개변수에 오류가 있거나 유효하지 않은 경우 서버가 오류와 함께 HTTP 400 Bad Request 상태 코드를 반환합니다. 메시지가 표시됩니다. 예를 들어 files.list(fields='files(id,capabilities,canAddChildren)')는 "잘못된 필드 선택 canAddChildren." 다음에 대한 올바른 필드 쿼리 매개변수는 이 예는 files.list(fields='files(id,capabilities/canAddChildren)')

fields 매개변수를 사용하여 반환할 수 있는 필드를 확인하려면 다음을 방문하세요. 쿼리 중인 리소스의 문서 페이지 예를 들어 파일에 관해 반환할 수 있는 필드에 관해 자세히 알아보려면 files 리소스 문서를 참고하세요.

필드 매개변수 형식 규칙

필드 요청 매개변수 값의 형식은 대략 XPath를 기반으로 합니다. 구문을 사용합니다 다음은 fields 매개변수의 형식 지정 규칙입니다. 전체 이러한 규칙은 files.get 메서드와 관련된 예시를 사용합니다.

  • 여러 필드를 선택하려면 쉼표로 구분된 목록을 사용합니다(예: 'name, mimeType').

  • a/b를 사용하여 a 필드 내에 중첩된 b 필드를 선택하세요. 예를 들면 다음과 같습니다. 'capabilities/canDownload'입니다. 자세한 내용은 중첩됨 리소스를 참고하세요.

  • 하위 선택자를 사용하여 배열의 특정 하위 필드 세트를 요청하거나 괄호 '()' 안에 표현식을 넣어 객체를 반환합니다. 예를 들어 'permissions(id)'는 다음 항목에 있는 각 요소의 권한 ID만 반환합니다. 권한 배열을 생성합니다.

  • 객체의 모든 필드를 반환하려면 별표를 필드에 와일드카드로 사용하세요. 선택할 수 있습니다. 예를 들어 'permissions/permissionDetails/*'는 모두 선택합니다. 각 권한마다 사용 가능한 권한 세부정보 필드를 제공합니다. 참고: 이 와일드 카드가 있으면 요청에 부정적인 영향을 미칠 수 있습니다.

예 보기

요청

이 예에서는 요청에서 파일 ID 경로 매개변수와 여러 필드를 쿼리 매개변수로 제공합니다. 응답은 파일 ID의 필드 값을 반환합니다.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared

응답

{
  "name": "File1",
  "starred": false,
  "shared": true
  }
}

중첩된 리소스의 필드 가져오기

필드가 다른 리소스를 참조하는 경우 선택해야 합니다

예를 들어 permissions의 role 필드 (중첩된 리소스)를 검색합니다. 리소스를 사용하려면 다음 옵션 중 하나를 사용하세요.

  • fields=role 또는 fields=*로 permissions.get.
  • fields=permissions(role) 또는 fields=permissions/role로 files.get.
  • fields=permissions가 포함된 files.get: 중첩된 모든 필드를 암시 리소스도 제공합니다
  • fields=changes(file(permissions(role)))로 changes.list 호출

여러 필드를 검색하려면 쉼표로 구분된 목록을 사용합니다. 예를 들어 fields=files(id,name,createdTime,modifiedTime,size)에서 files.list

예 보기

요청

이 예에서는 파일 ID 경로 매개변수와 중첩된 권한 리소스의 특정 필드를 비롯한 여러 필드를 요청의 쿼리 매개변수로 제공합니다. 응답은 파일 ID의 필드 값을 반환합니다.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=name,starred,shared,permissions(kind,type,role)

응답

{
  "name": "File1",
  "starred": false,
  "shared": true,
  "permissions": [
    {
      "kind": "drive#permission",
      "type": "user",
      "role": "owner"
    }
  ]
}