Package google.chat.v1

ButtonList

Eine Liste mit Schaltflächen.

ResponseType

Nur Eingabe. Der Typ der Chat-App-Antwort.

string

Nur Eingabe. URL, über die sich Nutzer authentifizieren oder konfigurieren können. (Nur für REQUEST_CONFIG-Antworttypen.)

DialogAction

Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss von ResponseType.Dialog begleitet werden.

UpdatedWidget

Nur Eingabe. Die Antwort des aktualisierten Widgets.

SelectionItem

Ein Array von „SelectionItem“-Objekten.

string

Die ID des aktualisierten Widgets. Die ID muss mit der ID des Widgets übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat.

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung von Widgets

Code

Der Statuscode.

string

Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet wird. Wenn diese Option nicht festgelegt ist, wird eine generische Nachricht basierend auf der status_code gesendet.

AnnotationType

Der Typ dieser Anmerkung.

int32

Länge des Teilstrings im Textkörper der Nachricht, dem diese Anmerkung entspricht.

int32

Der Startindex (basierend auf 0, einschließlich) im Textkörper der Nachricht, der dieser Anmerkung entspricht.

UserMentionMetadata

Die Metadaten der Nutzererwähnung.

SlashCommandMetadata

Die Metadaten für einen Slash-Befehl.

RichLinkMetadata

Die Metadaten für einen Rich-Link.

string

Nur Ausgabe. Die URL, auf der das GIF-Bild gehostet wird.

string

Optional. Ressourcenname des Anhangs im Format spaces/{space}/messages/{message}/attachments/{attachment}.

string

Nur Ausgabe. Der ursprüngliche Dateiname für den Inhalt, nicht der vollständige Pfad.

string

Nur Ausgabe. Der Inhaltstyp (MIME-Typ) der Datei.

string

Nur Ausgabe. Die Thumbnail-URL, die für die Vorschau des Anhangs für einen Nutzer verwendet werden soll. Chat-Apps sollten diese URL nicht verwenden, um Inhalte von Anhängen herunterzuladen.

string

Nur Ausgabe. Die Download-URL, über die ein Nutzer den Anhang herunterladen kann. Chat-Apps sollten diese URL nicht zum Herunterladen von Anhängen verwenden.

Source

Nur Ausgabe. Die Quelle des Anhangs.

AttachmentDataRef

Optional. Ein Verweis auf die Anhangsdaten. Dieses Feld wird verwendet, um Nachrichten mit Anhängen zu erstellen oder zu aktualisieren, oder mit der Media API, um die Anhangsdaten herunterzuladen.

DriveDataRef

Nur Ausgabe. Ein Verweis auf den Google Drive-Anhang. Dieses Feld wird mit der Google Drive API verwendet.

string

Optional. Der Ressourcenname der Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen.

string

Optional. Opaque-Token mit einem Verweis auf einen hochgeladenen Anhang. Wird von Clients als undurchsichtiger String behandelt und zum Erstellen oder Aktualisieren von Chatnachrichten mit Anhängen verwendet.

string

Erforderlich, wenn die Nachricht mehrere Karten enthält. Eine eindeutige Kennung für eine Karte in einer Nachricht.

Card

Eine Infokarte Die maximale Größe beträgt 32 KB.

string

Der Bereich der verknüpften Chatbereichsressource.

Format: spaces/{space}

string

Der Thread der verknüpften Chatbereichsressource.

Format: spaces/{space}/threads/{thread}

string

Die Nachricht der verknüpften Chatbereichsressource.

Format: spaces/{space}/messages/{message}

string

Erforderlich. Ressourcenname des Bereichs im Importmodus.

Format: spaces/{space}

Space

Bereich für den Importmodus

CardHeader

Die Kopfzeile der Karte. Eine Kopfzeile enthält normalerweise einen Titel und ein Bild.

Section

Abschnitte sind durch eine Trennlinie getrennt.

CardAction

Die Aktionen dieser Karte.

string

Name der Karte.

string

Das Label wurde früher im Menüpunkt „Aktion“ angezeigt.

OnClick

Die onclick-Aktion für dieses Aktionselement.

string

Der Titel muss angegeben werden. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch eine Unterüberschrift angegeben sind, belegt jede eine Zeile. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.

string

Der Untertitel der Kartenüberschrift.

ImageStyle

Der Typ des Bildes (z. B. quadratischer oder kreisförmiger Rahmen).

string

Die URL des Bildes in der Kartenüberschrift.

string

Die Kopfzeile des Abschnitts. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

WidgetMarkup

Ein Abschnitt muss mindestens ein Widget enthalten.

CustomEmoji

Erforderlich. Das benutzerdefinierte Emoji, das erstellt werden soll.

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, für den die Mitgliedschaft erstellt werden soll.

Format: Leerzeichen/{Leerzeichen}

Membership

Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung.

Das Feld memberType muss einen Nutzer enthalten, für den die Felder user.name und user.type ausgefüllt sind. Der Server weist einen Ressourcennamen zu und überschreibt alle angegebenen Angaben.

Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen Nutzer erstellt, muss sie bestimmte Autorisierungsbereiche verwenden und bestimmte Werte für bestimmte Felder festlegen:

• Bei der Authentifizierung als Nutzer ist der Autorisierungsbereich chat.memberships erforderlich.

• Bei der Authentifizierung als App ist der Autorisierungsbereich chat.app.memberships erforderlich. Die Authentifizierung als App ist in folgenden Ländern verfügbar:

• Legen Sie user.type auf HUMAN und user.name auf das Format users/{user} fest. Dabei kann {user} die E-Mail-Adresse des Nutzers sein. Für Nutzer in derselben Workspace-Organisation kann {user} auch der id der Person aus der People API oder der id für den Nutzer in der Directory API sein. Wenn die Personenprofil-ID der People API für user@example.com beispielsweise 123456789 lautet, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name auf users/user@example.com oder users/123456789 festlegen.

Wenn eine Chat-App eine Mitgliedschaftsbeziehung für sich selbst erstellt, muss sie sich als Nutzer authentifizieren, den Bereich chat.memberships.app verwenden, user.type auf BOT und user.name auf users/app festlegen.

bool

Wenn true, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.memberships OAuth 2.0-Bereich.

Das Erstellen von App-Mitgliedschaften oder Mitgliedschaften für Nutzer außerhalb der Google Workspace-Organisation des Administrators wird mit Administratorzugriff nicht unterstützt.

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, in dem eine Nachricht erstellt werden soll.

Format: spaces/{space}

Message

Erforderlich. Nachrichtentext

string

Optional. Verworfen. Verwenden Sie stattdessen thread.thread_key. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Wenn Sie eine Unterhaltung starten oder einer Unterhaltung hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie einen threadKey oder thread.name an. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.

string

Optional. Eine eindeutige Anfrage-ID für diese Nachricht. Wenn Sie eine vorhandene Anfrage-ID angeben, wird die mit dieser ID erstellte Nachricht zurückgegeben, anstatt eine neue Nachricht zu erstellen.

MessageReplyOption

Optional. Gibt an, ob eine Nachricht einen Thread startet oder darauf antwortet. Nur in benannten Gruppenbereichen unterstützt.

Wenn Sie auf Nutzerinteraktionen reagieren, wird dieses Feld ignoriert. Bei Interaktionen innerhalb einer Konversation wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt.

string

Optional. Eine benutzerdefinierte ID für eine Nachricht. Ermöglicht es Chat-Apps, eine Nachricht abzurufen, zu aktualisieren oder zu löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Feld name der Nachricht) speichern zu müssen.

Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:

• Beginnt mit client-. Beispiel: client-custom-name ist eine gültige benutzerdefinierte ID, custom-name jedoch nicht.
• Enthält bis zu 63 Zeichen und nur Kleinbuchstaben, Ziffern und Bindestriche.
• Darf innerhalb eines Gruppenbereichs nur einmal vorkommen. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für unterschiedliche Nachrichten verwenden.

Weitere Informationen

string

