Package google.chat.v1

Index

ChatService

Ermöglicht Entwicklern, Chat-Apps und -Integrationen auf der Google Chat-Plattform zu erstellen.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Schließt den Importvorgang für den angegebenen Bereich ab und macht ihn für Nutzer sichtbar. Erfordert eine App-Authentifizierung und eine domainweite Delegierung. Weitere Informationen finden Sie im Hilfeartikel Google Chat-Apps zum Importieren von Daten autorisieren.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/chat.import

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Erstellt eine Mitgliedschaft oder App-Mitgliedschaft für die anrufende App. Das Erstellen von Mitgliedschaften für andere Apps wird nicht unterstützt. Ein Beispiel finden Sie unter Nutzer oder eine Google Chat App zu einem Gruppenbereich einladen oder hinzufügen. Wenn das angegebene Mitglied beim Erstellen einer Mitgliedschaft die Richtlinie für die automatische Annahme deaktiviert hat, wird es eingeladen. Es muss die Einladung zum Gruppenbereich annehmen, bevor es beitreten kann. Andernfalls wird das Mitglied beim Erstellen einer Mitgliedschaft direkt dem angegebenen Gruppenbereich hinzugefügt. Erfordert eine Nutzerauthentifizierung.

Wenn Sie das hinzuzufügende Mitglied angeben möchten, legen Sie den membership.member.name für den Nutzer oder das App-Mitglied oder den membership.group_member.name für das Gruppenmitglied fest.

  • Verwenden Sie users/app, um die Anruf-App einem Gruppenbereich oder einer Direktnachricht zwischen zwei menschlichen Nutzern hinzuzufügen. Dem Gruppenbereich können keine weiteren Apps hinzugefügt werden.

  • Wenn Sie einen menschlichen Nutzer hinzufügen möchten, verwenden Sie users/{user}, wobei {user} die E-Mail-Adresse des Nutzers sein kann. Für Nutzer in derselben Workspace-Organisation kann {user} auch der id für die Person aus der People API oder der id für den Nutzer in der Directory API sein. Wenn die People API-Personenprofil-ID 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.

  • Verwenden Sie groups/{group}, um eine Google-Gruppe in einem benannten Gruppenbereich hinzuzufügen oder einzuladen. Dabei ist {group} der id für die Gruppe aus der Cloud Identity Groups API. Sie können beispielsweise die Cloud Identity Groups Lookup API verwenden, um die ID 123456789 für die Gruppen-E-Mail-Adresse group@example.com abzurufen. Anschließend können Sie die Gruppe einem benannten Gruppenbereich hinzufügen oder sie in einen benannten Gruppenbereich einladen, indem Sie membership.group_member.name auf groups/123456789 setzen. Die E-Mail-Adresse einer Gruppe wird nicht unterstützt und Google-Gruppen können nur in benannten Gruppenbereichen als Mitglieder hinzugefügt werden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Eine Nachricht in einem Google Chat-Bereich erstellen. Die maximale Nachrichtengröße, einschließlich Text und Karten, beträgt 32.000 Byte. Ein Beispiel finden Sie im Hilfeartikel Nachrichten senden.

Der Aufruf dieser Methode erfordert eine Authentifizierung und unterstützt die folgenden Authentifizierungstypen:

  • Für SMS wird die Nutzer- oder App-Authentifizierung unterstützt.
  • Für Kartennachrichten wird nur die App-Authentifizierung unterstützt. Nur Chat-Apps können Kartennachrichten erstellen.
Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Erstellt eine Reaktion und fügt sie einer Nachricht hinzu. Es werden nur Unicode-Emojis unterstützt. Ein Beispiel finden Sie im Hilfeartikel Reaktion auf eine Nachricht hinzufügen. Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Erstellt einen benannten Gruppenbereich. Nach Themen gruppierte Gruppenbereiche werden nicht unterstützt. Ein Beispiel finden Sie unter Gruppenbereich erstellen.

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

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Löscht eine Mitgliedschaft. Ein Beispiel finden Sie unter Nutzer oder Google Chat-Apps aus einem Gruppenbereich entfernen.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Löscht eine Nachricht. Ein Beispiel finden Sie unter Nachrichten löschen.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Bei der App-Authentifizierung können Anfragen nur Nachrichten löschen, die von der aufrufenden Chat-App erstellt wurden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Löscht eine Reaktion auf eine Nachricht. Es werden nur Unicode-Emojis unterstützt. Ein Beispiel finden Sie unter Reaktionen löschen. Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Löscht einen benannten Gruppenbereich. Es wird immer ein kaskadierendes Löschen durchgeführt. Das bedeutet, dass die untergeordneten Ressourcen des Gruppenbereichs, z. B. im Gruppenbereich gepostete Nachrichten und Mitgliedschaften im Gruppenbereich, ebenfalls gelöscht werden. Ein Beispiel finden Sie unter Gruppenbereiche löschen. Erfordert die Nutzerauthentifizierung eines Nutzers, der berechtigt ist, den Gruppenbereich zu löschen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Gibt die vorhandene Direktnachricht an den angegebenen Nutzer zurück Wenn kein Gruppenbereich für Direktnachrichten gefunden wird, wird der Fehler 404 NOT_FOUND zurückgegeben. Ein Beispiel finden Sie im Hilfeartikel Direktnachrichten suchen.

Bei der Nutzerauthentifizierung wird der Direktnachrichtbereich zwischen dem angegebenen Nutzer und dem authentifizierten Nutzer zurückgegeben.

Bei der App-Authentifizierung wird der Direktnachrichtbereich zwischen dem angegebenen Nutzer und der aufrufenden Chat-App zurückgegeben.

Dafür ist eine Nutzerauthentifizierung oder App-Authentifizierung erforderlich.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Ruft die Metadaten eines Nachrichtenanhangs ab. Die Daten der Anhänge werden mithilfe der Media API abgerufen. Ein Beispiel finden Sie unter Metadaten zu einem Nachrichtenanhang abrufen. Erfordert eine App-Authentifizierung.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Gibt Details zu einer Mitgliedschaft zurück. Ein Beispiel finden Sie unter Details zur Mitgliedschaft eines Nutzers oder der Google Chat App abrufen.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Gibt Details zu einer Nachricht zurück. Ein Beispiel finden Sie unter Details zu einer Nachricht abrufen.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Hinweis: Möglicherweise wird eine Nachricht von einem blockierten Mitglied oder Gruppenbereich zurückgegeben.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Gibt Details zu einem Gruppenbereich zurück. Ein Beispiel finden Sie unter Details zu einem Gruppenbereich abrufen.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Gibt einen Termin aus einem Google Chat-Bereich zurück. Die Ereignisnutzlast enthält die neueste Version der Ressource, die sich geändert hat. Wenn Sie beispielsweise ein Ereignis zu einer neuen Nachricht anfordern, die Nachricht aber später aktualisiert wurde, gibt der Server die aktualisierte Ressource Message in der Ereignisnutzlast zurück.

Erfordert eine Nutzerauthentifizierung. Um ein Ereignis abzurufen, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie im Hilfeartikel Termindetails aus einem Google Chat-Bereich abrufen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Gibt Details zum Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zurück. Diese Informationen werden verwendet, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Lesestatus eines Gruppenbereichs eines Nutzers abrufen.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Gibt Details zum Lesestatus eines Nutzers innerhalb eines Threads zurück, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Thread-Lesestatus eines Nutzers abrufen.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Listet Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Nutzer und Google Chat-Apps in einem Gruppenbereich auflisten. Wenn Sie Mitgliedschaften über die App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die die Chat-App Zugriff hat. Mitgliedschaften in der Chat-App, einschließlich ihrer eigenen, werden jedoch ausgeschlossen. Wenn Sie Mitgliedschaften über die Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die der authentifizierte Nutzer Zugriff hat.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Ein Beispiel finden Sie unter Nachrichten auflisten. Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Listet Reaktionen auf eine Nachricht auf. Ein Beispiel finden Sie unter Reaktionen für eine Nachricht auflisten. Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Listet Ereignisse aus einem Google Chat-Bereich auf. Für jedes Ereignis enthält die Nutzlast die neueste Version der Chatressource. Wenn Sie beispielsweise Ereignisse zu neuen Mitgliedern des Gruppenbereichs auflisten, gibt der Server Membership-Ressourcen mit den neuesten Mitgliedschaftsdetails zurück. Wenn im angeforderten Zeitraum neue Mitglieder entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource.

