Package apps.extensions.markup

Index

CalendarClientActionMarkup

Felder
editAttendeesActionMarkup

EditAttendeesActionMarkup

Eine Aktion, mit der dem Google Kalender-Termin Teilnehmer hinzugefügt werden.
editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Eine Aktion, mit der dem Google Kalender-Termin Konferenzdaten hinzugefügt werden. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.
addAttachmentsActionMarkup

AddAttachmentsActionMarkup

Eine Aktion, mit der dem Google Kalender-Termin Anhänge hinzugefügt werden.
createConferenceDataActionMarkup

CreateConferenceDataActionMarkup

Eine Aktion, die Konferenzdaten anzeigt, wenn Sie einen Google Kalender-Termin erstellen.
createConferenceSettingUrlActionMarkup

CreateConferenceSettingUrlActionMarkup

Eine Aktion, mit der die URL für die Einstellung „Konferenz erstellen“ generiert wird.
calendarSubscriptionActionMarkup

CalendarSubscriptionActionMarkup

Eine Aktion, mit der ein Kalenderabo verwaltet wird. Unterstützt nur die Erstellung von Abos in Add-ons für HTTP-Endpunkte. Gilt nicht für Apps Script-Add‑ons.

AddAttachmentsActionMarkup

Felder
addonAttachments[]

AddonAttachment

AddonAttachment

Felder
resourceUrl

string
title

string

Titel des Anhangs.
mimeType

string

MIME-Typ des Inhalts in „resourceUrl“.
iconUrl

string

Link zum Symbol der Ressource.

CalendarSubscriptionActionMarkup

Felder
operation

Operation

Der auszuführende Vorgang. Derzeit wird nur CREATE unterstützt.
calendarId

string

Die Kalender-ID, die abonniert werden soll.

Vorgang

Enums
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

Markup, das Konferenzdaten definiert, die mit einem Google Kalender-Termin verknüpft sind. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

Felder
conferenceId

string

Eindeutige Kennung für diese Konferenzdaten. Maximal 512 Zeichen lang.
entryPoints[]

EntryPointMarkup

Einstiegspunkte für die Konferenz. Es sind maximal 300 Einstiegspunkte zulässig.
parameters[]

Parameter

Zusätzliche Add-on-Parameter. Es sind maximal 300 Parameter zulässig.
error

Error

Wenn festgelegt, bedeutet dies, dass beim Erstellen der Videokonferenz ein Fehler aufgetreten ist.
note

string

Zusätzliche Hinweise, die dem Nutzer angezeigt werden sollen, z. B. Anweisungen des Administrators oder rechtliche Hinweise. Kann HTML enthalten. Maximale Länge: 2.048 Zeichen.
conferenceSolutionId

string

Eine Kennzeichnung der Konferenzlösung. Muss mit einem Wert aus dem Feld calendar.conferenceSolution.id der Bereitstellung übereinstimmen.

EntryPointMarkup

Eine Möglichkeit, an der Konferenz teilzunehmen. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

Felder
type

Type

Der Typ des Einstiegspunkts. Erforderlich.
uri

string

Ein URI für die Teilnahme an der Konferenz. Unterstützt tel: und http(s): und darf maximal 1.300 Zeichen lang sein. Erforderlich.
label

string

Das Label des Einstiegspunkts, das dem Nutzer angezeigt werden soll. Maximal 512 Zeichen lang.
meetingCode

string

Ein Besprechungscode für den Zugriff auf die Konferenz. Maximal 128 Zeichen lang.
accessCode

string

Ein Zugangscode für den Zugriff auf die Konferenz. Maximal 128 Zeichen lang.
passcode

string

Ein Sicherheitscode für den Zugriff auf die Konferenz. Maximal 128 Zeichen lang.
password

string

Ein Passwort für den Zugriff auf die Videokonferenz. Maximal 128 Zeichen lang.
pin

string

Eine PIN für den Zugriff auf die Konferenz. Maximal 128 Zeichen lang.
regionCode

string

Der CLDR-/ISO 3166-Regionscode für das Land, das mit diesem Einstiegspunkt verknüpft ist. Gilt nur für Type.PHONE.
features[]

Feature

Merkmale des Einstiegspunkts, z. B. ob er gebührenpflichtig oder gebührenfrei ist. Ein Einstiegspunkt kann mehrere Funktionen haben.

Funktion

Funktionen des Einstiegspunkts. Einige Funktionen gelten möglicherweise nur für bestimmte Einstiegspunkte.

