범위

사용자는 본인의 데이터에 액세스하거나 사용자를 대신하여 작동하는 부가기능 및 기타 애플리케이션을 승인해야 합니다. 사용자가 부가기능을 처음 실행하면 부가기능 UI에 승인 흐름을 시작하라는 승인 메시지가 표시됩니다.

이 흐름에서 프롬프트는 사용자에게 애플리케이션이 수행할 권한을 요청합니다. 예를 들어 부가기능에 사용자의 이메일 메시지를 읽거나 캘린더에 일정을 만들 수 있는 권한이 필요할 수 있습니다. 부가기능의 스크립트 프로젝트는 이러한 개별 권한을 OAuth 범위로 정의합니다.

URL 문자열을 사용하여 매니페스트에서 범위를 선언합니다. 승인 흐름 중에 Apps Script는 범위에 관한 사람이 읽을 수 있는 설명을 사용자에게 제공합니다. 예를 들어 Google Workspace 부가기능은 매니페스트에 https://www.googleapis.com/auth/gmail.addons.current.message.readonly로 작성된 '현재 메시지 읽기' 범위를 사용할 수 있습니다. 승인 흐름이 진행되는 동안 이 범위의 부가기능은 사용자에게 부가기능이 실행 중일 때 이메일 메시지 보기에 부가기능을 허용하도록 요청합니다.

보기 범위

다음을 실행하여 스크립트 프로젝트에 현재 필요한 범위를 확인할 수 있습니다.

  1. 스크립트 프로젝트를 엽니다.
  2. 왼쪽에서 Overview(개요) 를 클릭합니다.
  3. '프로젝트 OAuth 범위'에서 범위를 확인합니다.

프로젝트 매니페스트의 oauthScopes 필드에서 스크립트 프로젝트의 현재 범위를 볼 수도 있지만 해당 범위를 명시적으로 설정한 경우에만 가능합니다.

명시적 범위 설정

Apps Script는 코드에서 필요한 함수 호출을 검색하여 스크립트에 필요한 범위를 자동으로 결정합니다. 대부분의 스크립트에서는 이 방법으로 충분하고 시간을 절약하지만 게시된 부가기능의 경우 범위를 더 직접 제어해야 합니다.

예를 들어 Apps Script는 부가기능 스크립트 프로젝트에 기본적으로 매우 관대한 범위 https://mail.google.com를 제공할 수 있습니다. 사용자가 이 범위로 스크립트 프로젝트를 승인하면 프로젝트에 사용자의 Gmail 계정에 대한 전체 액세스 권한이 부여됩니다. 게시된 부가기능의 경우 이 범위를 부가기능의 요구사항만 포함하는 좀 더 제한된 집합으로 대체해야 합니다.

매니페스트 파일을 수정하여 스크립트 프로젝트에서 사용하는 범위를 명시적으로 설정할 수 있습니다. 매니페스트 필드 oauthScopes는 부가기능에서 사용하는 모든 범위의 배열입니다. 프로젝트 범위를 설정하려면 다음 안내를 따르세요.

  1. 부가기능에서 현재 사용 중인 범위를 확인합니다. 더 좁은 범위를 사용하는 등 변경해야 할 사항을 결정합니다.
  2. 부가기능의 매니페스트 파일을 엽니다.
  3. oauthScopes로 라벨이 지정된 최상위 필드를 찾습니다. 없으면 추가할 수 있습니다.
  4. oauthScopes 필드는 문자열 배열을 지정합니다. 프로젝트에서 사용하는 범위를 설정하려면 이 배열의 콘텐츠를 사용하려는 범위로 바꿉니다. 예를 들어 Gmail을 확장하는 Google Workspace 부가기능에는 다음이 있을 수 있습니다.

    {
      ...
      "oauthScopes": [
        "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
        "https://www.googleapis.com/auth/userinfo.email"
      ],
      ...
    }
    
  5. 매니페스트 파일 변경사항을 저장합니다.

OAuth 확인

민감한 특정 OAuth 범위를 사용하려면 부가기능을 게시하기 전에 OAuth 클라이언트 확인을 거쳐야 할 수 있습니다. 자세한 내용은 다음 가이드를 참조하세요.

제한된 범위

특정 범위에는 제한되며 사용자 데이터 보호에 도움이 되는 추가 규칙이 적용됩니다. 하나 이상의 제한된 범위를 사용하는 Gmail 또는 편집자 부가기능을 게시하려면 먼저 부가기능이 지정된 모든 제한사항을 준수해야 합니다.

게시하기 전에 제한된 범위의 전체 목록을 검토하세요. 부가기능에서 이러한 기능을 사용하는 경우 게시하기 전에 특정 API 범위에 대한 추가 요구사항을 준수해야 합니다.

캘린더 범위

다음은 Google Calendar를 확장하는 Google Workspace 부가기능에 자주 사용되는 범위입니다.

범위
이벤트 메타데이터 액세스 https://www.googleapis.com/auth/calendar.addons.execute

부가기능이 Calendar 일정 메타데이터에 액세스하는 경우 필요합니다. 부가기능이 이벤트 메타데이터에 액세스하도록 허용합니다.

