Gmail-Manifestdatei

Die Ressourcenkonfiguration, mit der der Inhalt und das Verhalten des Google Workspace-Add-ons in Gmail definiert werden. In den Manifestdateien des Google Workspace-Add-ons müssen alle Komponenten als Erforderlich gekennzeichnet sein, wenn sie Gmail erweitern.

Gmail

Manifestkonfiguration des Google Workspace-Add-ons für Gmail-Erweiterungen Weitere Informationen finden Sie unter Gmail mit Google Workspace-Add-ons erweitern.

JSON-Darstellung
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Felder
authorizationCheckFunction

string

Veraltet. Der Name einer Apps Script-Funktion, die Überprüfungen von Drittanbieter-Autorisierungsanforderungen durchführt. Diese Funktion wird vor jedem Aufruf des Google Workspace-Add-ons aufgerufen.

Diese Funktion wurde verworfen, um unnötige Ausführungslatenz zu vermeiden. Stattdessen sollte das Add-on eine Ausnahme vom Hauptaufruf auslösen, wie in diesem Beispiel gezeigt.

composeTrigger

object (ComposeTrigger)

Erforderlich beim Schreiben einer E-Mail. Definiert die Benutzeroberflächen, die dem Nutzer beim Schreiben einer E-Mail zur Verfügung stehen.

Weitere Informationen finden Sie unter Benutzeroberfläche zum Schreiben einer Nachricht um Nachrichten schreiben.

contextualTriggers[]

object (ContextualTrigger)

Erforderlich. Eine Liste der Trigger, die ausgelöst werden, wenn eine Nachricht in Gmail geöffnet wird. Wenn der Trigger ausgelöst wird, führt er eine bestimmte Apps Script-Funktion aus, in der Regel, um neue Karten zu erstellen und die UI zu aktualisieren.
homepageTrigger

object (HomepageTrigger)

Die Spezifikation der Triggerfunktion zum Erstellen der Startseite des Add-ons im Gmail-Host. Dadurch wird addOns.common.homepageTrigger überschrieben.

ComposeTrigger erstellen

Die Konfiguration für eine Erstellungsaktion. Weitere Informationen finden Sie unter Neue Benutzeroberfläche erweitern.

JSON-Darstellung
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Felder
draftAccess

string

Definiert die Ebene des Datenzugriffs, die einer Zusammensetzungs-Triggerfunktion zur Verfügung steht. Gültige Optionen:

  • NONE ist die Standardeinstellung. Dies führt dazu, dass das an die Triggerfunktion „compose“ übergebene Ereignisobjekt fast leer ist.
  • METADATA, über den das an die Triggerfunktion übergebene Ereignisobjekt mit Listen der Empfänger der Nachricht gefüllt wird. Für diese Einstellung muss das Add-on den Bereich gmail.addons.current.message.metadata enthalten.
selectActions[]

object (SelectAction)

Eine Liste von Erstellungsaktionen, mit denen Erstellungs-UIs erstellt werden. Diese Liste ist jedoch auf eine einzige Aktion pro Add-on beschränkt. Im Editorfenster von Gmail wird dann ein entsprechendes Symbol angezeigt. Das Symbol wird durch gmail.logoUrl angegeben.

Kontext-Trigger

Die Konfiguration für einen Trigger, der ausgelöst wird, wenn der Nutzer eine Gmail-Nachricht öffnet und diese Nachricht bestimmte Kriterien erfüllt. Weitere Informationen finden Sie unter Nachrichten-UI erweitern.

JSON-Darstellung
{
  "onTriggerFunction": string,
  "unconditional": {},
}
Felder
onTriggerFunction

string

Für jeden kontextbezogenen Trigger erforderlich. Der Name der Apps Script-Funktion, die ausgeführt wird, wenn der Trigger ausgelöst wird.

Weitere Informationen zur Definition dieser Funktion finden Sie unter Kontexttriggerfunktion.

unconditional

object

Für jeden kontextbezogenen Trigger erforderlich. Damit wird angegeben, dass der kontextabhängige Trigger für alle Gmail-Nachrichten aktiviert wird, wenn sie geöffnet werden. Das ist derzeit die einzige Option, es sollte also immer ein leeres Objekt sein.

SelectAction

Die Konfiguration der Zusammensetzungsaktion, die definiert, welche Funktion ausgeführt werden soll, wenn der Nutzer die Zusammensetzungsaktion auswählt.

JSON-Darstellung
{
  "runFunction": string,
  "text": string
}
Felder
runFunction

string

Erforderlich beim Schreiben einer E-Mail. Der Name der Apps Script-Funktion, die ausgeführt wird, wenn diese Erstellungsaktion ausgewählt wird. Diese Funktion erstellt die Add-on-Benutzeroberfläche zum Schreiben.

Weitere Informationen finden Sie unter Triggerfunktion erstellen.

text

string

Erforderlich beim Schreiben einer E-Mail. Eine kurze Textbeschreibung dieser Erstellungsaktion.