Enums
UNKNOWN_FEATURE Unbekannte Funktion.
TOLL Gilt für den Einstiegspunkt PHONE. Anrufe bei gebührenpflichtigen Nummern werden dem Anrufer in Rechnung gestellt. Eine Nummer kann nicht gleichzeitig gebührenpflichtig und gebührenfrei sein.
TOLL_FREE Gilt für den Einstiegspunkt PHONE. Für den Anrufer ist ein Anruf bei einer gebührenfreien Rufnummer kostenlos. Eine Nummer kann nicht gleichzeitig gebührenpflichtig und gebührenfrei sein.

Typ

Der Typ des Einstiegspunkts. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

Enums
UNKNOWN Unbekannter Konferenztyp.
VIDEO Eine Videokonferenz.
PHONE Eine Telefonkonferenz.
MORE Wird verwendet, um einen Link zu weiteren Informationen zum Beitreten einer Videokonferenz bereitzustellen.
SIP Eine Konferenz mit dem Session Initiation Protocol

Fehler

Stellt einen Fehler dar, der beim Erstellen einer Videokonferenz aufgetreten ist. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

Felder
type

Type

Der Fehlertyp. Erforderlich.
authenticationUrl

string

Wenn der Fehlertyp AUTHENTICATION ist, kann das Add-on eine URL bereitstellen, über die sich Nutzer anmelden können. Maximale Länge: 1.300 Zeichen.

Typ

Enums
UNKNOWN Unbekannter Fehler.
AUTHENTICATION Ein Authentifizierungsfehler.
TEMPORARY Ein vorübergehender Fehler.
PERMANENT Ein dauerhafter Fehler.
PERMISSION_DENIED Der Nutzer darf im Drittanbieter-Videokonferenzsystem keine bestimmte Aktion ausführen.
CONFERENCE_SOLUTION_FORBIDDEN Der Nutzer darf die ausgewählte Videokonferenzlösung nicht verwenden, möglicherweise aber andere Lösungen, die vom Add-on angeboten werden.

Parameter

Lösungsspezifische Parameter, die mit den Ereignisdaten gespeichert werden und bei einer Aktualisierung oder Löschung an das Add-on übergeben werden. Beispiel: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

Felder
key

string

Der Schlüssel des Parameters. Maximal 50 Zeichen lang. Erforderlich.
value

string

Wert des Parameters. Darf maximal 1.024 Zeichen lang sein. Erforderlich.

CreateConferenceDataActionMarkup

Felder
createConferenceData

ConferenceDataMarkup

Die Konferenzdaten, die beim Erstellen eines Google Kalender-Termins hinzugefügt werden sollen.

CreateConferenceSettingUrlActionMarkup

Felder
settingsUrl

string

Der URI für eine vom Add‑on generierte Einstellungsseite.

EditAttendeesActionMarkup

Felder
addAttendeeEmails[]

string

Eine Liste mit Teilnehmern, die dem Google Kalender-Termin hinzugefügt werden sollen.

EditConferenceDataActionMarkup

Felder

Union-Feld conference.

Für conference ist nur einer der folgenden Werte zulässig:
conferenceData

ConferenceDataMarkup

Die Konferenzdaten, die dem Google Kalender-Termin hinzugefügt werden sollen. Konferenz-Add-ons von Drittanbietern können nur in Apps Script erstellt werden.

ChatClientDataSourceMarkup

Für ein SelectionInput-Widget, das ein Menü mit Mehrfachauswahl verwendet, eine Datenquelle aus Google Chat. Die Datenquelle füllt die Auswahlmöglichkeiten für das Menü mit Mehrfachauswahl aus. Ein Nutzer kann beispielsweise Google Chat-Gruppenbereiche auswählen, in denen er Mitglied ist.

 Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

Felder
Union-Feld source. Die Google Chat-Datenquelle. Für source ist nur einer der folgenden Werte zulässig:
spaceDataSource

SpaceDataSource

Google Chat-Gruppenbereiche, in denen der Nutzer Mitglied ist.

SpaceDataSource

Eine Datenquelle, die Google Chat-Bereiche als Auswahlmöglichkeiten für ein Mehrfachauswahlmenü enthält. Es werden nur Spaces ausgefüllt, in denen der Nutzer Mitglied ist.

 Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

Felder
defaultToCurrentSpace

bool

Wenn der Wert auf true festgelegt ist, wird im Menü zur Mehrfachauswahl standardmäßig der aktuelle Google Chat-Bereich als Element ausgewählt.

ChatDataActionMarkup

