Package google.chat.v1

Der Gruppenbereich im Importmodus.

ContextualAddOnMarkup

Dieser Typ hat keine Felder.

Das Markup, mit dem Entwickler den Inhalt eines kontextbezogenen Add-ons angeben können.

Infokarte

Eine Karte ist ein UI-Element, das UI-Widgets wie Text und Bilder enthalten kann.

Felder
`header`	`CardHeader` Die Kopfzeile der Karte. Ein Header enthält in der Regel einen Titel und ein Bild.
`sections[]`	`Section` Die Abschnitte sind durch eine Trennlinie voneinander getrennt.
`card_actions[]`	`CardAction` Die Aktionen dieser Karte.
`name`	`string` Name der Karte.

CardAction

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Bei einer Rechnungskarte wäre eine typische Aktion: Rechnung löschen, Rechnung per E-Mail senden oder Rechnung im Browser öffnen.

Wird von Google Chat-Apps nicht unterstützt.

Felder

action_label

string

Das Label, das im Aktionsmenüelement angezeigt wurde.

on_click

OnClick

Die onclick-Aktion für dieses Aktionselement.

CardHeader

Felder
`title`	`string` Der Titel muss angegeben werden. Der Header hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben ist, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.
`subtitle`	`string` Der Untertitel der Kartenkopfzeile.
`image_style`	`ImageStyle` Der Typ des Bildes (z. B. quadratischer oder runder Rahmen).
`image_url`	`string` Die URL des Bildes in der Kopfzeile der Karte.

ImageStyle

Enums
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Quadratischer Rahmen.
`AVATAR`	Kreisförmiger Rahmen.

Bereich

Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der Reihenfolge gerendert werden, in der sie angegeben sind. Auf allen Plattformen haben Karten eine schmale feste Breite, sodass derzeit keine Layout-Properties (z. B. „float“) erforderlich sind.

Felder

header

string

Die Überschrift 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.

widgets[]

WidgetMarkup

Ein Abschnitt muss mindestens ein Widget enthalten.

CreateCustomEmojiRequest

Eine Anfrage zum Erstellen eines benutzerdefinierten Emojis.

Felder

custom_emoji

Erforderlich. Das zu erstellende benutzerdefinierte Emoji.

CreateMembershipRequest

Anfragenachricht zum Erstellen einer Mitgliedschaft.

Felder

parent

string

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

Format: spaces/{space}

membership

Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung.

Das Feld memberType muss einen Nutzer enthalten, bei dem die Felder user.name und user.type ausgefüllt sind. Der Server weist einen Ressourcennamen zu und überschreibt alle angegebenen Werte.

Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen menschlichen 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.
Legen Sie user.type auf HUMAN und user.name im Format users/{user} fest, wobei {user} die E-Mail-Adresse des Nutzers sein kann. Für Nutzer in derselben Workspace-Organisation kann {user} auch die id der Person aus der People API oder die id für den Nutzer in der Directory API sein. Wenn die Profil-ID der Person in 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 Sie Nutzer außerhalb der Workspace-Organisation einladen möchten, die Inhaber des Gruppenbereichs ist, ist eine Nutzerauthentifizierung erforderlich.

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

use_admin_access

bool

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

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

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

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

CreateMessageNotificationOptions

Optionen für das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird.

Felder

notification_type

NotificationType

Der Benachrichtigungstyp für die Nachricht.

NotificationType

Die Optionen für die Benachrichtigungstypen der Nachricht.

Enums

NOTIFICATION_TYPE_NONE Standardverhalten. Das Benachrichtigungsverhalten ist ähnlich wie beim Senden der Nachricht über die Chat-Benutzeroberfläche: Der menschliche Absender erhält keine Benachrichtigung.

NOTIFICATION_TYPE_FORCE_NOTIFY

Erzwingen Sie die Benachrichtigung der Empfänger. Dadurch werden die Benachrichtigungseinstellungen für Gruppenbereiche und die Einstellungen für „Bitte nicht stören“ in Google Chat umgangen. Diese Option umgeht nicht die Einstellungen für „Bitte nicht stören“ auf Geräteebene.

App-Authentifizierung erforderlich.

NOTIFICATION_TYPE_SILENT

Empfänger nicht benachrichtigen und die Nachricht nicht als ungelesen markieren. Das Verhalten ist ähnlich, wie wenn der Nutzer die Unterhaltung stummschaltet oder Bitte nicht stören aktiviert.

App-Authentifizierung erforderlich.

CreateMessagePinRequest

Anfragenachricht zum Erstellen einer angepinnten Nachricht.

Felder

parent

string

Erforderlich. Der übergeordnete Space, in dem die angepinnte Nachricht erstellt werden soll. Format: spaces/{space}

message_pin

MessagePin

Erforderlich. Der zu erstellende MessagePin.

CreateMessageRequest

Erstellt eine Nachricht.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Space, in dem eine Nachricht erstellt werden soll. Format: `spaces/{space}`
`message`	`Message` Erforderlich. Inhalt der Nachricht.
`thread_key (deprecated)`	`string` Dieses Element wird nicht mehr unterstützt. Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen `thread.thread_key`. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Wenn Sie einen Thread starten oder einem Thread etwas hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie eine `threadKey` oder die `thread.name` an. Beispiele für die Verwendung finden Sie unter Unterhaltung starten oder auf eine Nachricht antworten.
`request_id`	`string` Optional. Eine eindeutige ID für diese Anfrage. Eine zufällige UUID wird empfohlen. Durch die Angabe einer Anfrage-ID wird die Anfrage idempotent. So wird sichergestellt, dass mehrere identische Anfragen mit derselben Anfrage-ID nur zur Erstellung einer einzigen Nachricht führen. Bei nachfolgenden Anfragen mit derselben Anfrage-ID wird die vorhandene Nachricht zurückgegeben und nicht aktualisiert, auch wenn sich die angeforderten Details vom aktuellen Status unterscheiden. So verwenden Sie dieses Feld effektiv: Achten Sie darauf, dass nachfolgende Anfragen mit der ursprünglichen Anfrage identisch sind und dieselben Authentifizierungsdaten verwenden. Wenn bereits eine Nachricht mit der angegebenen Anfrage-ID erstellt wurde, wird diese Nachricht zurückgegeben. Die zurückgegebene Nachricht ist möglicherweise nicht vollständig ausgefüllt. Die API gibt die Nachricht in Ihrer Anfrage mit den vom System zugewiesenen Ressourcennamen zurück. Rufen Sie `GetMessage` auf, um die neuesten Metadaten für die Nachricht abzurufen. Wenn Sie eine vorhandene Anfrage-ID mit einem anderen authentifizierten Nutzer wiederverwenden, wird ein Fehler ausgegeben.
`message_reply_option`	`MessageReplyOption` Optional. Gibt an, ob eine Nachricht einen Thread startet oder auf einen Thread antwortet. Wird nur in benannten Gruppenbereichen unterstützt. Wenn Sie auf Nutzerinteraktionen reagieren, wird dieses Feld ignoriert. Bei Interaktionen innerhalb eines Threads wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt.
`message_id`	`string` Optional. Eine benutzerdefinierte ID für eine Nachricht. Ermöglicht Chat-Apps, eine Nachricht abzurufen, zu aktualisieren oder zu löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Nachrichtenfeld `name`) 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. Ist innerhalb eines Space eindeutig. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für verschiedene Nachrichten verwenden. Weitere Informationen finden Sie unter Nachricht benennen.
`create_message_notification_options`	`CreateMessageNotificationOptions` Optional. Steuert das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird. Weitere Informationen finden Sie unter Benachrichtigungen erzwingen oder lautlose Nachrichten senden.

MessageReplyOption

Gibt an, wie auf eine Nachricht geantwortet werden soll. In Zukunft werden möglicherweise weitere Bundesstaaten hinzugefügt.

Enums
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	Standard. Startet einen neuen Thread. Wenn Sie diese Option verwenden, werden alle enthaltenen `thread ID`- oder `thread_key`-Werte ignoriert.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Erstellt die Nachricht als Antwort auf den Thread, der durch `thread ID` oder `thread_key` angegeben ist. Wenn dies fehlschlägt, wird mit der Nachricht stattdessen ein neuer Thread gestartet.
`REPLY_MESSAGE_OR_FAIL`	Erstellt die Nachricht als Antwort auf den Thread, der durch `thread ID` oder `thread_key` angegeben ist. Wenn ein neuer `thread_key` verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachrichtenerstellung fehlschlägt, wird stattdessen ein `NOT_FOUND`-Fehler zurückgegeben.

CreateReactionRequest

Erstellt eine Reaktion auf eine Nachricht.

Felder

parent

string

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

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

reaction

Erforderlich. Die zu erstellende Reaktion.

CreateSectionRequest

Anfragenachricht zum Erstellen eines Abschnitts.

Felder

parent

string

Erforderlich. Der Name der übergeordneten Ressource, in der der Abschnitt erstellt wird.

Format: users/{user}

section

Erforderlich. Der zu erstellende Abschnitt.

CreateSpaceRequest

Eine Anfrage zum Erstellen eines benannten Gruppenbereichs ohne Mitglieder.

Felder

space

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

Wenn du die Fehlermeldung „ALREADY_EXISTS“ erhältst, versuche es mit einem anderen displayName. Ein vorhandener Gruppenbereich in der Google Workspace-Organisation verwendet diesen Anzeigenamen möglicherweise bereits.

Der Bereich name wird auf dem Server zugewiesen. Alle in diesem Feld angegebenen Werte werden daher ignoriert.

request_id

string

Optional. Eine eindeutige ID für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine Anfrage-ID angeben, wird die Anfrage idempotent. Das bedeutet, dass mehrere identische Anfragen mit derselben Anfrage-ID nur zur Erstellung eines einzigen Space führen. Bei nachfolgenden Anfragen mit derselben Anfrage-ID wird der vorhandene Space zurückgegeben und nicht aktualisiert, auch wenn sich die angeforderten Details vom aktuellen Status unterscheiden.

So verwenden Sie dieses Feld effektiv:

Achten Sie darauf, dass nachfolgende Anfragen mit der ursprünglichen Anfrage identisch sind und dieselben Authentifizierungsdaten verwenden.
Wenn bereits ein Gruppenbereich mit der angegebenen Anfrage-ID erstellt wurde, wird dieser Gruppenbereich zurückgegeben. Der zurückgegebene Space ist möglicherweise nicht vollständig ausgefüllt. Die API gibt den Space in Ihrer Anfrage mit dem vom System zugewiesenen Ressourcennamen zurück. Rufen Sie GetSpace auf, um die neuesten Metadaten für den Space abzurufen.
Wenn Sie eine vorhandene Anfrage-ID mit einem anderen authentifizierten Nutzer wiederverwenden, wird ein Fehler ausgegeben.

CustomEmoji

Stellt ein benutzerdefiniertes Emoji dar.