Erfordert eine Nutzerauthentifizierung. Um Ereignisse aufzulisten, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie im Hilfeartikel Ereignisse aus einem Google Chat-Bereich auflisten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde. Ein Beispiel finden Sie unter Gruppenbereiche auflisten.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

Listet Gruppenbereiche auf, die für den Aufrufer oder authentifizierten Nutzer sichtbar sind. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde.

Wenn Sie alle benannten Gruppenbereiche nach Google Workspace-Organisation auflisten möchten, verwenden Sie stattdessen die Methode spaces.search() mit Workspace-Administratorberechtigungen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Gibt basierend auf der Suche eines Nutzers eine Liste von Gruppenbereichen zurück. Erfordert eine Nutzerauthentifizierung. Der Nutzer muss ein Administrator für die Google Workspace-Organisation sein. Legen Sie in der Anfrage use_admin_access auf true fest.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Erstellt einen Gruppenbereich und fügt ihm angegebene Nutzer hinzu. Der aufrufende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte in der Anfrage nicht als Mitgliedschaft angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich mit ersten Mitgliedern einrichten.

Um die hinzuzufügenden menschlichen Mitglieder anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden membership.member.name hinzu. Wenn Sie einen menschlichen Nutzer hinzufügen möchten, verwenden Sie users/{user}, wobei {user} die E-Mail-Adresse des Nutzers sein kann. Für Nutzer in derselben Workspace-Organisation kann {user} auch der id für die Person aus der People API oder der id für den Nutzer in der Directory API sein. Wenn die People API-Personenprofil-ID 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.

Um die hinzuzufügenden Google-Gruppen anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden membership.group_member.name hinzu. Verwenden Sie groups/{group}, um eine Google-Gruppe hinzuzufügen oder einzuladen, wobei {group} der id für die Gruppe aus der Cloud Identity Groups API ist. Sie können beispielsweise die Cloud Identity Groups Lookup API verwenden, um die ID 123456789 für die Gruppen-E-Mail-Adresse group@example.com abzurufen, und die Gruppe dann dem Gruppenbereich hinzufügen, indem Sie membership.group_member.name auf groups/123456789 setzen. Die E-Mail-Adresse einer Gruppe wird nicht unterstützt und Google-Gruppen können nur in benannten Gruppenbereichen als Mitglieder hinzugefügt werden.

Wenn der Anrufer in einem benannten Gruppenbereich oder Gruppenchat von einigen Mitgliedern blockiert oder blockiert wird oder nicht berechtigt ist, einige Mitglieder hinzuzufügen, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt.

Wenn Sie eine Direktnachricht (DN) zwischen dem aufrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft für den menschlichen Nutzer an. Wenn ein Nutzer den anderen blockiert, schlägt die Anfrage fehl und die DM wird nicht erstellt.

Wenn Sie eine DN zwischen dem aufrufenden Nutzer und der anrufenden App erstellen möchten, setzen Sie Space.singleUserBotDm auf true und geben Sie keine Mitgliedschaften an. Sie können diese Methode nur verwenden, um eine Direktnachricht mit der aufrufenden App einzurichten. Wie Sie die Anruf-App als Mitglied eines Gruppenbereichs oder als bestehende DN zwischen zwei menschlichen Nutzern hinzufügen, erfahren Sie im Hilfeartikel Nutzer oder Apps zu Gruppenbereichen einladen oder hinzufügen.

Wenn bereits eine DM zwischen zwei Nutzern existiert, wird die vorhandene DM zurückgegeben, selbst wenn ein Nutzer den anderen bei der Anfrage blockiert.

Gruppenbereiche mit Antworten mit Unterhaltungsthreads werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden Gruppenbereich in der Google Workspace-Organisation verwendet.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Aktualisiert eine Mitgliedschaft. Ein Beispiel finden Sie unter Mitgliedschaft eines Nutzers in einem Gruppenbereich aktualisieren.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Aktualisiert eine Nachricht. Es gibt einen Unterschied zwischen den Methoden patch und update. Die Methode patch verwendet eine patch-Anfrage, während die Methode update eine put-Anfrage verwendet. Wir empfehlen die Verwendung der Methode patch. Ein Beispiel finden Sie unter Nachrichten aktualisieren.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Bei Verwendung der App-Authentifizierung können Anfragen nur Nachrichten aktualisieren, die von der aufrufenden Chat-App erstellt wurden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Gruppenbereiche aktualisieren.

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

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aktualisiert den Lesestatus eines Nutzers in einem Gruppenbereich. Er wird verwendet, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Lesestatus eines Nutzers für Gruppenbereiche aktualisieren.

Erfordert eine Nutzerauthentifizierung.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

AccessoryWidget

Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Weitere Informationen finden Sie im Hilfeartikel Interaktive Widgets am Ende einer Nachricht hinzufügen.

Felder
Union-Feld action. Die Art der Aktion. Für action ist nur einer der folgenden Werte zulässig:
button_list

ButtonList

Eine Liste mit Schaltflächen.

ActionResponse

Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden.

Felder
type

ResponseType

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

string

Nur Eingabe. URL zum Authentifizieren oder Konfigurieren. (Nur für REQUEST_CONFIG-Antworttypen.)
dialog_action

DialogAction

Nur Eingabe. Eine Antwort auf ein Interaktionsereignis, das mit einem Dialogfeld zusammenhängt. Muss von ResponseType.Dialog begleitet werden.
updated_widget

UpdatedWidget

Nur Eingabe. Die Antwort des aktualisierten Widgets.

ResponseType

Der Typ der Chat-App-Antwort.

Enums
TYPE_UNSPECIFIED Standardtyp, der als NEW_MESSAGE behandelt wird.
NEW_MESSAGE Als neue Nachricht im Thema posten.
UPDATE_MESSAGE Aktualisieren Sie die Nachricht der Chat-App. Dies ist nur bei einem CARD_CLICKED-Ereignis zulässig, bei dem der Absendertyp der Nachricht BOT ist.
UPDATE_USER_MESSAGE_CARDS Karten in der Nachricht eines Nutzers aktualisieren. Dies ist nur als Antwort auf ein MESSAGE-Ereignis mit einer übereinstimmenden URL oder auf ein CARD_CLICKED-Ereignis mit dem Absendertyp HUMAN zulässig. Text wird ignoriert.
REQUEST_CONFIG Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration bitten
DIALOG Zeigt ein Dialogfeld an.
UPDATE_WIDGET Anfrage für Widget-Text-Vervollständigungsoptionen.

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung von Widgets.

Felder
items[]

SelectionItem

Ein Array der SelectionItem-Objekte.

UpdatedWidget

Die Antwort des aktualisierten Widgets. Wird verwendet, um Optionen zur automatischen Vervollständigung für ein Widget bereitzustellen.

Felder
widget

string

Die ID des aktualisierten Widgets. Die ID muss mit der ID des Widgets übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat.
Union-Feld updated_widget. Das Widget wurde als Reaktion auf eine Nutzeraktion aktualisiert. Für updated_widget ist nur einer der folgenden Werte zulässig:
suggestions

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung von Widgets

ActionStatus

Stellt den Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds dar.

Felder
status_code

Code

Der Statuscode.
user_facing_message

string

Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet wird. Wenn die Richtlinie nicht konfiguriert ist, wird eine generische Nachricht basierend auf dem status_code gesendet.

Annotation

Nur Ausgabe. Mit dem Nur-Text-Text der Nachricht verknüpfte Annotationen. Informationen zum grundlegenden Formatieren von SMS finden Sie unter Textnachrichten formatieren.

Beispiel für einen Nachrichtentext:

Hello @FooBot how are you!"

Die entsprechenden Metadaten der Annotationen:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Felder
type

AnnotationType

Der Typ dieser Anmerkung.
length

int32

Länge der Teilzeichenfolge im Nur-Text-Nachrichtentext, der diese Anmerkung entspricht.
start_index

int32

Startindex (0-basiert, einschließlich) im Nur-Text-Nachrichtentext, dem diese Annotation entspricht.
Union-Feld metadata. Zusätzliche Metadaten zur Anmerkung. Für metadata ist nur einer der folgenden Werte zulässig:
user_mention

UserMentionMetadata

Die Metadaten der Nutzererwähnung.
slash_command

SlashCommandMetadata

Die Metadaten für einen Slash-Befehl.

AnnotationType

Typ der Anmerkung.