Erstellt oder aktualisiert eine Nachricht in Google Chat. Weitere Informationen finden Sie unter Google Chat-Oberflächen erstellen.

Felder
Union-Feld action. Eine Google Chat-Aktion. Für action ist nur einer der folgenden Werte zulässig:
createMessageAction

CreateMessageAction

Sendet eine Nachricht als Google Chat-App.
updateMessageAction

UpdateMessageAction

Aktualisiert eine Nachricht einer Google Chat-App.
updateInlinePreviewAction

UpdateInlinePreviewAction

Wenn Sie Links in der Vorschau ansehen, werden der Nachricht eines Google Chat-Nutzers eine oder mehrere Karten hinzugefügt.

CreateMessageAction

Die Chat-App sendet eine Nachricht. Weitere Informationen finden Sie unter Google Chat-Nachrichten senden.

Felder
message

Message

Die Google Chat-Nachricht.

UpdateInlinePreviewAction

In der Chat-App wird eine Vorschau eines Links in einer Nachricht angezeigt, indem eine oder mehrere Karten hinzugefügt oder aktualisiert werden. Weitere Informationen finden Sie im Hilfeartikel Vorschau von Links in Google Chat-Nachrichten.

Felder
cardsV2[]

CardWithId

Ein Array mit einer oder mehreren Karten.

UpdateMessageAction

Die Chat-App aktualisiert Text oder Karten in einer Nachricht. Weitere Informationen finden Sie unter Google Chat-Nachrichten senden.

Felder
message

Message

Die aktualisierte Nachricht.

DriveClientActionMarkup

Felder
requestFileScope

RequestFileScope

RequestFileScope

Felder
itemId

string

EditorClientActionMarkup

Felder

Union-Feld action.

Für action ist nur einer der folgenden Werte zulässig:
requestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

Dieser Typ hat keine Felder.

GmailClientActionMarkup

Felder

Union-Feld type.

Für type ist nur einer der folgenden Werte zulässig:
taskAction

TaskActionMarkup
updateDraftActionMarkup

UpdateDraftActionMarkup
openCreatedDraftActionMarkup

OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup

AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

Felder
type

AddonComposeUiActionType

AddonComposeUiActionType

Enums
UNSPECIFIED Standard. Wenn nichts angegeben ist, wird keine Aktion ausgeführt.
DISMISS Schließt die Benutzeroberfläche zum Verfassen von Add-ons.

OpenCreatedDraftActionMarkup

Felder
draftId

string

Die ID des neu erstellten Entwurfs im Format „r123“.
draftStorageId

string

Die Server-Speicher-ID im Hexadezimalformat, z. B. „15e9fa622ce1029d“.
draftThreadServerPermId

string

Die permanente Server-ID für den Thread des Entwurfs. Dieses Feld wird nirgends festgelegt und bei der Verarbeitung von OpenCreatedDraftActionMarkup ignoriert. Geben Sie stattdessen „draftThreadStorageId“ an und verwenden Sie diese.
draftThreadId

string

Die ID des Threads, der den neu erstellten Entwurf enthält, z. B. „15e9fa622ce1029d“.

TaskActionMarkup

Felder
reloadTasks

bool

UpdateDraftActionMarkup

Felder
updateBody

UpdateBody

Ein Feld, das eine Reihe von Aktualisierungsaktionen enthält, die für den Entwurfstext ausgeführt werden sollen, den der Nutzer gerade bearbeitet.
updateToRecipients

UpdateToRecipients

Wenn diese Option festgelegt ist, werden die vorhandenen „An“-Empfänger des Entwurfs, den der Nutzer gerade bearbeitet, ersetzt.
updateCcRecipients

UpdateCcRecipients

Wenn diese Option festgelegt ist, werden die vorhandenen CC-Empfänger des Entwurfs, den der Nutzer gerade bearbeitet, ersetzt.
updateBccRecipients

UpdateBccRecipients

Wenn festgelegt, werden die vorhandenen BCC-Empfänger des Entwurfs, den der Nutzer gerade bearbeitet, ersetzt.
updateSubject

UpdateSubject

Wenn festgelegt, wird die vorhandene Betreffzeile des Entwurfs, den der Nutzer gerade bearbeitet, ersetzt.

Empfänger

Felder
email

string

UpdateBccRecipients

Felder
bccRecipients[]

Recipient

UpdateBody

Felder
insertContents[]

InsertContent

Ein wiederholtes Feld, das eine Reihe von Inhalten enthält, die in den Entwurf eingefügt werden sollen, den der Nutzer gerade bearbeitet. Der Inhalt kann HTML- oder Nur-Text-Inhalte enthalten.
type

