Class File

파일

Google Drive 파일 DriveApp에서 파일에 액세스하거나 파일을 만들 수 있습니다.

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

방법

메서드반환 유형간략한 설명
addCommenter(emailAddress)File지정된 사용자를 File의 댓글 작성자 목록에 추가합니다.
addCommenter(user)File지정된 사용자를 File의 댓글 작성자 목록에 추가합니다.
addCommenters(emailAddresses)File지정된 사용자 배열을 File의 댓글 작성자 목록에 추가합니다.
addEditor(emailAddress)File지정된 사용자를 File의 편집자 목록에 추가합니다.
addEditor(user)File지정된 사용자를 File의 편집자 목록에 추가합니다.
addEditors(emailAddresses)File지정된 사용자 배열을 File의 편집기 목록에 추가합니다.
addViewer(emailAddress)File지정된 사용자를 File의 뷰어 목록에 추가합니다.
addViewer(user)File지정된 사용자를 File의 뷰어 목록에 추가합니다.
addViewers(emailAddresses)File지정된 사용자 배열을 File의 뷰어 목록에 추가합니다.
getAccess(email)Permission지정된 사용자에게 부여된 권한을 가져옵니다.
getAccess(user)Permission지정된 사용자에게 부여된 권한을 가져옵니다.
getAs(contentType)Blob이 객체 내의 데이터를 지정된 콘텐츠 유형으로 변환된 blob으로 반환합니다.
getBlob()Blob이 객체 내의 데이터를 blob으로 반환합니다.
getDateCreated()DateFile가 생성된 날짜를 가져옵니다.
getDescription()StringFile의 설명을 가져옵니다.
getDownloadUrl()String파일을 다운로드하는 데 사용할 수 있는 URL을 가져옵니다.
getEditors()User[]File의 편집자 목록을 가져옵니다.
getId()StringFile의 ID를 가져옵니다.
getLastUpdated()DateFile가 마지막으로 업데이트된 날짜를 가져옵니다.
getMimeType()String파일의 MIME 유형을 가져옵니다.
getName()StringFile의 이름을 가져옵니다.
getOwner()User파일 소유자를 가져옵니다.
getParents()FolderIteratorFile의 직속 상위 요소인 폴더 컬렉션을 가져옵니다.
getResourceKey()String링크를 사용하여 공유된 항목에 액세스하는 데 필요한 File의 리소스 키를 가져옵니다.
getSecurityUpdateEligible()Boolean링크를 사용하여 공유할 때 액세스하기 위해 리소스 키가 필요한 보안 업데이트를 이 File에 적용할 수 있는지 확인합니다.
getSecurityUpdateEnabled()Boolean링크를 사용하여 공유할 때 이 File에 액세스하기 위한 리소스 키가 필요한지 여부를 가져옵니다.
getSharingAccess()Access명시적으로 액세스 권한이 부여된 개별 사용자 외에도 File에 액세스할 수 있는 사용자 클래스를 가져옵니다.
getSharingPermission()Permission명시적으로 액세스 권한이 부여된 모든 개별 사용자 외에 File에 액세스할 수 있는 사용자에게 부여된 권한을 가져옵니다.
getSize()IntegerFile를 Drive에 저장하는 데 사용된 바이트 수를 가져옵니다.
getTargetId()String바로가기인 경우 이 항목이 가리키는 항목의 ID를 반환합니다.
getTargetMimeType()String바로가기인 경우 가리키는 항목의 MIME 유형을 반환합니다.
getTargetResourceKey()String파일이 바로가기인 경우 파일이 가리키는 항목의 리소스 키를 반환합니다.
getThumbnail()Blob파일의 썸네일 이미지를 가져오거나 썸네일이 없는 경우 null을 가져옵니다.
getUrl()StringDrive 또는 Docs와 같은 Google 앱에서 File를 여는 데 사용할 수 있는 URL을 가져옵니다.
getViewers()User[]File의 뷰어 및 댓글 작성자 목록을 가져옵니다.
isShareableByEditors()BooleanFile의 수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있는지 여부를 결정합니다.
isStarred()Boolean사용자 Drive에서 File에 별표표시했는지 여부를 결정합니다.
isTrashed()BooleanFile가 사용자 드라이브의 휴지통에 있는지 확인합니다.
makeCopy()File파일 사본을 만듭니다.
makeCopy(destination)File대상 디렉터리에 파일의 사본을 만듭니다.
makeCopy(name)File파일의 사본을 만들고 제공된 이름을 지정합니다.
makeCopy(name, destination)File대상 디렉터리에 파일의 사본을 만들고 제공된 이름을 지정합니다.
moveTo(destination)File이 항목을 제공된 대상 폴더로 이동합니다.
removeCommenter(emailAddress)FileFile의 댓글 작성자 목록에서 지정된 사용자를 삭제합니다.
removeCommenter(user)FileFile의 댓글 작성자 목록에서 지정된 사용자를 삭제합니다.
removeEditor(emailAddress)FileFile의 편집자 목록에서 지정된 사용자를 삭제합니다.
removeEditor(user)FileFile의 편집자 목록에서 지정된 사용자를 삭제합니다.
removeViewer(emailAddress)FileFile의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다.
removeViewer(user)FileFile의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다.
revokePermissions(emailAddress)File지정된 사용자에게 부여된 File에 대한 액세스를 취소합니다.
revokePermissions(user)File지정된 사용자에게 부여된 File에 대한 액세스를 취소합니다.
setContent(content)File지정된 대체 파일로 파일의 콘텐츠를 덮어씁니다.
setDescription(description)FileFile의 설명을 설정합니다.
setName(name)FileFile의 이름을 설정합니다.
setOwner(emailAddress)FileFile의 소유자를 변경합니다.
setOwner(user)FileFile의 소유자를 변경합니다.
setSecurityUpdateEnabled(enabled)File링크를 사용하여 공유할 때 File에 액세스를 위한 리소스 키가 필요한지 여부를 설정합니다.
setShareableByEditors(shareable)FileFile에 대한 수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있는지 여부를 설정합니다.
setSharing(accessType, permissionType)File명시적으로 액세스 권한이 부여된 개별 사용자 외에도 File에 액세스할 수 있는 사용자 클래스와 사용자에게 부여할 권한을 설정합니다.
setStarred(starred)File사용자 Drive에서 File에 별표표시할지 여부를 설정합니다.
setTrashed(trashed)FileFile가 사용자 드라이브의 휴지통에 있는지 설정합니다.