Enums
ANNOTATION_TYPE_UNSPECIFIED Standardwert für die Aufzählung. Nicht verwenden.
USER_MENTION Ein Nutzer wird erwähnt.
SLASH_COMMAND Ein Slash-Befehl wird aufgerufen.

AttachedGif

Ein GIF-Bild, das durch eine URL angegeben wird.

Felder
uri

string

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

Anhang

Ein Anhang in Google Chat.

Felder
name

string

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

string

Nur Ausgabe. Der Name der ursprünglichen Datei für den Inhalt, nicht der vollständige Pfad.
content_type

string

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

string

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

string

Nur Ausgabe. Die Download-URL, mit der ein menschlicher Nutzer den Anhang herunterladen kann. Chat-Apps sollten diese URL nicht verwenden, um Inhalte von Anhängen herunterzuladen.
source

Source

Nur Ausgabe. Die Quelle des Anhangs.
Union-Feld data_ref. Der Datenverweis auf den Anhang. Für data_ref ist nur einer der folgenden Werte zulässig:
attachment_data_ref

AttachmentDataRef

Ein Verweis auf die Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen.
drive_data_ref

DriveDataRef

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

Quelle

Die Quelle des Anhangs.

Enums
SOURCE_UNSPECIFIED Reserviert.
DRIVE_FILE Die Datei ist eine Google Drive-Datei.
UPLOADED_CONTENT Die Datei wird in Google Chat hochgeladen.

AttachmentDataRef

Ein Verweis auf die Anhangsdaten.

Felder
resource_name

string

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

string

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

CardWithId

Eine Karte in einer Google Chat-Nachricht.

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

Entwerfen Sie Karten mit dem Card Builder und zeigen Sie Vorschauen an.

Card Builder öffnen

Felder
card_id

string

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

Card

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

ChatSpaceLinkData

Daten für Links zu Chatbereichen.

Felder
space

string

Der Bereich der verknüpften Chatbereich-Ressource.

Format: spaces/{space}
thread

string

Der Thread der verknüpften Chatbereich-Ressource.

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

string

Die Nachricht der verknüpften Chatbereich-Ressource.

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

CompleteImportSpaceRequest

Anfragenachricht zum Abschluss des Importvorgangs für einen Gruppenbereich.

Felder
name

string

Erforderlich. Ressourcenname des Bereichs im Importmodus.

Format: spaces/{space}

CompleteImportSpaceResponse

Antwortnachricht zum Abschließen des Importvorgangs für einen Gruppenbereich.

Felder
space

Space

Bereich für den Importmodus

ContextualAddOnMarkup

Dieser Typ hat keine Felder.

Das Markup für Entwickler zur Angabe der Inhalte eines kontextbezogenen Add-ons.

Infokarte

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

Felder
header

CardHeader

Der Header der Karte. Eine Kopfzeile enthält normalerweise einen Titel und ein Bild.
sections[]

Section

Die einzelnen 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. Eine typische Aktion für eine Rechnungskarte wäre: eine Rechnung löschen, eine E-Mail-Rechnung senden oder die Rechnung im Browser öffnen.

Wird von Google Chat-Apps nicht unterstützt.

Felder
action_label

string

Das Label, das früher im Aktionsmenü angezeigt wurde.
on_click

OnClick

Die „onclick“-Aktion für diese Aufgabe.

CardHeader

Felder
title

string

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

string

Der Untertitel der Kartenüberschrift.
image_style

ImageStyle

Der Bildtyp, z. B. quadratischer oder kreisförmiger Rahmen
image_url

string

Die URL des Bildes in der Kopfzeile der Karte.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Quadratische Rahmenlinie.
AVATAR Kreisförmiger Rahmen.

Abschnitt

Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der angegebenen Reihenfolge gerendert werden. Auf allen Plattformen haben Infokarten eine schmale feste Breite, sodass derzeit keine Layouteigenschaften (z. B. Float) erforderlich sind.

Felder
header

string

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

WidgetMarkup

Ein Abschnitt muss mindestens ein Widget enthalten.

CreateMembershipRequest

Anfragenachricht zum Erstellen einer Mitgliedschaft.

Felder
parent

string

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

Format: Leerzeichen/{Leerzeichen}
membership

Membership

Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung. Das Feld memberType muss einen Nutzer enthalten, dessen Felder user.name und user.type ausgefüllt sind. Der Server weist dann einen Ressourcennamen zu und überschreibt alle angegebenen Daten. Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen menschlichen Nutzer erstellt, muss sie den Bereich chat.memberships verwenden, user.type auf HUMAN und user.name auf das Format users/{user} setzen, wobei {user} die E-Mail-Adresse des Nutzers sein muss. Für Nutzer in derselben Workspace-Organisation kann {user} auch der id der Person aus der People API oder der id für den Nutzer in der Directory API sein. Wenn die People API-Personenprofil-ID für user@example.com beispielsweise 123456789 lautet, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name auf users/user@example.com oder users/123456789 festlegen. Wenn eine Chat-App eine Mitgliedschaftsbeziehung für sich selbst erstellt, muss sie den Bereich chat.memberships.app verwenden, user.type auf BOT und user.name auf users/app setzen.
use_admin_access

bool

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

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

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

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

CreateMessageRequest

Erstellt eine Nachricht.

Felder
parent

string

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

Format: spaces/{space}
message

Message

Erforderlich. Nachrichtentext.
thread_key
(deprecated)

string

Optional. Eingestellt: Verwende stattdessen thread.thread_key. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Erstellen Sie eine Nachricht und geben Sie einen threadKey- oder thread.name-Wert an, um eine Konversation zu starten oder hinzuzufügen. Anwendungsbeispiele finden Sie im Hilfeartikel Unterhaltungen starten oder beantworten.
request_id

string

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

MessageReplyOption

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

string

Optional. Eine benutzerdefinierte ID für eine Nachricht. Hiermit können Chat-Apps Nachrichten abrufen, aktualisieren oder löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht speichern zu müssen (wird im Feld name der Nachricht angezeigt).

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

  • Beginnt mit client-. client-custom-name ist beispielsweise eine gültige benutzerdefinierte ID, custom-name jedoch nicht.
  • Sie kann bis zu 63 Zeichen enthalten und darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.
  • Ist innerhalb eines Gruppenbereichs eindeutig. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für verschiedene Nachrichten verwenden.

Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen.

MessageReplyOption

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

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Standard. Eine neue Unterhaltung wird gestartet. Bei dieser Option werden alle enthaltenen thread ID oder thread_key ignoriert.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Erstellt die Nachricht als Antwort auf den in thread ID oder thread_key angegebenen Thread. Wenn der Vorgang fehlschlägt, wird stattdessen ein neuer Thread gestartet.
REPLY_MESSAGE_OR_FAIL Erstellt die Nachricht als Antwort auf den in thread ID oder thread_key angegebenen Thread. Wenn eine neue thread_key verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachricht nicht erstellt werden kann, wird stattdessen der Fehler NOT_FOUND 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

Reaction

Erforderlich. Die zu erstellende Reaktion.

CreateSpaceRequest

Eine Anfrage zum Erstellen eines benannten Gruppenbereichs.

Felder
space

Space

Erforderlich. Die Felder displayName und spaceType müssen ausgefüllt werden. Nur SpaceType.SPACE wird unterstützt.

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

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

string

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

CustomEmoji

Stellt ein benutzerdefiniertes Emoji dar.

Felder
uid

string

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

DeleteMembershipRequest

Anfrage zum Löschen einer Mitgliedschaft in einem Gruppenbereich.

Felder
name

string

Erforderlich. Ressourcenname der zu löschenden Mitgliedschaft. Chat-Apps können Nutzer von Nutzern löschen oder eine eigene Mitgliedschaft. Chat-Apps können keine anderen Apps löschen Kanalmitgliedschaft.

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

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

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

bool

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

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

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

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

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 im Hilfeartikel Nachrichten benennen.
force

bool

Wenn true, werden beim Löschen einer Nachricht auch die zugehörigen Antworten mit Unterhaltungsthreads gelöscht. Wenn eine Nachricht false mit Unterhaltungsthreads beantwortet, schlägt das Löschen fehl.

Gilt nur, wenn Sie sich als Nutzer authentifizieren. Hat keine Auswirkungen, wenn Sie sich als Chat-App authentifizieren.

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}

DeleteSpaceRequest

Anfrage zum Löschen eines Gruppenbereichs.

Felder
name