사용자 생성 이벤트 데이터 읽기 https://www.googleapis.com/auth/calendar.addons.current.event.read

부가기능에서 사용자 생성 이벤트 데이터를 읽어야 하는 경우 필요합니다. 부가기능이 사용자 생성 이벤트 데이터에 액세스하도록 허용합니다. 이 데이터는 addOns.calendar.eventAccess 매니페스트 필드READ 또는 READ_WRITE로 설정된 경우에만 사용할 수 있습니다.

사용자 생성 이벤트 데이터 쓰기 https://www.googleapis.com/auth/calendar.addons.current.event.write

부가기능에서 사용자 생성 이벤트 데이터를 작성해야 하는 경우 필요합니다. 부가기능이 사용자 생성 이벤트 데이터를 수정하도록 허용합니다. 이 데이터는 addOns.calendar.eventAccess 매니페스트 필드WRITE 또는 READ_WRITE로 설정된 경우에만 사용할 수 있습니다.

Drive 범위

다음은 Google Drive를 확장하는 Google Workspace 부가기능에 자주 사용되는 범위입니다.

범위
선택한 항목 메타데이터 읽기 https://www.googleapis.com/auth/drive.addons.metadata.readonly

부가기능에서 사용자가 Drive에서 항목을 선택할 때 트리거되는 컨텍스트 인터페이스를 구현하는 경우에 필요합니다. 부가기능이 사용자가 Google Drive에서 선택한 항목에 대해 제한된 메타데이터를 읽도록 허용합니다. 메타데이터는 항목의 ID, 제목, MIME 유형, 아이콘 URL, 부가기능에 항목 액세스 권한이 있는지 여부로 제한됩니다.

파일별 액세스 https://www.googleapis.com/auth/drive.file

부가기능에서 개별 Drive 파일에 액세스해야 하는 경우 권장됩니다. Apps Script 고급 드라이브 서비스를 사용하여 앱에서 만들거나 연 파일에 대한 파일별 액세스 권한을 부여합니다. 하지만 기본 드라이브 서비스를 사용하여 비슷한 작업을 사용할 수는 없습니다. 파일 승인은 파일 단위로 부여되며 사용자가 앱을 승인 취소하면 취소됩니다.

선택한 파일의 파일 액세스 요청 예시를 참고하세요.

Gmail 부가기능 범위

사용자의 Gmail 데이터를 보호하는 데 도움이 되도록 Google Workspace 부가기능용으로 특별히 생성된 몇 가지 범위가 있습니다. 부가기능 코드에 필요한 다른 항목과 함께 부가기능 매니페스트에 이러한 범위를 명시적으로 추가해야 합니다.

다음은 Gmail을 확장하는 Google Workspace 부가기능에 자주 사용되는 범위입니다. 부가기능이 Gmail을 확장하는 경우 필수 라벨이 지정된 범위는 Google Workspace 부가기능 매니페스트에 추가해야 합니다.

또한 부가기능의 매우 광범위한 https://mail.google.com 범위를 부가기능에 필요한 상호작용과 더 이상 허용하지 않도록 하는 더 좁은 범위로 대체해야 합니다.

범위
새 초안 만들기 https://www.googleapis.com/auth/gmail.addons.current.action.compose

부가기능에서 작성 작업 트리거를 사용하는 경우 필요합니다. 부가기능에서 임시로 새 임시보관 메일 및 답장을 만들 수 있도록 허용합니다. 자세한 내용은 임시보관 메시지 작성을 참조하세요. 이 범위는 작성 작업에도 자주 사용됩니다. 액세스 토큰이 필요합니다.

열린 메시지 메타데이터 읽기 https://www.googleapis.com/auth/gmail.addons.current.message.metadata

열려 있는 메시지의 메타데이터 (예: 제목 또는 수신자)에 대한 임시 액세스 권한을 부여합니다. 메시지 콘텐츠 읽기를 허용하지 않으며 액세스 토큰이 필요합니다.

부가기능이 작성 작업 트리거에서 메타데이터를 사용하는 경우 필요합니다. 작성 작업의 경우 작성 트리거가 메타데이터에 액세스해야 하면 이 범위가 필요합니다. 실제로 이 범위를 사용하면 Compose에서 답장 이메일 초안의 액세스 수신자 목록 (받는사람:, 참조:, 숨은참조:)을 트리거할 수 있습니다.

열려 있는 메일 내용 읽기 https://www.googleapis.com/auth/gmail.addons.current.message.action

부가기능 메뉴 항목을 선택하는 경우와 같은 사용자 상호작용 시 열려 있는 메시지의 콘텐츠에 대한 액세스 권한을 부여합니다. 액세스 토큰이 필요합니다.

열린 대화목록 콘텐츠 읽기 https://www.googleapis.com/auth/gmail.addons.current.message.readonly

열려 있는 메시지의 메타데이터 및 콘텐츠에 대한 임시 액세스 권한을 부여합니다. 열린 대화목록에 있는 다른 메시지의 콘텐츠에 대한 액세스 권한도 부여합니다. 액세스 토큰이 필요합니다.