Felder
`name`	`string` ID. Der Ressourcenname des benutzerdefinierten Emojis, der vom Server zugewiesen wird. Format: `customEmojis/{customEmoji}`
`uid`	`string` Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource.
`emoji_name`	`string` Optional. Nicht veränderbar. Vom Nutzer angegebener Name für das benutzerdefinierte Emoji, der innerhalb der Organisation eindeutig ist. Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird, andernfalls nur Ausgabe. Emoji-Namen müssen mit Doppelpunkten beginnen und enden, müssen 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:`
`temporary_image_uri`	`string` Nur Ausgabe. Eine temporäre Bild-URL für das benutzerdefinierte Emoji, die mindestens 10 Minuten lang gültig ist. Beachten Sie, dass dieses Feld in der Antwort nicht ausgefüllt wird, wenn das benutzerdefinierte Emoji erstellt wird.
`payload`	`CustomEmojiPayload` Optional. Nur Eingabe. Nutzlastdaten. Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird.

CustomEmojiPayload

Nutzlastdaten für das benutzerdefinierte Emoji.

Felder

file_content

bytes

Erforderlich. Nur Eingabe. Das Bild, das für das benutzerdefinierte Emoji verwendet wird.

Die Nutzlast muss kleiner als 256 KB sein und das Bild muss quadratisch sein und eine Größe zwischen 64 und 500 Pixeln haben. Die Einschränkungen können sich ändern.

filename

string

Erforderlich. Nur Eingabe. Der Name der Bilddatei.

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

CustomEmojiMetadata

Anmerkungsmetadaten für benutzerdefinierte Emojis.

Felder

custom_emoji

Das benutzerdefinierte Emoji.

CustomStatus

Stellt den benutzerdefinierten Status eines Nutzers in Google Chat dar. Dazu gehört eine kurze Textnachricht mit einem optionalen Emoji, das ein Nutzer festlegt, um mehr Kontext zu seiner Verfügbarkeit zu geben.

Felder
`text`	`string` Erforderlich. Der Text des benutzerdefinierten Status. Dies ist ein String mit einer maximalen Länge von 64 Zeichen.
`emoji`	`Emoji` Erforderlich. Das Emoji des benutzerdefinierten Status. Es werden nur Unicode-Emojis unterstützt. Benutzerdefinierte Emojis werden nicht unterstützt.
Union-Feld `expiration`. Die Ablaufzeit des benutzerdefinierten Status. Sie kann entweder als absoluter Zeitstempel oder als Gültigkeitsdauer angegeben werden. Für `expiration` ist nur einer der folgenden Werte zulässig:
`expire_time`	`Timestamp` Der Zeitstempel, der angibt, wann der benutzerdefinierte Status abläuft.
`ttl`	`Duration` Nur Eingabe. Die Gültigkeitsdauer, nach der der benutzerdefinierte Status abläuft.

DeleteCustomEmojiRequest

Anfrage zum Löschen eines benutzerdefinierten Emojis.

Felder

name

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 Name eines benutzerdefinierten Emojis ist.

DeleteMembershipRequest

Anfrage zum Löschen einer Mitgliedschaft in einem Gruppenbereich.

Felder

name

string

Erforderlich. Ressourcenname der zu löschenden Mitgliedschaft. Chat-Apps können die Mitgliedschaften von menschlichen Nutzern oder ihre eigenen Mitgliedschaften löschen. Chat-Apps können die Mitgliedschaften anderer Apps nicht löschen.

Zum Löschen einer menschlichen Mitgliedschaft ist der Bereich chat.memberships mit Nutzerauthentifizierung oder der Bereich chat.memberships.app mit App-Authentifizierung 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

use_admin_access

bool

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

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

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

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

DeleteMessagePinRequest

Anfragenachricht zum Löschen einer angepinnten Nachricht.

Felder

name

string

Erforderlich. Der Ressourcenname der zu entfernenden angepinnten Nachricht. Format: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

Anfrage zum Löschen einer Nachricht.

Felder

name

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 finden Sie unter Nachricht benennen.

force

bool

Optional. Wenn true, werden beim Löschen einer Nachricht auch die Antworten im Thread gelöscht. Wenn false, schlägt das Löschen fehl, wenn eine Nachricht Antworten mit Threads enthält.

Gilt nur bei der Authentifizierung als Nutzer. Hat keine Auswirkungen, wenn die Authentifizierung als Chat-App erfolgt.

DeleteReactionRequest

Löscht eine Reaktion auf eine Nachricht.

Felder

name

string

Erforderlich. Name der zu löschenden Reaktion.

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

DeleteSectionRequest

Anfragenachricht zum Löschen eines Abschnitts.

Felder

name

string

Erforderlich. Der Name des zu löschenden Abschnitts.

Format: users/{user}/sections/{section}

DeleteSpaceRequest

Anfrage zum Löschen eines Gruppenbereichs.

Felder

name

string

Erforderlich. Ressourcenname des zu löschenden Space.

Format: spaces/{space}

use_admin_access

bool

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

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

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

DeletionMetadata

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

Felder

deletion_type

DeletionType

Gibt an, wer die Nachricht gelöscht hat.

DeletionType

Wer die Nachricht gelöscht hat und wie sie gelöscht wurde. In Zukunft werden möglicherweise weitere Werte hinzugefügt. Weitere Informationen dazu, wann Nachrichten gelöscht werden können, finden Sie im Hilfeartikel Nachrichten in Google Chat bearbeiten oder löschen.

Enums
`DELETION_TYPE_UNSPECIFIED`	Dieser Wert wird nicht verwendet.
`CREATOR`	Der Nutzer hat seine eigene Nachricht gelöscht.
`SPACE_OWNER`	Ein Inhaber oder Manager hat die Nachricht gelöscht.
`ADMIN`	Ein Google Workspace-Administrator hat die Nachricht gelöscht. Administratoren können jede Nachricht im Gruppenbereich löschen, einschließlich Nachrichten, die von einem Mitglied des Gruppenbereichs oder einer Chat-App gesendet wurden.
`APP_MESSAGE_EXPIRY`	Eine Chat-App hat ihre eigene Nachricht gelöscht, als sie abgelaufen ist.
`CREATOR_VIA_APP`	Eine Chat-App hat die Nachricht im Namen des Erstellers gelöscht (über die Nutzerauthentifizierung).
`SPACE_OWNER_VIA_APP`	Eine Chat-App hat die Nachricht im Namen eines Administrators des Gruppenbereichs gelöscht (über die Nutzerauthentifizierung).
`SPACE_MEMBER`	Ein Mitglied des Gruppenbereichs hat die Nachricht gelöscht. Nutzer können von Apps gesendete Nachrichten löschen.

Dialog

Wrapper um den Kartentext des Dialogfelds.

Felder

body

Card

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

DialogAction

Enthält einen Dialog und einen Anfragestatuscode.

Felder

action_status

ActionStatus

Nur Eingabe. Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds. Zeigt Nutzern bei Bedarf einen Status und eine Nachricht an. Beispielsweise im Falle eines Fehlers oder Erfolgs.

Union-Feld action. Auszuführende Aktion. Für action ist nur einer der folgenden Werte zulässig:

dialog

Dialog

Nur Eingabe. Dialog für die Anfrage.

DoNotDisturbMetadata

Metadaten, die mit dem Verfügbarkeitsstatus DO_NOT_DISTURB verknüpft sind und angeben, wann der Status abläuft.

Felder

expiration_time

Timestamp

Nur Ausgabe. Zeitstempel, bis zu dem der Nutzer als DO_NOT_DISTURB markiert werden soll. Das Datum kann maximal ein Jahr in der Zukunft liegen.

DriveDataRef

Ein Verweis auf die Daten eines Drive-Anhangs.

Felder

drive_file_id

string

Die ID der Drive-Datei. Verwendung mit der Drive API.

DriveLinkData

Daten für Google Drive-Links.

Felder

drive_data_ref

DriveDataRef

Ein DriveDataRef, der auf eine Google Drive-Datei verweist.

mime_type

string

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

Elemente

Elemente sind zusätzliche Komponenten, die mit dem Nachrichtentext verknüpft sein können, der beim Erstellen der Nachricht angegeben wurde.

Felder

cited_sources[]

CitedSource

Eine Liste von Quellen, die unter der Nachricht als Links in der Fußzeile angezeigt werden sollen. Diese werden nicht inline referenziert. Verwenden Sie für Inline-Verweise citations.

citations[]

Citation

Eine Liste von Inline-Quellenangaben, auf die im Nachrichtentext (über <chat-citation>-Tags) verwiesen wird und die als interaktive Kurzinfos gerendert werden.

ElementsImage

Ein Objekt, das verschiedene Möglichkeiten zur Darstellung eines Bildes enthält. Derzeit unterstützte Darstellungen: – Ein Bild, das von einem URI abgerufen wurde. In Zukunft werden möglicherweise weitere Darstellungen unterstützt.

Felder

Union-Feld image Erforderlich. Eine der unterstützten Bilddarstellungen. Für image ist nur einer der folgenden Werte zulässig:

image_uri

string

Erforderlich. Ein öffentlich zugänglicher URI für ein Bild.

Emoji

Ein Emoji, das als Reaktion auf eine Nachricht verwendet wird.

Felder

Union-Feld content Erforderlich. Der Inhalt des Emojis. Für content ist nur einer der folgenden Werte zulässig:

unicode

string

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

custom_emoji

Ein benutzerdefiniertes Emoji.

EmojiReactionSummary

Die Anzahl der Personen, die mit einem bestimmten Emoji auf eine Nachricht reagiert haben.

Felder

emoji

Emoji

Nur Ausgabe. Emoji, das mit den Reaktionen verknüpft ist.

reaction_count

int32

Nur Ausgabe. Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

FindDirectMessageRequest

Eine Anfrage zum Abrufen eines Direktnachrichten-Gruppenbereichs basierend auf der Nutzerressource.

Felder

name

string

Erforderlich. Ressourcenname des Nutzers, mit dem die Direktnachricht gesucht werden soll.

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 People API-Profil-ID beispielsweise 123456789 lautet, können Sie eine Direktnachricht mit dieser 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.

FindGroupChatsRequest

Eine Anfrage zum Abrufen von Gruppenchatbereichen basierend auf Nutzerressourcen.

Felder
`users[]`	`string` Optional. Ressourcennamen aller menschlichen Nutzer im Gruppenchat mit dem anrufenden Nutzer. Chat-Apps können nicht in die Anfrage aufgenommen werden. Die maximale Anzahl von Nutzern, die in einer einzelnen Anfrage angegeben werden können, beträgt `49`. 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 Sie beispielsweise alle Gruppenchats mit dem aufrufenden Nutzer und zwei anderen Nutzern mit den People API-Profil-IDs `123456789` und `987654321` finden möchten, können Sie `users/123456789` und `users/987654321` verwenden. Sie können die E-Mail-Adresse auch als Alias für `{user}` verwenden. Beispiel: `users/example@gmail.com`, wobei `example@gmail.com` die E-Mail-Adresse des Google Chat-Nutzers ist.
`page_size`	`int32` Optional. Die maximale Anzahl der zurückzugebenden Spaces. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 10 Spaces zurückgegeben. Der Höchstwert sind 30 Tage. Wenn Sie einen Wert über 30 verwenden, wird er automatisch in 30 geändert. Negative Werte geben einen `INVALID_ARGUMENT`-Fehler zurück.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Suchen von Gruppenchats empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Token bereitgestellt hat. Die Übergabe anderer Werte kann zu unerwarteten Ergebnissen führen.
`space_view`	`SpaceView` Angeforderter Ansichtstyp für den Space. Wenn nicht festgelegt, wird standardmäßig `SPACE_VIEW_RESOURCE_NAME_ONLY` verwendet. Anfragen, die `SPACE_VIEW_EXPANDED` angeben, müssen Bereiche enthalten, die das Lesen von Space-Daten ermöglichen, z. B. https://www.googleapis.com/auth/chat.spaces oder https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Eine Antwort, die Gruppenchat-Spaces mit genau dem aufrufenden Nutzer und den angeforderten Nutzern enthält.

Felder

spaces[]

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

next_page_token

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.

ForwardedMetadata

Metadaten zum Quell-Space, aus dem eine Nachricht weitergeleitet wurde.

Felder

space

string

Nur Ausgabe. Der Ressourcenname des Quell-Space. Format: spaces/{space}

space_display_name

string

Nur Ausgabe. Der Anzeigename des Quell-Space oder der Quell-DM zum Zeitpunkt der Weiterleitung. Bei SPACE ist dies der Name des Gruppenbereichs. Bei DIRECT_MESSAGE ist dies der Name des anderen Teilnehmers (z.B. „Nutzer A“). Bei GROUP_CHAT ist dies ein generierter Name, der auf den Vornamen der Mitglieder basiert. Er ist auf 5 Namen beschränkt, einschließlich des Creators (z. B. „Nutzer A, Nutzer B“).

GetAttachmentRequest

Anfrage zum Abrufen eines Anhangs.

Felder

name

string

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

GetAvailabilityRequest

Anfragenachricht für die Methode GetAvailability.

Felder

name

string

Erforderlich. Der Ressourcenname der abzurufenden Verfügbarkeit.

Format: users/{user}/availability

{user} ist die ID für die Person in der People API oder der Admin SDK Directory API. Beispiel: users/123456789.

Die E-Mail-Adresse des Nutzers oder me kann auch als Alias verwendet werden, um auf den Aufrufer zu verweisen. Beispiel: users/user@example.comoder users/me

GetCustomEmojiRequest

Eine Anfrage, um ein einzelnes benutzerdefiniertes Emoji zurückzugeben.

Felder

name

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 Name eines benutzerdefinierten Emojis ist.

GetMembershipRequest

Anfrage zum Abrufen einer Mitgliedschaft in einem Gruppenbereich.

Felder

name

string

Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft.

Wenn Sie die Mitgliedschaft der App per Nutzerauthentifizierung abrufen möchten, können Sie 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.

use_admin_access

bool

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

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

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

Das Abrufen von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung des Administratorzugriffs nicht unterstützt.

GetMessageRequest

Anfrage zum Abrufen einer Nachricht.

Felder

name

string

Erforderlich. Ressourcenname der Nachricht.

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

markup_syntax

MarkupSyntax

Optional. Gibt die gewünschte Ausgabesyntax für das Feld formatted_text der Chatnachricht an.

GetSpaceEventRequest

Anfragenachricht zum Abrufen eines Space-Ereignisses.

Felder

name

string

Erforderlich. Der Ressourcenname des Space-Ereignisses.

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

GetSpaceNotificationSettingRequest

Nachricht zur Abfrage der Benachrichtigungseinstellungen für Gruppenbereiche. Unterstützt nur das Abrufen der Benachrichtigungseinstellung für den aufrufenden Nutzer.

Felder

name

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 Aufrufers zulässig.

GetSpaceReadStateRequest

Anfragenachricht für die GetSpaceReadState API.

Felder

name

string

Erforderlich. Ressourcenname des abzurufenden Lesestatus des Space.

Es wird nur das Abrufen des Lesestatus für den aufrufenden Nutzer unterstützt.

Wenn Sie sich auf den aufrufenden Nutzer beziehen möchten, legen Sie eine der folgenden Optionen fest:

Der Alias me. Beispiel: users/me/spaces/{space}/spaceReadState.
Die Workspace-E‑Mail-Adresse des Nutzers. Beispiel: users/user@example.com/spaces/{space}/spaceReadState.
Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState.

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

GetSpaceRequest

Anfrage zum Zurückgeben eines einzelnen Space.

Felder

name

string

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

Format: spaces/{space}

use_admin_access

bool

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

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

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

GetThreadReadStateRequest

Anfragenachricht für die GetThreadReadStateRequest API.

Felder

name

string

Erforderlich. Ressourcenname des abzurufenden Lesestatus des Threads.

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

Wenn Sie sich auf den aufrufenden Nutzer beziehen möchten, legen Sie eine der folgenden Optionen fest:

Der Alias 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

Gruppe

Eine Google-Gruppe in Google Chat.

Felder

name

string

Ressourcenname für eine Google-Gruppe.

Stellt eine Gruppe in der Cloud Identity Groups API dar.

Format: groups/{group}

HistoryState

Der Status des Verlaufs für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach der Erstellung aufbewahrt werden.

Enums
`HISTORY_STATE_UNSPECIFIED`	Standardwert. Nicht verwenden.
`HISTORY_OFF`	Verlauf deaktiviert. Nachrichten und Threads werden 24 Stunden lang aufbewahrt.
`HISTORY_ON`	Verlauf aktiviert. In den Vault-Aufbewahrungsregeln der Organisation ist festgelegt, wie lange Nachrichten und Threads aufbewahrt werden.

ListCustomEmojisRequest

Eine Anfrage zum Abrufen einer Liste benutzerdefinierter Emojis.

Felder

page_size

int32

Optional. Die maximale Anzahl der zurückgegebenen benutzerdefinierten Emojis. Der Dienst kann weniger benutzerdefinierte Emojis als diesen Wert zurückgeben. Wenn nicht angegeben, ist der Standardwert 25. Der Höchstwert beträgt 200. Werte über 200 werden auf 200 geändert.

page_token

string

Optional. (Wenn Sie eine vorherige Abfrage fortsetzen.)

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

Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.

filter

string

Optional. Ein Abfragefilter.

Unterstützt das Filtern nach Creator.

Wenn Sie nach Ersteller filtern möchten, müssen Sie einen gültigen Wert angeben. Derzeit werden nur creator("users/me") und NOT creator("users/me") akzeptiert, um benutzerdefinierte Emojis danach zu filtern, ob sie vom aufrufenden Nutzer erstellt wurden oder nicht.

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

creator("users/me")

Ungültige Abfragen werden mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListCustomEmojisResponse

Eine Antwort zum Auflisten benutzerdefinierter Emojis.

Felder

custom_emojis[]

Unsortierte Liste. Liste der benutzerdefinierten Emojis.

next_page_token

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.

ListMembershipsRequest

Anfragenachricht zum Auflisten von Mitgliedschaften.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Space, für den eine Mitgliederliste abgerufen werden soll. Format: spaces/{space}
`page_size`	`int32` Optional. Die maximale Anzahl der zurückzugebenden Mitgliedschaften. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Mitgliedschaften zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. Negative Werte geben einen `INVALID_ARGUMENT`-Fehler zurück.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Mitgliedschaften empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`filter`	`string` Optional. Ein Abfragefilter. Sie können Mitgliedschaften nach der Rolle (`role`) und dem Typ (`member.type`) eines Mitglieds filtern. Wenn Sie nach Rolle filtern möchten, legen Sie für `role` den Wert `ROLE_MEMBER` oder `ROLE_MANAGER` fest. Wenn Sie nach Typ filtern möchten, legen Sie für `member.type` den Wert `HUMAN` oder `BOT` fest. 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`. Wenn Sie nach Rolle oder Typ filtern möchten, verwenden Sie den Operator `OR`. Entweder `member.type = "HUMAN"` oder `member.type != "BOT"` ist erforderlich, wenn `use_admin_access` auf „true“ gesetzt ist. Andere Filter für die Art der Mitgliedschaft 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.
`show_groups`	`bool` Optional. Wenn `true`, werden zusätzlich zu anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit einem `Google Group` verknüpft sind. Wenn ein `filter` festgelegt ist, werden `Google Group`-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.
`show_invited`	`bool` Optional. Wenn `true`, werden zusätzlich zu anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit `invited`-Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden `invited`-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben. Derzeit ist eine Nutzerauthentifizierung erforderlich.
`use_admin_access`	`bool` Optional. Wenn `true`, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt. Der aufrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereich `chat.admin.memberships.readonly` oder `chat.admin.memberships`. Das Auflisten von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung des Administratorzugriffs nicht unterstützt.