string

Erforderlich. Ressourcenname des zu löschenden Gruppenbereichs.

Format: spaces/{space}
use_admin_access

bool

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

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

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

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.

Enums
DELETION_TYPE_UNSPECIFIED Dieser Wert wird nicht verwendet.
CREATOR Ein Nutzer hat seine eigene Nachricht gelöscht.
SPACE_OWNER Der Eigentümer des Gruppenbereichs hat die Nachricht gelöscht.
ADMIN Ein Google Workspace-Administrator hat die Nachricht gelöscht.
APP_MESSAGE_EXPIRY Eine Chat-App hat ihre eigene Nachricht gelöscht, nachdem sie abgelaufen ist.
CREATOR_VIA_APP Eine Chat-App hat die Nachricht im Namen des Nutzers gelöscht.
SPACE_OWNER_VIA_APP Eine Chat-App hat die Nachricht im Namen des Inhabers des Gruppenbereichs gelöscht.

Dialog

Wrapper um den Kartentext des Dialogfelds.

Felder
body

Card

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

DialogAction

Enthält ein dialog-Fenster und einen Statuscode für die Anfrage.

Felder
action_status

ActionStatus

Nur Eingabe. Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds. Zeigt Nutzern bei Bedarf einen Status und eine Nachricht an. beispielsweise bei einem Fehler oder Erfolg.
Union-Feld action. Auszuführende Aktion Für action ist nur einer der folgenden Werte zulässig:
dialog

Dialog

Nur Eingabe. Dialog (Dialogfeld) für die Anfrage.

DriveDataRef

Ein Verweis auf die Daten eines Drive-Anhangs.

Felder
drive_file_id

string

Die ID der Drive-Datei. Wird mit der Drive API verwendet.

DriveLinkData

Daten für Google Drive-Links.

Felder
drive_data_ref

DriveDataRef

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

string

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

Emoji

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

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

string

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

CustomEmoji

Nur Ausgabe. Ein benutzerdefiniertes Emoji.

EmojiReactionSummary

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

Felder
emoji

Emoji

Mit den Reaktionen verknüpftes Emoji.
reaction_count

int32

Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

FindDirectMessageRequest

Eine Anfrage zum Abrufen des Gruppenbereichs für Direktnachrichten basierend auf der Nutzerressource.

Felder
name

string

Erforderlich. Ressourcenname des Nutzers, bei 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 Profil-ID der People API beispielsweise 123456789 lautet, können Sie eine Direktnachricht an diese Person finden, indem Sie users/123456789 als name verwenden. Wenn Sie als Nutzer authentifiziert sind, können Sie die E-Mail-Adresse als Alias für {user} verwenden. Beispiel: users/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.

GetAttachmentRequest

Anfrage zum Abrufen eines Anhangs

Felder
name

string

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

GetMembershipRequest

Beantragen Sie die Mitgliedschaft in einem Gruppenbereich.

Felder
name

string

Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft.

Um die eigene Mitgliedschaft der Anwendung über die Nutzerauthentifizierung zu erhalten, können Sie optional spaces/{space}/members/app verwenden.

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

Wenn Sie als Nutzer authentifiziert sind, können Sie 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

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

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

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

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

GetMessageRequest

Anfrage, um eine Nachricht zu erhalten.

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 im Hilfeartikel Nachrichten benennen.

GetSpaceEventRequest

Anfragenachricht zum Abrufen eines Raumereignisses.

Felder
name

string

Erforderlich. Der Ressourcenname des Gruppenbereichsereignisses.

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

GetSpaceReadStateRequest

Anfragenachricht für GetSpaceReadState API.

Felder
name

string

Erforderlich. Ressourcenname des abzurufenden Lesestatus des Gruppenbereichs.

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

Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:

  • 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

Eine Anfrage zum Zurückgeben eines einzelnen Leerzeichens.

Felder
name

string

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

Format: spaces/{space}
use_admin_access

bool

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

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

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

GetThreadReadStateRequest

Anfragenachricht für die GetThreadReadStateRequest API.

Felder
name

string

Erforderlich. Ressourcenname des abzurufenden Thread-Lesestatus.

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

Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:

  • 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 Verlaufsstatus für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach dem Erstellen gespeichert 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.

ListMembershipsRequest

Anfragenachricht zum Auflisten von Mitgliedschaften.

Felder
parent

string

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

Format: Leerzeichen/{Leerzeichen}
page_size

int32

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

Wenn keine Angabe gemacht wird, werden maximal 100 Mitgliedschaften zurückgegeben.

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

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
page_token

string

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

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Optional. Einen Abfragefilter.

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

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

Wenn Sie nach Typ filtern möchten, setzen Sie member.type auf HUMAN oder BOT. Entwicklervorschau: Mit dem Operator != kannst du auch nach member.type filtern.

Verwenden Sie den Operator AND, um sowohl nach Rolle als auch nach Typ zu filtern. Verwenden Sie den Operator OR, um nach Rolle oder Typ zu filtern.

member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn use_admin_access auf „true“ gesetzt ist. Andere Mitgliedstypfilter 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 Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
show_groups

bool

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

bool

Optional. Bei true werden neben anderen 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.

Erfordert derzeit eine Nutzerauthentifizierung.
use_admin_access

bool

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

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

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

Wenn Sie Administratorzugriff haben, wird das Auflisten von App-Mitgliedschaften in einem Gruppenbereich nicht unterstützt.

ListMembershipsResponse

Antwort auf die Auflistung der Mitgliedschaften des Gruppenbereichs.

Felder
memberships[]

Membership

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. Ist das Feld leer, gibt es keine nachfolgenden Seiten.

ListMessagesRequest

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

Felder
parent

string

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

Format: spaces/{space}
page_size

int32

Die maximale Anzahl zurückgegebener Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als dieser Wert zurück.

Wenn keine Angabe gemacht wird, werden höchstens 25 zurückgegeben.

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

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
page_token

string

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

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

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Einen Abfragefilter.

Du kannst 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 Format RFC-3339 und in doppelten Anführungszeichen an. Beispiel: "2023-04-21T11:30:00-04:00" Sie können den Operator > verwenden, um Nachrichten aufzulisten, die nach einem Zeitstempel erstellt wurden, oder den Operator <, um Nachrichten aufzulisten, die vor einem Zeitstempel erstellt wurden. Um Nachrichten innerhalb eines Zeitintervalls zu filtern, verwenden Sie den Operator AND zwischen zwei Zeitstempeln.

Geben Sie thread.name im Format spaces/{space}/threads/{thread} an, um nach Thread zu filtern. Sie können nur ein thread.name pro Abfrage angeben.

Verwenden Sie in Ihrer Abfrage den Operator AND, um sowohl nach Threads als auch nach Datum zu filtern.

Die folgenden Abfragen sind beispielsweise gültig:

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

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

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

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

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

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

Die Reihenfolge der Nachrichtenliste. Geben Sie einen Wert für die Sortierung über einen Sortiervorgang an. Gültige Werte für Sortiervorgänge sind:

  • ASC für aufsteigend.

  • DESC für absteigend.

Die Standardsortierung ist create_time ASC.
show_deleted

bool

Gibt an, ob gelöschte Nachrichten berücksichtigt werden sollen. Gelöschte Nachrichten enthalten den gelöschten Zeitraum und Metadaten zum Löschen, der Inhalt der Nachricht ist jedoch nicht verfügbar.

ListMessagesResponse

Antwortnachricht zum Auflisten von Nachrichten.

Felder
messages[]

Message

Liste der Nachrichten.
next_page_token

string

Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Ist das Feld leer, 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 zurückgegebener Reaktionen. Der Dienst kann weniger Reaktionen als dieser Wert zurückgeben. Wenn keine Vorgabe erfolgt, gilt der Standardwert 25. Der Maximalwert ist 200. werden die Werte über 200 in 200 geändert.
page_token

string

Optional. (Bei Fortsetzung einer vorherigen Abfrage.)

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

Beim Paginieren sollte 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. Einen Abfragefilter.

Sie können Reaktionen nach Emojis (entweder emoji.unicode oder emoji.custom_emoji.uid) und Nutzer (user.name) filtern.

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

Mit dem Operator AND wie emoji.unicode = "🙂" AND user.name = "users/AAAAAA" können Sie Reaktionen nach Emojis und Nutzern filtern.

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

Die folgenden Abfragen sind beispielsweise gültig:

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

Die folgenden Abfragen sind ungültig:

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

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