Erforderlich. Die Nachricht, in der die Reaktion erstellt wird.

Format: spaces/{space}/messages/{message}

Reaction

Erforderlich. Die zu erstellende Reaktion.

Space

Erforderlich. Die Felder displayName und spaceType müssen ausgefüllt sein. Es werden nur SpaceType.SPACE und SpaceType.GROUP_CHAT unterstützt. SpaceType.GROUP_CHAT kann nur verwendet werden, wenn importMode auf „wahr“ gesetzt ist.

Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden Gruppenbereich in der Google Workspace-Organisation verwendet.

Der Bereich name ist auf dem Server zugewiesen. Daher werden alle Angaben in diesem Feld ignoriert.

string

Optional. Eine eindeutige Kennung für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben, anstatt einen neuen zu erstellen. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App für einen anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben.

string

Kennung. Der Ressourcenname des benutzerdefinierten Emojis, der vom Server zugewiesen wird.

Format: customEmojis/{customEmoji}

string

Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource.

string

Nicht veränderbar. Vom Nutzer angegebener Name für das benutzerdefinierte Emoji, der innerhalb der Organisation eindeutig sein muss.

Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird, nur Ausgabe.

Emoji-Namen müssen mit Doppelpunkten beginnen und enden, in Kleinbuchstaben geschrieben werden und dürfen nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Wörter werden durch Binde- und Unterstriche getrennt. Diese Zeichen dürfen nicht mehrmals hintereinander stehen.

Beispiel: :valid-emoji-name:

string

Nur Ausgabe. Die Bild-URL für das benutzerdefinierte Emoji, gültig für mindestens 10 Minuten. Hinweis: Dieser Wert wird nicht in die Antwort eingefügt, wenn das benutzerdefinierte Emoji erstellt wird.

CustomEmojiPayload

Nur Eingabe. Nutzlastdaten.

bytes

Erforderlich. Nur Eingabe. Das für das benutzerdefinierte Emoji verwendete Bild.

Die Nutzlast darf nicht größer als 256 KB sein und die Größe des Bildes muss zwischen 64 und 500 Pixel liegen. Die Einschränkungen können sich ändern.

string

Erforderlich. Nur Eingabe. Der Name der Bilddatei.

Unterstützte Dateiendungen: .png, .jpg, .gif.

string

Erforderlich. Ressourcenname des zu löschenden benutzerdefinierten Emojis.

Format: customEmojis/{customEmoji}

Sie können den Emoji-Namen als Alias für {customEmoji} verwenden. Beispiel: customEmojis/:example-emoji:, wobei :example-emoji: der Emoji-Name für ein benutzerdefiniertes Emoji ist.

string

Erforderlich. Ressourcenname der Mitgliedschaft, die gelöscht werden soll. Chat-Apps können die Mitgliedschaften von Nutzern oder die eigenen Mitgliedschaften löschen. Chat-Apps können keine Mitgliedschaften anderer Apps löschen.

Zum Löschen einer Mitgliedschaft einer natürlichen Person sind der Bereich chat.memberships und das Format spaces/{space}/members/{member} erforderlich. Sie können die E-Mail-Adresse als Alias für {member} verwenden. Beispiel: spaces/{space}/members/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.

Beim Löschen einer App-Mitgliedschaft sind der Bereich chat.memberships.app und das Format spaces/{space}/members/app erforderlich.

Format: spaces/{space}/members/{member} oder spaces/{space}/members/app

bool

Wenn true, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.memberships OAuth 2.0-Bereich.

Das Löschen von App-Mitgliedschaften in einem Gruppenbereich wird mit Administratorzugriff nicht unterstützt.

string

Erforderlich. Ressourcenname der Nachricht.

Format: spaces/{space}/messages/{message}

Wenn Sie eine benutzerdefinierte ID für Ihre Nachricht festgelegt haben, können Sie den Wert aus dem Feld clientAssignedMessageId für {message} verwenden. Weitere Informationen

bool

Wenn true ausgewählt ist, werden beim Löschen einer Nachricht auch die Antworten im Thread gelöscht. Wenn false und eine Nachricht Antworten in einem Thread enthält, schlägt das Löschen fehl.

Gilt nur bei der Authentifizierung als Nutzer. Hat keine Auswirkungen bei der Authentifizierung als Chat-App.

string

Erforderlich. Name der Reaktion, die gelöscht werden soll.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

string

Erforderlich. Ressourcenname des zu löschenden Gruppenbereichs.

Format: spaces/{space}

bool

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung „Unterhaltungen in Chats und Gruppenbereichen verwalten“ sein.

Erfordert den chat.admin.delete OAuth 2.0-Bereich.

DeletionType

Gibt an, wer die Nachricht gelöscht hat.

Card

Nur Eingabe. Text des Dialogfelds, der in einem modalen Fenster gerendert wird. Die folgenden Kartenentitäten werden in Google Chat-Apps nicht unterstützt: DateTimePicker, OnChangeAction.

ActionStatus

Nur Eingabe. Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds. Zeigt Nutzern bei Bedarf einen Status und eine Nachricht an. Beispielsweise bei einem Fehler oder Erfolg.

Dialog

Nur Eingabe. Dialog für die Anfrage.

string

Die ID der Drive-Datei. Mit der Drive API verwenden

DriveDataRef

Eine DriveDataRef, die auf eine Google Drive-Datei verweist.

string

Der MIME-Typ der verknüpften Google Drive-Ressource.

string

Ein einfaches Emoji, das durch einen Unicode-String dargestellt wird.

CustomEmoji

Nur Ausgabe. Ein benutzerdefiniertes Emoji.

Emoji

Das mit den Reaktionen verknüpfte Emoji.

int32

Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

string

Erforderlich. Ressourcenname des Nutzers, für den Direktnachrichten gesucht werden sollen.

Format: users/{user}, wobei {user} entweder die id für die Person aus der People API oder die id für den Nutzer in der Directory API ist. Wenn die Profil-ID der People API beispielsweise 123456789 ist, können Sie eine Direktnachricht an diese Person finden, indem Sie users/123456789 als name verwenden. Wenn Sie als Nutzer authentifiziert sind, können Sie die E-Mail-Adresse als Alias für {user} verwenden. Beispiel: users/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.

string

Erforderlich. Ressourcenname des Anhangs im Format spaces/{space}/messages/{message}/attachments/{attachment}.

string

Erforderlich. Ressourcenname des benutzerdefinierten Emojis.

Format: customEmojis/{customEmoji}

Sie können den Emoji-Namen als Alias für {customEmoji} verwenden. Beispiel: customEmojis/:example-emoji:, wobei :example-emoji: der Emoji-Name für ein benutzerdefiniertes Emoji ist.

string

Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft.

Wenn du die Mitgliedschaft der App über die Nutzerauthentifizierung abrufen möchtest, kannst du optional spaces/{space}/members/app verwenden.

Format: spaces/{space}/members/{member} oder spaces/{space}/members/app

Sie können die E-Mail-Adresse des Nutzers als Alias für {member} verwenden. Beispiel: spaces/{space}/members/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.

bool

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert die OAuth 2.0-Bereichechat.admin.memberships oder chat.admin.memberships.readonly.

Wenn Sie Administratorzugriff haben, wird die App-Mitgliedschaft in einem Gruppenbereich nicht unterstützt.

string

Erforderlich. Ressourcenname der Nachricht.

Format: spaces/{space}/messages/{message}

Wenn Sie eine benutzerdefinierte ID für Ihre Nachricht festgelegt haben, können Sie den Wert aus dem Feld clientAssignedMessageId für {message} verwenden. Weitere Informationen

string

Erforderlich. Der Ressourcenname des Gruppenbereichsereignisses.

Format: spaces/{space}/spaceEvents/{spaceEvent}

string

Erforderlich. Format: users/{user}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting ODER
• users/user@example.com/spaces/{space}/spaceNotificationSetting, ODER
• users/123456789/spaces/{space}/spaceNotificationSetting. Hinweis: Im Pfad ist nur die Nutzer-ID oder E-Mail-Adresse des Anrufers zulässig.