ListMembershipsResponse

Antwort zum Auflisten der Mitgliedschaften im Gruppenbereich.

Felder

memberships[]

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

next_page_token

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.

ListMessagePinsRequest

Anfragenachricht zum Auflisten von angepinnten Nachrichten.

Felder

parent

string

Erforderlich. Der übergeordnete Space, zu dem die Sammlung angepinnter Elemente gehört. Format: spaces/{space}

page_size

int32

Optional. Die maximale Anzahl der zurückgegebenen angepinnten Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als diesen Wert zurück. Der Höchstwert beträgt 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch in 100 geändert. Wenn nicht angegeben, werden maximal 100 Nachrichten-Pins zurückgegeben. Negative Werte geben einen INVALID_ARGUMENT-Fehler zurück.

page_token

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Nachrichten-Pins empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

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

ListMessagePinsResponse

Antwortnachricht für das Auflisten von angepinnten Nachrichten.

Felder

message_pins[]

MessagePin

Die angepinnten Nachrichten aus dem angegebenen Gruppenbereich.

next_page_token

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.

ListMessagesRequest

Listet Nachrichten im angegebenen Space auf, in dem der Nutzer Mitglied ist.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Space, aus dem Nachrichten aufgelistet werden sollen. Format: `spaces/{space}`
`page_size`	`int32` Optional. 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. Negative Werte geben einen `INVALID_ARGUMENT`-Fehler zurück.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`filter`	`string` Optional. Ein Abfragefilter. Sie können Nachrichten nach Datum (`create_time`) und 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 Größer-als-Operator `>` können Sie Nachrichten auflisten, die nach einem Zeitstempel erstellt wurden, oder mit dem Kleiner-als-Operator `<` Nachrichten, die vor einem Zeitstempel erstellt wurden. Wenn Sie Nachrichten innerhalb eines Zeitintervalls 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. Sie können nur eine `thread.name` pro Abfrage angeben. 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 Abfragen werden vom Server mit dem Fehler `INVALID_ARGUMENT` abgelehnt.
`order_by`	`string` Optional. Wie die Liste der Nachrichten sortiert wird. Geben Sie einen Wert an, nach dem ein Sortiervorgang sortiert werden soll. Gültige Werte für Sortiervorgänge: `ASC` für aufsteigend. `DESC` für absteigend. Die Standardreihenfolge ist `create_time ASC`.
`show_deleted`	`bool` Optional. Gibt an, ob gelöschte Nachrichten berücksichtigt werden sollen. Bei gelöschten Nachrichten werden der Zeitpunkt des Löschens und Metadaten zum Löschen angezeigt, der Nachrichteninhalt ist jedoch nicht verfügbar.
`markup_syntax`	`MarkupSyntax` Optional. Gibt die gewünschte Ausgabesyntax für das Feld `formatted_text` der Chatnachricht an.

ListMessagesResponse

Antwortnachricht für das Auflisten von Nachrichten.

Felder

messages[]

Liste der Nachrichten.

next_page_token

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.

ListReactionsRequest

Listet Reaktionen auf eine Nachricht auf.

Felder
`parent`	`string` Erforderlich. Die Nachricht, auf die Nutzer reagiert haben. Format: `spaces/{space}/messages/{message}`
`page_size`	`int32` Optional. Die maximale Anzahl der zurückgegebenen Reaktionen. Der Dienst kann weniger Reaktionen als diesen Wert zurückgeben. Wenn nicht angegeben, beträgt der Standardwert 25. Der Höchstwert beträgt 200. Werte über 200 werden auf 200 geändert.
`page_token`	`string` Optional. (Wenn Sie eine vorherige Abfrage fortsetzen.) Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Reaktionen empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
`filter`	`string` Optional. Ein Abfragefilter. Sie können Reaktionen nach Emoji (entweder `emoji.unicode` oder `emoji.custom_emoji.uid`) und Nutzer (`user.name`) filtern. Wenn Sie Reaktionen für mehrere Emojis oder Nutzer filtern möchten, verbinden Sie ähnliche Felder mit dem Operator `OR`, 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 Ihre Abfrage sowohl `AND` als auch `OR` enthält, 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 mit dem Fehler `INVALID_ARGUMENT` abgelehnt.

ListReactionsResponse

Antwort auf eine Anfrage zum Auflisten von Reaktionen.

Felder

reactions[]

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

next_page_token

string

Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Für die letzte Ergebnisseite ist es leer.

ListSectionItemsRequest

Anfragenachricht zum Auflisten von Abschnittselementen.

Felder
`parent`	`string` Erforderlich. Das übergeordnete Element, d. h. der Ressourcenname des Abschnitts, zu dem diese Sammlung von Abschnittselementen gehört. Unterstützt nur das Auflisten von Abschnittselementen für den aufrufenden Nutzer. Wenn Sie nach Space filtern, verwenden Sie den Platzhalter `-`, um in allen Abschnitten zu suchen. Beispiel: `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`
`page_size`	`int32` Optional. Die maximale Anzahl der zurückzugebenden Abschnittselemente. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 10 Abschnittselemente zurückgegeben. Der Höchstwert beträgt 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch in 100 geändert. Negative Werte geben einen `INVALID_ARGUMENT`-Fehler zurück.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Abschnittselementen empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`filter`	`string` Optional. Ein Abfragefilter. Derzeit wird nur das Filtern nach Space unterstützt. Beispiel: `space = spaces/{space}`. Ungültige Abfragen werden mit dem Fehler `INVALID_ARGUMENT` abgelehnt.

ListSectionItemsResponse

Antwortnachricht für die Auflistung von Abschnittselementen.

Felder

section_items[]

SectionItem

Die Abschnittselemente aus dem angegebenen Abschnitt.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSectionsRequest

Anfragenachricht zum Auflisten von Abschnitten.

Felder

parent

string

Erforderlich. Das übergeordnete Element, d. h. der Name der Nutzerressource, die diese Sammlung von Abschnitten besitzt. Unterstützt nur das Auflisten von Abschnitten für den aufrufenden Nutzer. Wenn Sie sich auf den aufrufenden Nutzer beziehen möchten, legen Sie eine der folgenden Optionen fest:

Der Alias me. Beispiel: users/me.
Die Workspace-E‑Mail-Adresse des Nutzers. Beispiel: users/user@example.com.
Die Nutzer-ID. Beispiel: users/123456789.

Format: users/{user}

page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden Abschnitte. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 10 Abschnitte zurückgegeben.

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

Negative Werte geben einen INVALID_ARGUMENT-Fehler zurück.

page_token

string

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

ListSectionsResponse

Antwortnachricht für das Auflisten von Abschnitten.

Felder

sections[]

Die Abschnitte des angegebenen Nutzers.

next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSpaceEventsRequest

Anfragenachricht zum Auflisten von Ereignissen im Gruppenbereich.

Felder
`parent`	`string` Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind. Format: `spaces/{space}`.
`page_size`	`int32` Optional. Die maximale Anzahl der zurückgegebenen Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Negative Werte geben einen `INVALID_ARGUMENT`-Fehler zurück.
`page_token`	`string` Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Ereignissen im Gruppenbereich empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen Parameter, die für das Auflisten von Space-Ereignissen bereitgestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`filter`	`string` Erforderlich. Ein Abfragefilter. Sie müssen mindestens einen Ereignistyp (`event_type`) mit dem Operator `:` angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator `OR`. Lassen Sie Batch-Ereignistypen in Ihrem Filter weg. Die Anfrage gibt automatisch alle zugehörigen Batchereignisse zurück. Wenn Sie beispielsweise nach neuen Reaktionen (`google.workspace.chat.reaction.v1.created`) filtern, gibt der Server auch Batch-Ereignisse für neue Reaktionen (`google.workspace.chat.reaction.v1.batchCreated`) zurück. Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation zu `SpaceEvents`. Optional können Sie auch nach Startzeit (`start_time`) und Endzeit (`end_time`) filtern: `start_time`: Ausschließlicher Zeitstempel, ab dem Space-Ereignisse aufgelistet werden sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn nicht angegeben, werden Ereignisse im Gruppenbereich der letzten 28 Tage aufgelistet. `end_time`: Zeitstempel (einschließlich), bis zu dem Space-Ereignisse aufgelistet werden. Wenn keine Angabe gemacht wird, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgelistet. Wenn Sie eine Start- oder Endzeit angeben möchten, verwenden Sie den Gleichheitsoperator `=` und das Format 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.

ListSpaceEventsResponse

Antwortnachricht für das Auflisten von Gruppenbereichsereignissen.

Felder

space_events[]

SpaceEvent

Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). Hinweis: Das Feld permissionSettings wird im Space-Objekt für Listenanfragen nicht zurückgegeben.

next_page_token

string

Fortsetzungstoken, das zum Abrufen weiterer Ereignisse verwendet wird. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSpacesRequest

Eine Anfrage zum Auflisten der Gruppenbereiche, in denen der Aufrufer Mitglied ist.

Felder

page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden Spaces. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

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

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

Negative Werte geben einen INVALID_ARGUMENT-Fehler zurück.

page_token

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Bereichen empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.

filter

string

Optional. Ein Abfragefilter.

Sie können Gruppenbereiche nach dem Typ des Gruppenbereichs filtern (space_type).

Wenn Sie nach dem Typ des Gruppenbereichs 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 Typen von Gruppenbereichen 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.

ListSpacesResponse

Die Antwort auf eine Anfrage zum Auflisten von Bereichen.

Felder

spaces[]

MembershipCreatedEventData

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

next_page_token

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.

MarkAsActiveRequest

Anfragenachricht für die Methode MarkAsActive.

Felder
`name`	`string` Erforderlich. Der Ressourcenname der Verfügbarkeit, die als aktiv markiert werden soll. Format: users/{user}/availability `{user}` ist die ID für die Person in der People API oder der Admin SDK Directory API. Beispiel: `users/123456789`. Die E-Mail-Adresse des Nutzers oder `me` kann auch als Alias verwendet werden, um auf den Aufrufer zu verweisen. Beispiel: `users/user@example.com`oder `users/me`
Union-Feld `expiration`. Das Ablaufdatum für den Verfügbarkeitsstatus AKTIV. Nach Ablauf wird der Nutzer als „Abwesend“ markiert. Wenn kein Ablaufdatum angegeben ist, läuft der Status AKTIV 30 Minuten nach der aktuellen Zeit ab. Für `expiration` ist nur einer der folgenden Werte zulässig:
`expire_time`	`Timestamp` Der absolute Zeitstempel, zu dem der Status AKTIV abläuft.
`ttl`	`Duration` Die Dauer von der aktuellen Zeit bis zum Ablauf des Status ACTIVE. Mit einer kurzen TTL kann der Status des Nutzers effektiv auf die Aktivität nach dieser kurzen Dauer zurückgesetzt werden.

MarkAsAwayRequest

Anfragenachricht für die Methode MarkAsAway.

Felder

name

string

Erforderlich. Der Ressourcenname der Verfügbarkeit, die als „Abwesend“ markiert werden soll. Format: users/{user}/availability

{user} ist die ID für die Person in der People API oder der Admin SDK Directory API. Beispiel: users/123456789.

Die E-Mail-Adresse des Nutzers oder me kann auch als Alias verwendet werden, um auf den Aufrufer zu verweisen. Beispiel: users/user@example.comoder users/me

MarkAsDoNotDisturbRequest

Anfragenachricht für die Methode MarkAsDoNotDisturb.

Felder
`name`	`string` Erforderlich. Der Ressourcenname der Verfügbarkeit, die als „Bitte nicht stören“ markiert werden soll. Format: users/{user}/availability `{user}` ist die ID für die Person in der People API oder der Admin SDK Directory API. Beispiel: `users/123456789`. Die E-Mail-Adresse des Nutzers oder `me` kann auch als Alias verwendet werden, um auf den Aufrufer zu verweisen. Beispiel: `users/user@example.com`oder `users/me`
Union-Feld `expiration`. Erforderlich. Das Ablaufdatum für den Verfügbarkeitsstatus „Bitte nicht stören“. Der Nutzer wird nach Ablauf als „Abwesend“ markiert. Dieser Wert darf maximal 1 Jahr nach der aktuellen Zeit liegen. Für `expiration` ist nur einer der folgenden Werte zulässig:
`expire_time`	`Timestamp` Der absolute Zeitstempel, zu dem der „Bitte nicht stören“-Status abläuft.
`ttl`	`Duration` Die Dauer von der aktuellen Uhrzeit bis zum Ablauf des „Bitte nicht stören“-Status.

MarkupSyntax

Gibt die Markup-Syntax an, die zum Formatieren des Textes der Chatnachricht verwendet wird. Gilt für das Feld text der Ressource Message.

Enums
`MARKUP_SYNTAX_UNSPECIFIED`	Stellt den nicht angegebenen Wert dar.
`MARKUP_SYNTAX_CHAT`	Verwendet die Markup-Syntax von Google Chat. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts.
`MARKUP_SYNTAX_MARKDOWN`	Verwendet Markdown-Syntax. Diese Syntax basiert auf der CommonMark-Spezifikation mit zusätzlichen Erweiterungen. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts.

MatchedUrl

Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können eine Vorschau von übereinstimmenden URLs anzeigen. Weitere Informationen finden Sie unter Vorschau von Links anzeigen.

Felder

url

string

Nur Ausgabe. Die URL, die übereinstimmt.

MeetSpaceLinkData

Daten für Meet-Konferenzraumlinks.

Felder

meeting_code

string

Besprechungscode des verknüpften Meet-Konferenzraums.

type

Type

Gibt den Typ des Konferenzraums an.

huddle_status

HuddleStatus

Optional. Nur Ausgabe. Wenn es sich bei der Meet-Besprechung um ein Huddle handelt, wird der Status des Huddles angezeigt. Andernfalls ist dieser Wert nicht festgelegt.

HuddleStatus

Status des Huddles

Enums
`HUDDLE_STATUS_UNSPECIFIED`	Standardwert für das Enum. Nicht verwenden.
`STARTED`	Das Huddle hat begonnen.
`ENDED`	Das Huddle wurde beendet. In diesem Fall sind die URI und die IDs des Meet-Bereichs nicht mehr gültig.
`MISSED`	Das Huddle wurde verpasst. In diesem Fall sind die URI und die IDs des Meet-Bereichs nicht mehr gültig.

Typ