ListReactionsResponse

Antwort auf eine Anfrage zum Auflisten von Reaktionen.

Felder
reactions[]

Reaction

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

string

Fortsetzungs-Token zum Abrufen der nächsten Ergebnisseite. Auf der letzten Seite der Ergebnisse ist kein Eintrag vorhanden.

ListSpaceEventsRequest

Anfragenachricht zum Auflisten von Space-Ereignissen.

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 zurückgegebener Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
page_token

string

Seitentoken, das von einem vorherigen Aufruf einer Gruppenbereichsereignisliste erhalten wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen Parameter, die zum Auflisten von Space-Ereignissen zur Verfügung gestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Erforderlich. Einen Abfragefilter.

Sie müssen mindestens einen Ereignistyp (event_type) mit dem Operator : angeben. Verwenden Sie den Operator OR, um nach mehreren Ereignistypen zu filtern. Lassen Sie Batchereignistypen im Filter aus. Die Anfrage gibt automatisch alle zugehörigen Batchereignisse zurück. Wenn Sie beispielsweise nach neuen Reaktionen filtern (google.workspace.chat.reaction.v1.created), gibt der Server auch neue Ereignisse im Batch zurück (google.workspace.chat.reaction.v1.batchCreated). Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation zu SpaceEvents.

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

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

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

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 Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListSpaceEventsResponse

Antwortnachricht zum Auflisten von Space-Ereignissen.

Felder
space_events[]

SpaceEvent

Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst).
next_page_token

string

Fortsetzungs-Token zum Abrufen weiterer Ereignisse. 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 von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn keine Angabe gemacht wird, werden maximal 100 Leerzeichen zurückgegeben.

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

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
page_token

string

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

Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Das Übergeben eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter

string

Optional. Einen Abfragefilter.

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

Zum Filtern nach Gruppenbereichstyp müssen Sie einen gültigen ENUM-Wert wie SPACE oder GROUP_CHAT angeben (space_type kann nicht SPACE_TYPE_UNSPECIFIED sein). Verwenden Sie den Operator OR, um mehrere Gruppenbereichstypen abzufragen.

Die folgenden Abfragen sind beispielsweise gültig:

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

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

ListSpacesResponse

Die Antwort auf eine Anfrage zum Auflisten von Gruppenbereichen.

Felder
spaces[]

Space

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

string

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

MatchedUrl

Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können sich übereinstimmende URLs in der Vorschau ansehen. Weitere Informationen finden Sie unter Vorschaulinks.

Felder
url

string

Nur Ausgabe. Die übereinstimmende URL.

Mitgliedschaft

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

Felder
name

string

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, durch die die zulässigen Aktionen im Gruppenbereich bestimmt werden.

Dieses Feld kann nur als Eingabe in UpdateMembership verwendet werden.
create_time

Timestamp

Optional. Nicht veränderbar. Der Erstellungszeitpunkt der Mitgliedschaft, z. B. wann ein Mitglied einem Gruppenbereich beigetreten ist oder eingeladen wurde Dieses Feld wird nur ausgegeben, wenn es nicht zum Importieren von historischen Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird.
delete_time

Timestamp

Optional. Nicht veränderbar. Der Zeitpunkt des Löschens der Mitgliedschaft, z. B. wann ein Mitglied das Unternehmen verlassen hat oder aus einem Gruppenbereich entfernt wurde. Dieses Feld wird nur ausgegeben, wenn es nicht zum Importieren von historischen Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird.
Union-Feld memberType. Mit dieser Mitgliedschaft verknüpftes Mitglied. In Zukunft werden möglicherweise noch weitere Mitgliedstypen unterstützt. Für memberType ist nur einer der folgenden Werte zulässig:
member

User

Der Google Chat-Nutzer oder die Google Chat-App, zu der die Mitgliedschaft gehört. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Feldern Nutzer name und type ausgefüllt.
group_member

Group

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

MembershipRole

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

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Standardwert. users: Die Person ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für Google Groups: Dem Nutzer wird immer diese Rolle zugewiesen. In Zukunft werden möglicherweise noch andere enum-Werte verwendet.
ROLE_MEMBER Ein Mitglied des Gruppenbereichs. Der Nutzer hat grundlegende Berechtigungen, z. B. das Senden von Nachrichten in den Gruppenbereich. In Einzelunterhaltungen und unbenannten Gruppenunterhaltungen haben alle Nutzer diese Rolle.
ROLE_MANAGER Ein Administrator des Gruppenbereichs. Der Nutzer hat alle grundlegenden Berechtigungen sowie Administratorberechtigungen, mit denen er den Gruppenbereich verwalten kann, z. B. Mitglieder hinzufügen oder entfernen. Nur in SpaceType.SPACE unterstützt.

MembershipState

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

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

MembershipBatchCreatedEventData

Ereignisnutzlast für mehrere neue Mitgliedschaften.

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

Felder
memberships[]

MembershipCreatedEventData

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

Membership

Die neue Mitgliedschaft.

MembershipDeletedEventData

Ereignisnutzlast für eine gelöschte Mitgliedschaft.

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

Felder
membership

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

Membership

Die aktualisierte Mitgliedschaft.

Meldung

Eine Nachricht in einem Google Chat-Bereich.

Felder
name

string

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 im Hilfeartikel Nachrichten benennen.
sender

User

Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Feldern Nutzer name und type ausgefüllt.
create_time

Timestamp

Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld wird nur für die Ausgabe verwendet, es sei denn, es wird in Bereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.
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

Nur-Text der Nachricht. Über den ersten Link zu einem Bild, einem Video oder einer Webseite wird ein Vorschau-Chip generiert. Sie können auch einen Google Chat-Nutzer oder alle Personen im Gruppenbereich@erwähnen.

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

string

Nur Ausgabe. Enthält die Nachricht text mit Markups, die hinzugefügt wurden, um die Formatierung zu kommunizieren. Dieses Feld erfasst möglicherweise nicht alle Formatierungen, die in der Benutzeroberfläche sichtbar sind, enthält aber Folgendes:

  • Markup-Syntax für Fett- und Kursivformatierung, durchgestrichene Zeichen, Festbreiten- und Monospace-Blocks und Aufzählungslisten.

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

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

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

Weitere Informationen finden Sie im Hilfeartikel In Nachrichten gesendete Textformatierungen ansehen.
cards[]
(deprecated)

Card

Eingestellt: Verwende stattdessen cards_v2.

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

CardWithId

Ein Array mit Karten.

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

Weitere Informationen zu Karten und wie du sie erstellst, findest du unter Kartennachrichten senden.

Entwerfen Sie Karten mit dem Card Builder und zeigen Sie Vorschauen an.

Card Builder öffnen
annotations[]

Annotation

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

Thread

Der Thread, zu dem die Nachricht gehört. Anwendungsbeispiele finden Sie im Hilfeartikel Unterhaltungen starten oder beantworten.
space

Space

Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe im Bereich name dargestellt.
fallback_text

string

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

ActionResponse

Nur Eingabe. Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden.
argument_text

string

Nur Ausgabe. Nur-Text der Nachricht, wobei alle Erwähnungen in der Google Chat App entfernt wurden.
slash_command

SlashCommand

Nur Ausgabe. Informationen zu Slash-Befehlen, falls vorhanden.
attachment[]

Attachment

Vom Nutzer hochgeladener Anhang.
matched_url

MatchedUrl

Nur Ausgabe. Eine URL in spaces.messages.text, die mit einem Muster für die Linkvorschau übereinstimmt. Weitere Informationen finden Sie unter Vorschaulinks.
thread_reply

bool

Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwortthread. Wenn false, wird die Nachricht in der Unterhaltung der obersten Ebene des Gruppenbereichs entweder als erste Nachricht einer Unterhaltung oder als Nachricht ohne Unterhaltungsthreads angezeigt.

Wenn in einem Gruppenbereich keine Antworten in Threads unterstützt werden, lautet das Feld immer false.
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 eine Nachricht abzurufen, zu löschen oder zu aktualisieren. Geben Sie beim Erstellen der Nachricht das Feld messageId an, um eine benutzerdefinierte ID festzulegen. Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen.
emoji_reaction_summaries[]

EmojiReactionSummary

Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen in der Nachricht.
private_message_viewer

User

Nicht veränderbar. Eingabe zum Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht ansehen kann. Wenn dies festgelegt ist, ist die Nachricht privat und nur für den angegebenen Nutzer und die Chat-App sichtbar. Linkvorschauen und Anhänge werden für private Nachrichten nicht unterstützt.

