라이브러리

라이브러리는 함수를 다른 스크립트에서 재사용할 수 있는 스크립트 프로젝트입니다.

경고: 라이브러리를 사용하는 스크립트는 모든 코드가 단일 스크립트 프로젝트 내에 포함된 경우와 비교하여 빠르게 실행되지 않습니다. 라이브러리를 사용하면 개발과 유지보수가 더 편리해지지만 속도가 중요한 프로젝트에서는 라이브러리를 가급적 사용하지 마세요. 이 문제로 인해 부가기능에서는 라이브러리 사용을 제한해야 합니다.

라이브러리 액세스 권한 획득

프로젝트에 라이브러리를 포함하려면 최소한 보기 수준의 액세스 권한이 있어야 합니다. 포함하려는 라이브러리의 작성자가 아닌 경우 작성자에게 문의하여 액세스 권한을 요청하세요.

포함하려는 라이브러리의 스크립트 ID가 필요합니다. 라이브러리에 액세스할 수 있는 경우 프로젝트 설정 페이지에서 스크립트 ID를 찾을 수 있습니다.

스크립트 프로젝트에 라이브러리 추가

1. Apps Script 편집기 왼쪽의 '라이브러리' 옆에 있는 라이브러리 추가 를 클릭합니다.
2. '스크립트 ID' 필드에 라이브러리의 스크립트 ID를 붙여넣습니다.
3. Look up을 클릭합니다.
   오류가 발생하면 포함하려는 프로젝트에 대한 뷰 수준 액세스 권한이 있는지 확인하세요.
4. 버전 드롭다운을 클릭하고 사용할 라이브러리 버전을 선택합니다.
5. 기본 '식별자' 이름이 이 라이브러리에서 사용하려는 이름인지 확인합니다. 스크립트에서 라이브러리를 참조하는 데 사용하는 이름입니다. 예를 들어 Test로 설정하면 다음과 같이 해당 라이브러리의 메서드를 호출할 수 있습니다. Test.libraryMethod()
   이미 존재하는 서비스의 이름(예: MailApp) 또는 이전에 추가된 라이브러리의 이름과 일치하는 식별자 이름을 사용하는 경우 가장 최근에 추가한 라이브러리가 기존 서비스 또는 라이브러리를 재정의합니다.
6. 추가를 클릭합니다.

라이브러리 사용

기본 서비스를 사용하는 것처럼 포함된 라이브러리를 사용합니다. 예를 들어 Test가 라이브러리의 식별자인 경우 Test 뒤에 마침표를 입력하여 라이브러리의 메서드 목록을 확인합니다.

포함된 라이브러리의 참조 문서는 다음 단계에 따라 열 수 있습니다.

스크립트 편집기 왼쪽의 라이브러리 이름 옆에 있는 더보기 > 새 탭에서 열기를 클릭합니다.

보관함 삭제

스크립트 편집기 왼쪽의 라이브러리 이름 옆에 있는 더보기 > 삭제 > 라이브러리 삭제를 클릭합니다.

저자가 라이브러리를 삭제한 경우에도 포함된 라이브러리 목록에서 라이브러리를 삭제해야 합니다.

라이브러리 업데이트

라이브러리 버전을 변경하거나 식별자를 업데이트할 수 있습니다.

1. 편집기 왼쪽의 '라이브러리'에서 라이브러리 이름을 클릭합니다.
2. 수정을 완료한 후 저장을 클릭합니다.

라이브러리 만들기 및 공유하기

스크립트 프로젝트를 라이브러리로 사용하고 공유하려면 아래 단계를 따르세요.

1. 스크립트의 버전이 지정된 배포를 만듭니다.
2. 라이브러리의 모든 잠재적 사용자와 최소한 보기 수준의 액세스 권한을 공유합니다.
3. 이러한 사용자에게 스크립트 ID를 제공합니다. 스크립트 ID는 프로젝트 설정 페이지에서 확인할 수 있습니다.

권장사항

다음은 라이브러리를 작성할 때 따라야 하는 가이드라인입니다.