Der Typ des Meet-Bereichs.

Enums
`TYPE_UNSPECIFIED`	Standardwert für das Enum. Nicht verwenden.
`MEETING`	Der Meet-Bereich ist eine Videokonferenz.
`HUDDLE`	Der Meet-Bereich ist ein Huddle.

Mitgliedschaft

Stellt eine Mitgliedschaftsbeziehung in Google Chat dar, z. B. ob ein Nutzer oder eine Chat-App zu einem Gruppenbereich eingeladen wurde, Teil davon ist oder nicht.

Felder
`name`	`string` ID. Ressourcenname der Mitgliedschaft, der vom Server zugewiesen wird. Format: `spaces/{space}/members/{member}`
`state`	`MembershipState` Nur Ausgabe. Status der Mitgliedschaft.
`role`	`MembershipRole` Optional. Die Rolle des Nutzers in einem Chatbereich, die seine zulässigen Aktionen im Bereich bestimmt. Dieses Feld kann nur als Eingabe in `UpdateMembership` verwendet werden.
`create_time`	`Timestamp` Optional. Nicht veränderbar. Der Zeitpunkt, zu dem die Mitgliedschaft erstellt wurde, z. B. wenn ein Mitglied einem Gruppenbereich beigetreten ist oder eingeladen wurde, einem Gruppenbereich beizutreten. Dieses Feld dient nur der Ausgabe, außer wenn es zum Importieren von früheren Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird.
`delete_time`	`Timestamp` Optional. Nicht veränderbar. Der Zeitpunkt, zu dem die Mitgliedschaft gelöscht wurde, z. B. wenn ein Mitglied einen Gruppenbereich verlassen hat oder daraus entfernt wurde. Dieses Feld ist nur für die Ausgabe vorgesehen, außer wenn es zum Importieren von früheren Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird.
`affiliation`	`Affiliation` Nur Ausgabe. Die Beziehung eines Nutzers zur Workspace-Organisation, die Eigentümer des Space ist. In Gruppenbereichen, die zu Privatnutzerkonten gehören, ist die Zugehörigkeit aller Mitglieder `EXTERNAL`.
Union-Feld `memberType`. Mitglied, das mit dieser Mitgliedschaft verknüpft ist. In Zukunft werden möglicherweise weitere Mitgliedstypen unterstützt. Für `memberType` ist nur einer der folgenden Werte zulässig:
`member`	`User` Optional. Der Google Chat-Nutzer oder die Google Chat-App, dem bzw. der die Mitgliedschaft entspricht. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden in der Ausgabe nur die user-Felder `name` und `type` für interne und externe Nutzer ausgefüllt, es sei denn, sie sind Mitglieder des Gruppenbereichs oder haben eine vorherige Affinität, z. B. eine Direktnachricht (DM) mit dem aufrufenden Nutzer.
`group_member`	`Group` Optional. Die Google-Gruppe, der die Mitgliedschaft entspricht. Zum Lesen oder Ändern von Mitgliedschaften für Google Groups ist eine Nutzerauthentifizierung erforderlich.

Händler/Partner

Gibt die Zugehörigkeit eines Nutzers zur Google Workspace-Organisation an, die Inhaber des Gruppenbereichs ist. Diesem Enum können in Zukunft weitere Werte hinzugefügt werden.

Enums
`AFFILIATION_UNSPECIFIED`	Standardwert. Dieser Wert wird nicht verwendet.
`INTERNAL`	Ein Konto, das von derselben Google Workspace-Organisation verwaltet wird, die Inhaber des Gruppenbereichs ist.
`EXTERNAL`	Ein Konto außerhalb der Google Workspace-Organisation, die Inhaber des Gruppenbereichs ist (z.B. ein Privatnutzerkonto oder ein Konto, das von einer anderen Workspace-Organisation verwaltet wird).
`MANAGED_EXTERNAL`	Ein Konto, das von der Workspace-Organisation verwaltet wird, die Inhaber des Gruppenbereichs ist, aber für einen Nutzer außerhalb der Organisation bereitgestellt wird (z.B. einen Gastnutzer). Weitere Informationen zu Gästen finden Sie unter https://support.google.com/chat/answer/16997417.

MembershipRole

Stellt die zulässigen Aktionen eines Nutzers in einem Chatbereich dar. In Zukunft werden möglicherweise weitere Aufzählungswerte hinzugefügt.

Enums
`MEMBERSHIP_ROLE_UNSPECIFIED`	Standardwert. `users`: Der Nutzer ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für `Google Groups`: Ihnen wird immer diese Rolle zugewiesen (in Zukunft können andere Enum-Werte verwendet werden).
`ROLE_MEMBER`	Ein Mitglied des Gruppenbereichs. In der Chat-Benutzeroberfläche wird diese Rolle als „Mitglied“ bezeichnet. Der Nutzer hat grundlegende Berechtigungen, z. B. zum Senden von Nachrichten an den Gruppenbereich. Administratoren und Inhaber können Mitgliedern zusätzliche Berechtigungen in einem Gruppenbereich gewähren, darunter: Mitglieder hinzufügen oder entfernen Details zum Gruppenbereich ändern Verlauf aktivieren oder deaktivieren Mit `@all` können Sie alle im Gruppenbereich erwähnen. Im Gruppenbereich installierte Chat-Apps und Webhooks verwalten. In Direktnachrichten und unbenannten Gruppenunterhaltungen hat jeder diese Rolle.
`ROLE_MANAGER`	Sie müssen Eigentümer des Gruppenbereichs sein. In der Chatbenutzeroberfläche wird diese Rolle als „Inhaber“ bezeichnet. Der Nutzer hat alle Berechtigungen zum Verwalten des Space, einschließlich: die Rolle anderer Mitglieder im Gruppenbereich in „Mitglied“, „Administrator“ oder „Inhaber“ ändern den Gruppenbereich löschen Wird nur in `SpaceType.SPACE` (benannten Gruppenbereichen) unterstützt. Weitere Informationen finden Sie im Hilfeartikel Die Rolle als Inhaber oder Administrator eines Gruppenbereichs.
`ROLE_ASSISTANT_MANAGER`	Sie müssen Administrator des Gruppenbereichs sein. In der Chatbenutzeroberfläche wird diese Rolle als „Administrator“ bezeichnet. Der Nutzer hat alle grundlegenden Berechtigungen von `ROLE_MEMBER` und kann von einem Inhaber eine Teilmenge der Administratorberechtigungen erhalten. Administratoren haben standardmäßig alle Berechtigungen eines Inhabers, mit folgenden Ausnahmen: den Gruppenbereich löschen Ein anderes Mitglied des Gruppenbereichs zum Inhaber machen. Rolle eines Inhabers ändern Standardmäßig umfassen die Berechtigungen von Managern unter anderem Folgendes: Ein anderes Mitglied zum Manager ernennen. Nachrichten im Gruppenbereich löschen Berechtigungen für Gruppenbereiche verwalten Benachrichtigungen zu Beitrittsanfragen für den Gruppenbereich erhalten, wenn der Administrator in den Einstellungen des Gruppenbereichs die Berechtigung „Mitglieder verwalten“ hat. Gruppenbereich sichtbar machen Wird nur in `SpaceType.SPACE` (benannten Gruppenbereichen) unterstützt. Weitere Informationen finden Sie unter Einstellungen für Gruppenbereiche verwalten.

MembershipState

Gibt die Beziehung des Mitglieds zu einem Gruppenbereich an. In Zukunft werden möglicherweise weitere Mitgliedschaftsstatus unterstützt.

Enums
`MEMBERSHIP_STATE_UNSPECIFIED`	Standardwert. Nicht verwenden.
`JOINED`	Der Nutzer wird dem Gruppenbereich hinzugefügt und kann daran teilnehmen.
`INVITED`	Der Nutzer wurde eingeladen, dem Gruppenbereich beizutreten, ist ihm aber noch nicht beigetreten.
`NOT_A_MEMBER`	Der Nutzer gehört nicht zum Gruppenbereich und hat keine ausstehende Einladung, dem Gruppenbereich beizutreten.

MembershipBatchCreatedEventData

Ereignisnutzlast für mehrere neue Mitgliedschaften.

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

Felder

memberships[]

Eine Liste neuer Mitgliedschaften.

MembershipBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Mitgliedschaften.

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

Felder

memberships[]

MembershipDeletedEventData

Eine Liste der gelöschten Mitgliedschaften.

MembershipBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften.

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

Felder

memberships[]

MembershipUpdatedEventData

Eine Liste der aktualisierten Mitgliedschaften.

MembershipCreatedEventData

Ereignisnutzlast für eine neue Mitgliedschaft.

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

Felder

membership

Die neue Mitgliedschaft.

MembershipDeletedEventData

Ereignisnutzlast für eine gelöschte Mitgliedschaft.

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

Felder

membership

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

MembershipUpdatedEventData

Ereignisnutzlast für eine aktualisierte Mitgliedschaft.

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

Felder

membership

MessageCreatedEventData

Die aktualisierte Mitgliedschaft.

Nachricht

Eine Nachricht in einem Google Chat-Bereich.