Nur Chat-Apps können private Nachrichten senden. Wenn sich Ihre Chat-App zum Senden einer Nachricht als Nutzer authentifiziert, kann die Nachricht nicht privat sein und muss dieses Feld weggelassen werden.

Weitere Informationen finden Sie im Hilfeartikel Private Nachrichten an Google Chat-Nutzer 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

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

AttachedGif

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

AccessoryWidget

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

Zum Erstellen einer Mitteilung mit Zubehör-Widgets ist die App-Authentifizierung erforderlich.

MessageBatchCreatedEventData

Ereignisnutzlast für mehrere neue Nachrichten.

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

Felder
messages[]

MessageCreatedEventData

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

Message

Die neue Nachricht.

MessageDeletedEventData

Ereignisnutzlast für eine gelöschte Nachricht.

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

Felder
message

Message

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

MessageUpdatedEventData

Ereignisnutzlast für eine aktualisierte Nachricht.

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

Felder
message

Message

Die aktualisierte Nachricht.

QuotedMessageMetadata

Informationen zu einer zitierten Nachricht.

Felder
name

string

Nur Ausgabe. Ressourcenname der in Anführungszeichen gesetzten Nachricht.

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

Timestamp

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

Reaktion

Eine Reaktion auf eine Nachricht.

Felder
name

string

Der Ressourcenname der Reaktion.

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

User

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

Emoji

Das in der Reaktion verwendete Emoji.

ReactionBatchCreatedEventData

Ereignisnutzlast für mehrere neue Reaktionen.

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

Felder
reactions[]

ReactionCreatedEventData

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

Reaction

Die neue Reaktion.

ReactionDeletedEventData

Ereignisnutzlast für eine gelöschte Reaktion.

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

Felder
reaction

Reaction

Die gelöschte Reaktion.

RichLinkMetadata

Ein Rich-Link zu einer Ressource.

Felder
uri

string

Der URI dieses Links.
Union-Feld data. Daten für die verknüpfte Ressource. Für data ist nur einer der folgenden Werte zulässig:

RichLinkType

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

Enums
DRIVE_FILE Ein Rich-Link-Typ für Google Drive.
CHAT_SPACE Ein Rich-Link-Typ für Chatbereiche. Beispiel: ein Smartchip für den Weltraum.

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 anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung „Unterhaltungen in Chats und Gruppenbereichen verwalten“ sein.

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

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

int32

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

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

Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert.
page_token

string

Ein Token, das vom vorherigen Aufruf von Gruppenbereichen für die Suche empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
query

string

Erforderlich. Eine Suchanfrage.

Sie können mithilfe der folgenden Parameter suchen:

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

create_time und last_active_time akzeptieren einen Zeitstempel im RFC-3339-Format und die unterstützten Vergleichsoperatoren sind: =, <, >, <= und >=.

customer ist erforderlich und wird verwendet, um anzugeben, von welchem Kunden Gruppenbereiche abgerufen werden sollen. customers/my_customer ist der einzige unterstützte Wert.

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

external_user_allowed akzeptiert 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.

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

Bei demselben Feld unterstützt space_type die Operatoren AND und OR nicht. display_name, „space_history_state“ und „external_user_allowed“ unterstützen nur OR-Operatoren. last_active_time und create_time unterstützen die Operatoren AND und OR. AND kann nur für ein Intervall wie last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" verwendet werden.

Die folgenden Beispielabfragen sind gültig:

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

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

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

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

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

string

Optional. Die Reihenfolge der Liste der Gruppenbereiche.

Unterstützte Attribute für die Sortierung sind:

  • membership_count.joined_direct_human_user_count: Die Anzahl der menschlichen Nutzer, die einem Gruppenbereich direkt beigetreten sind.
  • last_active_time: Gibt an, wann das letzte zulässige Element zu einem Thema dieses Gruppenbereichs hinzugefügt wurde.
  • create_time: Gibt den Zeitpunkt der Erstellung des Gruppenbereichs an.

Gültige Werte für Sortiervorgänge sind:

  • ASC für aufsteigend. Standardwert.

  • DESC für absteigend.

Folgende Syntax wird unterstützt:

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

SearchSpacesResponse

Antwort mit einer Liste von Gruppenbereichen, die der Anfrage für Gruppenbereiche entsprechen.

Felder
spaces[]

Space

Eine Seite der angeforderten Gruppenbereiche.
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.
total_size

int32

Die Gesamtzahl der Leerzeichen, die auf allen Seiten mit der Abfrage übereinstimmen. Wenn das Ergebnis mehr als 10.000 Leerzeichen beträgt, ist dieser Wert eine Schätzung.

SetUpSpaceRequest

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

Felder
space

Space

Erforderlich. Space.spaceType ist ein Pflichtfeld.

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

Wenn du einen Gruppenchat erstellen möchtest, setze Space.spaceType auf GROUP_CHAT. Legen Sie Space.displayName nicht fest.

Wenn Sie eine 1:1-Unterhaltung zwischen Personen erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

Wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

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

string

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

Membership

Optional. Die Google Chat-Nutzer oder -Gruppen, die in den Gruppenbereich eingeladen werden sollen. Lassen Sie den aufrufenden Nutzer aus, da er automatisch hinzugefügt wird.

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

Für die menschliche Mitgliedschaft muss das Feld Membership.member eine user enthalten, bei der name ausgefüllt ist (Format: users/{user}) und type auf User.Type.HUMAN gesetzt ist. Sie können nur menschliche Nutzer hinzufügen, wenn Sie einen Gruppenbereich einrichten. Das Hinzufügen von Chat-Apps wird nur beim Einrichten 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 einem Wert für name enthalten (Format groups/{group}). Sie können nur dann Google-Gruppen 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 für einen menschlichen Nutzer auf DIRECT_MESSAGE gesetzt wird, zusammen mit genau einer Mitgliedschaft.

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

SlashCommand

Einen Slash-Befehl in Google Chat.

Felder
command_id

int64

Die ID des aufgerufenen Slash-Befehls.

SlashCommandMetadata

Annotationsmetadaten 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 ein Dialogfeld bestimmt ist.

Typ

Enums
TYPE_UNSPECIFIED Standardwert für die Aufzählung. Nicht verwenden.
ADD Chat-App zu Gruppenbereich hinzufügen.
INVOKE Rufen Sie den Slash-Befehl im Leerzeichen auf.

Leerzeichen

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

Felder
name

string

Ressourcenname des Gruppenbereichs.

Format: spaces/{space}
type
(deprecated)

Type

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

SpaceType

Die Art des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder den Typ eines Gruppenbereichs aktualisieren. Ausgabe nur für andere Zwecke.
single_user_bot_dm

bool

Optional. Gibt an, ob der Gruppenbereich eine DN zwischen einer Chat-App und einem einzelnen Nutzer ist.
threaded
(deprecated)

bool

Nur Ausgabe. Eingestellt: Verwende stattdessen spaceThreadingState. Gibt an, ob Nachrichten in diesem Gruppenbereich als Thread gespeichert sind.
display_name

string

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

Bei Direktnachrichten ist dieses Feld möglicherweise leer.

Unterstützt bis zu 128 Zeichen.
external_user_allowed

bool

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

  • Der authentifizierte Nutzer verwendet ein Privatnutzerkonto (nicht verwaltetes Nutzerkonto). Standardmäßig kann jeder Google Chat-Nutzer in einem Gruppenbereich, der von einem Privatnutzerkonto erstellt wurde, die Berechtigung erteilen.

Für vorhandene Gruppenbereiche wird dieses Feld nur für die Ausgabe verwendet.
space_threading_state

SpaceThreadingState

Nur Ausgabe. Der Threading-Status im Chatbereich.
space_details

SpaceDetails

Details zum Gruppenbereich, einschließlich einer Beschreibung und Regeln
space_history_state

HistoryState

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

bool

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

Timestamp

Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, ist dies der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld wird nur für die Ausgabe verwendet, es sei denn, es wird in Bereichen im Importmodus verwendet.

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

Wird nur in der Ausgabe dargestellt, wenn spaceType GROUP_CHAT oder SPACE ist.
last_active_time

Timestamp

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.

admin_installed

bool

Nur Ausgabe. Gibt bei Gruppenbereichen mit Direktnachrichten (DN) mit einer Chat-App an, ob der Gruppenbereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Direktnachricht mit einer Chat-App installieren und einrichten.

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