모든 메시지 콘텐츠 및 메타데이터 읽기 https://www.googleapis.com/auth/gmail.readonly

열린 메일을 포함하여 모든 이메일 메타데이터 및 콘텐츠를 읽습니다. 검색어를 실행하거나 전체 메일 대화목록을 읽을 때와 같이 다른 메시지에 관한 정보를 읽어야 할 때 필요합니다.

액세스 토큰

사용자 데이터를 보호하기 위해 Google Workspace 부가기능에서 사용되는 Gmail 범위는 사용자 데이터에 대한 임시 액세스 권한만 부여합니다. 임시 액세스를 사용 설정하려면 액세스 토큰을 인수로 사용하여 GmailApp.setCurrentMessageAccessToken(accessToken) 함수를 호출해야 합니다. 작업 이벤트 객체에서 액세스 토큰을 가져와야 합니다.

다음은 메시지 메타데이터에 액세스할 수 있도록 액세스 토큰을 설정하는 예입니다. 이 예에 필요한 유일한 범위는 https://www.googleapis.com/auth/gmail.addons.current.message.metadata입니다.

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

편집기 범위

다음은 Docs, Sheets, Slides를 확장하는 Google Workspace 부가기능에 자주 사용되는 범위입니다.

범위
현재 문서 파일 액세스 https://www.googleapis.com/auth/documents.currentonly

부가기능이 Apps Script Docs API에 액세스하는 경우에 필요합니다. 열려 있는 문서의 콘텐츠에 대한 임시 액세스 권한을 부여합니다.

현재 Sheets 파일 액세스 권한 https://www.googleapis.com/auth/spreadsheets.currentonly

부가기능이 Apps Script Sheets API에 액세스하는 경우 필요합니다. 열려 있는 스프레드시트의 콘텐츠에 대한 임시 액세스 권한을 부여합니다.

현재 Slides 파일 액세스 https://www.googleapis.com/auth/presentations.currentonly

부가기능이 Apps Script Slides API에 액세스하는 경우에 필요합니다. 열려 있는 프레젠테이션의 콘텐츠에 대한 임시 액세스 권한을 부여합니다.

파일별 액세스 https://www.googleapis.com/auth/drive.file

부가기능에서 onFileScopeGrantedTrigger를 사용하고 부가기능이 Docs, Sheets, Slides 또는 Drive API에 액세스하는 데 필요합니다. Apps Script 고급 드라이브 서비스를 사용하여 앱에서 만들거나 연 파일에 대한 파일별 액세스 권한을 부여합니다. 하지만 기본 드라이브 서비스를 사용하여 비슷한 작업을 사용할 수는 없습니다. 파일 승인은 파일 단위로 부여되며 사용자가 앱을 승인 취소하면 취소됩니다.

기타 범위

부가기능에서 다른 Apps Script 서비스를 사용하는 경우 추가 범위가 필요할 수 있습니다. 대부분의 경우 Apps Script에서 이러한 범위를 감지하고 매니페스트를 자동으로 업데이트하도록 할 수 있습니다. 매니페스트의 범위 목록을 수정할 때 범위를 더 적절한 대안(예: 더 좁은 범위)으로 교체하는 경우가 아니라면 범위를 삭제하지 마세요.

다음은 Google Workspace 부가기능과 함께 자주 사용되는 Apps Script 범위 목록입니다.

범위
사용자의 이메일 주소 읽기 https://www.googleapis.com/auth/userinfo.email

프로젝트가 현재 사용자의 이메일 주소를 읽도록 허용합니다.

외부 서비스에 대한 호출 허용 https://www.googleapis.com/auth/script.external_request

프로젝트에서 UrlFetch 요청을 수행할 수 있도록 허용합니다. 프로젝트에서 Apps Script용 OAuth2 라이브러리를 사용하는 경우에도 필요합니다.

사용자의 언어 및 시간대 읽기 https://www.googleapis.com/auth/script.locale

프로젝트가 현재 사용자의 언어와 시간대를 알 수 있도록 허용합니다. 자세한 내용은 사용자 언어 및 시간대 액세스를 참조하세요.

트리거 만들기 https://www.googleapis.com/auth/script.scriptapp

프로젝트가 트리거를 만들 수 있도록 허용합니다.

타사 링크 미리보기 https://www.googleapis.com/auth/workspace.linkpreview

부가기능에서 서드 파티 서비스의 링크를 미리 보는 경우에 필요합니다. 사용자가 Google Workspace 애플리케이션과 상호작용하는 동안 프로젝트가 Google Workspace 애플리케이션 내에서 링크를 볼 수 있도록 허용합니다. 자세한 내용은 스마트 칩으로 링크 미리보기를 참고하세요.

타사 리소스 만들기 https://www.googleapis.com/auth/workspace.linkcreate

부가기능이 서드 파티 서비스에서 리소스를 만드는 경우 필수 항목입니다. 프로젝트에서 사용자가 리소스 만들기 양식에 제출하는 정보를 읽고 Google Workspace 애플리케이션 내에서 리소스 링크를 삽입할 수 있도록 허용합니다. 자세한 내용은 @ 메뉴에서 서드 파티 리소스 만들기를 참고하세요.