Felder
`name`	`string` ID. Ressourcenname der Nachricht. Format: `spaces/{space}/messages/{message}` Dabei ist `{space}` die ID des Gruppenbereichs, in dem die Nachricht gepostet wird, und `{message}` eine vom System zugewiesene 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 unter Nachricht benennen.
`sender`	`User` Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden in der Ausgabe nur die user-Felder `name` und `type` für interne und externe Nutzer ausgefüllt, es sei denn, sie sind Mitglieder des Gruppenbereichs oder haben eine vorherige Affinität, z. B. eine Direktnachricht (DM) mit dem aufrufenden Nutzer.
`create_time`	`Timestamp` Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird. Legen Sie für Bereiche im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um die ursprüngliche Erstellungszeit beizubehalten.
`last_update_time`	`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.
`delete_time`	`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.
`text`	`string` Optional. Nur-Text-Inhalt der Nachricht. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschau-Chip. Sie können auch einen Google Chat-Nutzer oder alle Personen im Gruppenbereich mit@erwähnen. Informationen zum Erstellen von Nachrichten finden Sie unter Nachricht senden.
`formatted_text`	`string` Nur Ausgabe. Enthält die Nachricht `text` mit Markups, die die Formatierung angeben. In diesem Feld werden möglicherweise nicht alle in der Benutzeroberfläche sichtbaren Formatierungen erfasst, aber die folgenden: Markup-Syntax für fett, kursiv, durchgestrichen, Monospace, Monospace-Block, Aufzählungsliste und Blockzitat. Erwähnungen von Nutzern 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:`. Dies gilt nicht für Unicode-Emojis wie `U+1F600` für ein grinsendes Gesicht. Listenpunkte mit Sternchen (``), z. B. ` item`. Weitere Informationen finden Sie unter Textformatierung in einer Nachricht ansehen.
`cards[] (deprecated)`	`Card` Dieses Element wird nicht mehr unterstützt. Nicht mehr unterstützt: Verwenden Sie stattdessen `cards_v2`. Umfangreiche, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierten Text, Schaltflächen und anklickbare Bilder anzeigen können. Karten werden normalerweise unter dem Nur-Text-Inhalt der Nachricht angezeigt. `cards` und `cards_v2` können eine maximale Größe von 32 KB haben.
`cards_v2[]`	`CardWithId` Optional. Ein Array von Karten. Chat-Apps können Karten mit App-Authentifizierung erstellen. Im Rahmen des Entwicklervorschauprogramms kann Ihre Chat-App Kartennachrichten erstellen, wenn sie sich als Nutzer authentifiziert. Wenn Ihre Chat-App nicht Teil des Entwicklervorschau-Programms ist, können damit keine Karten mit Nutzerauthentifizierung erstellt werden. Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden. Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen. Card Builder öffnen
`annotations[]`	`Annotation` Nur Ausgabe. Anmerkungen können mit dem Nur-Text-Inhalt der Nachricht oder mit Chips verknüpft werden, die auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets mit `start_index` und `length` von 0 verweisen.
`thread`	`Thread` Die Unterhaltung, zu der die Nachricht gehört. Beispiele für die Verwendung finden Sie unter Unterhaltung starten oder auf eine Nachricht antworten.
`space`	`Space` Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich `name` ausgegeben.
`fallback_text`	`string` Optional. Eine Nur-Text-Beschreibung der Karten der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. bei mobilen Benachrichtigungen.
`action_response`	`ActionResponse` Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
`argument_text`	`string` Nur Ausgabe. Nur-Text-Inhalt der Nachricht, wobei alle Erwähnungen der Chat-App entfernt wurden.
`slash_command`	`SlashCommand` Nur Ausgabe. Informationen zum Slash-Befehl, falls zutreffend.
`attachment[]`	`Attachment` Optional. Vom Nutzer hochgeladener Anhang.
`matched_url`	`MatchedUrl` Nur Ausgabe. Eine URL im Feld `text` der Chatnachricht, die mit einem Linkvorschaumuster übereinstimmt. Weitere Informationen finden Sie unter Vorschau-Links.
`thread_reply`	`bool` Nur Ausgabe. Wenn `true`, ist die Nachricht eine Antwort in einem Antwortthread. Wenn `false`, ist die Nachricht in der Unterhaltung auf oberster Ebene des Gruppenbereichs entweder als erste Nachricht eines Threads oder als Nachricht ohne Antworten mit Threads sichtbar. Wenn der Gruppenbereich keine Antworten in Threads unterstützt, ist dieses Feld immer `false`.
`silent`	`bool` Nur Ausgabe. Gibt an, ob es sich um eine lautlose Nachricht handelt. Lautlose Nachrichten sind Nachrichten, bei denen Google Chat Push-Benachrichtigungen für Empfänger unterdrückt.
`client_assigned_message_id`	`string` Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können das Feld verwenden, um eine Nachricht zu identifizieren oder um 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 finden Sie unter Nachricht benennen.
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Nur Ausgabe. Die Liste der Zusammenfassungen von Emoji-Reaktionen auf die Nachricht.
`private_message_viewer`	`User` Optional. Nicht veränderbar. Eingabe zum 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 weglassen: Anhänge Weitere Informationen finden Sie unter Private Nachrichten senden.
`deletion_metadata`	`DeletionMetadata` Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn `delete_time` festgelegt ist.
`quoted_message_metadata`	`QuotedMessageMetadata` Optional. Informationen zu einer Nachricht, die in einer anderen Nachricht zitiert wird. Wenn Sie eine Nachricht erstellen, können Sie Nachrichten innerhalb desselben Threads zitieren oder eine Stammnachricht zitieren, um eine neue Stammnachricht zu erstellen. Sie können jedoch keine Antwort auf eine Nachricht aus einem anderen Thread zitieren. Wenn Sie eine Nachricht aktualisieren, können Sie das Feld `quotedMessageMetadata` nicht hinzufügen oder ersetzen, aber Sie können es entfernen. Ein Beispiel für die Verwendung finden Sie unter Andere Nachricht zitieren.
`attached_gifs[]`	`AttachedGif` Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind.
`accessory_widgets[]`	`AccessoryWidget` Optional. Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Nachrichten, die Text, Karten oder beides enthalten, Zubehör-Widgets hinzufügen. Nicht unterstützt für Nachrichten, die Dialoge enthalten. Weitere Informationen finden Sie unter Interaktive Widgets am Ende einer Nachricht hinzufügen. Zum Erstellen einer Nachricht mit Zubehör-Widgets ist eine App-Authentifizierung erforderlich.
`elements`	`Elements` Optional. Elemente sind zusätzliche Komponenten, die beim Erstellen von Nachrichten bereitgestellt werden und mit bestimmten Teilen des Nachrichtentexts verknüpft sein können. Diese unterscheiden sich von Annotationen, die nur ausgegeben werden und zusätzliche Informationen zu Nachrichtenfragmenten oder dem gesamten Nachrichtentext enthalten. Entwicklervorschau: Verfügbar im Rahmen des Google Workspace Developer Preview Program, das Vorabzugriff auf bestimmte Funktionen bietet.
`markup_syntax`	`MarkupSyntax` Optional. Gibt an, wie der Server den Inhalt des Nachrichtenfelds `text` interpretiert.

MessageBatchCreatedEventData

Ereignisnutzlast für mehrere neue Nachrichten.

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

Felder

messages[]

Eine Liste der neuen Nachrichten.

MessageBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Nachrichten.

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

Felder

messages[]

MessageDeletedEventData

Eine Liste der gelöschten Nachrichten.

MessageBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Nachrichten.

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

Felder

messages[]

MessageUpdatedEventData

Eine Liste der aktualisierten Nachrichten.

MessageCreatedEventData

Ereignisnutzlast für eine neue Nachricht.

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

Felder

message

Die neue Nachricht.

MessageDeletedEventData

Ereignisnutzlast für eine gelöschte Nachricht.

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

Felder

message

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

MessagePin

Eine angepinnte Chatnachricht. Weitere Informationen finden Sie unter Nachricht anpinnen.

Felder

name

string

ID. Der Ressourcenname der angepinnten Nachricht. Format: spaces/{space}/messagePins/{message_pin} Die Ressourcen-ID-Komponente entspricht der Ressourcen-ID-Komponente der Nachricht. Eine Nachricht mit spaces/AAA/messages/bbb.ccc entspricht beispielsweise der Nachrichten-PIN mit dem Ressourcennamen spaces/AAA/messagePins/bbb.ccc.

message

string

Erforderlich. Nicht veränderbar. Der Ressourcenname der angepinnten Nachricht. Format: spaces/{space}/messages/{message}

MessageUpdatedEventData

Ereignisnutzlast für eine aktualisierte Nachricht.

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

Felder

message

Die aktualisierte Nachricht.

MoveSectionItemRequest

Anfragenachricht zum Verschieben eines Abschnittselements zwischen Abschnitten.

Felder

name

string

Erforderlich. Der Ressourcenname des zu verschiebenden Abschnittselements.

Format: users/{user}/sections/{section}/items/{item}

target_section

string

Erforderlich. Der Ressourcenname des Abschnitts, in den das Abschnittselement verschoben werden soll.

Format: users/{user}/sections/{section}

MoveSectionItemResponse

Antwortnachricht für das Verschieben eines Abschnittselements.

Felder

section_item

SectionItem

Das aktualisierte Abschnittselement.

PositionSectionRequest

Anfragenachricht zum Positionieren eines Abschnitts.

Felder
`name`	`string` Erforderlich. Der Ressourcenname des zu positionierenden Abschnitts. Format: `users/{user}/sections/{section}`
Union-Feld `position`. Erforderlich. Die neue Position des Abschnitts. Für `position` ist nur einer der folgenden Werte zulässig:
`sort_order`	`int32` Optional. Die absolute Position des Abschnitts in der Liste der Abschnitte. Die Position muss größer als 0 sein. Wenn die Position größer als die Anzahl der Abschnitte ist, wird der Abschnitt am Ende der Liste angefügt. Bei diesem Vorgang wird der Abschnitt an der angegebenen Position eingefügt und der ursprüngliche Abschnitt an dieser Position sowie die darunter liegenden Abschnitte werden an die nächste Position verschoben.
`relative_position`	`Position` Optional. Die relative Position des Abschnitts in der Liste der Abschnitte.

Position

Die Position des Abschnitts.

Enums
`POSITION_UNSPECIFIED`	Nicht angegebene Position.
`START`	Beginn der Liste der Abschnitte.
`END`	Ende der Liste der Abschnitte.

PositionSectionResponse

Antwortnachricht für die Positionierung eines Abschnitts.

Felder

section

ReactionCreatedEventData

Der aktualisierte Abschnitt.

QuotedMessageMetadata

Informationen zu einer Nachricht, die in einer anderen Nachricht zitiert wird.

Wenn Sie eine Nachricht aktualisieren, können Sie das Feld quotedMessageMetadata nicht hinzufügen oder ersetzen, aber Sie können es entfernen.

Ein Beispiel für die Verwendung finden Sie unter Andere Nachricht zitieren.

Felder
`name`	`string` Erforderlich. Ressourcenname der zitierten Nachricht. Format: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Erforderlich. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde. Wenn die Nachricht bearbeitet wurde, verwenden Sie dieses Feld: `last_update_time`. Wenn die Nachricht nie bearbeitet wurde, verwenden Sie `create_time`. Wenn `last_update_time` nicht mit der aktuellen Version der zitierten Nachricht übereinstimmt, schlägt die Anfrage fehl.
`quote_type`	`QuoteType` Optional. Gibt den Angebotstyp an. Wenn nicht festgelegt, wird aus Gründen der Abwärtskompatibilität standardmäßig REPLY im Lese-/Schreibpfad der Nachricht verwendet.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Nur Ausgabe. Eine Momentaufnahme des Inhalts der zitierten Nachricht.
`forwarded_metadata`	`ForwardedMetadata` Nur Ausgabe. Metadaten zum Quell-Space der zitierten Nachricht. Wird nur für den Angebotstyp FORWARD ausgefüllt.

QuoteType

Der Typ des Zitats der zitierten Nachricht.

Enums

QUOTE_TYPE_UNSPECIFIED Reserviert. Dieser Wert wird nicht verwendet.

REPLY

Wenn quote_type den Wert REPLY hat, können Sie Folgendes tun:

Wenn Sie in einem Thread antworten, können Sie eine andere Nachricht in diesem Thread zitieren.
Wenn Sie eine Stammnachricht erstellen, können Sie eine andere Stammnachricht in diesem Gruppenbereich zitieren.

FORWARD

Wenn quote_type auf FORWARD festgelegt ist, können Sie Folgendes zitieren:

Nachricht aus einem anderen Gruppenbereich.
Antwort auf eine Nachricht aus einem anderen Thread im selben Gruppenbereich.

QuotedMessageSnapshot

Bietet eine Momentaufnahme des Inhalts der zitierten Nachricht zum Zeitpunkt des Zitierens oder Weiterleitens

Felder
`sender`	`string` Nur Ausgabe. Der Name des Autors der zitierten Nachricht. Wird sowohl für die Zitattypen REPLY als auch FORWARD ausgefüllt.
`text`	`string` Nur Ausgabe. Snapshot des Textinhalts der zitierten Nachricht.
`formatted_text`	`string` Nur Ausgabe. Enthält die zitierte Nachricht `text` mit Markups,um Rich-Formatierungen wie Hyperlinks, benutzerdefinierte Emojis, Markups usw. zu unterstützen. Wird nur für den Zitattyp FORWARD ausgefüllt.
`annotations[]`	`Annotation` Nur Ausgabe. Anmerkungen, die aus dem Text der zitierten Nachricht geparst wurden. Wird nur für den Angebotstyp FORWARD ausgefüllt.
`attachments[]`	`Attachment` Nur Ausgabe. Anhänge, die Teil der zitierten Nachricht waren. Dies sind Kopien der Anhangsmetadaten der zitierten Nachricht. Wird nur für den Angebotstyp FORWARD ausgefüllt.

Reaktion

Eine Reaktion auf eine Nachricht.

Felder

name

string

ID. Der Ressourcenname der Reaktion.

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

user

User

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

emoji

Emoji

Erforderlich. Das in der Reaktion verwendete Emoji.

ReactionBatchCreatedEventData

Ereignisnutzlast für mehrere neue Reaktionen.

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

Felder

reactions[]

Eine Liste neuer Reaktionen.

ReactionBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Reaktionen.

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

Felder

reactions[]

ReactionDeletedEventData

Eine Liste der gelöschten Reaktionen.

ReactionCreatedEventData

Ereignisnutzlast für eine neue Reaktion.

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

Felder

reaction

Die neue Reaktion.

ReactionDeletedEventData

Ereignisnutzlast für eine gelöschte Reaktion.

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

Felder

reaction

Die gelöschte Reaktion.

ReplaceMessageCardsRequest

Anfragenachricht für die API-Methode „ReplaceMessageCards“.

Felder

name

string

Erforderlich. Der Ressourcenname der Nachricht.

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

cards_v2[]

CardWithId

Optional. Ein Array von Karten, die in die Nachricht aufgenommen werden sollen. Diese Karten ersetzen die vorhandenen Karten der Nachricht. Wenn das Feld leer ist, werden die ursprünglichen Karten in der Nachricht gelöscht.

ReplaceMessageCardsResponse

Dieser Typ hat keine Felder.

Antwortnachricht für die ReplaceMessageCards API.

RichLinkMetadata

Ein Rich-Link zu einer Ressource. Rich-Links können mit dem Nur-Text-Inhalt der Nachricht verknüpft sein oder Chips darstellen, die auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets mit start_index und length von 0 verweisen.

Felder
`uri`	`string` Der URI dieses Links.
`rich_link_type`	`RichLinkType` Der Typ des Rich-Links.
Union-Feld `data`. Daten für die verknüpfte Ressource. Für `data` ist nur einer der folgenden Werte zulässig:
`drive_link_data`	`DriveLinkData` Daten für einen Drive-Link.
`chat_space_link_data`	`ChatSpaceLinkData` Daten für einen Link zu einem Chatbereich.
`meet_space_link_data`	`MeetSpaceLinkData` Daten für einen Meet-Raum-Link.
`calendar_event_link_data`	`CalendarEventLinkData` Daten für einen Kalendertermin-Link.

RichLinkType

Der Typ des Rich-Links. In Zukunft werden möglicherweise weitere Typen hinzugefügt.

Enums
`RICH_LINK_TYPE_UNSPECIFIED`	Standardwert für das Enum. Nicht verwenden.
`DRIVE_FILE`	Ein Typ für Rich-Links in Google Drive.
`CHAT_SPACE`	Ein Rich-Link-Typ für Google Chat-Bereiche. Beispiel: ein Smartchip für einen Gruppenbereich.
`GMAIL_MESSAGE`	Ein Rich-Link-Typ für Gmail-Nachrichten. Konkret geht es um einen Gmail-Chip aus In Chat teilen. Die API unterstützt nur das Lesen von Nachrichten mit GMAIL_MESSAGE-Rich-Links.
`MEET_SPACE`	Ein Rich-Link-Typ für Meet-Nachrichten. Beispiel: ein Meet-Chip.
`CALENDAR_EVENT`	Ein Rich-Link-Typ für Kalendernachrichten. Beispiel: ein Kalender-Chip.

SearchMessageResult

Ein einzelnes Ergebniselement aus einer Nachrichtensuche.

Felder

message

Die übereinstimmende Nachricht.

space_mute_setting

MuteSetting

Die Stummschaltungseinstellung des aufrufenden Nutzers für den Gruppenbereich, in dem die Nachricht gepostet wird. Die aufrufende App kann diese Informationen verwenden, um zu entscheiden, wie die Nachricht verarbeitet werden soll, je nachdem, ob der Gruppenbereich für den Nutzer stummgeschaltet ist oder nicht.

Wird nur zurückgegeben, wenn die Anfrageansicht SEARCH_MESSAGES_VIEW_FULL ist und die aufrufenden Anmeldedaten den folgenden Autorisierungsbereich enthalten:

https://www.googleapis.com/auth/chat.users.spacesettings

read

bool

Gibt an, ob die übereinstimmende Nachricht vom aufrufenden Nutzer gelesen wurde.

Wird nur zurückgegeben, wenn die Anfrageansicht SEARCH_MESSAGES_VIEW_FULL ist und die aufrufenden Anmeldedaten einen der folgenden Autorisierungsbereiche enthalten:

https://www.googleapis.com/auth/chat.users.readstate.readonly
https://www.googleapis.com/auth/chat.users.readstate

SearchMessagesRequest

Anfragenachricht für die Suche nach Nachrichten.

Felder
`parent`	`string` Erforderlich. Der Ressourcenname des Space, in dem gesucht werden soll. Wenn Sie in allen Gruppenbereichen suchen möchten, auf die der Nutzer Zugriff hat, setzen Sie dieses Feld auf `spaces/-`. Die Verwendung eines anderen Werts für `parent` führt zu einem `INVALID_ARGUMENT`-Fehler. Wenn Sie die Suche auf einen oder mehrere Gruppenbereiche beschränken möchten, verwenden Sie `space.name` oder `space.display_name` in der `filter`.
`filter`	`string` Erforderlich. Eine Suchanfrage. Die Abfrage kann ein oder mehrere Suchbegriffe enthalten, die zum Filtern der Ergebnisse verwendet werden. Sie können die Ergebnisse auch mithilfe der folgenden Nachrichtenfelder filtern: `create_time`: Akzeptiert einen Zeitstempel im RFC-3339-Format. Die unterstützten Vergleichsoperatoren sind `<` und `>=`. `sender.name`: Der Ressourcenname des Absenders (`users/{user}`). Es wird nur `=` unterstützt. Sie können 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. `space.name`: Der Ressourcenname des Space, in dem die Nachricht gepostet wird. (`spaces/{space}`). Unterstützt nur `=`. Wenn dieser Filter nicht festgelegt ist, wird die Suche in allen Direktnachrichten und Gruppenbereichen durchgeführt, auf die der Nutzer als Mitglied eines Gruppenbereichs Zugriff hat. `space.display_name`: Unterstützt den Operator `:` (hat) und filtert Gruppenbereiche basierend auf einer teilweisen Übereinstimmung ihres Anzeigenamens. Die Ergebnisse sind auf die fünf besten Space-Übereinstimmungen beschränkt. Mit `space.display_name:Project` wird beispielsweise nach Nachrichten in den fünf wichtigsten Gruppenbereichen gesucht, die das Wort „Projekt“ im Anzeigenamen enthalten. `space.space_type`: Der Typ des Space. Unterstützt nur `=`. Beispiel: `space.space_type="DIRECT_MESSAGE"` gibt nur Nachrichten aus Direktnachrichten zurück. Die möglichen Werte sind `DIRECT_MESSAGE`, `GROUP_CHAT` und `SPACE`. `attachment`: Unterstützt den Operator `:` (hat beliebige), um zu prüfen, ob Anhänge vorhanden sind. Wenn `attachment:` angegeben ist, werden nur Nachrichten zurückgegeben, die mindestens einen Anhang haben. `annotations.user_mentions.user.name`: Der Ressourcenname des erwähnten Nutzers (`users/{user}`). Unterstützt nur `:` (has). Beispiel: `annotations.user_mentions.user.name:"users/1234567890"` gibt nur Nachrichten zurück, die eine Erwähnung des angegebenen Nutzers enthalten. Alternativ kann der Alias `me` verwendet werden, um nach Nachrichten zu filtern, in denen der aufrufende Nutzer erwähnt wird, z. B. `annotations.user_mentions.user.name:users/me`. Sie können die E‑Mail-Adresse auch als Alias für `{user}` verwenden, z. B. `users/example@gmail.com`. Für die erweiterte Filterung sind außerdem die folgenden Funktionen verfügbar: `has_link()`: Es werden nur Nachrichten zurückgegeben, die mindestens einen Hyperlink im Nachrichtentext enthalten. `is_unread()`: Filtert Nachrichten heraus, die vom aufrufenden Nutzer gelesen wurden. Wenn Sie die Filter `space.display_name` oder `space.space_type` verwenden, müssen die Aufrufanmeldedaten einen der folgenden Autorisierungsbereiche enthalten: `https://www.googleapis.com/auth/chat.spaces.readonly` `https://www.googleapis.com/auth/chat.spaces` Wenn Sie den Filter `is_unread()` verwenden, müssen die aufrufenden Anmeldedaten einen der folgenden Autorisierungsbereiche enthalten: `https://www.googleapis.com/auth/chat.users.readstate.readonly` `https://www.googleapis.com/auth/chat.users.readstate` Für verschiedene Felder werden nur `AND`-Operatoren unterstützt. Ein gültiges Beispiel ist `sender.name = "users/1234567890" AND is_unread()`. Das Wort `AND` ist optional und wird impliziert, wenn es weggelassen wird. `sender.name = "users/1234567890" is_unread()` ist beispielsweise gültig und entspricht dem vorherigen Beispiel. Ein ungültiges Beispiel ist `sender.name = "users/1234567890" OR is_unread()`, da `OR` zwischen verschiedenen Feldern nicht unterstützt wird. Im selben Feld: `create_time` unterstützt nur `AND` und kann nur zur Darstellung eines Intervalls wie `create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"` verwendet werden. `sender.name` unterstützt nur den Operator `OR`, z. B. `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`. `space.name` unterstützt nur den Operator `OR`, z. B. `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`. `space.display_name` unterstützt die Operatoren `AND` und `OR`, aber keine Kombination aus beiden. Beispiel: `space.display_name:Project AND space.display_name:Tasks` gibt Nachrichten zurück, die sich in Gruppenbereichen mit Anzeigenamen befinden, die sowohl `Project` als auch `Tasks` enthalten. `space.display_name:Project OR space.display_name:Tasks` gibt Nachrichten zurück, die sich in Gruppenbereichen mit Anzeigenamen befinden, die entweder `Project` oder `Tasks` oder beides enthalten. `space.space_type` unterstützt nur den Operator `OR`, z. B. `space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"`. `annotations.user_mentions.user.name` unterstützt die Operatoren `AND` und `OR`, aber keine Kombination aus beiden. Beispiel: `annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321"` gibt nur Nachrichten zurück, in denen beide Nutzer erwähnt werden, während `annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321"` Nachrichten zurückgibt, in denen einer der beiden Nutzer oder beide erwähnt werden. Klammern sind erforderlich, um die Operatorrangfolge zu unterscheiden, wenn die Operatoren `AND` und `OR` in derselben Abfrage kombiniert werden. z. B. `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`. Andernfalls sind Klammern optional. Die folgenden Beispielabfragen sind gültig: `"Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/example@gmail.com" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks` Die maximale Abfragelänge beträgt 1.000 Zeichen. Ungültige Abfragen werden vom Server mit dem Fehler `INVALID_ARGUMENT` abgelehnt.
`page_size`	`int32` Optional. Die maximale Anzahl von zurückzugebenden Ergebnissen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 25 zurückgegeben. Der Höchstwert beträgt 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch in 100 geändert.
`page_token`	`string` Optional. Ein Token, das vom vorherigen Aufruf zum Suchen von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`order_by`	`string` Optional. Wie die Ergebnisliste sortiert wird. Unterstützte Attribute für die Sortierung: `create_time`: Sortiert die Ergebnisse nach dem Zeitpunkt der Nachrichtenerstellung. Standardwert. `relevance`: Sortiert die Ergebnisse nach Relevanz. (-Entwicklervorschau) Die Standardreihenfolge ist `create_time desc`. Pro Abfrage wird nur eine einzelne Reihenfolge (`create_time` oder `relevance`) unterstützt. Es wird nur die absteigende Reihenfolge (`desc`) unterstützt. Sie muss nach dem Attribut „order“ angegeben werden.
`markup_syntax`	`MarkupSyntax` Optional. Gibt die gewünschte Ausgabesyntax für das Feld `formatted_text` der Chatnachricht an.
`view`	`SearchMessagesView` Optional. Gibt an, welche Art von Suchergebnisansicht zurückgegeben werden soll. Der Standardwert ist `SEARCH_MESSAGES_VIEW_BASIC`.