Type

ContentType

Enums
UNSPECIFIED_CONTENT_TYPE Standardwert, wenn nichts für ContentType festgelegt ist.
TEXT Gibt an, dass der Inhalt als Nur-Text vorliegt.
MUTABLE_HTML Gibt an, dass der Inhalt in HTML vorliegt und geändert werden kann.
IMMUTABLE_HTML Gibt an, dass der Inhalt in HTML vorliegt und unveränderlich ist (nicht bearbeitet werden kann).

EmailMimeType

EmailMimeType ist veraltet. Verwenden Sie ContentType.

Enums
UNSPECIFIED_EMAIL_MIME_TYPE Standardwert, wenn für EmailMimeType nichts festgelegt ist.
PLAIN_TEXT Gibt an, dass der eingefügte Inhalt als Nur-Text vorliegt.
HTML Gibt an, dass der eingefügte Inhalt in HTML ist.

InsertContent

Felder
content

string

Der einzufügende Inhalt.
mimeType
(deprecated)

EmailMimeType
contentType

ContentType

Der Typ des eingefügten Inhalts.

Typ

Enums
UNSPECIFIED_ACTION_TYPE Standardwert, wenn für „Typ“ nichts festgelegt ist.
IN_PLACE_INSERT Gibt an, dass mit dieser Aktion eine Einfügung an Ort und Stelle erfolgen soll. Standardmäßig werden die Inhalte an der aktuellen Cursorposition eingefügt. Wenn Inhalte ausgewählt sind, werden sie durch die eingefügten Inhalte ersetzt.
INSERT_AT_START Gibt an, dass diese Aktion das Einfügen am Anfang des Nachrichtentexts vorsieht.
INSERT_AT_END Gibt an, dass mit dieser Aktion am Ende des Nachrichtentexts eingefügt werden soll.
REPLACE Gibt an, dass durch diese Aktion der Nachrichtentext ersetzt werden soll.

UpdateCcRecipients

Felder
ccRecipients[]

Recipient

UpdateSubject

Felder
subject

string

UpdateToRecipients

Felder
toRecipients[]

Recipient

HostAppActionMarkup

Aktionen, die von einzelnen Host-Apps verarbeitet werden.

Felder

Union-Feld action.

Für action ist nur einer der folgenden Werte zulässig:
gmailAction

GmailClientActionMarkup

Von Gmail ausgeführte Aktionen
calendarAction

CalendarClientActionMarkup

Von Google Kalender ausgeführte Aktionen
driveAction

DriveClientActionMarkup

Aktionen, die von Drive ausgeführt werden.
editorAction

EditorClientActionMarkup

Aktionen, die von Google Docs, Google Sheets oder Google Präsentationen verarbeitet werden.
sheetsAction

SheetsClientActionMarkup

Von Google Sheets verarbeitete Aktionen.

HostAppDataActionMarkup

Definiert, wie Google Workspace-Daten aktualisiert werden.

Felder
Union-Feld action. Die Add-on-Aktion für eine bestimmte Google Workspace-Hostanwendung. Für action ist nur einer der folgenden Werte zulässig:
chatDataAction

ChatDataActionMarkup

Eine Google Chat-Aktion, mit der Text oder Karten in einer Nachricht erstellt oder aktualisiert werden.

HostAppDataSourceMarkup

Eine Datenquelle aus einer Google Workspace-Anwendung. Die Datenquelle füllt die verfügbaren Elemente für ein Widget.

Felder
Union-Feld data_source. Die Google Workspace-Anwendung, die verfügbare Elemente für ein Widget bereitstellt. Für data_source ist nur einer der folgenden Werte zulässig:
chatDataSource

ChatClientDataSourceMarkup

Eine Datenquelle aus Google Chat.

SheetsClientActionMarkup

Nächste ID: 5.

Felder

Union-Feld action.

Für action ist nur einer der folgenden Werte zulässig:
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

Das Ergebnis der Ausführung einer benutzerdefinierten Funktion durch einen Nutzer.

Felder
Union-Feld result. Das Ergebnis der Ausführung der benutzerdefinierten Funktion. Für result ist nur einer der folgenden Werte zulässig:
value

Value

Der Wert, der sich aus der Ausführung der benutzerdefinierten Funktion ergeben hat.
errorMessage

string

Die Fehlermeldung, die dem Nutzer angezeigt werden soll, wenn etwas schiefgegangen ist.