MembershipCount

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

access_settings

AccessSettings

Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn space_type den Wert SPACE hat.
space_uri

string

Nur Ausgabe. Der URI für einen Nutzer, um auf den Gruppenbereich zuzugreifen.
Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn space_type den Wert SPACE hat. Für space_permission_settings ist nur einer der folgenden Werte zulässig:
predefined_permission_settings

PredefinedPermissionSettings

Optional. Nur Eingabe. Berechtigungseinstellungen für den Gruppenbereich. Eingabe zum Erstellen eines Gruppenbereichs. Wenn dieses Feld nicht festgelegt ist, wird ein Gruppenbereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld PermissionSettings vorgenommen.

permission_settings

PermissionSettings

Optional. Genaue Berechtigungseinstellungen, die zum Aktualisieren des Gruppenbereichs festgelegt werden können. Eingabe zum Aktualisieren eines Gruppenbereichs. Andernfalls wird nur die Ausgabe ausgegeben. Verwenden Sie zum Erstellen des Gruppenbereichs stattdessen predefined_permission_settings.

AccessSettings

Die Zugriffseinstellung für den Gruppenbereich.

Felder
access_state

AccessState

Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an.
audience

string

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

Format: audiences/{audience}

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

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 einzeln zum Gruppenbereich hinzugefügt oder dazu eingeladen wurden, können den Gruppenbereich ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für bestimmte Nutzer sichtbar machen.

MembershipCount

Gibt die Anzahl der Mitgliedschaften in einem Gruppenbereich an, gruppiert in Kategorien.

Felder
joined_direct_human_user_count

int32

Anzahl der menschlichen Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nicht berücksichtigt werden Nutzer, die durch Mitgliedschaft in einer verbundenen Gruppe beigetreten sind.
joined_group_count

int32

Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

PermissionSetting

Stellt eine Berechtigungseinstellung für den Gruppenbereich dar.

Felder
managers_allowed

bool

Ob Administratoren des Gruppenbereichs diese Berechtigung haben
members_allowed

bool

Gibt an, ob Nutzer, die keine Administratoren sind, diese Berechtigung haben.

PermissionSettings

Berechtigungseinstellungen für einen benannten Gruppenbereich. 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

Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich.
modify_space_details

PermissionSetting

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

PermissionSetting

Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs.
use_at_mention_all

PermissionSetting

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

PermissionSetting

Einstellung zum Verwalten von Apps in einem Gruppenbereich.
manage_webhooks

PermissionSetting

Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.
post_messages

PermissionSetting

Nur Ausgabe. Einstellung zum Posten von Nachrichten in einem Gruppenbereich.
reply_messages

PermissionSetting

Einstellung zum Beantworten von Nachrichten in einem Gruppenbereich.

PredefinedPermissionSettings

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

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Nicht angegeben Nicht verwenden.
COLLABORATION_SPACE Einstellung, um den Gruppenbereich zu einem Gruppenbereich für die Zusammenarbeit zu machen, in dem alle Mitglieder Nachrichten posten können.
ANNOUNCEMENT_SPACE Einstellung, um einen Gruppenbereich für Ankündigungen zu erstellen, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können.

SpaceDetails

Details zum Gruppenbereich, einschließlich einer Beschreibung und Regeln

Felder
description

string

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

Unterstützt bis zu 150 Zeichen.
guidelines

string

Optional. Regeln, Erwartungen und Etikette im Raum.

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 Benannte Gruppenbereiche, die Nachrichtenthreads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie innerhalb des Threads antworten, sodass die Antwort im Kontext der ursprünglichen Nachricht bleibt.
GROUPED_MESSAGES Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen geordnet ist. Themen und die dazugehörigen Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten (DNs) zwischen zwei Personen und Gruppenunterhaltungen zwischen drei oder mehr Personen.

SpaceType

Die Art des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder aktualisieren. Ausgabe nur für andere Zwecke.

Enums
SPACE_TYPE_UNSPECIFIED Reserviert.
SPACE Ein Ort, an dem Nutzer Nachrichten senden, Dateien freigeben und mit anderen zusammenarbeiten. Ein SPACE kann Chat-Apps enthalten.
GROUP_CHAT Gruppenunterhaltungen mit drei oder mehr Personen. Ein GROUP_CHAT kann Chat-Apps enthalten.
DIRECT_MESSAGE 1:1-Nachrichten zwischen zwei Personen oder einer Person und einer Chat-App

Typ

Eingestellt: Verwende stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED Reserviert.
ROOM Unterhaltungen zwischen zwei oder mehr Menschen.
DM 1:1-Direktnachricht zwischen einem Nutzer und einer Chat-App, bei der alle Nachrichten in einer flachen Form dargestellt werden. Dies gilt nicht für Direktnachrichten zwischen zwei Personen.

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Updates eines Gruppenbereichs.

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 im Hilfeartikel Mit Terminen aus Google Chat arbeiten.

Felder
name

string

Ressourcenname des Gruppenbereichsereignisses.

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

Timestamp

Zeitpunkt des Ereignisses.
event_type

string

Art des Raumfahrtereignisses. Für jeden Ereignistyp gibt es eine Batch-Version, die mehrere Instanzen der Ereignisart darstellt, die innerhalb kurzer Zeit auftreten. Lassen Sie bei spaceEvents.list()-Anfragen die Batchereignistypen im Abfragefilter weg. Standardmäßig gibt der Server sowohl den Ereignistyp als auch seine Batchversion zurück.

Unterstützte Ereignistypen für messages:

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

Unterstützte Ereignistypen für Mitgliedschaften:

  • Neue Mitgliedschaft: google.workspace.chat.membership.v1.created
  • Mitgliedschaft aktualisiert: 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
  • Reaktion gelöscht: 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 zum Bereich:

  • Gruppenbereich aktualisiert: google.workspace.chat.space.v1.updated
  • Mehrere Aktualisierungen für Gruppenbereiche: 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 eine Gruppenbereichsaktualisierung.

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

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Updates eines Gruppenbereichs.

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

SpaceReadState

Der Lesestatus eines Nutzers in einem Gruppenbereich. Er dient dazu, gelesene und ungelesene Nachrichten zu identifizieren.

Felder
name

string

Ressourcenname des Lesestatus des Gruppenbereichs.

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

Timestamp

Optional. Der Zeitpunkt, zu dem der Lesestatus des Gruppenbereichs des Nutzers aktualisiert wurde. In der Regel entspricht dies entweder dem Zeitstempel der zuletzt gelesenen Nachricht oder einem Zeitstempel, der vom Nutzer angegeben wurde, um die zuletzt gelesene Position in einem Bereich zu markieren.

SpaceUpdatedEventData

Ereignisnutzlast für einen aktualisierten Bereich.

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

Felder
space

Space

Der aktualisierte Gruppenbereich.

Thread

Thread in einem Google Chat-Bereich. Anwendungsbeispiele finden Sie im Hilfeartikel Unterhaltungen starten oder beantworten.

Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie über das Feld messageReplyOption festlegen, was passiert, wenn keine passende Unterhaltung gefunden wird.

Felder
name

string

Ressourcenname des Threads.

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

string

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

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

ThreadReadState

Der Lesestatus eines Nutzers innerhalb eines Threads, mit dem gelesene und ungelesene Nachrichten identifiziert werden.

Felder
name

string

Ressourcenname des Thread-Lesestatus.

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

Timestamp

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

UpdateMembershipRequest

Anfragenachricht zum Aktualisieren einer Mitgliedschaft.

Felder
membership

Membership

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

FieldMask

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

Derzeit unterstützte Feldpfade:

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

Anfrage zum Aktualisieren einer Nachricht.

Felder
message

Message

Erforderlich. Nachricht mit aktualisierten Feldern.
update_mask

FieldMask

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

Derzeit unterstützte Feldpfade:
allow_missing

bool

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

UpdateSpaceReadStateRequest

Anfragenachricht für die UpdateSpaceReadState API.

Felder
space_read_state

SpaceReadState

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

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

Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:

  • 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

FieldMask

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

  • last_read_time

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

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

UpdateSpaceRequest

Eine Anfrage zum Aktualisieren eines einzelnen Gruppenbereichs.

Felder
space

Space

Erforderlich. Gruppenbereich 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

FieldMask