string

Erforderlich. Ressourcenname des abzurufenden Lesestatus des Gruppenbereichs.

Unterstützt nur das Abrufen des Lesestatus für den anrufenden Nutzer.

Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest:

• Der Alias für me. Beispiel: users/me/spaces/{space}/spaceReadState.

• Ihre Workspace-E-Mail-Adresse. Beispiel: users/user@example.com/spaces/{space}/spaceReadState.

• Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

string

Erforderlich. Ressourcenname des Gruppenbereichs im Format spaces/{space}.

Format: spaces/{space}

bool

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert die OAuth 2.0-Bereichechat.admin.spaces oder chat.admin.spaces.readonly.

string

Erforderlich. Ressourcenname des abzurufenden Threads.

Unterstützt nur das Abrufen des Lesestatus für den anrufenden Nutzer.

Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest:

• Der Alias für me. Beispiel: users/me/spaces/{space}/threads/{thread}/threadReadState.

• Die Workspace-E-Mail-Adresse des Nutzers Beispiel: users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

• Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Ressourcenname für eine Google-Gruppe.

Stellt eine Gruppe in der Cloud Identity Groups API dar.

Format: groups/{group}

int32

Optional. Die maximale Anzahl zurückgegebener benutzerdefinierter Emojis. Der Dienst kann weniger benutzerdefinierte Emojis als diesen Wert zurückgeben. Wenn keine Vorgabe erfolgt, gilt der Standardwert 25. Der Maximalwert ist 200. Werte über 200 werden in 200 geändert.

string

Optional. (Bei Fortsetzung einer vorherigen Abfrage.)

Ein Seitentoken, das von einem vorherigen Aufruf der Liste mit benutzerdefinierten Emojis empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Optional. Einen Abfragefilter.

Es wird die Filterung nach Creator unterstützt.

Wenn du nach Creator filtern möchtest, musst du einen gültigen Wert angeben. Derzeit können benutzerdefinierte Emojis nur mit creator("users/me") und NOT creator("users/me") danach gefiltert werden, ob sie vom anrufenden Nutzer erstellt wurden oder nicht.

Die folgende Abfrage gibt beispielsweise benutzerdefinierte Emojis zurück, die vom Anrufer erstellt wurden:

creator("users/me")

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

CustomEmoji

Unsortierte Liste. Liste der benutzerdefinierten Emojis auf der angeforderten (oder ersten) Seite.

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll.

Format: spaces/{space}

int32

Optional. Die maximale Anzahl der Mitgliedschaften, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Kanalmitgliedschaften zurückgegeben.

Der Höchstwert beträgt 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zur Auflistung von Mitgliedschaften empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Optional. Einen Abfragefilter.

Du kannst Mitgliedschaften nach der Rolle eines Mitglieds (role) und dem Typ (member.type) filtern.

Wenn Sie nach Rolle filtern möchten, legen Sie role auf ROLE_MEMBER oder ROLE_MANAGER fest.

Wenn Sie nach Typ filtern möchten, setzen Sie member.type auf HUMAN oder BOT. Sie können auch mit dem Operator != nach member.type filtern.

Wenn Sie sowohl nach Rolle als auch nach Typ filtern möchten, verwenden Sie den Operator AND. Verwenden Sie den Operator OR, um nach Rolle oder Typ zu filtern.

Entweder member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn use_admin_access auf „wahr“ festgelegt ist. Andere Filter für den Mitgliedertyp werden abgelehnt.

Die folgenden Abfragen sind beispielsweise gültig:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Die folgenden Abfragen sind ungültig:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

bool

Optional. Wenn true, werden neben anderen Mitgliedschaftstypen auch Mitgliedschaften zurückgegeben, die mit einer Google Group verknüpft sind. Wenn eine filter festgelegt ist, werden Google Group-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

bool

Optional. Wenn true, werden neben anderen Mitgliedschaftstypen auch Mitgliedschaften zurückgegeben, die mit invited-Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden invited-Kanalmitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

Derzeit ist eine Nutzerauthentifizierung erforderlich.

bool

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert entweder den OAuth 2.0-Bereichchat.admin.memberships.readonly oder chat.admin.memberships.

Die Auflistung von App-Mitgliedschaften in einem Gruppenbereich wird beim Verwenden des Administratorzugriffs nicht unterstützt.

Membership

Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite.

string

Ein Token, das Sie als pageToken senden können, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen.

Format: spaces/{space}

int32

Die maximale Anzahl der zurückgegebenen Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 25 zurückgegeben.

Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.

string

Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird.

Ein Seitentoken, das von einem vorherigen Aufruf der Nachrichtenliste empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Einen Abfragefilter.

Sie können Nachrichten nach Datum (create_time) und nach Thread (thread.name) filtern.

Wenn Sie Nachrichten nach dem Erstellungsdatum filtern möchten, geben Sie create_time mit einem Zeitstempel im RFC-3339-Format und doppelten Anführungszeichen an. Beispiel: "2023-04-21T11:30:00-04:00" Mit dem Operator „größer als“ > können Sie Nachrichten auflisten, die nach einem Zeitstempel erstellt wurden. Mit dem Operator „kleiner als“ < können Sie Nachrichten auflisten, die vor einem Zeitstempel erstellt wurden. Wenn Sie Nachrichten innerhalb eines bestimmten Zeitraums filtern möchten, verwenden Sie den Operator AND zwischen zwei Zeitstempeln.

Wenn Sie nach Thread filtern möchten, geben Sie die thread.name im Format spaces/{space}/threads/{thread} an. Pro Abfrage kann nur eine thread.name angegeben werden.

Wenn Sie sowohl nach Thread als auch nach Datum filtern möchten, verwenden Sie den Operator AND in Ihrer Abfrage.

Die folgenden Abfragen sind beispielsweise gültig:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Ungültige Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

string

Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird.

Wie die Liste der Nachrichten sortiert wird. Geben Sie einen Wert an, nach dem sortiert werden soll. Gültige Werte für Sortiervorgänge sind:

• ASC für aufsteigend.

• DESC für absteigend.

Die Standardsortierung ist create_time ASC.

bool

Gibt an, ob gelöschte Nachrichten berücksichtigt werden sollen. Gelöschte Nachrichten enthalten das Löschdatum und ‑uhrzeit sowie Metadaten zum Löschen, der Inhalt der Nachricht ist jedoch nicht verfügbar.

Message

Liste der Nachrichten.

string

Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

string

Erforderlich. Die Nachricht, auf die Nutzer reagiert haben.

Format: spaces/{space}/messages/{message}

int32

Optional. Die maximale Anzahl zurückgegebener Reaktionen. Der Dienst kann weniger Reaktionen als diesen Wert zurückgeben. Wenn keine Vorgabe erfolgt, gilt der Standardwert 25. Der Maximalwert ist 200. Werte über 200 werden in 200 geändert.

string

Optional. (Bei Fortsetzung einer vorherigen Abfrage.)

Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Reaktionen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Optional. Einen Abfragefilter.

Du kannst Reaktionen nach Emoji (emoji.unicode oder emoji.custom_emoji.uid) und Nutzer (user.name) filtern.

Wenn Sie Reaktionen nach mehreren Emojis oder Nutzern filtern möchten, können Sie ähnliche Felder mit dem Operator OR zusammenführen, z. B. emoji.unicode = "🙂" OR emoji.unicode = "👍" und user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Wenn Sie Reaktionen nach Emoji und Nutzer filtern möchten, verwenden Sie den Operator AND, z. B. emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Wenn in Ihrer Abfrage sowohl AND als auch OR verwendet werden, gruppieren Sie sie mit Klammern.

Die folgenden Abfragen sind beispielsweise gültig:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Die folgenden Abfragen sind ungültig:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Reaction

Liste der Reaktionen auf der angeforderten (oder ersten) Seite.

string