자세한 문서

addCommenter(emailAddress)

지정된 사용자를 File의 댓글 작성자 목록에 추가합니다. 사용자가 이미 뷰어 목록에 있는 경우 이 방법은 뷰어 목록에서 사용자를 승격합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

매개변수

이름유형설명
emailAddressString추가할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addCommenter(user)

지정된 사용자를 File의 댓글 작성자 목록에 추가합니다. 사용자가 이미 뷰어 목록에 있는 경우 이 방법은 뷰어 목록에서 사용자를 승격합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

매개변수

이름유형설명
userUser추가할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addCommenters(emailAddresses)

지정된 사용자 배열을 File의 댓글 작성자 목록에 추가합니다. 사용자 목록에 이미 뷰어가 있는 경우 이 방법은 뷰어 목록에서 사용자를 승격시킵니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters.
  const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com'];
  console.log(file.addCommenters(emails));
}

매개변수

이름유형설명
emailAddressesString[]추가할 사용자의 이메일 주소 배열입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addEditor(emailAddress)

지정된 사용자를 File의 편집자 목록에 추가합니다. 사용자가 이미 뷰어 목록에 있는 경우 이 방법은 뷰어 목록에서 사용자를 승격합니다.

매개변수

이름유형설명
emailAddressString추가할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addEditor(user)