SearchMessagesView

Die Arten von Ansichten, die für Teilergebnisse der Suche unterstützt werden.

Enums
`SEARCH_MESSAGES_VIEW_UNSPECIFIED`	Der Standardwert / nicht festgelegte Wert. Die API verwendet standardmäßig die BASIC-Ansicht.
`SEARCH_MESSAGES_VIEW_BASIC`	In den Ergebnissen sind nur die übereinstimmenden Nachrichten enthalten, keine zusätzlichen Metadaten. „Immer“ ist der Standardwert.
`SEARCH_MESSAGES_VIEW_FULL`	Umfasst alle Ergebnisse: die übereinstimmenden Nachrichten und zusätzliche Metadaten.

SearchMessagesResponse

Antwortnachricht für die Suche nach Nachrichten.

Felder

results[]

SearchMessageResult

Die Liste der Suchergebnisse, die der Abfrage entsprechen.

next_page_token

string

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

SearchSpacesRequest

Anfrage zum Suchen nach einer Liste von Gruppenbereichen basierend auf einer Abfrage.

Felder
`use_admin_access`	`bool` Wenn `true`, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt. Der aufrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereich `chat.admin.spaces.readonly` oder `chat.admin.spaces`.
`page_size`	`int32` Die maximale Anzahl der zurückzugebenden Spaces. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Spaces zurückgegeben. Der Höchstwert ist 1.000, wenn `useAdminAccess` auf `true` gesetzt ist. Andernfalls beträgt der Höchstwert 100. Wenn Sie einen Wert verwenden, der über dem Höchstwert liegt, wird er automatisch in den Höchstwert geändert.
`page_token`	`string` Ein Token, das vom vorherigen Aufruf der Suchbereiche empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie andere Werte an die anderen Parameter übergeben, kann dies zu unerwarteten Ergebnissen führen.
`query`	`string` Erforderlich. Eine Suchanfrage. Wenn `useAdminAccess` auf `true` festgelegt ist, können Sie mit den folgenden Parametern suchen: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` Wenn `useAdminAccess` auf `false` gesetzt ist: `display_name` `external_user_allowed` `space_type` `create_time` und `last_active_time` akzeptieren einen Zeitstempel im RFC-3339-Format. Die unterstützten Vergleichsoperatoren sind: `=`, `<`, `>`, `<=`, `>=`. `customer` ist erforderlich, wenn `useAdminAccess` auf `true` festgelegt ist. Damit wird angegeben, von welchem Kunden Spaces abgerufen werden sollen. `customers/my_customer` ist der einzige unterstützte Wert. `display_name` akzeptiert nur den Operator `HAS` (`:`). Der zu vergleichende Text wird zuerst in Tokens aufgeteilt. Jedes Token wird dann unabhängig und ohne Berücksichtigung der Groß-/Kleinschreibung als Teilstring an einer beliebigen Stelle im `display_name` des Gruppenbereichs abgeglichen. Beispielsweise führt `Fun Eve` zu Übereinstimmungen mit `Fun event` oder `The evening was fun`, aber nicht mit `notFun event` oder `even`. Wenn `useAdminAccess` auf `false` festgelegt ist, ist `display_name` erforderlich, um aussagekräftige Ergebnisse zu erhalten. Andernfalls wird standardmäßig eine leere Antwort zurückgegeben. `external_user_allowed` akzeptiert entweder `true` oder `false`. `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`. Für verschiedene Felder 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 die Operatoren `AND` und `OR` von `space_type` nicht unterstützt. `display_name`, „space_history_state“ und „external_user_allowed“ unterstützen nur `OR`-Operatoren. `last_active_time` und `create_time` unterstützen sowohl den Operator `AND` als auch den Operator `OR`. `AND` kann nur zur Darstellung eines Intervalls verwendet werden, z. B. `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. Die folgenden Beispielabfragen sind gültig, wenn `useAdminAccess` auf `true` festgelegt ist: 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") Die folgenden Beispielabfragen sind gültig, wenn `useAdminAccess` auf `false` festgelegt ist: `display_name:"Hello World" AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello" AND space_type = "SPACE")` Die maximale Abfragelänge beträgt 1.000 Zeichen. Ungültige Abfragen werden vom Server mit dem Fehler `INVALID_ARGUMENT` abgelehnt.
`order_by`	`string` Optional. Wie die Liste der Gruppenbereiche sortiert wird. Unterstützte Attribute für die Sortierung: `membership_count.joined_direct_human_user_count`: Gibt die Anzahl der menschlichen Nutzer an, die einem Gruppenbereich direkt beigetreten sind. `last_active_time`: Gibt den Zeitpunkt an, zu dem das letzte infrage kommende Element einem Thema dieses Gruppenbereichs hinzugefügt wurde. `create_time`: Gibt den Zeitpunkt der Erstellung des Gruppenbereichs an. Wenn `useAdminAccess` den Wert `false` hat, werden nur `create_time` und `relevance` für die Sortierung unterstützt. Für diese Felder wird bei Suchanfragen, die nicht von Administratoren stammen, nur `DESC` unterstützt. Gültige Werte für Sortiervorgänge sind: `ASC` für aufsteigend. Standardwert. `DESC` für absteigend. Die unterstützte Syntax, wenn `useAdminAccess` auf `true` festgelegt ist: `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` Wenn `useAdminAccess` auf `false` gesetzt ist: `create_time DESC` `relevance DESC` ( Entwicklervorschau)

SearchSpacesResponse

Antwort mit einer Liste von Gruppenbereichen, die der Anfrage zur Suche nach Gruppenbereichen entsprechen.

Felder
`spaces[] (deprecated)`	`Space` Dieses Element wird nicht mehr unterstützt. Eingestellt: Verwenden Sie stattdessen das neue Feld „`results`“. Eine Seite der angeforderten Spaces. Dieses Feld wird nur ausgefüllt, wenn `useAdminAccess` auf `true` gesetzt ist. Es wird zugunsten des neuen Felds `results` eingestellt.
`next_page_token`	`string` Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten. Wird nur ausgefüllt, wenn `useAdminAccess` auf `true` festgelegt ist.
`total_size`	`int32` Die Gesamtzahl der Spaces, die der Abfrage entsprechen, über alle Seiten hinweg. Wenn das Ergebnis mehr als 10.000 Bereiche umfasst, ist dieser Wert eine Schätzung. Wird nur ausgefüllt, wenn `useAdminAccess` auf `true` festgelegt ist.
`results[]`	`SearchSpaceResult` Nur Ausgabe. Die Liste der Suchergebnisse, die der Abfrage entsprechen.

SearchSpaceResult

Ein einzelnes Ergebniselement aus einer Suche nach Gruppenbereichen.

Felder

space

Nur Ausgabe. Der übereinstimmende Gruppenbereich.

Bereich

Stellt einen Abschnitt in Google Chat dar. Mithilfe von Abschnitten können Nutzer ihre Gruppenbereiche organisieren. Es gibt zwei Arten von Abschnitten:

Systembereiche:Dies sind vordefinierte Bereiche, die von Google Chat verwaltet werden. Ihre Ressourcennamen sind fest vorgegeben und sie können nicht erstellt oder gelöscht werden. Außerdem kann ihre display_name nicht geändert werden. Beispiele:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
Benutzerdefinierte Bereiche:Diese Bereiche werden vom Nutzer erstellt und verwaltet. Für das Erstellen eines benutzerdefinierten Bereichs mit CreateSection ist ein display_name erforderlich. Benutzerdefinierte Bereiche können mit UpdateSection aktualisiert und mit DeleteSection gelöscht werden.

Felder
`name`	`string` ID. Ressourcenname des Abschnitts. Bei Systemabschnitten ist die Abschnitts-ID ein konstanter String: DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` DEFAULT_SPACES: `users/{user}/sections/default-spaces` DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
`display_name`	`string` Optional. Der Anzeigename des Abschnitts. Wird nur für Abschnitte vom Typ `CUSTOM_SECTION` ausgefüllt. Unterstützt bis zu 80 Zeichen. Erforderlich beim Erstellen eines `CUSTOM_SECTION`.
`sort_order`	`int32` Nur Ausgabe. Die Reihenfolge des Abschnitts im Verhältnis zu anderen Abschnitten. Abschnitte mit einem niedrigeren `sort_order`-Wert werden vor Abschnitten mit einem höheren Wert angezeigt.
`type`	`SectionType` Erforderlich. Der Typ des Abschnitts.

SectionType

Abschnittstypen.

Enums
`SECTION_TYPE_UNSPECIFIED`	Nicht angegebener Abschnittstyp.
`CUSTOM_SECTION`	Benutzerdefinierter Bereich.
`DEFAULT_DIRECT_MESSAGES`	Standardbereich mit DIRECT_MESSAGE zwischen zwei menschlichen Nutzern oder GROUP_CHAT-Bereichen, die keinem benutzerdefinierten Bereich angehören.
`DEFAULT_SPACES`	Standardbereiche, die zu keinem benutzerdefinierten Bereich gehören.
`DEFAULT_APPS`	Standardbereich mit den installierten Apps eines Nutzers.

SectionItem

Ein benutzerdefiniertes Abschnittselement. Damit werden Abschnittselemente wie Bereiche dargestellt, die in einem Abschnitt gruppiert sind.

Felder

name

string

ID. Der Ressourcenname des Abschnittselements.

Format: users/{user}/sections/{section}/items/{item}

Union-Feld item. Erforderlich. Das Abschnittselement. Für item ist nur einer der folgenden Werte zulässig:

space

string

Optional. Der Name der Space-Ressource.

Format: spaces/{space}

SetUpSpaceRequest

Anfrage zum Erstellen eines Gruppenbereichs und zum Hinzufügen bestimmter Nutzer.

Felder

space

Erforderlich. Space.spaceType ist ein Pflichtfeld.