Fortsetzungs-Token zum Abrufen der nächsten Ergebnisseite. Bei der letzten Ergebnisseite ist er leer.

string

Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind.

Format: spaces/{space}.

int32

Optional. Die maximale Anzahl zurückgegebener Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.

string

Ein Seitentoken, das von einem vorherigen Aufruf von Listenbereichsereignissen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen Parameter, die zum Auflisten von Space-Ereignissen zur Verfügung gestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Erforderlich. Einen Abfragefilter.

Sie müssen mindestens einen Ereignistyp (event_type) mit dem Operator „hat :“ angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator OR. Schließen Sie Batch-Ereignistypen aus Ihrem Filter aus. Die Anfrage gibt automatisch alle zugehörigen Batch-Ereignisse zurück. Wenn du beispielsweise nach neuen Reaktionen (google.workspace.chat.reaction.v1.created) filterst, gibt der Server auch Ereignisse für neue Reaktionen im Batch (google.workspace.chat.reaction.v1.batchCreated) zurück. Eine Liste der unterstützten Ereignistypen findest du in der SpaceEvents-Referenzdokumentation.

Optional können Sie auch nach Startzeit (start_time) und Endzeit (end_time) filtern:

• start_time: Exklusiver Zeitstempel, ab dem die Listen der Gruppenbereiche beginnen sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn keine Angabe erfolgt, werden Gruppenbereichsereignisse der letzten 28 Tage aufgelistet.
• end_time: Inklusiver Zeitstempel, bis zu dem Gruppenbereichsereignisse aufgeführt werden. Wenn kein Wert angegeben ist, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgelistet.

Um eine Start- oder Endzeit anzugeben, verwenden Sie den Gleichheitsoperator = und das Format in RFC-3339. Wenn Sie sowohl nach start_time als auch nach end_time filtern möchten, verwenden Sie den Operator AND.

Die folgenden Abfragen sind beispielsweise gültig:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Die folgenden Abfragen sind ungültig:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

SpaceEvent

Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). Hinweis: Das Feld permissionSettings wird bei Listenanfragen nicht im Gruppenbereichsobjekt zurückgegeben.

string

Fortsetzungs-Token zum Abrufen weiterer Ereignisse. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

int32

Optional. Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Gruppenbereiche zurückgegeben.

Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.

string

Optional. Seitentoken, das von einem vorherigen Aufruf einer Gruppenbereichsliste erhalten wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Optional. Einen Abfragefilter.

Sie können Gruppenbereiche nach dem Gruppenbereichstyp (space_type) filtern.

Wenn Sie nach Gruppentyp filtern möchten, müssen Sie einen gültigen enum-Wert angeben, z. B. SPACE oder GROUP_CHAT. space_type darf nicht SPACE_TYPE_UNSPECIFIED sein. Wenn Sie nach mehreren Gruppentypen suchen möchten, verwenden Sie den Operator OR.

Die folgenden Abfragen sind beispielsweise gültig:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Space

Liste der Gruppenbereiche auf der angeforderten (oder ersten) Seite. Hinweis: Das Feld permissionSettings wird im Gruppenbereichsobjekt für Listenanfragen nicht zurückgegeben.

string

Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

string

Nur Ausgabe. Die übereinstimmende URL.

string

Vom Server zugewiesener Ressourcenname der Mitgliedschaft.

Format: spaces/{space}/members/{member}

MembershipState

Nur Ausgabe. Status der Mitgliedschaft.

MembershipRole

Optional. Die Rolle des Nutzers in einem Chatbereich, durch die die zulässigen Aktionen im Gruppenbereich bestimmt werden.

Dieses Feld kann nur in UpdateMembership als Eingabe verwendet werden.

Timestamp

Optional. Nicht veränderbar. Die Erstellungszeit der Mitgliedschaft, z. B. wenn ein Mitglied einem Gruppenbereich beigetreten ist oder dazu eingeladen wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird verwendet, um bisherige Mitgliedschaften in Gruppenbereichen im Importmodus zu importieren.

Timestamp

Optional. Nicht veränderbar. Der Zeitpunkt des Löschens der Mitgliedschaft, z. B. wann ein Mitglied das Unternehmen verlassen hat oder aus einem Gruppenbereich entfernt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird verwendet, um bisherige Mitgliedschaften in Gruppenbereichen im Importmodus zu importieren.

User

Der Google Chat-Nutzer oder die Google Chat-App, zu der die Mitgliedschaft gehört. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer name und type eingefügt.

Group

Die Google-Gruppe, zu der die Mitgliedschaft gehört.

Das Lesen oder Ändern von Mitgliedschaften für Google Groups erfordert eine Nutzerauthentifizierung.

MembershipCreatedEventData

Eine Liste der neuen Mitgliedschaften.

MembershipDeletedEventData

Eine Liste der gelöschten Mitgliedschaften.

MembershipUpdatedEventData

Eine Liste der aktualisierten Mitgliedschaften.

Membership

Die neue Mitgliedschaft.

Membership

Die gelöschte Mitgliedschaft. Nur die Felder name und state werden ausgefüllt.

Membership

Die aktualisierte Mitgliedschaft.

string

Ressourcenname der Nachricht.

Format: spaces/{space}/messages/{message}

Dabei steht {space} für die ID des Gruppenbereichs, in dem die Nachricht gepostet wurde, und {message} für eine systemzugewiesene ID für die Nachricht. Beispiel: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

Wenn Sie beim Erstellen einer Nachricht eine benutzerdefinierte ID festlegen, können Sie diese ID verwenden, um die Nachricht in einer Anfrage anzugeben. Ersetzen Sie dazu {message} durch den Wert aus dem Feld clientAssignedMessageId. Beispiel: spaces/AAAAAAAAAAA/messages/client-custom-name Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen.

User

Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer name und type eingefügt.

Timestamp

Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen die Uhrzeit, zu der die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Nachricht zuletzt von einem Nutzer bearbeitet wurde. Wenn die Nachricht noch nie bearbeitet wurde, ist dieses Feld leer.

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Nachricht in Google Chat gelöscht wurde. Wenn die Nachricht nie gelöscht wird, ist dieses Feld leer.

string

Der Textkörper der Nachricht im Nur-Text-Format. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschau-Chip. Sie können auch einen Google Chat-Nutzer oder alle Nutzer im Gruppenbereich erwähnen.

Weitere Informationen zum Erstellen von SMS finden Sie unter Nachrichten senden.

string

Nur Ausgabe. Enthält die Nachricht text mit Markups zur Angabe der Formatierung. Dieses Feld erfasst möglicherweise nicht alle Formatierungen, die in der Benutzeroberfläche sichtbar sind, enthält aber Folgendes:

• Markup-Syntax für Fettdruck, Kursivschrift, Durchstreichen, einzeilige Schrift, einzeiligen Block und Aufzählungsliste.

• Nutzererwähnungen im Format <users/{user}>

• Benutzerdefinierte Hyperlinks im Format <{url}|{rendered_text}>, wobei der erste String die URL und der zweite der gerenderte Text ist, z. B. <http://example.com|custom text>.

• Benutzerdefinierte Emojis im Format :{emoji_name}:, z. B. :smile:. Das gilt nicht für Unicode-Emojis wie U+1F600 für ein grinsendes Gesicht.

Weitere Informationen finden Sie im Hilfeartikel In Nachrichten gesendete Textformatierungen ansehen.

Card

Verworfen. Verwenden Sie stattdessen cards_v2.

Umfangreiche, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierte Texte, Schaltflächen und anklickbare Bilder darstellen können. Karten werden normalerweise unter dem unformatierten Textkörper der Nachricht angezeigt. cards und cards_v2 dürfen eine maximale Größe von 32 KB haben.

CardWithId

Ein Array mit Karten.

Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, können die Nachrichten keine Karten enthalten.

Informationen zum Erstellen einer Nachricht, die Karten enthält, finden Sie im Hilfeartikel Nachrichten senden.

Mit dem Card Builder Karten entwerfen und eine Vorschau anzeigen

Annotation

