Bibliotheken

Eine Bibliothek ist ein Skriptprojekt, dessen Funktionen in anderen Skripts wiederverwendet werden können.

Warnung: Ein Script, das eine Bibliothek verwendet wird nicht so schnell ausgeführt als wenn der gesamte Code in einem einzelnen Skriptprojekt enthalten wäre. Auch wenn Bibliotheken die Entwicklung und Wartung komfortabel machen können, verwenden Sie in Projekten, in denen Geschwindigkeit ausschlaggebend ist, sparsam einsetzen. Aus diesem Grund sollte die Nutzung der Bibliothek in Add-ons eingeschränkt sein.

Zugriff auf eine Mediathek erhalten

Wenn Sie Ihrem Projekt eine Bibliothek hinzufügen möchten, müssen Sie mindestens die Ansichtsebene haben darauf zugreifen können. Wenn Sie nicht der Autor der Bibliothek sind, die Sie lesen möchten Kontakt mit dem Autor aufnehmen und Zugriff anfordern.

Sie benötigen die Skript-ID der Bibliothek, die Sie einbinden möchten. Wenn Sie Zugriff auf die Bibliothek haben, finden Sie die Skript-ID in den Projekteinstellungen. Seite.

Bibliothek dem Skriptprojekt hinzufügen

1. Klicken Sie links im Apps Script-Editor neben „Libraries“ (Bibliotheken) auf „Add a“ (Hinzufügen) Bibliothek .
2. Im Feld „Skript-ID“ fügen Sie die Skript-ID der Bibliothek ein.
3. Klicken Sie auf Suchen.
   Wenn ein Fehler auftritt, Sie müssen mindestens Zugriff auf Ansichtsebene für das Projekt haben, enthalten.
4. Klicken Sie auf das Drop-down-Menü Version und wählen Sie die Version der Bibliothek aus. zu verwenden.
5. Überprüfen Sie, ob die Standard-ID Name ist der Name, den Sie Bibliothek verwenden können. Dies ist der Name, mit dem Ihr Skript auf die Bibliothek verweisen. Wenn Sie ihn beispielsweise auf Test festlegen, können Sie rufen Sie eine Methode dieser Bibliothek auf: Test.libraryMethod().
   Wenn Sie einen Bezeichnernamen verwenden, der mit dem Namen einem bereits vorhandenen Dienst wie MailApp oder ein früherer Hinzugefügte Bibliothek überschreibt, überschreibt die zuletzt von Ihnen hinzugefügte Bibliothek vorhandenen Dienst oder Bibliothek vorhanden sind.
6. Klicken Sie auf Hinzufügen.

Bibliothek verwenden

Verwenden Sie die enthaltene Bibliothek wie einen Standarddienst. Für Wenn beispielsweise Test die ID für Ihre Bibliothek ist, geben Sie Test gefolgt von einem Punkt, um die Liste der Methoden in der Bibliothek aufzurufen.

Die Referenzdokumentation für eine enthaltene Bibliothek kann folgendermaßen geöffnet werden: diese Schritte:

Klicken Sie links im Skripteditor neben dem Namen der Bibliothek auf das Dreipunkt-Menü > In neuem Tab öffnen.

Bibliothek entfernen

Klicken Sie links im Skripteditor neben dem Namen der Bibliothek auf das Dreipunkt-Menü > Entfernen > Mediathek entfernen.

Wenn eine Bibliothek vom Autor gelöscht wurde, müssen Sie noch Folgendes tun: aus der Liste der enthaltenen Bibliotheken entfernen.

Mediathek aktualisieren

Sie können die Version der Bibliothek ändern oder ihre ID aktualisieren.

1. Klicken Sie links im Editor unter „Libraries“ (Bibliotheken) auf den Namen der Bibliothek.
2. Nehmen Sie die gewünschten Änderungen vor und klicken Sie auf Speichern.

Fotogalerie erstellen und teilen

Führen Sie die folgenden Schritte aus, um Ihr Skriptprojekt als Bibliothek zu verwenden und freizugeben.

1. Versionierte Bereitstellung erstellen des Skripts.
2. Teilen Sie allen potenziellen Nutzern der Bibliothek mindestens den Zugriff auf Datenansichtsebene.
3. Geben Sie diesen Nutzern die Skript-ID, die Sie im Projekt Einstellungen .

Best Practices