Wenn Sie einen Space erstellen möchten, setzen Sie Space.spaceType auf SPACE und legen Sie Space.displayName fest. Wenn du beim Einrichten eines Raums die Fehlermeldung ALREADY_EXISTS erhältst, versuche es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits von einem 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 1:1-Unterhaltung zwischen Menschen erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false. Legen Sie Space.displayName oder Space.spaceDetails nicht fest.

Wenn Sie eine 1:1-Unterhaltung zwischen einer Person und der aufrufenden Chat-App erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true. Legen Sie Space.displayName oder Space.spaceDetails nicht fest.

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

request_id

string

So verwenden Sie dieses Feld effektiv:

Achten Sie darauf, dass nachfolgende Anfragen mit der ursprünglichen Anfrage identisch sind und dieselben Authentifizierungsdaten verwenden.
Wenn bereits ein Gruppenbereich mit der angegebenen Anfrage-ID erstellt wurde, wird dieser Gruppenbereich zurückgegeben. Der zurückgegebene Space ist möglicherweise nicht vollständig ausgefüllt. Die API gibt den Space in Ihrer Anfrage mit dem vom System zugewiesenen Ressourcennamen zurück. Rufen Sie GetSpace auf, um die neuesten Metadaten für den Space abzurufen.
Wenn Sie eine vorhandene Anfrage-ID mit einem anderen authentifizierten Nutzer wiederverwenden, wird ein Fehler ausgegeben.

memberships[]

AccessPermissionSetting

Optional. Die Google Chat-Nutzer oder -Gruppen, die Sie in den Gruppenbereich einladen möchten. Lassen Sie den aufrufenden Nutzer weg, da er automatisch hinzugefügt wird.

Der Satz lässt derzeit bis zu 49 Mitgliedschaften zu (zusätzlich zum Aufrufer).

Bei einer Mitgliedschaft von Personen muss das Feld Membership.member einen user mit ausgefülltem name (Format: users/{user}) enthalten und type muss auf User.Type.HUMAN festgelegt sein. Sie können beim Einrichten eines Gruppenbereichs nur menschliche 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 einer Google-Gruppe muss das Feld Membership.group_member einen group mit ausgefülltem 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 festgelegt wird.

Erforderlich, wenn Space.spaceType auf GROUP_CHAT festgelegt wird, zusammen mit mindestens zwei Mitgliedschaften.

Erforderlich, wenn Space.spaceType mit einem menschlichen Nutzer auf DIRECT_MESSAGE festgelegt wird, zusammen mit genau einer Mitgliedschaft.

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

SlashCommand

Metadaten zu einem Slash-Befehl in Google Chat.

Felder

command_id

int64

Die ID des Slash-Befehls.

SlashCommandMetadata

Anmerkungsmetadaten für Slash-Befehle (/).

Felder
`bot`	`User` Die Chat-App, deren Befehl aufgerufen wurde.
`type`	`Type` Der Typ des Slash-Befehls.
`command_name`	`string` Der Name des aufgerufenen Slash-Befehls.
`command_id`	`int64` Die Befehls-ID des aufgerufenen Slash-Befehls.
`triggers_dialog`	`bool` Gibt an, ob der Slash-Befehl für einen Dialog ist.

Typ

Enums
`TYPE_UNSPECIFIED`	Standardwert für das Enum. Nicht verwenden.
`ADD`	Fügen Sie die Chat-App dem Gruppenbereich hinzu.
`INVOKE`	Slash-Befehl in einem Gruppenbereich aufrufen.

Leerzeichen

Ein Gruppenbereich in Google Chat. Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehr Nutzern oder Direktnachrichten zwischen einem Nutzer und einer Chat-App.

Felder
`name`	`string` ID. Ressourcenname des Space. Format: `spaces/{space}` Dabei steht `{space}` für die vom System zugewiesene ID des Space. Sie können die ID des Gruppenbereichs abrufen, indem Sie die Methode `spaces.list()` aufrufen oder die URL des Gruppenbereichs verwenden. Wenn die URL des Gruppenbereichs beispielsweise `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA` lautet, ist die ID des Gruppenbereichs `AAAAAAAAA`.
`type (deprecated)`	`Type` Dieses Element wird nicht mehr unterstützt. Nur Ausgabe. Nicht mehr unterstützt: Verwenden Sie stattdessen `space_type`. Der Typ eines Gruppenbereichs.
`space_type`	`SpaceType` Optional. Der Typ des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder den Typ eines Gruppenbereichs aktualisieren. Nur Ausgabe für andere Nutzung.
`single_user_bot_dm`	`bool` Optional. Gibt an, ob der Gruppenbereich eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person ist.
`threaded (deprecated)`	`bool` Dieses Element wird nicht mehr unterstützt. Nur Ausgabe. Nicht mehr unterstützt: Verwenden Sie stattdessen `spaceThreadingState`. Gibt an, ob Nachrichten in diesem Gruppenbereich in Threads organisiert sind.
`display_name`	`string` Optional. Der Anzeigename des Space. Erforderlich, wenn Sie einen Space mit einem `spaceType` von `SPACE` erstellen. Wenn Sie beim Erstellen eines Space oder beim Aktualisieren des `displayName` die Fehlermeldung `ALREADY_EXISTS` erhalten, versuchen Sie es mit einem anderen `displayName`. Möglicherweise wird dieser Anzeigename bereits von einem vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet. Bei Direktnachrichten ist dieses Feld möglicherweise leer. Unterstützt bis zu 128 Zeichen.
`external_user_allowed`	`bool` Optional. Nicht veränderbar. Gibt an, ob jeder Google Chat-Nutzer Mitglied dieses Gruppenbereichs sein darf. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld beim Erstellen von Gruppenbereichen unter den folgenden Bedingungen weg: Der authentifizierte Nutzer verwendet ein Privatnutzerkonto (nicht verwaltetes Nutzerkonto). Standardmäßig sind in einem Bereich, der von einem Privatnutzerkonto erstellt wurde, alle Google Chat-Nutzer zugelassen. Bei vorhandenen Spaces ist dieses Feld schreibgeschützt.
`space_threading_state`	`SpaceThreadingState` Nur Ausgabe. Der Thread-Status im Chatbereich.
`space_details`	`SpaceDetails` Optional. Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.
`space_history_state`	`HistoryState` Optional. Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich.
`import_mode`	`bool` Optional. Gibt an, ob dieser Gruppenbereich im Rahmen einer Datenmigration zu Google Workspace in `Import Mode` erstellt wurde. Während Gruppenbereiche importiert werden, sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist. Zum Erstellen eines Space in `Import Mode` ist eine Nutzerauthentifizierung erforderlich.
`create_time`	`Timestamp` Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen: der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird. Legen Sie für Spaces im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem der Space in der Quelle erstellt wurde, um die ursprüngliche Erstellungszeit beizubehalten. Wird nur in der Ausgabe ausgefüllt, wenn `spaceType` `GROUP_CHAT` oder `SPACE` ist.
`last_active_time`	`Timestamp` Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.
`admin_installed`	`bool` Nur Ausgabe. Bei Gruppenbereichen für Direktnachrichten (DM) mit einer Chat-App, ob der Gruppenbereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Chat-App installieren und eine Direktnachricht mit ihr einrichten. Damit die Installation durch Administratoren unterstützt wird, muss Ihre Chat-App Direktnachrichten unterstützen.
`membership_count`	`MembershipCount` Nur Ausgabe. Die Anzahl der beigetretenen Mitglieder, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn der `space_type` `SPACE`, `DIRECT_MESSAGE` oder `GROUP_CHAT` ist.
`access_settings`	`AccessSettings` Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur angegeben, wenn der `space_type` `SPACE` ist.
`space_uri`	`string` Nur Ausgabe. Der URI, über den ein Nutzer auf den Space zugreifen kann.
`import_mode_expire_time`	`Timestamp` Nur Ausgabe. Der Zeitpunkt, zu dem der Space automatisch vom System gelöscht wird, wenn er im Importmodus bleibt. Jeder im Importmodus erstellte Space muss diesen Modus vor Ablauf dieser Zeit mit `spaces.completeImport` verlassen. Dieses Feld wird nur für Gruppenbereiche ausgefüllt, die im Importmodus erstellt wurden.
`customer`	`string` Optional. Nicht veränderbar. Die Kundennummer der Domain des Gruppenbereichs. Nur erforderlich, wenn ein Space mit App-Authentifizierung erstellt wird und `SpaceType` den Wert `SPACE` hat. Andernfalls sollte dieses Feld nicht festgelegt werden. Im Format `customers/{customer}`, wobei `customer` die `id` aus der Admin SDK-Kundenressource ist. Bei internen Apps kann auch der Alias `customers/my_customer` verwendet werden, um den Gruppenbereich in derselben Google Workspace-Organisation wie die App zu erstellen. Dieses Feld wird nicht für Direktnachrichten (DMs) oder für Gruppenbereiche ausgefüllt, die von Nutzern erstellt wurden, die nicht Google Workspace verwenden.
Union-Feld `space_permission_settings`. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur angegeben, wenn der `space_type` `SPACE` ist. Für `space_permission_settings` ist nur einer der folgenden Werte zulässig:
`predefined_permission_settings`	`PredefinedPermissionSettings` Optional. Nur Eingabe. Vordefinierte Einstellungen für die Berechtigungen für Gruppenbereiche, die nur beim Erstellen eines Gruppenbereichs eingegeben werden können. Wenn das Feld nicht festgelegt ist, wird ein Space für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld `PermissionSettings` ausgefüllt. Das Festlegen vordefinierter Berechtigungseinstellungen unterstützt Folgendes: App-Authentifizierung mit Administratorgenehmigung mit den Bereichen `chat.app.spaces` oder `chat.app.spaces.create`. Nutzerauthentifizierung
`permission_settings`	`PermissionSettings` Optional. Berechtigungseinstellungen für vorhandene Gruppenbereiche. Eingabe zum Aktualisieren der genauen Berechtigungseinstellungen für Gruppenbereiche, wobei vorhandene Berechtigungseinstellungen ersetzt werden. In der Ausgabe werden die aktuellen Berechtigungseinstellungen aufgeführt. Das Lesen und Aktualisieren von Berechtigungseinstellungen wird unterstützt für: App-Authentifizierung mit Administratorgenehmigung mit dem Bereich `chat.app.spaces`. Wird nur ausgefüllt und kann nur festgelegt werden, wenn die Chat-App den Gruppenbereich erstellt hat. Nutzerauthentifizierung

AccessPermissionSetting

Eine Einstellung für Zugriffsberechtigungen.

Felder

principals[]

Principal

Optional. Unsortierte Liste. Zulässige Hauptkonten für diese Berechtigung.

AccessPermissionSettings

Auf die Berechtigungseinstellungen für einen Gruppenbereich zugreifen

Felder

discover_space_setting

Optional. Einstellung für die Zugriffsberechtigung zum Entdecken des Gruppenbereichs.

join_space_setting

AccessPermissionSetting

Optional. Einstellung für die Zugriffsberechtigung zum Beitreten zum Gruppenbereich.

view_space_membership_setting

AccessPermissionSetting

Optional. Einstellung für die Zugriffsberechtigung zum Aufrufen der Mitgliedschaft in einem Gruppenbereich. Muss zusammen mit PermissionSettings.view_space_membership in der Aktualisierungsmaske und im Anfragetext angegeben werden, wenn aktualisiert wird, wer die Mitgliedschaft im Gruppenbereich sehen kann. Wenn Sie einer Zielgruppe Lesezugriff gewähren, müssen Sie in derselben Anfrage auch allen Mitgliedern PermissionSettings.view_space_membership gewähren. Wenn Sie eine vorhandene Zielgruppe entfernen möchten, um beispielsweise den Lesezugriff auf Administratoren oder stellvertretende Administratoren des Gruppenbereichs zu beschränken, geben Sie ein leeres AccessPermissionSetting (ohne principals) an.

AccessSettings

Stellt die Zugriffseinstellung des Gruppenbereichs dar.

Felder

access_state

AccessState

Nur Ausgabe. Gibt den Zugriffsstatus des Space an.

audience

string

Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und eine Vorschau der Nachrichten im Gruppenbereich ansehen kann. Wenn diese Option nicht festgelegt 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 auffindbar machen.

Format: audiences/{audience}

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

Die Zielgruppe liest:

Nutzerauthentifizierung
App-Authentifizierung mit Administratorgenehmigung mit dem Bereich chat.app.spaces.

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

Zum Festlegen der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

access_permission_settings

AccessPermissionSettings

Optional. Rufen Sie die Berechtigungseinstellungen für den Gruppenbereich auf.

Wenn Sie die Zielgruppe beim Erstellen eines Gruppenbereichs festlegen möchten, geben Sie in Ihrer Anfrage das Feld accessSettings.audience an.

AccessState

Stellt den Zugriffsstatus des Gruppenbereichs dar.

Enums

ACCESS_STATE_UNSPECIFIED Der Zugriffsstatus ist unbekannt oder wird in dieser API nicht unterstützt.

PRIVATE Nur Nutzer oder Google-Gruppen, die von anderen Nutzern oder Google Workspace-Administratoren einzeln hinzugefügt oder eingeladen wurden, können den Gruppenbereich finden und darauf zugreifen.

DISCOVERABLE

Ein Administrator des Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die dem Gruppenbereich einzeln hinzugefügt oder eingeladen wurden, können den Gruppenbereich ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer auffindbar machen.

Für das Erstellen von Gruppenbereichen mit offenem Zugang ist eine Nutzerauthentifizierung erforderlich.

MembershipCount

Stellt die Anzahl der Mitgliedschaften in einem Gruppenbereich dar, gruppiert nach Kategorien.

Felder

joined_direct_human_user_count

int32

Nur Ausgabe. Anzahl der menschlichen Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über eine Mitgliedschaft in einer Gruppe beigetreten sind, werden nicht berücksichtigt.

joined_group_count

int32

Nur Ausgabe. Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

PermissionSetting

Stellt eine Berechtigungseinstellung für einen Gruppenbereich dar.

Felder

managers_allowed

bool

Optional. Gibt an, ob Inhaber von Gruppenbereichen (ROLE_MANAGER) diese Berechtigung haben.

members_allowed

bool

Optional. Ob einfache Mitglieder des Gruppenbereichs (ROLE_MEMBER) diese Berechtigung haben.

assistant_managers_allowed

bool

Optional. Ob Administratoren von Gruppenbereichen (ROLE_ASSISTANT_MANAGER) diese Berechtigung haben.

PermissionSettings

Berechtigungseinstellungen, die Sie beim Aktualisieren eines vorhandenen benannten Gruppenbereichs festlegen können.

Wenn Sie beim Erstellen eines Gruppenbereichs Berechtigungseinstellungen festlegen möchten, geben Sie in Ihrer Anfrage das Feld PredefinedPermissionSettings an.