지정된 사용자를 File의 편집자 목록에 추가합니다. 사용자가 이미 뷰어 목록에 있는 경우 이 방법은 뷰어 목록에서 사용자를 승격합니다.

매개변수

이름유형설명
userUser추가할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

지정된 사용자 배열을 File의 편집기 목록에 추가합니다. 이미 뷰어 목록에 있는 사용자가 있는 경우 이 메서드는 뷰어 목록에서 사용자를 승격시킵니다.

매개변수

이름유형설명
emailAddressesString[]추가할 사용자의 이메일 주소 배열입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

지정된 사용자를 File의 뷰어 목록에 추가합니다. 사용자가 이미 편집자 목록에 있는 경우 이 메서드는 영향을 미치지 않습니다.

매개변수

이름유형설명
emailAddressString추가할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addViewer(user)

지정된 사용자를 File의 뷰어 목록에 추가합니다. 사용자가 이미 편집자 목록에 있는 경우 이 메서드는 영향을 미치지 않습니다.

매개변수

이름유형설명
userUser추가할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

지정된 사용자 배열을 File의 뷰어 목록에 추가합니다. 이미 편집자 목록에 있는 사용자가 있는 경우 이 방법은 사용자에게 영향을 미치지 않습니다.

매개변수

이름유형설명
emailAddressesString[]추가할 사용자의 이메일 주소 배열입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

getAccess(email)

지정된 사용자에게 부여된 권한을 가져옵니다.

매개변수

이름유형설명
emailString권한을 확인해야 하는 사용자의 이메일 주소

리턴

Permission: 사용자에게 부여된 권한

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

지정된 사용자에게 부여된 권한을 가져옵니다.

매개변수

이름유형설명
userUser권한을 확인해야 하는 사용자 표현

리턴

Permission: 사용자에게 부여된 권한

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAs(contentType)

이 객체 내의 데이터를 지정된 콘텐츠 유형으로 변환된 blob으로 반환합니다. 이 방법은 파일 이름에 적절한 확장자를 추가합니다(예: 'myfile.pdf'). 그러나 마지막 마침표 뒤에 오는 파일 이름 부분이 (존재하는 경우) 대체되어야 하는 기존 확장 프로그램이라고 가정합니다. 따라서 'ShoppingList.12.25.2014'는 'ShoppingList.12.25.pdf'가 됩니다.

전환의 일일 할당량은 Google 서비스 할당량을 참고하세요. 새로 만든 Google Workspace 도메인에는 더 엄격한 할당량이 적용될 수 있습니다.

매개변수

이름유형설명
contentTypeString변환할 MIME 유형입니다. 대부분의 blob에서 'application/pdf'가 유일한 유효한 옵션입니다. BMP, GIF, JPEG 또는 PNG 형식의 이미지도 'image/bmp', 'image/gif', 'image/jpeg' 또는 'image/png'입니다.

리턴

Blob - blob 데이터


getBlob()

이 객체 내의 데이터를 blob으로 반환합니다.

리턴

Blob - blob 데이터


getDateCreated()

File가 생성된 날짜를 가져옵니다.

리턴

Date: File가 생성된 날짜입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

File의 설명을 가져옵니다.

리턴

String: File의 설명입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDownloadUrl()

파일을 다운로드하는 데 사용할 수 있는 URL을 가져옵니다. Google Drive에서 파일을 열 권한이 있는 사용자만 URL에 액세스할 수 있습니다. 브라우저에서 이 URL을 사용하여 파일을 다운로드할 수 있지만 UrlFetchApp로 파일을 가져오는 데는 사용할 수 없습니다. 스크립트에 있는 파일 콘텐츠를 원하면 getBlob()를 사용합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

리턴

String: 파일을 다운로드하는 데 사용할 수 있는 URL입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