Hier sind einige Richtlinien, die Sie beim Schreiben einer Bibliothek beachten sollten:

1. Wählen Sie einen aussagekräftigen Namen für Ihr Projekt, da er als Standardkennung, wenn Ihre Bibliothek von anderen Nutzern verwendet wird.
2. Wenn eine oder mehrere Methoden Ihres Skripts nicht sichtbar sein sollen (noch verwendbar) haben, können Sie am Ende des Namens der Methode ein Unterstrich setzen. Beispiel: myPrivateMethod_().
3. Nur aufzählbare globale Attribute sind für Bibliotheksnutzer sichtbar. Dies beinhaltet die Funktion Deklarationen, Variablen, die außerhalb einer Funktion mit var erstellt wurden, und explizit festgelegte Attribute für das globale Objekt. Beispiel: Object.defineProperty(), wobei enumerable auf false festgelegt ist erstellt ein Symbol, das Sie in Ihrer Bibliothek verwenden können. Dieses Symbol ist für Ihre Nutzer jedoch nicht zugänglich.

4. Wenn die Nutzer Ihrer Bibliothek die automatische Vervollständigung des Script-Editors automatisch generierte Dokumentation, müssen Sie das JSDoc-Format verwenden, Dokumentation für alle Funktionen. Beispiel:

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

Ressourcenumfang festlegen

Bei der Arbeit mit Bibliotheken gibt es zwei Arten von Ressourcen: freigegebene Ressourcen und nicht freigegeben. Eine gemeinsam genutzte Ressource bedeutet, dass sowohl die Bibliothek als auch die Integrierten Zugriff auf dieselbe Instanz der Ressource haben. Die Das folgende Diagramm zeigt eine gemeinsam genutzte Ressource am Beispiel Nutzereigenschaften:

Eine nicht gemeinsam genutzte Ressource bedeutet, dass sowohl die Bibliothek als auch das einschließlich des Skripts Zugriff nur auf die Instanz der Ressource gewähren. Eine Bibliothek kann jedoch Zugriff auf nicht gemeinsam genutzte Ressourcen gewähren, indem sie explizite Funktionen haben, damit sie von ihnen bearbeitet werden können. Hier ist ein Beispiel für eine Funktion, die Sie in eine Ihrer Bibliothek, um die zugehörigen Skripteigenschaften bereitzustellen:

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

Das folgende Diagramm zeigt eine nicht freigegebene Ressource am Beispiel Skripteigenschaften:

In der folgenden Tabelle sind die freigegebenen und nicht freigegebenen Ressourcen aufgeführt:

Ressource	Freigegeben*	Nicht geteilt**	Hinweise
Sperren			Dieselbe Instanz ist für alle sichtbar, auch für Skripts, wenn sie in erstellt werden. in der Bibliothek.
Skripteigenschaften			Dieselbe Instanz ist für alle sichtbar, auch für Skripts, wenn sie in erstellt werden. in der Bibliothek.
Cache			Dieselbe Instanz ist für alle sichtbar, auch für Skripts, wenn sie in erstellt werden. der Bibliothek.
Trigger			Einfache Trigger, die in der Bibliothek erstellt wurden, werden nicht durch die Einbeziehung .
ScriptApp
UiApp
Nutzereigenschaften
Protokollierung und Ausführungstranskript
Google Sites, Google Tabellen und andere Container			Ein Aufruf von getActive() gibt den Container der einschließlich Skript.
MailApp und GmailApp
* Dies bedeutet, dass die Bibliothek keine eigene Instanz des Feature/Ressource und verwendet stattdessen die vom Skript erstellte die sie aufgerufen haben. ** Dies bedeutet, dass die Bibliothek eine eigene Instanz der Ressource/Funktion hat. und dass alle Skripts, die die Bibliothek verwenden, auf derselben Instanz.

Bibliothek testen

Testen Sie Ihre Bibliothek mit der Head-Bereitstellung. Alle Nutzer mit Bearbeitungsberechtigung kann der Zugriff auf das Skript die Head-Bereitstellung verwenden.

Sie benötigen noch mindestens eine Version der Bibliothek gespeichert.

Bibliotheksfehler beheben

Wenn Sie den Debugger in einem Projekt verwenden, das eine Bibliothek enthält, in eine Funktion der enthaltenen Bibliothek eintreten kann. Der Code erscheint in Debugger im Lesemodus und in der richtigen Version aufrufen.