Felder
`manage_members_and_groups`	`PermissionSetting` Optional. Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Space.
`modify_space_details`	`PermissionSetting` Optional. Einstellung zum Aktualisieren des Namens, Avatars, der Beschreibung und der Richtlinien des Gruppenbereichs.
`toggle_history`	`PermissionSetting` Optional. Einstellung zum Aktivieren und Deaktivieren des Verlaufs für Gruppenbereiche.
`use_at_mention_all`	`PermissionSetting` Optional. Einstellung für die Verwendung von @alle in einem Gruppenbereich.
`manage_apps`	`PermissionSetting` Optional. Einstellung zum Verwalten von Apps in einem Gruppenbereich.
`manage_webhooks`	`PermissionSetting` Optional. Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.
`post_messages`	`PermissionSetting` Nur Ausgabe. Einstellung zum Posten von Nachrichten in einem Gruppenbereich.
`reply_messages`	`PermissionSetting` Optional. Einstellung für das Antworten auf Nachrichten in einem Gruppenbereich.
`view_space_membership`	`PermissionSetting` Optional. Einstellung zum Ansehen der Mitgliedschaft in einem Gruppenbereich. Muss zusammen mit `AccessPermissionSettings.view_space_membership_setting` in der Aktualisierungsmaske und im Anfragetext angegeben werden, wenn aktualisiert wird, wer die Mitgliedschaft im Gruppenbereich sehen kann. Wenn Sie den Lesezugriff auf bestimmte Rollen beschränken möchten (z. B. nur Space-Administratoren oder stellvertretende Administratoren), geben Sie hier die gewünschten Rollenberechtigungen an und geben Sie in derselben Anfrage ein leeres `AccessPermissionSettings.view_space_membership_setting` an. Wenn eine Zielgruppe in `AccessPermissionSettings.view_space_membership_setting` konfiguriert ist, muss diese Einstellung allen Mitgliedern gewährt werden.

PredefinedPermissionSettings

Vordefinierte Berechtigungseinstellungen, die Sie nur beim Erstellen eines benannten Gruppenbereichs festlegen können. In Zukunft werden möglicherweise weitere Einstellungen hinzugefügt. Weitere Informationen zu den Berechtigungseinstellungen für benannte Gruppenbereiche finden Sie unter Informationen zu Gruppenbereichen.

Enums
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	Nicht angegeben Nicht verwenden.
`COLLABORATION_SPACE`	Einstellung, mit der der Gruppenbereich zu einem Bereich für die Zusammenarbeit wird, in dem alle Mitglieder Nachrichten posten können.
`ANNOUNCEMENT_SPACE`	Einstellung, mit der der Gruppenbereich zu einem Gruppenbereich für Ankündigungen wird, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können.

Hauptkonto

Ein Hauptkonto, das eine Entität darstellt, der Zugriff gewährt wurde.

Felder

Union-Feld principal_type. Der Typ des Hauptkontos. Für principal_type ist nur einer der folgenden Werte zulässig:

audience

Audience

Eine Zielgruppe.

SpaceDetails

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.

Felder

description

string

Optional. Eine Beschreibung des Gruppenbereichs. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionalen Zweck oder die Teilnehmer des Gruppenbereichs.

Unterstützt bis zu 4.096 Zeichen.

guidelines

string

Optional. Die Regeln, Erwartungen und Verhaltensweisen für den Gruppenbereich.

Unterstützt bis zu 5.000 Zeichen.

SpaceThreadingState

Gibt den Typ des Threading-Status im Chatbereich an.

Enums
`SPACE_THREADING_STATE_UNSPECIFIED`	Reserviert.
`THREADED_MESSAGES`	Gruppenbereiche, die Nachrichten-Threads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie dies im Thread tun. So bleibt ihre Antwort im Kontext der ursprünglichen Nachricht.
`GROUPED_MESSAGES`	Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen sortiert ist. Themen und die zugehörigen Antworten werden gruppiert.
`UNTHREADED_MESSAGES`	Gruppenbereiche, die keine Nachrichten-Threads unterstützen. Dieser Threading-Status für Gruppenbereiche wird nur in besonderen Fällen verwendet, z. B.: Fortlaufender Chat in Besprechungen, bei dem die Thread-Ansicht absichtlich deaktiviert ist. Legacy-Gruppenunterhaltungen, die vor 2022 erstellt wurden.

SpaceType

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Space. Nur Ausgabe für andere Nutzung.

Enums
`SPACE_TYPE_UNSPECIFIED`	Reserviert.
`SPACE`	Ein Ort, an dem Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können. Ein `SPACE` kann Chat-Apps enthalten.
`GROUP_CHAT`	Gruppenunterhaltungen mit mindestens drei Personen. Ein `GROUP_CHAT` kann Chat-Apps enthalten.
`DIRECT_MESSAGE`	1:1-Nachrichten zwischen zwei Personen oder einer Person und einer Chat-App.

Typ

Nicht mehr unterstützt: Verwenden Sie stattdessen SpaceType.

Enums
`TYPE_UNSPECIFIED`	Reserviert.
`ROOM`	Unterhaltungen zwischen zwei oder mehr Menschen.
`DM`	Direktnachricht zwischen einer Person und einer Chat-App, bei der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon nicht betroffen.

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Aktualisierungen eines Space.

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

Felder

spaces[]

SpaceUpdatedEventData

Eine Liste der aktualisierten Gruppenbereiche.

SpaceEvent

Ein Ereignis, das eine Änderung oder Aktivität in einem Google Chat-Bereich darstellt. Weitere Informationen finden Sie unter Mit Ereignissen aus Google Chat arbeiten.

Felder
`name`	`string` Ressourcenname des Space-Ereignisses. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Zeitpunkt des Ereignisses.
`event_type`	`string` Art des Gruppenbereichsereignisses. Für jeden Ereignistyp gibt es eine Batchversion, die mehrere Instanzen des Ereignistyps darstellt, die in einem kurzen Zeitraum auftreten. Lassen Sie bei `spaceEvents.list()`-Anfragen Batch-Ereignistypen in Ihrem Abfragefilter weg. Standardmäßig gibt der Server sowohl den Ereignistyp als auch die Batchversion zurück. Unterstützte Ereignistypen für Nachrichten: 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 Mitgliedschaften: 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 Space: Aktualisierter Gruppenbereich: `google.workspace.chat.space.v1.updated` Mehrere Aktualisierungen des Gruppenbereichs: `google.workspace.chat.space.v1.batchUpdated`
Union-Feld `payload`. Für `payload` ist nur einer der folgenden Werte zulässig:
`message_created_event_data`	`MessageCreatedEventData` Ereignisnutzlast für eine neue Nachricht. Ereignistyp: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Ereignisnutzlast für eine aktualisierte Nachricht. Ereignistyp: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Ereignisnutzlast für eine gelöschte Nachricht. Ereignistyp: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Ereignisnutzlast für mehrere neue Nachrichten. Ereignistyp: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Ereignisnutzlast für mehrere aktualisierte Nachrichten. Ereignistyp: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Ereignisnutzlast für mehrere gelöschte Nachrichten. Ereignistyp: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Ereignisnutzlast für die Aktualisierung eines Gruppenbereichs. Ereignistyp: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Ereignisnutzlast für mehrere Aktualisierungen eines Space. Ereignistyp: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Ereignisnutzlast für eine neue Mitgliedschaft. Ereignistyp: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Ereignisnutzlast für eine aktualisierte Mitgliedschaft. Ereignistyp: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Ereignisnutzlast für eine gelöschte Mitgliedschaft. Ereignistyp: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Ereignisnutzlast für mehrere neue Mitgliedschaften. Ereignistyp: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften. Ereignistyp: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Ereignisnutzlast für mehrere gelöschte Mitgliedschaften. Ereignistyp: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Ereignisnutzlast für eine neue Reaktion. Ereignistyp: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Ereignisnutzlast für eine gelöschte Reaktion. Ereignistyp: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Ereignisnutzlast für mehrere neue Reaktionen. Ereignistyp: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Ereignisnutzlast für mehrere gelöschte Reaktionen. Ereignistyp: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

Die Benachrichtigungseinstellung eines Nutzers in einem Gruppenbereich.

Felder

name

string

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

notification_setting

NotificationSetting

Die Benachrichtigungseinstellung.

mute_setting

MuteSetting

Die Einstellung zum Stummschalten von Benachrichtigungen für den Gruppenbereich.

MuteSetting

Die Arten von Einstellungen für das Stummschalten von Benachrichtigungen in Gruppenbereichen.

Enums
`MUTE_SETTING_UNSPECIFIED`	Reserviert.
`UNMUTED`	Der Nutzer erhält Benachrichtigungen für den Gruppenbereich basierend auf der Benachrichtigungseinstellung.
`MUTED`	Der Nutzer erhält keine Benachrichtigungen für den Gruppenbereich, unabhängig von der Benachrichtigungseinstellung.

NotificationSetting

Die Typen von Benachrichtigungseinstellungen. In Zukunft werden möglicherweise weitere Typen unterstützt.

Enums
`NOTIFICATION_SETTING_UNSPECIFIED`	Reserviert.
`ALL`	Benachrichtigungen werden durch @Erwähnungen, Threads, denen Sie folgen, und die erste Nachricht in neuen Threads ausgelöst. Allen neuen Threads wird automatisch gefolgt, es sei denn, der Nutzer beendet das Folgen manuell.
`MAIN_CONVERSATIONS`	Die Benachrichtigung wird durch @Erwähnungen, Threads, denen Sie folgen, und die erste Nachricht in neuen Threads ausgelöst. Nicht verfügbar für 1:1-Direktnachrichten.
`FOR_YOU`	Die Benachrichtigung wird durch @Erwähnungen und Threads, denen Sie folgen, ausgelöst. Nicht verfügbar für 1:1-Direktnachrichten.
`OFF`	Benachrichtigung ist deaktiviert.

SpaceReadState

Der Lesestatus eines Nutzers in einem Gruppenbereich, der verwendet wird, um gelesene und ungelesene Nachrichten zu identifizieren.

Felder

name

string

Ressourcenname des Lesestatus des Space.

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

last_read_time

Timestamp

Optional. Der Zeitpunkt, zu dem der Lesestatus des Nutzers für den Gruppenbereich aktualisiert wurde. Normalerweise entspricht dies entweder dem Zeitstempel der zuletzt gelesenen Nachricht oder einem vom Nutzer angegebenen Zeitstempel, um die zuletzt gelesene Position in einem Gruppenbereich zu markieren.

SpaceUpdatedEventData

Ereignisnutzlast für einen aktualisierten Space.

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

Felder

space

Der aktualisierte Space.

SpaceView

Eine Ansicht, die angibt, welche Felder in der Space-Ressource ausgefüllt werden sollen. Damit die Kompatibilität mit zukünftigen Versionen gewährleistet ist, empfehlen wir, in Ihrem Code zusätzliche Werte zu berücksichtigen.

Enums
`SPACE_VIEW_UNSPECIFIED`	Der Standardwert / nicht festgelegte Wert.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Füllt nur den Namen der Space-Ressource aus.
`SPACE_VIEW_EXPANDED`	Füllt Felder für Space-Ressourcen aus. Hinweis: Das Feld `permissionSettings` wird nicht ausgefüllt. Anfragen, die SPACE_VIEW_EXPANDED angeben, müssen Bereiche enthalten, die das Lesen von Space-Daten ermöglichen, z. B. https://www.googleapis.com/auth/chat.spaces oder https://www.googleapis.com/auth/chat.spaces.readonly.

Thread

Ein Thread in einem Google Chat-Gruppenbereich. Beispiele für die Verwendung finden Sie unter Unterhaltung starten oder auf eine Nachricht antworten.

Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie im Feld messageReplyOption festlegen, was passiert, wenn kein übereinstimmender Thread gefunden wird.

Felder

name

string

ID. Ressourcenname des Threads.

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

thread_key

string

Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls nur Ausgabe. 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 Threadschlü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-Feld name an.

ThreadReadState

Der Lesestatus eines Nutzers in einem Thread, der verwendet wird, um gelesene und ungelesene Nachrichten zu identifizieren.

Felder

name

string

Ressourcenname des Lesestatus des Threads.

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

last_read_time

Timestamp

Der Zeitpunkt, zu dem der Lesestatus des Threads des Nutzers aktualisiert wurde. In der Regel entspricht dies dem Zeitstempel der letzten gelesenen Nachricht in einem Thread.

UpdateAvailabilityRequest

Anfragenachricht für die Methode UpdateAvailability.

Felder

availability

Availability

Erforderlich. Die zu aktualisierende Verfügbarkeit.

update_mask

Erforderlich. Die Liste der zu aktualisierenden Felder. Das einzige Feld, das aktualisiert werden kann, ist custom_status.

UpdateMembershipRequest

Anfragenachricht zum Aktualisieren einer Mitgliedschaft.

Felder

membership

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

update_mask

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

Derzeit unterstützte Feldpfade:

role

use_admin_access

bool

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

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

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

UpdateMessageRequest

Anfrage zum Aktualisieren einer Nachricht.

Felder

message

Erforderlich. Nachricht mit aktualisierten Feldern.

update_mask

Erforderlich. Die zu aktualisierenden Feldpfade. 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)
quoted_message_metadata (nur zum Entfernen der zitierten Nachricht)

allow_missing

bool

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

UpdateSectionRequest

Anfragenachricht zum Aktualisieren eines Abschnitts.

Felder

section

Erforderlich. Der zu aktualisierende Abschnitt.

update_mask

SpaceNotificationSetting

Erforderlich. Die Maske, die angibt, welche Felder aktualisiert werden sollen.

Derzeit unterstützte Feldpfade:

display_name

UpdateSpaceNotificationSettingRequest

Anfrage zum Aktualisieren der Benachrichtigungseinstellungen für den Gruppenbereich. Unterstützt nur das Aktualisieren der Benachrichtigungseinstellung für den aufrufenden Nutzer.

Felder

space_notification_setting

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

update_mask

Erforderlich. Unterstützte Feldpfade:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Anfragenachricht für die UpdateSpaceReadState API.

Felder

space_read_state

SpaceReadState

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

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

Wenn Sie sich auf den aufrufenden Nutzer beziehen möchten, legen Sie eine der folgenden Optionen fest:

Der Alias me. Beispiel: users/me/spaces/{space}/spaceReadState.
Die Workspace-E‑Mail-Adresse des Nutzers. Beispiel: users/user@example.com/spaces/{space}/spaceReadState.
Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState.

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

update_mask

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

last_read_time

Wenn der last_read_time vor dem Erstellungszeitpunkt der neuesten Nachricht liegt, wird der Gruppenbereich in der Benutzeroberfläche als ungelesen angezeigt.

Wenn Sie den Gruppenbereich als gelesen markieren möchten, legen Sie für last_read_time einen Wert fest, der nach dem Erstellungszeitpunkt der letzten Nachricht liegt. Der last_read_time wird implizit umgewandelt, um mit der Erstellungszeit der neuesten Nachricht übereinzustimmen. 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. Stattdessen wird der Lesestatus des Threads verwendet.

UpdateSpaceRequest

Eine Anfrage zum Aktualisieren eines einzelnen Space.

Felder

space

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

update_mask