Biblioteki

Biblioteka to projekt skryptów, których funkcje można wykorzystać w innych skryptach.

Ostrzeżenie: skrypt korzystający z biblioteki nie działa tak szybko, jak gdyby cały kod był zawarty w pojedynczym projekcie skryptu. Chociaż biblioteki mogą ułatwić programowanie i konserwację, w projektach, w których szybkość ma kluczowe znaczenie. Z tego powodu korzystanie z biblioteki powinno być ograniczone w dodatkach.

Uzyskiwanie dostępu do biblioteki

Aby dołączyć do projektu bibliotekę, musisz mieć co najmniej poziom widoku dostęp do niej. Jeśli nie jesteś autorem biblioteki, którą chcesz należy skontaktować się z autorem i poprosić o dostęp.

Potrzebny jest identyfikator skryptu z biblioteki, którą chcesz dołączyć. Jeśli masz dostęp do biblioteki znajdziesz, identyfikator skryptu znajdziesz w ustawieniach projektu .

Dodawanie biblioteki do projektu skryptu

1. Po lewej stronie edytora Apps Script, obok pozycji „Biblioteki” kliknij Dodaj .
2. W polu „Identyfikator skryptu” wklej identyfikator skryptu z biblioteki.
3. Kliknij Wyszukaj.
   Jeśli napotkasz błąd, upewnij się, że Musisz mieć dostęp do projektu, który próbujesz, na poziomie widoku danych uwzględniania.
4. Kliknij menu Wersja i wybierz wersję biblioteki. których użyć.
5. Sprawdź, czy domyślny „Identyfikator” Wybierz tę, którą chcesz z tej biblioteki. Jest to nazwa, której skrypt używa do uzyskać dostęp do biblioteki. Jeśli na przykład ustawisz wartość Test, możesz: wywoła metodę tej biblioteki w następujący sposób: Test.libraryMethod().
   Jeśli używasz identyfikatora zgodnego z nazwą istniejącej już usługi, takiej jak MailApp lub poprzednio dodanej biblioteki, to biblioteka dodana jako ostatnia zastąpi z istniejącej usługi lub biblioteki.
6. Kliknij Dodaj.

Korzystanie z biblioteki

Korzystaj z dołączonej biblioteki tak samo jak z usługi domyślnej. Dla: na przykład jeśli Test jest identyfikatorem biblioteki, wpisz Test bezpośrednio z kropką, aby zobaczyć listę metod w bibliotece.

Dokumentację referencyjną biblioteki dołączonej można otworzyć, wykonując następujące czynności wykonaj te czynności:

Po lewej stronie edytora skryptów obok nazwy biblioteki kliknij Więcej. > Otwórz w nowej karcie.

Usuwanie biblioteki

Po lewej stronie edytora skryptów obok nazwy biblioteki kliknij Więcej. > Usuń > Usuń bibliotekę.

Jeśli biblioteka została usunięta przez autora, nadal musisz i usuń ją z listy uwzględnionych bibliotek.

Aktualizowanie biblioteki

Możesz zmienić wersję biblioteki lub zaktualizować jej identyfikator.

1. Po lewej stronie edytora, w sekcji „Biblioteki” kliknij nazwę biblioteki.
2. Wprowadź zmiany i kliknij Zapisz.

Tworzenie i udostępnianie biblioteki

Aby używać projektu skryptu i je udostępniać jako bibliotekę, wykonaj poniższe czynności.

1. Tworzenie wdrożenia z obsługą wersji Twojego skryptu.
2. Przyznaj wszystkim potencjalnym użytkownikom biblioteki dostęp co najmniej na poziomie widoku danych.
3. Podaj tym użytkownikom identyfikator skryptu, który znajdziesz w projekcie stronie ustawień .

Sprawdzone metody

Oto kilka wskazówek, których należy przestrzegać podczas pisania biblioteki:

1. Nadaj projektowi rozpoznawalną nazwę, ponieważ jest używana jako Domyślny identyfikator, jeśli do Twojej biblioteki dołączają inne osoby.
2. Jeśli chcesz, by co najmniej jedna metoda skryptu była niewidoczna (ani możesz zakończyć korzystanie z niej) użytkownikom biblioteki, podkreślenie. Na przykład: myPrivateMethod_().
3. Użytkownicy biblioteki widzą tylko wymienne właściwości globalne. Obejmuje to funkcję deklaracje, zmienne utworzone poza funkcją z użyciem parametru var oraz jawnie ustawione właściwości w obiekcie globalnym. np. Object.defineProperty() z wartością enumerable ustawioną na false powoduje utworzenie symbolu do wykorzystania w bibliotece, który nie jest dostępny dla użytkowników.

4. Jeśli chcesz, aby użytkownicy biblioteki korzystali z autouzupełniania i automatycznie wygenerowaną dokumentację, musisz mieć format JSDoc dokumentację wszystkich funkcji. Oto przykład:

   /**
    * 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) { ... }
   

Określanie zakresu zasobów

Dostępne są 2 typy zasobów podczas pracy z bibliotekami: i nieudostępnione. Zasób udostępniony oznacza, że zarówno biblioteka, jak i skrypt ma wbudowany dostęp do tej samej instancji zasobu. diagram przedstawiający udostępniony zasób z wykorzystaniem przykładu Właściwości użytkownika:

Jeśli zasób nie jest udostępniany, zarówno biblioteka, jak i skrypt dołączający mają dla wbudowanego dostępu wyłącznie do ich instancji zasobu. Biblioteka może jednak zapewnia dostęp do nieudostępnionych zasobów za pomocą jawnych funkcji, które na nich działa. Oto przykład funkcji, której można użyć w funkcji w bibliotece, aby udostępnić jej właściwości skryptu:

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

Poniższy diagram przedstawia nieudostępniany zasób z wykorzystaniem przykładu Właściwości skryptu:

Poniższa tabela zawiera dostępne i nieudostępnione zasoby informacyjne:

Zasób	Udostępnione*	Nieudostępnione**	Uwagi
Zablokuj			Ta sama instancja jest widoczna dla wszystkich (łącznie ze skryptami), gdy została utworzona w do biblioteki.
Właściwości skryptu			Ta sama instancja jest widoczna dla wszystkich (łącznie ze skryptami), gdy została utworzona w do biblioteki.
Cache (Pamięć podręczna)			Ta sama instancja jest widoczna dla wszystkich (łącznie ze skryptami), gdy została utworzona w do biblioteki.
Reguły			Proste aktywatory utworzone w bibliotece nie są wywoływane przez wywołanie skrypt.
ScriptApp
UiApp
Właściwości użytkownika
Rejestrator i transkrypcja wykonania
Witryny, Arkusze i inne kontenery			Wywołanie getActive() zwraca kontener klucza łącznie ze skryptem.
MailApp i GmailApp
* Oznacza to, że biblioteka nie ma własnego wystąpienia funkcję/zasób, a zamiast tego używa zasobu utworzonego przez skrypt który je wywołał. ** Oznacza to, że biblioteka ma własną instancję zasobu/funkcji oraz że wszystkie skrypty korzystające z biblioteki udostępniają i mają do nich dostęp w tej samej instancji.

Testowanie biblioteki

Aby przetestować bibliotekę, użyj wdrożenia głównego. Każdy, kto ma poziom edytora dostępu do skryptu może używać wdrożenia głównego.

Nadal potrzebujesz co najmniej 1 wersji biblioteki zapisane.

Debugowanie biblioteki

Gdy używasz debugera w projekcie, który zawiera bibliotekę za pomocą funkcji dostępnej w uwzględnionej bibliotece. Kod pojawi się w z debugera w trybie „tylko wyświetlanie” i w odpowiedniej wersji.