File의 편집자 목록을 가져옵니다. 스크립트를 실행하는 사용자에게 File에 대한 수정 액세스 권한이 없으면 이 메서드는 빈 배열을 반환합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

리턴

User[] - 사용자에게 이 File의 수정 액세스 권한이 있으면 편집자 목록을 반환합니다. 사용자에게 수정 권한이 없는 경우 빈 배열을 반환합니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

File의 ID를 가져옵니다.

리턴

String: File의 ID입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

File가 마지막으로 업데이트된 날짜를 가져옵니다.

리턴

Date: File이 마지막으로 업데이트된 날짜입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getMimeType()

파일의 MIME 유형을 가져옵니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

리턴

String: 파일의 MIME 유형입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

File의 이름을 가져옵니다.

리턴

String: File의 이름입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

파일 소유자를 가져옵니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

리턴

User — 파일 소유자입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

File의 직속 상위 요소인 폴더 컬렉션을 가져옵니다.

리턴

FolderIterator: File의 직속 상위 요소인 폴더 컬렉션

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

링크를 사용하여 공유된 항목에 액세스하는 데 필요한 File의 리소스 키를 가져옵니다.

리턴

String: File의 리소스 키입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

링크를 사용하여 공유할 때 액세스하기 위해 리소스 키가 필요한 보안 업데이트를 이 File에 적용할 수 있는지 확인합니다.

링크를 사용하여 공유된 일부 파일 또는 폴더에 액세스하려면 Drive에 리소스 키가 필요합니다. 이 변경사항은 보안 업데이트의 일부입니다. 사용 가능한 파일과 폴더에는 이 업데이트가 기본적으로 사용 설정됩니다. 적합한 파일의 리소스 키 요구사항을 사용 설정 또는 중지하려면 setSecurityUpdateEnabled를 사용합니다.

Google Drive 보안 업데이트에 관해 자세히 알아보세요.

리턴

Boolean - File에 리소스 키 요구사항을 적용할 수 있는지 여부입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

링크를 사용하여 공유할 때 이 File에 액세스하기 위한 리소스 키가 필요한지 여부를 가져옵니다. 이 요구사항은 요건을 충족하는 파일 및 폴더에 기본적으로 사용 설정되어 있습니다. 대상 파일에 대한 리소스 키 요구사항을 사용 또는 사용 중지하려면 setSecurityUpdateEnabled를 사용합니다.

Google Drive 보안 업데이트에 관해 자세히 알아보세요.

리턴

Boolean - 이 File에 리소스 키 요구사항이 사용 설정되어 있는지 여부입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

명시적으로 액세스 권한이 부여된 개별 사용자 외에도 File에 액세스할 수 있는 사용자 클래스를 가져옵니다.

리턴

Access: File에 액세스할 수 있는 사용자 클래스

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

명시적으로 액세스 권한이 부여된 모든 개별 사용자 외에 File에 액세스할 수 있는 사용자에게 부여된 권한을 가져옵니다.

리턴

Permission: File에 액세스할 수 있는 사용자에게 부여된 권한입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

File를 Drive에 저장하는 데 사용된 바이트 수를 가져옵니다. Google Workspace 애플리케이션 파일은 Drive 스토리지 한도 계산에 포함되지 않으므로 0바이트가 반환됩니다.

리턴

Integer — Drive에 File를 저장하는 데 사용된 바이트 수

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTargetId()

바로가기인 경우 이 항목이 가리키는 항목의 ID를 반환합니다.

그렇지 않으면 null를 반환합니다.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

리턴

String: 대상 항목 ID입니다.


getTargetMimeType()

바로가기인 경우 가리키는 항목의 MIME 유형을 반환합니다.

그렇지 않으면 null를 반환합니다.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

리턴

String — 타겟 항목 MIME 유형입니다.


getTargetResourceKey()

파일이 바로가기인 경우 파일이 가리키는 항목의 리소스 키를 반환합니다. 리소스 키는 링크를 사용하여 공유된 파일에 액세스하기 위해 전달해야 하는 추가 매개변수입니다.