Nur Ausgabe. Annotationen, die mit text in dieser Nachricht verknüpft sind.

Thread

Der Thread, zu dem die Nachricht gehört. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.

Space

Wenn Ihre Chat-App einen Nutzer authentifiziert, wird in der Ausgabe der Gruppenbereich name ausgefüllt.

string

Eine Klartextbeschreibung der Karten der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. mobile Benachrichtigungen.

ActionResponse

Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.

string

Nur Ausgabe. Der Nur-Text-Textkörper der Nachricht ohne Erwähnungen der Chat App

SlashCommand

Nur Ausgabe. Informationen zu Slash-Befehlen, falls vorhanden.

Attachment

Von einem Nutzer hochgeladener Anhang.

MatchedUrl

Nur Ausgabe. Eine URL in spaces.messages.text, die einem Muster für Linkvorschauen entspricht. Weitere Informationen finden Sie unter Vorschaulinks.

bool

Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwortthread. Bei false ist die Nachricht in der Unterhaltung auf oberster Ebene des Gruppenbereichs entweder als erste Nachricht eines Threads oder als Nachricht ohne Antworten im Thread sichtbar.

Wenn das Gruppenbereich das Antworten in Threads nicht unterstützt, ist dieses Feld immer false.

string

Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können das Feld verwenden, um eine Nachricht zu identifizieren oder eine Nachricht abzurufen, zu löschen oder zu aktualisieren. Wenn Sie eine benutzerdefinierte ID festlegen möchten, geben Sie beim Erstellen der Nachricht das Feld messageId an. Weitere Informationen

EmojiReactionSummary

Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen auf die Nachricht.

User

Nicht veränderbar. Eingabe für das Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht sehen kann. Wenn dieses Feld festgelegt ist, ist die Nachricht privat und nur für den angegebenen Nutzer und die Chat-App sichtbar. Wenn Sie dieses Feld in Ihre Anfrage aufnehmen möchten, müssen Sie die Chat API mit der App-Authentifizierung aufrufen und Folgendes auslassen:

• Anhänge
• Zubehör-Widgets

Weitere Informationen finden Sie unter Private Nachrichten senden.

DeletionMetadata

Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn delete_time festgelegt ist.

QuotedMessageMetadata

Nur Ausgabe. Informationen zu einer Nachricht, die von einem Google Chat-Nutzer in einem Gruppenbereich zitiert wurde. Google Chat-Nutzer können eine Nachricht zitieren, um darauf zu antworten.

AttachedGif

Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind.

AccessoryWidget

Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Zubehör-Widgets zu Nachrichten hinzufügen, die Text, Karten oder sowohl Text als auch Karten enthalten. Nicht unterstützt für Nachrichten, die Dialoge enthalten. Weitere Informationen finden Sie unter Interaktive Widgets unten in einer Nachricht einfügen.

Für das Erstellen einer Nachricht mit Zubehör-Widgets ist eine App-Authentifizierung erforderlich.

MessageCreatedEventData

Eine Liste der neuen Nachrichten.

MessageDeletedEventData

Eine Liste der gelöschten Nachrichten.

MessageUpdatedEventData

Eine Liste der aktualisierten Nachrichten.

Message

Die neue Nachricht.

Message

Die gelöschte Nachricht. Nur die Felder name, createTime, deleteTime und deletionMetadata werden ausgefüllt.

Message

Die aktualisierte Nachricht.

string

Nur Ausgabe. Ressourcenname der zitierten Nachricht.

Format: spaces/{space}/messages/{message}

Timestamp

Nur Ausgabe. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde.

string

Der Ressourcenname der Reaktion.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

User

Nur Ausgabe. Der Nutzer, der die Reaktion erstellt hat.

Emoji

Das in der Reaktion verwendete Emoji.

ReactionCreatedEventData

Eine Liste der neuen Reaktionen.

ReactionDeletedEventData

Eine Liste der gelöschten Reaktionen.

Reaction

Die neue Reaktion.

Reaction

Die gelöschte Reaktion.

string

Der URI dieses Links.

RichLinkType

Der Rich-Link-Typ.

DriveLinkData

Daten für einen Drive-Link.

ChatSpaceLinkData

Daten für einen Link zu einem Chatbereich.

bool

Wenn true, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den OAuth 2.0-Bereich chat.admin.spaces.readonly oder chat.admin.spaces.

Diese Methode unterstützt derzeit nur Administratorzugriff. Daher wird für dieses Feld nur true akzeptiert.

int32

Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Gruppenbereiche zurückgegeben.

Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.

string

Ein Token, das vom vorherigen Suchbereichsaufruf empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.

string

Erforderlich. Eine Suchanfrage.

Sie können mit den folgenden Parametern suchen:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

Für create_time und last_active_time ist ein Zeitstempel im RFC-3339-Format zulässig. Die unterstützten Vergleichsoperatoren sind: =, <, >, <= und >=.

customer ist erforderlich und gibt an, von welchem Kunden Gruppenbereiche abgerufen werden sollen. customers/my_customer ist der einzige unterstützte Wert.

Für display_name ist nur der Operator HAS (:) zulässig. Der übereinstimmende Text wird zuerst in Tokens tokenisiert und bei jedem Token wird die Groß-/Kleinschreibung nicht berücksichtigt und unabhängig als Teilstring an beliebiger Stelle im display_name des Bereichs abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even.

Für external_user_allowed sind entweder true oder false zulässig.

space_history_state akzeptiert nur Werte aus dem Feld historyState einer space-Ressource.

space_type ist erforderlich und der einzige gültige Wert ist SPACE.

In verschiedenen Feldern werden nur AND-Operatoren unterstützt. Ein gültiges Beispiel ist space_type = "SPACE" AND display_name:"Hello" und ein ungültiges Beispiel ist space_type = "SPACE" OR display_name:"Hello".

Innerhalb desselben Felds werden für space_type keine AND- oder OR-Operatoren unterstützt. Für display_name, „space_history_state“ und „external_user_allowed“ werden nur OR-Operatoren unterstützt. last_active_time und create_time unterstützen sowohl AND- als auch OR-Operatoren. AND kann nur für ein Intervall wie last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" verwendet werden.

Die folgenden Beispielabfragen sind gültig:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

Optional. Die Reihenfolge der Liste der Gruppenbereiche.

Folgende Attribute werden für die Sortierung unterstützt:

• membership_count.joined_direct_human_user_count: Gibt die Anzahl der Nutzer an, die einem Gruppenbereich direkt beigetreten sind.
• last_active_time: Gibt an, wann dem letzten Thema in diesem Gruppenbereich ein berechtigtes Element hinzugefügt wurde.
• create_time – Gibt die Zeit an, zu der der Gruppenbereich erstellt wurde.

Gültige Werte für den Sortiervorgang:

• ASC für aufsteigend. Standardwert.

• DESC für absteigend.

Folgende Syntax wird unterstützt:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Eine Seite der angeforderten Gruppenbereiche.

string

Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

int32

Die Gesamtzahl der Gruppenbereiche, die der Suchanfrage entsprechen, auf allen Seiten. Wenn das Ergebnis mehr als 10.000 Plätze beträgt, ist dieser Wert eine Schätzung.

Space

Erforderlich. Space.spaceType ist ein Pflichtfeld.

Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie Space.spaceType auf SPACE und Space.displayName. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einer anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Wenn Sie einen Gruppenchat erstellen möchten, setzen Sie Space.spaceType auf GROUP_CHAT. Legen Sie Space.displayName nicht fest.

Wenn Sie eine Unterhaltung zwischen zwei Menschen erstellen möchten, legen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false fest. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

Wenn Sie eine Unterhaltung zwischen einer natürlichen Person und der anrufenden Chat-App starten möchten, legen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true fest. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

Wenn ein DIRECT_MESSAGE-Bereich bereits vorhanden ist, wird dieser zurückgegeben, anstatt einen neuen Bereich zu erstellen.

string

