Gmail-Manifest-Ressource

Die Ressourcenkonfiguration, die verwendet wird, um Inhalt und Verhalten von Google Workspace-Add-ons in Gmail zu definieren. Google Workspace-Add‑on-Manifeste müssen alle Komponenten enthalten, die als Erforderlich gekennzeichnet sind, wenn sie Gmail erweitern.

Gmail

Die Google Workspace-Add-on-Manifestkonfiguration 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 die Anforderungen für die Autorisierung durch Dritte prüft. Diese Funktion wird vor jedem Aufruf des Google Workspace-Add‑ons aufgerufen.

Diese Funktion wurde eingestellt, 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)

Für Compose-Aktionen erforderlich. Definiert die Benutzeroberflächen, die dem Nutzer beim Verfassen einer E-Mail zur Verfügung stehen.

Weitere Informationen finden Sie unter Compose-Benutzeroberfläche mit Compose-Aktionen erweitern.

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, wird eine bestimmte Apps Script-Funktion ausgeführt, in der Regel, um neue Karten zu erstellen und die Benutzeroberfläche 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

Die Konfiguration für eine Compose-Aktion. Weitere Informationen finden Sie unter Compose-UI erweitern.

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

string

Definiert die Ebene des Datenzugriffs, die für eine Compose-Triggerfunktion verfügbar ist. Gültige Optionen sind:

  • NONE (Standardeinstellung) Dadurch ist das Ereignisobjekt, das an die Compose-Triggerfunktion übergeben wird, größtenteils leer.
  • METADATA, wodurch das Ereignisobjekt, das an die Compose-Triggerfunktion übergeben wird, mit Listen von Empfängern der Nachricht gefüllt wird. Für diese Einstellung muss das Add-on den gmail.addons.current.message.metadata-Bereich enthalten.
selectActions[]

object (SelectAction)

Eine Liste von Compose-Aktionen, die Compose-UIs erstellen. Diese Liste ist jedoch auf eine einzelne Aktion pro Add-on beschränkt. Die Aktion „compose“ hat ein entsprechendes Symbol, das im Gmail-Fenster zum Verfassen von E-Mails angezeigt wird. Das Symbol wird durch gmail.logoUrl angegeben.

ContextualTrigger

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

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

Weitere Informationen zum Definieren dieser Funktion finden Sie unter Kontextbezogene Triggerfunktion.

unconditional

object

Erforderlich für jeden kontextbezogenen Trigger. Wird verwendet, um anzugeben, dass der kontextbezogene Trigger für alle Gmail-Nachrichten aktiviert wird, wenn sie geöffnet werden. Das ist derzeit die einzige Option. Daher sollte es sich immer um ein leeres Objekt handeln.

SelectAction

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

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

string

Für Compose-Aktionen erforderlich. Der Name der Apps Script-Funktion, die ausgeführt wird, wenn diese Compose-Aktion ausgewählt wird. Diese Compose-Triggerfunktion erstellt die Compose-Benutzeroberfläche des Add-ons.

Weitere Informationen finden Sie unter Triggerfunktion erstellen.

text

string

Für Compose-Aktionen erforderlich. Eine kurze Textbeschreibung dieser Compose-Aktion.