1. 프로젝트의 의미 있는 이름을 선택하세요. 다른 사용자가 라이브러리를 포함할 때 기본 식별자로 사용되기 때문입니다.
2. 스크립트의 메서드 하나 이상을 라이브러리 사용자에게 표시하지 않거나 사용할 수 없도록 하려면 메서드 이름을 밑줄로 끝내면 됩니다. 예를 들면 myPrivateMethod_()입니다.
3. 라이브러리 사용자에게는 enumarable 전역 속성만 표시됩니다. 여기에는 함수 선언, var를 사용하여 함수 외부에서 만든 변수, 전역 객체에 명시적으로 설정된 속성이 포함됩니다. 예를 들어 enumerable가 false로 설정된 Object.defineProperty()는 라이브러리에서 사용할 수 있는 기호를 만들지만 사용자는 이 기호에 액세스할 수 없습니다.

4. 라이브러리 사용자가 스크립트 편집기 자동 완성과 자동 생성된 문서를 사용하려면 모든 함수에 JSDoc 스타일 문서가 있어야 합니다. 예를 들면 다음과 같습니다.

   /**
    * Raises a number to the given power, and returns the result.
    *
    * @param {number} base the number we're raising to a power
    * @param {number} exp the exponent we're raising the base to
    * @return {number} the result of the exponential calculation
    */
   function power(base, exp) { ... }
   

리소스 범위 지정

라이브러리를 사용할 때는 공유 리소스와 공유되지 않는 리소스라는 두 가지 유형의 리소스가 있습니다. 공유 리소스란 라이브러리와 포함 스크립트 모두 리소스의 동일한 인스턴스에 기본적으로 액세스할 수 있음을 의미합니다. 다음 다이어그램은 사용자 속성의 예를 사용하여 공유 리소스를 보여줍니다.

공유되지 않는 리소스란 라이브러리와 포함 스크립트 모두 리소스의 인스턴스에만 기본 제공되는 액세스 권한이 있음을 의미합니다. 그러나 라이브러리는 공유되지 않는 리소스에 작동하는 명시적 함수를 사용하여 액세스 권한을 제공할 수 있습니다. 다음은 라이브러리에 포함하여 스크립트 속성을 노출하는 함수의 예입니다.

  function getLibraryProperty(key) {
    return ScriptProperties.getProperty(key);
  }

다음 다이어그램은 스크립트 속성의 예를 사용하여 공유되지 않는 리소스를 보여줍니다.

다음 표에는 공유 리소스와 공유되지 않는 리소스가 나와 있습니다.

리소스	공유됨*	공유되지 않음**	참고
잠금			라이브러리에서 만들면 스크립트를 비롯한 모든 사용자에게 동일한 인스턴스가 표시됩니다.
스크립트 속성			라이브러리에서 만들면 스크립트를 비롯한 모든 사용자에게 동일한 인스턴스가 표시됩니다.
캐시			라이브러리에서 만들면 스크립트를 비롯한 모든 사용자에게 동일한 인스턴스가 표시됩니다.
트리거			라이브러리에서 만든 간단한 트리거는 포함 스크립트에 의해 트리거되지 않습니다.
ScriptApp
UiApp
사용자 속성
로거 및 실행 스크립트
사이트, 시트, 기타 컨테이너			getActive() 호출은 포함 스크립트의 컨테이너를 반환합니다.
MailApp 및 GmailApp
* 즉, 라이브러리에는 자체 기능/리소스 인스턴스가 없으며 대신 이를 호출한 스크립트에서 만든 인스턴스를 사용합니다. ** 즉, 라이브러리에는 자체 리소스/기능 인스턴스가 있으며 라이브러리를 사용하는 모든 스크립트는 동일한 인스턴스를 공유하고 이에 액세스할 수 있습니다.

라이브러리 테스트

라이브러리를 테스트하려면 헤드 배포를 사용하세요. 스크립트에 대한 편집자 수준 액세스 권한이 있는 사용자는 누구나 헤드 배포를 사용할 수 있습니다.

라이브러리 버전이 하나 이상 저장되어 있어야 합니다.

라이브러리 디버그

라이브러리가 포함된 프로젝트에서 디버거를 사용하면 포함된 라이브러리의 함수로 스텝 인할 수 있습니다. 코드가 보기 전용 모드로 디버거에 올바른 버전으로 표시됩니다.