Optional. Eine eindeutige Kennung für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben, anstatt einen neuen Gruppenbereich zu erstellen. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App mit einem anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben.

Membership

Optional. Die Google Chat-Nutzer oder -Gruppen, die zum Beitritt zum Gruppenbereich eingeladen werden sollen. Den anrufenden Nutzer weglassen, da er automatisch hinzugefügt wird.

Derzeit sind bis zu 20 Mitgliedschaften (zusätzlich zum Anrufer) möglich.

Bei einer Mitgliedschaft für natürliche Personen muss das Feld Membership.member ein user mit ausgefülltem name enthalten (Format: users/{user}) und type auf User.Type.HUMAN festgelegt sein. Sie können nur bei der Einrichtung eines Gruppenbereichs Nutzer hinzufügen. Das Hinzufügen von Chat-Apps wird nur für die Einrichtung von Direktnachrichten mit der Anruf-App unterstützt. Sie können auch Mitglieder hinzufügen, indem Sie die E-Mail-Adresse des Nutzers als Alias für {user} verwenden. user.name kann beispielsweise users/example@gmail.com sein. Wenn Sie Gmail-Nutzer oder Nutzer aus externen Google Workspace-Domains einladen möchten, muss die E-Mail-Adresse des Nutzers für {user} verwendet werden.

Für die Mitgliedschaft in Google-Gruppen muss das Feld Membership.group_member ein group mit name enthalten (Format groups/{group}). Sie können Google-Gruppen nur hinzufügen, wenn Sie Space.spaceType auf SPACE festlegen.

Optional, wenn Space.spaceType auf SPACE gesetzt ist.

Erforderlich, wenn Space.spaceType auf GROUP_CHAT gesetzt ist, zusammen mit mindestens zwei Mitgliedschaften.

Erforderlich, wenn Space.spaceType auf DIRECT_MESSAGE gesetzt ist und ein Nutzer dabei ist, sowie genau eine Mitgliedschaft.

Muss leer sein, wenn eine Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellt wird (wenn Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true gesetzt wird).

int64

Die ID des aufgerufenen Slash-Befehls.

User

Die Chat-App, deren Befehl aufgerufen wurde.

Type

Der Typ des Slash-Befehls.

string

Der Name des aufgerufenen Slash-Befehls.

int64

Die Befehls-ID des aufgerufenen Slash-Befehls.

bool

Gibt an, ob der Befehl für ein Dialogfeld gedacht ist.

string

Ressourcenname des Gruppenbereichs.

Format: spaces/{space}

Dabei steht {space} für die vom System zugewiesene ID des Gruppenbereichs. Sie können die Gruppenbereichs-ID durch Aufrufen der Methode spaces.list() oder über die Gruppenbereichs-URL abrufen. Wenn die Gruppenbereichs-URL beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die Gruppenbereichs-ID AAAAAAAAA.

Type

Nur Ausgabe. Eingestellt: Verwende stattdessen space_type. Der Typ eines Gruppenbereichs.

SpaceType

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder Aktualisieren des Gruppenbereichstyps. Ausgabe nur für andere Zwecke.

bool

Optional. Gibt an, ob es sich bei dem Gruppenbereich um eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person handelt.

bool

Nur Ausgabe. Eingestellt: Verwende stattdessen spaceThreadingState. Ob Nachrichten in diesem Gruppenbereich in Threads angezeigt werden.

string

Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich mit einer spaceType von SPACE erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs oder Aktualisieren des displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden Gruppenbereich in der Google Workspace-Organisation verwendet.

Bei Direktnachrichten ist dieses Feld möglicherweise leer.

Unterstützt bis zu 128 Zeichen.

bool

Nicht veränderbar. Gibt an, ob für diesen Gruppenbereich alle Google Chat-Nutzer als Mitglied zugelassen sind. Wird beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation eingegeben. Lassen Sie dieses Feld in den folgenden Fällen weg, wenn Sie Gruppenbereiche erstellen:

• Der authentifizierte Nutzer verwendet ein Privatkonto (nicht verwaltetes Nutzerkonto). In einem Gruppenbereich, der von einem privaten Konto erstellt wurde, ist standardmäßig der Zugriff für alle Google Chat-Nutzer erlaubt.

Bei bestehenden Gruppenbereichen dient dieses Feld nur der Ausgabe.

SpaceThreadingState

Nur Ausgabe. Der Status der Unterhaltungsbereiche im Chatbereich.

SpaceDetails

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.

HistoryState

Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich.

bool

Optional. Gibt an, ob dieser Gruppenbereich in Import Mode im Rahmen einer Datenmigration zu Google Workspace erstellt wird. Während des Imports von Gruppenbereichen sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist.

Für das Erstellen eines Gruppenbereichs in Import Mode ist eine Nutzerauthentifizierung erforderlich.

Timestamp

Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen ist es die Uhrzeit, zu der der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus in diesem Feld den Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.

Wird nur in die Ausgabe aufgenommen, wenn spaceType GROUP_CHAT oder SPACE ist.

Timestamp

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.

bool

Nur Ausgabe. Ob ein Gruppenbereich für Direktnachrichten (DM-Gruppenbereich) mit einer Chat-App von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Direktnachricht mit einer Chat-App installieren und einrichten.

Damit die Installation durch Administratoren unterstützt wird, muss Ihre Chat-App Direktnachrichten unterstützen.

MembershipCount

Nur Ausgabe. Die Anzahl der Mitgliedschaften, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn space_type SPACE, DIRECT_MESSAGE oder GROUP_CHAT ist.

AccessSettings

Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn space_type SPACE ist.

string

Nur Ausgabe. Der URI, über den ein Nutzer auf den Gruppenbereich zugreifen kann.

string

Optional. Nicht veränderbar. Die Kunden-ID der Domain des Gruppenbereichs. Nur erforderlich, wenn Sie einen Gruppenbereich mit App-Authentifizierung erstellen und SpaceType = SPACE ist. Andernfalls sollte dieser Parameter nicht festgelegt werden.

Im Format customers/{customer}, wobei customer die id aus der [Admin SDK-Kundenressource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) ist. Bei privaten Apps kann der Alias customers/my_customer auch verwendet werden, um den Gruppenbereich in derselben Google Workspace-Organisation wie die App zu erstellen.

Bei DMs ist dieses Feld nicht ausgefüllt.

PredefinedPermissionSettings

Optional. Nur Eingabe. Vordefinierte Berechtigungseinstellungen für Gruppenbereiche, die nur beim Erstellen eines Gruppenbereichs eingegeben werden. Wenn das Feld nicht festgelegt ist, wird ein Gruppenbereich erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen in das Feld PermissionSettings eingefügt.

PermissionSettings

Optional. Berechtigungseinstellungen für den Gruppenbereich für vorhandene Gruppenbereiche. Eingabe zum Aktualisieren der genauen Berechtigungseinstellungen für den Gruppenbereich, wobei vorhandene Berechtigungseinstellungen ersetzt werden. Die Ausgabe enthält die aktuellen Berechtigungseinstellungen.

AccessState

Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an.

string

Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und sich eine Vorschau der Nachrichten im Gruppenbereich ansehen kann. Wenn die Richtlinie nicht konfiguriert ist, können nur Nutzer oder Google-Gruppen, die einzeln eingeladen oder dem Gruppenbereich hinzugefügt wurden, darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für eine Zielgruppe sichtbar machen.

Format: audiences/{audience}

Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie audiences/default fest.

Die Lektüre der Zielgruppe hilft:

• Nutzerauthentifizierung

• App-Authentifizierung mit Administratorzustimmung mit dem Bereich chat.app.spaces in

Dieses Feld wird nicht ausgefüllt, wenn der Umfang chat.bot mit der App-Authentifizierung verwendet wird.

Für die Festlegung der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

int32

Anzahl der natürlichen Personen, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über eine Mitgliedschaft in einer verknüpften Gruppe beigetreten sind, werden nicht gezählt.

int32

Die Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

bool

Ob Administratoren von Gruppenbereichen diese Berechtigung haben.

bool