Erforderlich. Die aktualisierten Feldpfade, durch Kommas getrennt, wenn es mehrere gibt.

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

  • space_details

  • display_name: Unterstützt nur die Aktualisierung des Anzeigenamens für Leerzeichen, in denen das Feld spaceType den Wert SPACE hat. Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Wert. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden Gruppenbereich in der Google Workspace-Organisation verwendet.

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

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

  • access_settings.audience: Aktualisiert die Zugriffseinstellung, wer den Gruppenbereich entdecken, ihm beitreten und die Nachrichten im benannten Gruppenbereich als Vorschau ansehen kann. Das Feld spaceType hat den Wert SPACE. Wenn der vorhandene Gruppenbereich eine Zielgruppe hat, können Sie die Zielgruppe entfernen und den Zugriff auf den Gruppenbereich einschränken, indem Sie einen Wert für diese Feldmaske weglassen. Wenn Sie die Zugriffseinstellungen für einen Gruppenbereich aktualisieren möchten, muss der authentifizierende Nutzer ein Administrator des Gruppenbereichs sein und alle anderen Feldmasken in der Anfrage weglassen. Sie können dieses Feld nicht aktualisieren, wenn sich der Gruppenbereich im Importmodus befindet. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für bestimmte Nutzer sichtbar machen. access_settings.audience wird für Administratorzugriff nicht unterstützt.

  • Entwicklervorschau: Unterstützt das Ändern der Berechtigungseinstellungen eines Gruppenbereichs. Unterstützte Feldpfade: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (Warnung: Sie schließen sich gegenseitig aus und schließen alle anderen Feldpfade ohne Berechtigung aus). permission_settings wird für Administratorzugriff nicht unterstützt.
use_admin_access

bool

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

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

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

Einige FieldMask-Werte werden bei Verwendung des Administratorzugriffs nicht unterstützt. Weitere Informationen finden Sie in der Beschreibung von update_mask.

Nutzer

Ein Nutzer in Google Chat. Wenn Ihre Chat-App als Ausgabe einer Anfrage als Nutzer authentifiziert wird, füllt die Ausgabe für eine User-Ressource nur die Werte name und type des Nutzers aus.

Felder
name

string

Ressourcenname für eine Google Chat-user.

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

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

  • die id für die Person in der People API Beispiel: users/123456789 in der Chat API steht für dieselbe Person wie die 123456789 Personenprofil-ID in der People API.

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

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

string

Nur Ausgabe. Der Anzeigename des Nutzers.
domain_id

string

Eindeutige Kennung der Google Workspace-Domain des Nutzers.
type

Type

Nutzertyp.
is_anonymous

bool

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

Typ

Enums
TYPE_UNSPECIFIED Standardwert für die Aufzählung. NICHT VERWENDEN.
HUMAN Menschlicher Nutzer.
BOT Chat-App-Nutzer.

UserMentionMetadata

Annotationsmetadaten für Nutzererwähnungen (@).

Felder
user

User

Der Nutzer hat etwas erwähnt.
type

Type

Der Typ der Nutzererwähnung.

Typ

Enums
TYPE_UNSPECIFIED Standardwert für die Aufzählung. Nicht verwenden.
ADD Nutzer zu Gruppenbereich hinzufügen.
MENTION Nutzer im Gruppenbereich erwähnen.

WidgetMarkup

Ein Widget ist ein UI-Element, das Text und Bilder darstellt.

Felder
buttons[]

Button

Eine Liste mit Schaltflächen. Für die Schaltfläche ist ebenfalls oneof data festgelegt. Es sollte nur eines dieser Felder festgelegt werden.
Union-Feld data. Ein WidgetMarkup kann nur eines der folgenden Elemente enthalten. Sie können mehrere WidgetMarkup-Felder verwenden, um mehr Elemente anzuzeigen. Für data ist nur einer der folgenden Werte zulässig:
text_paragraph

TextParagraph

Textabschnitt in diesem Widget anzeigen.
image

Image

Bild in diesem Widget anzeigen.
key_value

KeyValue

Zeigt ein Schlüsselwertelement in diesem Widget an.

Schaltfläche

Eine Schaltfläche. Es kann sich um eine Text- oder eine Bildschaltfläche handeln.

Felder

Union-Feld type.

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

TextButton

Eine Schaltfläche mit Text und der Aktion onclick.
image_button

ImageButton

Eine Schaltfläche mit einem Bild und der Aktion „onclick“.

FormAction

Mit einer Formularaktion wird das Verhalten beim Senden des Formulars beschrieben. Sie können beispielsweise Apps Script aufrufen, um das Formular zu verarbeiten.

Felder
action_method_name

string

Der Methodenname wird verwendet, um zu identifizieren, welcher Teil des Formulars die Übermittlung des Formulars ausgelöst hat. Diese Informationen werden beim Klick auf eine Karte an die Chat App zurückgegeben. Sie können denselben Methodennamen für mehrere Elemente verwenden, die ein gemeinsames Verhalten auslösen.
parameters[]

ActionParameter

Liste der Aktionsparameter.

ActionParameter

Liste der Stringparameter, die beim Aufrufen der Aktionsmethode angegeben werden sollen. Betrachten Sie zum Beispiel drei Schaltflächen für die Schlummerfunktion: "Jetzt pausieren", "Schlummern an einem Tag" und "Schlummern für nächste Woche". Sie können action method = snooze() verwenden und den Typ und die Zeit für die Schlummerfunktion in der Liste der Stringparameter übergeben.

Felder
key

string

Der Name des Parameters für das Aktionsskript.
value

string

Wert des Parameters.

Symbol

Die Gruppe der unterstützten Symbole.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Bild

Ein Bild, das durch eine URL angegeben wird und die Aktion onclick haben kann.

Felder
image_url

string

Die URL des Bildes.
on_click

OnClick

Die Aktion onclick.
aspect_ratio

double

Das Seitenverhältnis dieses Bildes (Breite und Höhe). In diesem Feld können Sie die richtige Höhe für das Bild reservieren, während Sie auf das Laden warten. Das integrierte Seitenverhältnis des Bildes wird dadurch nicht überschrieben. Wenn die Richtlinie nicht konfiguriert ist, wird das Bild vom Server per Vorabruf gefüllt.

ImageButton

Eine Bildschaltfläche mit der Aktion onclick.

Felder
on_click

OnClick

Die Aktion onclick.
name

string

Der Name dieses image_button, der für Bedienungshilfen verwendet wird. Wenn kein Name angegeben ist, wird ein Standardwert angegeben.
Union-Feld icons. Das Symbol kann durch ein Icon enum oder eine URL angegeben werden. Für icons ist nur einer der folgenden Werte zulässig:
icon

Icon

Das von einem enum angegebene Symbol, das einem von der Chat API bereitgestellten Symbol entspricht.
icon_url

string

Das durch eine URL angegebene Symbol.

KeyValue

Ein UI-Element enthält einen Schlüssel (Label) und einen Wert (Inhalt). Dieses Element kann auch Aktionen wie die Schaltfläche „onclick“ enthalten.

Felder
top_label

string

Der Text des oberen Labels. 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.
content

string

Der Text des Inhalts. Formatierter Text wird unterstützt und ist immer erforderlich. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.
content_multiline

bool

Ob der Inhalt mehrzeilig sein soll
bottom_label

string

Der Text des unteren Labels. 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.
on_click

OnClick

Die Aktion onclick. Nur das obere Label, das untere Label und der Inhaltsbereich sind anklickbar.
Union-Feld icons. Mindestens eines der Symbole, top_label und bottom_label, muss definiert werden. Für icons ist nur einer der folgenden Werte zulässig:
icon

Icon

Ein Enum-Wert, der von der Chat API durch das entsprechende Symbolbild ersetzt wird.
icon_url

string

Das durch eine URL angegebene Symbol.
Union-Feld control. Ein Kontroll-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. Für control ist nur einer der folgenden Werte zulässig:
button

Button

Eine Schaltfläche, auf die zum Auslösen einer Aktion geklickt werden kann.

OnClick

Eine onclick-Aktion (z. B. Öffnen eines Links)

Felder

Union-Feld data.

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

FormAction

Sofern angegeben, wird durch diese onclick-Aktion eine Formularaktion ausgelöst.

TextButton

Eine Schaltfläche mit Text und der Aktion onclick.

Felder
text

string

Text der Schaltfläche
on_click

OnClick

Die Aktion „onclick“ der Schaltfläche.

TextParagraph

Ein Textabschnitt. 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.

Felder
text

string