파일이 바로가기가 아니면 null를 반환합니다.

// Gets a file by its ID.
// TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it points to.
console.log(file.getTargetResourceKey());

리턴

String - 대상 항목의 리소스 키 또는 파일이 바로가기가 아닌 경우 null.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getThumbnail()

파일의 썸네일 이미지를 가져오거나 썸네일이 없는 경우 null을 가져옵니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

리턴

Blob: 파일의 썸네일 이미지입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

Drive 또는 Docs와 같은 Google 앱에서 File를 여는 데 사용할 수 있는 URL을 가져옵니다.

리턴

String: Drive 또는 Docs와 같은 Google 앱에서 이 File을(를) 확인하는 데 사용할 수 있는 URL

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

File의 뷰어 및 댓글 작성자 목록을 가져옵니다. 스크립트를 실행하는 사용자에게 File에 대한 수정 액세스 권한이 없으면 이 메서드는 빈 배열을 반환합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

리턴

User[] - 사용자에게 이 File의 수정 액세스 권한이 있는 경우 뷰어 및 댓글 작성자 목록을 반환합니다. 사용자에게 수정 권한이 없는 경우 빈 배열을 반환합니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

File의 수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있는지 여부를 결정합니다.

리턴

Boolean — 수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있는 경우 true, 허용되지 않는 경우 false

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

사용자 Drive에서 File에 별표표시했는지 여부를 결정합니다.

리턴

Boolean: File가 사용자 Drive에서 별표표시된 경우 true, 그렇지 않은 경우 false

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

File가 사용자 드라이브의 휴지통에 있는지 확인합니다.

리턴

BooleanFile가 사용자 드라이브의 휴지통에 있는 경우 true, 그렇지 않은 경우 false

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

makeCopy()

파일 사본을 만듭니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

리턴

File — 새 사본입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

makeCopy(destination)

대상 디렉터리에 파일의 사본을 만듭니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

매개변수

이름유형설명
destinationFolder파일을 복사할 디렉터리입니다.

리턴

File — 새 사본입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

makeCopy(name)

파일의 사본을 만들고 제공된 이름을 지정합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

매개변수

이름유형설명
nameString새 사본에 적용되어야 하는 파일 이름입니다.

리턴

File — 새 사본입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

makeCopy(name, destination)

대상 디렉터리에 파일의 사본을 만들고 제공된 이름을 지정합니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

매개변수

이름유형설명
nameString새 사본에 적용되어야 하는 파일 이름입니다.
destinationFolder파일을 복사할 디렉터리입니다.

리턴

File — 새 사본입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

moveTo(destination)

이 항목을 제공된 대상 폴더로 이동합니다.

항목을 대상 폴더로 이동하려면 현재 사용자가 파일의 소유자이거나 최소한 항목의 현재 상위 폴더에 대한 수정 액세스 권한이 있어야 합니다.

매개변수

이름유형설명
destinationFolder새 상위 항목이 되는 폴더입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeCommenter(emailAddress)

File의 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유된 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

매개변수

이름유형설명
emailAddressString삭제할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeCommenter(user)

File의 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유된 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

매개변수

이름유형설명
userUser삭제할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

File의 편집자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유되었거나 File가 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

Drive 파일의 경우 뷰어 목록에서도 사용자가 삭제됩니다.

매개변수

이름유형설명
emailAddressString삭제할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeEditor(user)

File의 편집자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유되었거나 File가 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

Drive 파일의 경우 뷰어 목록에서도 사용자가 삭제됩니다.

매개변수

이름유형설명
userUser삭제할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

File의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 뷰어 또는 댓글 작성자가 아닌 편집자인 경우 영향을 미치지 않습니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유되었거나 File가 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

Drive 파일의 경우 편집자 목록에서도 사용자가 삭제됩니다.

매개변수