Ob Mitglieder ohne die Rolle „Administrator“ diese Berechtigung haben.

PermissionSetting

Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich.

PermissionSetting

Einstellung zum Aktualisieren des Namens, des Avatars, der Beschreibung und der Richtlinien des Gruppenbereichs.

PermissionSetting

Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs.

PermissionSetting

Einstellung für die Verwendung von @alle in einem Gruppenbereich.

PermissionSetting

Einstellung zum Verwalten von Apps in einem Gruppenbereich.

PermissionSetting

Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.

PermissionSetting

Nur Ausgabe. Einstellung für das Posten von Nachrichten in einem Gruppenbereich.

PermissionSetting

Einstellung für das Beantworten von Nachrichten in einem Gruppenbereich.

string

Optional. Eine Beschreibung des Gruppenbereichs. Sie können beispielsweise das Diskussionsthema, den Zweck oder die Teilnehmer des Gruppenbereichs beschreiben.

Unterstützt bis zu 150 Zeichen.

string

Optional. die Regeln, Erwartungen und Umgangsformen des Gruppenbereichs

Unterstützt bis zu 5.000 Zeichen.

SpaceUpdatedEventData

Eine Liste der aktualisierten Gruppenbereiche.

string

Ressourcenname des Gruppenbereichsereignisses.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Zeit, zu der das Ereignis aufgetreten ist.

string

Art des Gruppenbereichsereignisses. Jeder Ereignistyp hat eine Batchversion, die mehrere Instanzen des Ereignistyps darstellt, die in einem kurzen Zeitraum auftreten. Lassen Sie bei spaceEvents.list()-Anfragen die Batchereignistypen im Abfragefilter weg. Standardmäßig gibt der Server sowohl den Ereignistyp als auch die Batchversion zurück.

Unterstützte Ereignistypen für messages:

• Neue Nachricht: google.workspace.chat.message.v1.created
• Aktualisierte Nachricht: google.workspace.chat.message.v1.updated
• Gelöschte Nachricht: google.workspace.chat.message.v1.deleted
• Mehrere neue Nachrichten: google.workspace.chat.message.v1.batchCreated
• Mehrere aktualisierte Nachrichten: google.workspace.chat.message.v1.batchUpdated
• Mehrere gelöschte Nachrichten: google.workspace.chat.message.v1.batchDeleted

Unterstützte Ereignistypen für Kanalmitgliedschaften:

• Neue Mitgliedschaft: google.workspace.chat.membership.v1.created
• Aktualisierte Mitgliedschaft: google.workspace.chat.membership.v1.updated
• Gelöschte Mitgliedschaft: google.workspace.chat.membership.v1.deleted
• Mehrere neue Mitgliedschaften: google.workspace.chat.membership.v1.batchCreated
• Mehrere aktualisierte Mitgliedschaften: google.workspace.chat.membership.v1.batchUpdated
• Mehrere gelöschte Mitgliedschaften: google.workspace.chat.membership.v1.batchDeleted

Unterstützte Ereignistypen für Reaktionen:

• Neue Reaktion: google.workspace.chat.reaction.v1.created
• Gelöschte Reaktion: google.workspace.chat.reaction.v1.deleted
• Mehrere neue Reaktionen: google.workspace.chat.reaction.v1.batchCreated
• Mehrere gelöschte Reaktionen: google.workspace.chat.reaction.v1.batchDeleted

Unterstützte Ereignistypen für den Raum:

• Aktualisierter Gruppenbereich: google.workspace.chat.space.v1.updated
• Mehrere Aktualisierungen für Gruppenbereiche: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Ereignisnutzlast für eine neue Nachricht.

Ereignistyp: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Ereignisnutzlast für eine aktualisierte Nachricht.

Ereignistyp: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Ereignisnutzlast für eine gelöschte Nachricht.

Ereignistyp: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Ereignisnutzlast für mehrere neue Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Ereignisnutzlast für eine Gruppenbereichsaktualisierung.

Ereignistyp: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Aktualisierungen eines Gruppenbereichs.

Ereignistyp: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Ereignisnutzlast für eine neue Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Ereignisnutzlast für eine aktualisierte Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Ereignisnutzlast für eine gelöschte Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Ereignisnutzlast für mehrere neue Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Ereignisnutzlast für eine neue Reaktion.

Ereignistyp: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Ereignisnutzlast für eine gelöschte Reaktion.

Ereignistyp: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Ereignisnutzlast für mehrere neue Reaktionen.

Ereignistyp: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Reaktionen.

Ereignistyp: google.workspace.chat.reaction.v1.batchDeleted

string

Kennung. Der Ressourcenname der Benachrichtigungseinstellung für den Gruppenbereich. Format: users/{user}/spaces/{space}/spaceNotificationSetting.

NotificationSetting

Die Benachrichtigungseinstellung.

MuteSetting

Die Einstellung für die Stummschaltung von Benachrichtigungen für den Gruppenbereich.

string

Ressourcenname des Lesestatus des Gruppenbereichs.

Format: users/{user}/spaces/{space}/spaceReadState

Timestamp

Optional. Die Uhrzeit, zu der der Lesestatus des Nutzers für den Gruppenbereich aktualisiert wurde. In der Regel entspricht dies entweder dem Zeitstempel der zuletzt gelesenen Nachricht oder einem Zeitstempel, der vom Nutzer angegeben wurde, um die zuletzt gelesene Position in einem Bereich zu markieren.

Space

Der aktualisierte Gruppenbereich.

string

Ressourcenname des Threads.

Beispiel: spaces/{space}/threads/{thread}

string

Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls wird nur die Ausgabe verwendet. ID für den Thread. Unterstützt bis zu 4.000 Zeichen.

Diese ID ist für die Chat-App, die sie festlegt, eindeutig. Wenn beispielsweise mehrere Chat-Apps eine Nachricht mit demselben Thread-Schlüssel erstellen, werden die Nachrichten in verschiedenen Threads gepostet. Wenn Sie in einem Thread antworten möchten, der von einer Person oder einer anderen Chat-App erstellt wurde, geben Sie stattdessen das Thread-name-Feld an.

string

Ressourcenname des Thread-Lesestatus.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

Die Uhrzeit, zu der der Lesestatus des Threads des Nutzers aktualisiert wurde. Normalerweise entspricht dies dem Zeitstempel der zuletzt gelesenen Nachricht in einem Thread.

Membership

Erforderlich. Die zu aktualisierende Mitgliedschaft. Nur die mit update_mask angegebenen Felder werden aktualisiert.

FieldMask

Erforderlich. Die zu aktualisierenden Feldpfade. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie *, um alle Feldpfade zu aktualisieren.

Derzeit unterstützte Feldpfade:

• role

bool

Wenn true, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.memberships OAuth 2.0-Bereich.

Message

Erforderlich. Nachricht mit aktualisierten Feldern.

FieldMask

Erforderlich. Die Feldpfade, die aktualisiert werden sollen. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie *, um alle Feldpfade zu aktualisieren.

Derzeit unterstützte Feldpfade:

• text

• attachment

• cards (App-Authentifizierung erforderlich)

• cards_v2 (App-Authentifizierung erforderlich)

• accessory_widgets (App-Authentifizierung erforderlich)

bool

Optional. Wenn true und die Nachricht nicht gefunden werden, wird eine neue Nachricht erstellt und updateMask wird ignoriert. Die angegebene Nachrichten-ID muss vom Client zugewiesen sein, andernfalls schlägt die Anfrage fehl.

SpaceNotificationSetting

Erforderlich. Der Ressourcenname für die Benachrichtigungseinstellungen des Gruppenbereichs muss im Format users/{user}/spaces/{space}/spaceNotificationSetting angegeben werden. Nur die mit update_mask angegebenen Felder werden aktualisiert.

FieldMask

Erforderlich. Unterstützte Feldpfade: – notification_setting – mute_setting

SpaceReadState

Erforderlich. Der Lesestatus und die zu aktualisierenden Felder des Gruppenbereichs.

