편집자 부가기능의 승인 범위

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

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

URL 문자열을 사용하여 매니페스트에서 범위를 선언합니다. 승인 흐름 중에 Apps Script는 범위에 관한 사람이 읽을 수 있는 설명을 사용자에게 제공합니다. 예를 들어 부가기능은 매니페스트에서 https://www.googleapis.com/auth/documents.currentonly로 작성된 '현재 문서 읽기' 범위를 사용할 수 있습니다. 승인 절차 중에 이 범위의 부가기능은 사용자에게 이 애플리케이션이 설치된 문서 보기 및 관리 작업을 허용하도록 요청합니다.

보기 범위

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

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

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

명시적 범위 설정

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

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

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

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

    {
      ...
      "oauthScopes": [
        "https://www.googleapis.com/auth/script.container.ui",
        "https://www.googleapis.com/auth/spreadsheets.currentonly"
      ],
      ...
    }
    

  5. 매니페스트 파일 변경사항을 저장합니다.

OAuth 확인

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

제한된 범위

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

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

편집자 부가기능 범위

편집자 부가기능을 빌드할 때 필요한 범위는 부가기능 코드에서 사용하는 Apps Script 서비스 및 메서드에 따라 결정됩니다. 예를 들어 스프레드시트 부가기능에 다른 Google 스프레드시트의 정보를 읽으려면 https://www.googleapis.com/auth/spreadsheets.readonly 범위가 필요할 수 있습니다.

Apps Script는 스크립트 프로젝트에 코드를 추가할 때 사용하는 서비스에 필요한 범위를 자동으로 결정합니다. 편집기 부가기능의 경우 직접 범위를 결정하고 명시적으로 설정하는 대신 이 자동 범위 수집을 사용할 수 있는 경우가 많습니다.

범위를 명시적으로 설정하지 않고 편집기 부가기능이 열린 편집기 파일을 읽거나 쓰기만 하는 경우 스크립트 프로젝트 파일 중 하나에 다음 주석을 추가합니다.

  /**
   * @OnlyCurrentDoc
   */

이 주석은 설정된 편집기 파일 범위를 currentonly로 좁히도록 Apps Script에 지시합니다. 예를 들어 Google Sheets 부가기능 스크립트 프로젝트 파일에 이 주석을 추가하는 경우 부가기능에 현재 열려 있는 시트에서만 작업할 수 있는 권한만 필요하고 사용자가 Google Drive에 보유하고 있을 수 있는 다른 Sheets에는 권한이 필요하지 않다고 지정합니다. 반대로, Sheets 부가기능에서 사용자가 현재 열지 않은 시트의 데이터를 읽거나 써야 하는 경우에는 이 주석을 사용해서는 안 됩니다.