이름유형설명
emailAddressString삭제할 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

removeViewer(user)

File의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는 사용자가 뷰어가 아닌 편집자인 경우 영향을 미치지 않습니다. 또한 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유되었거나 File가 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

Drive 파일의 경우 편집자 목록에서도 사용자가 삭제됩니다.

매개변수

이름유형설명
userUser삭제할 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

지정된 사용자에게 부여된 File에 대한 액세스를 취소합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유된 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

매개변수

이름유형설명
emailAddressString액세스 권한을 취소해야 하는 사용자의 이메일 주소입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

지정된 사용자에게 부여된 File에 대한 액세스를 취소합니다. 이 메서드는 일반 액세스 권한을 가진 사용자 클래스에 속한 경우(예: File이 사용자의 전체 도메인과 공유된 경우) 사용자가 File에 액세스하는 것을 차단하지 않습니다.

매개변수

이름유형설명
userUser액세스 권한을 취소해야 하는 사용자의 표현입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setContent(content)

지정된 대체 파일로 파일의 콘텐츠를 덮어씁니다. content가 10MB보다 크면 예외가 발생합니다.

// Creates a text file with the content 'Hello, world!'
file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

매개변수

이름유형설명
contentString파일의 새 콘텐츠입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setDescription(description)

File의 설명을 설정합니다.

매개변수

이름유형설명
descriptionStringFile의 새 설명

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setName(name)

File의 이름을 설정합니다.

매개변수

이름유형설명
nameStringFile의 새 이름

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

File의 소유자를 변경합니다. 이 메서드는 이전 소유자에게 File에 대한 명시적인 수정 액세스 권한도 부여합니다.

매개변수

이름유형설명
emailAddressString새 소유자가 되어야 하는 사용자의 이메일 주소

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setOwner(user)

File의 소유자를 변경합니다. 이 메서드는 이전 소유자에게 File에 대한 명시적인 수정 액세스 권한도 부여합니다.

매개변수

이름유형설명
userUser새 소유자가 되어야 하는 사용자 표현

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

링크를 사용하여 공유할 때 File에 액세스를 위한 리소스 키가 필요한지 여부를 설정합니다. 사용 가능한 파일 및 폴더는 기본적으로 사용 설정되어 있습니다.

Google Drive 보안 업데이트에 관해 자세히 알아보세요.

매개변수

이름유형설명
enabledBooleanFile의 리소스 키 요구사항을 사용 설정할지 여부입니다.

리턴

File: 체이닝용 File입니다.

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

File에 대한 수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있는지 여부를 설정합니다. 새 File의 기본값은 true입니다.

매개변수

이름유형설명
shareableBoolean수정 권한이 있는 사용자가 다른 사용자와 공유하거나 권한을 변경할 수 있어야 하는 경우 true, 허용되지 않는 경우 false

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

명시적으로 액세스 권한이 부여된 개별 사용자 외에도 File에 액세스할 수 있는 사용자 클래스와 사용자에게 부여할 권한을 설정합니다.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

매개변수

이름유형설명
accessTypeAccessFile에 액세스할 수 있는 사용자 클래스
permissionTypePermissionFile에 액세스할 수 있는 사용자에게 부여해야 하는 권한

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setStarred(starred)

사용자 Drive에서 File에 별표표시할지 여부를 설정합니다. 새 File의 기본값은 false입니다.

매개변수

이름유형설명
starredBoolean사용자 Drive에서 File에 별표표시해야 하는 경우 true, 그렇지 않은 경우 false

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

File가 사용자 드라이브의 휴지통에 있는지 설정합니다. 소유자만 File를 휴지통으로 이동할 수 있습니다. 새 File의 기본값은 false입니다.

매개변수

이름유형설명
trashedBooleanFile를 사용자 드라이브의 휴지통으로 이동해야 하는 경우 true, 이동하지 않으면 false

리턴

File — 체이닝용 File

승인

이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/drive