Unterstützt nur die Aktualisierung des Lesestatus für den anrufenden Nutzer.

Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest:

• Der Alias für me. Beispiel: users/me/spaces/{space}/spaceReadState.

• Ihre Workspace-E-Mail-Adresse. Beispiel: users/user@example.com/spaces/{space}/spaceReadState.

• Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState.

Format: users/{user}/spaces/{space}/spaceReadState

FieldMask

Erforderlich. Die zu aktualisierenden Feldpfade. Derzeit unterstützte Feldpfade:

• last_read_time

Wenn last_read_time vor dem Zeitpunkt der letzten Nachrichtenerstellung liegt, wird der Gruppenbereich in der UI als ungelesen angezeigt.

Um den Gruppenbereich als gelesen zu markieren, legen Sie für last_read_time einen beliebigen Wert fest, der nach dem Zeitpunkt der letzten Nachrichtenerstellung liegt (größer). Der Wert von last_read_time wird auf die Zeit des Erstellens der letzten Nachricht festgelegt. Der Lesestatus des Gruppenbereichs wirkt sich nur auf den Lesestatus von Nachrichten aus, die in der Unterhaltung auf oberster Ebene des Gruppenbereichs sichtbar sind. Antworten in Threads sind von diesem Zeitstempel nicht betroffen und basieren stattdessen auf dem Lesestatus des Threads.

Space

Erforderlich. Gruppenbereich mit Feldern, die aktualisiert werden sollen. Space.name muss im Format spaces/{space} ausgefüllt werden. Nur die mit update_mask angegebenen Felder werden aktualisiert.

FieldMask

Erforderlich. Die aktualisierten Feldpfade, bei mehreren durch Kommas getrennt.

Sie können die folgenden Felder für einen Gruppenbereich aktualisieren:

space_details: Aktualisiert die Beschreibung des Gruppenbereichs. Unterstützt bis zu 150 Zeichen.

display_name: Der Anzeigename kann nur für Gruppenbereiche aktualisiert werden, in denen das Feld spaceType den Wert SPACE hat. Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Wert. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden Gruppenbereich in der Google Workspace-Organisation verwendet.

space_type: Unterstützt nur das Ändern des Gruppenbereichstyps „GROUP_CHAT“ zu „SPACE“. Fügen Sie display_name zusammen mit space_type in die Aktualisierungsmaske ein und achten Sie darauf, dass das angegebene Leerzeichen einen Anzeigenamen und den Gruppenbereichstyp SPACE enthält. Das Einfügen der Maske space_type und des Typs SPACE im angegebenen Bereich beim Aktualisieren des Anzeigenamens ist optional, wenn der vorhandene Bereich bereits den Typ SPACE hat. Versuche, den Gruppenbereichstyp auf andere Weise zu aktualisieren, führen zu einem Fehler aufgrund eines ungültigen Arguments. space_type wird von useAdminAccess nicht unterstützt.

space_history_state: Aktualisiert die Einstellungen für den Verlauf des Gruppenbereichs, indem der Verlauf für den Gruppenbereich aktiviert oder deaktiviert wird. Wird nur unterstützt, wenn Verlaufseinstellungen für die Google Workspace-Organisation aktiviert sind. Wenn Sie den Verlaufsstatus des Gruppenbereichs aktualisieren möchten, müssen Sie alle anderen Feldmasken in Ihrer Anfrage weglassen. space_history_state wird von useAdminAccess nicht unterstützt.

access_settings.audience: Aktualisiert die Zugriffseinstellung für Nutzer, die den Gruppenbereich finden, ihm beitreten und sich eine Vorschau der Nachrichten im benannten Gruppenbereich ansehen können, in dem das Feld spaceType den Wert SPACE hat. Wenn für den vorhandenen Gruppenbereich eine Zielgruppe festgelegt ist, können Sie sie entfernen und den Zugriff auf den Gruppenbereich einschränken, indem Sie einen Wert für diese Feldmaske weglassen. Wenn Sie die Zugriffseinstellungen für einen Gruppenbereich aktualisieren möchten, muss der authentifizierende Nutzer ein Administrator des Gruppenbereichs sein und alle anderen Feldmasken in der Anfrage weglassen. Dieses Feld kann nicht aktualisiert werden, wenn sich der Gruppenbereich im Importmodus befindet. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer sichtbar machen. access_settings.audience wird von useAdminAccess nicht unterstützt.

permission_settings: Unterstützt das Ändern der Berechtigungseinstellungen eines Gruppenbereichs. Beim Aktualisieren der Berechtigungseinstellungen können Sie nur permissionSettings-Feldmasken angeben. Andere Feldmasken können nicht gleichzeitig aktualisiert werden. permissionSettings wird von useAdminAccess nicht unterstützt. Folgende Feldmasken werden unterstützt:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung „Unterhaltungen in Chats und Gruppenbereichen verwalten“ sein.

Erfordert den chat.admin.spaces OAuth 2.0-Bereich.

Einige FieldMask-Werte werden mit Administratorzugriff nicht unterstützt. Weitere Informationen finden Sie in der Beschreibung von update_mask.

string

Ressourcenname für eine Google Chat-user.

Format: users/{user}. users/app kann als Alias für den bot-Nutzer der aufrufenden App verwendet werden.

Für human users ist {user} dieselbe Nutzer-ID wie:

• die id für die Person in der People API. Beispielsweise entspricht users/123456789 in der Chat API derselben Person wie die 123456789-Personenprofil-ID in der People API.

• die id für einen Nutzer in der Admin SDK Directory API.

• Die E-Mail-Adresse des Nutzers kann in API-Anfragen als Alias für {user} verwendet werden. Wenn die Personenprofil-ID der People API für user@example.com beispielsweise 123456789 lautet, können Sie users/user@example.com als Alias verwenden, um auf users/123456789 zu verweisen. Es wird nur der kanonische Ressourcenname (z. B. users/123456789) von der API zurückgegeben.

string

Nur Ausgabe. Der Anzeigename des Nutzers.

string

Eindeutige Kennung der Google Workspace-Domain des Nutzers.

Type

Nutzertyp.

bool

Nur Ausgabe. Wenn true, wird der Nutzer gelöscht oder sein Profil ist nicht sichtbar.

User

Der erwähnte Nutzer.

Type

Der Typ der Nutzererwähnung.

Button

Eine Liste von Schaltflächen. Buttons ist ebenfalls oneof data und nur eines dieser Felder sollte festgelegt sein.

TextParagraph

In diesem Widget wird ein Textabsatz angezeigt.

Image

In diesem Widget wird ein Bild angezeigt.

KeyValue

Hier können Sie einen Schlüssel/Wert-Eintrag anzeigen.

TextButton

Eine Schaltfläche mit Text und onclick-Aktion.

ImageButton

Eine Schaltfläche mit Bild und onclick-Aktion.

string

Anhand des Methodennamens wird ermittelt, welcher Teil des Formulars die Formulareinreichung ausgelöst hat. Diese Informationen werden im Rahmen des Kartenklickereignisses an die Chat-App zurückgegeben. Sie können denselben Methodennamen für mehrere Elemente verwenden, die ein gemeinsames Verhalten auslösen.

ActionParameter

Liste der Aktionsparameter.

string

Der Name des Parameters für das Aktionsskript.

string

Wert des Parameters.

string

Die URL des Bildes.

OnClick

Die Aktion onclick.

double

Das Seitenverhältnis dieses Bilds (Breite und Höhe). In diesem Feld können Sie die richtige Höhe für das Bild reservieren, während Sie auf das Laden warten. Es ist nicht dazu gedacht, das integrierte Seitenverhältnis des Bildes zu überschreiben. Wenn das Attribut nicht festgelegt ist, wird es vom Server durch Vorabladen des Bildes ausgefüllt.

OnClick

Die Aktion onclick.

string

Der Name dieses image_button, der für Bedienungshilfen verwendet wird. Wenn dieser Name nicht angegeben ist, wird ein Standardwert verwendet.