Package google.chat.v1

Indeks

ChatService

Umożliwia deweloperom tworzenie aplikacji i integracji na platformie Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Wykonuje proces importowania do określonego pokoju i sprawia, że jest on widoczny dla użytkowników.

Wymaga uwierzytelniania aplikacji i przekazywania dostępu w całej domenie. Więcej informacji znajdziesz w artykule Autoryzowanie aplikacji Google Chat do importowania danych.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Tworzy niestandardowy emotikon.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tworzy członkostwo dla aplikacji do połączeń w Google Chat, użytkownika lub grupy Google. Tworzenie wspierania w innych aplikacjach do obsługi czatu nie jest obsługiwane. Jeśli podczas tworzenia członkostwa dany użytkownik ma wyłączoną zasadę automatycznego akceptowania, zostanie zaproszony i będzie musiał zaakceptować zaproszenie do pokoju, zanim dołączy. W przeciwnym razie utworzenie subskrypcji spowoduje dodanie użytkownika bezpośrednio do określonego pokoju.

Obsługuje te typy uwierzytelniania:

Przykładowe zastosowania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Tworzy wiadomość w pokoju Google Chat. Przykład znajdziesz w artykule Wysyłanie wiadomości.

Metoda create() wymaga uwierzytelniania użytkownika lub uwierzytelniania aplikacji. Google Chat przypisuje nadawcę wiadomości w różny sposób w zależności od typu uwierzytelniania użytego w prośbie.

Poniższy obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelnienia aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawcę wiadomości. Treść wiadomości może zawierać tekst (text), karty (cardsV2) i widżety dodatkowe (accessoryWidgets).

Wiadomość wysłana z uwierzytelnianiem aplikacji

Na ilustracji poniżej widać, jak Google Chat przypisuje wiadomość, gdy korzystasz z uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje do niej aplikację Google Chat, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst (text).

Wiadomość wysłana z uwierzytelnianiem użytkownika

Maksymalny rozmiar wiadomości, w tym jej zawartości, wynosi 32 tys. bajtów.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tworzy reakcję i dodaje ją do wiadomości. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład: Dodawanie reakcji do wiadomości.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

tworzy pokój bez użytkowników; Można go użyć do utworzenia pokoju o nazwie lub czatu grupowego w Import mode. Pokoje uporządkowane według tematów nie są obsługiwane. Przykład znajdziesz w artykule Tworzenie pokoju.

Jeśli podczas tworzenia pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

Obsługuje te typy uwierzytelniania:

Podczas uwierzytelniania aplikacji w żądaniu musi być ustawione pole space.customer.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Usuwa niestandardowy emotikon.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Usuwa subskrypcję. Przykład znajdziesz w artykule Usuwanie użytkownika lub aplikacji Google Chat z pokoju.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Usuwa wiadomość. Przykład znajdziesz w sekcji Usuwanie wiadomości.

Obsługuje te typy uwierzytelniania:

Gdy używasz uwierzytelniania aplikacji, żądania mogą usuwać tylko wiadomości utworzone przez aplikację Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Usuwa reakcję na wiadomość. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład znajdziesz w artykule Usuwanie reakcji.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Usuwa nazwany pokój. Zawsze wykonuje kasowanie kaskadowe, co oznacza, że zasoby podrzędne pokoju, takie jak wiadomości opublikowane w pokoju i członkostwa w pokoju, są również usuwane. Przykład znajdziesz w artykule Usuwanie pokoju.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Zwraca istniejące bezpośrednie wiadomości z określonym użytkownikiem. Jeśli nie znaleziono obszaru czatu, zwraca błąd 404 NOT_FOUND. Przykład: Znajdowanie czatu.

W przypadku uwierzytelniania aplikacji zwraca się pokój czatu między określonym użytkownikiem a wywołującą aplikacją Google Chat.

W przypadku uwierzytelniania użytkownika zwraca przestrzeń wiadomości bezpośrednich między określonym użytkownikiem a uwierzytelnionym użytkownikiem.

// Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Pobiera metadane załącznika wiadomości. Dane załącznika są pobierane za pomocą interfejsu media API. Przykład znajdziesz w artykule Pobieranie metadanych załącznika wiadomości. Wymaga uwierzytelniania aplikacji.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Zwraca informacje o niestandardowych emotikonach.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Zwraca szczegóły dotyczące subskrypcji. Przykładem jest uzyskiwanie informacji o subskrypcji użytkownika lub aplikacji Google Chat.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Zwraca szczegóły wiadomości. Przykład: Uzyskiwanie informacji o wiadomości.

Obsługuje te typy uwierzytelniania:

Uwaga: może zwrócić wiadomość od zablokowanego użytkownika lub z zablokowanego pokoju.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Zwraca informacje o pokoju. Przykładem jest pobieranie informacji o pokoju.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • 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
  • https://www.googleapis.com/auth/chat.app.spaces

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Zwraca wydarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zasobu, który uległ zmianie. Jeśli na przykład poprosisz o zdarzenie dotyczące nowej wiadomości, która została później zaktualizowana, serwer zwróci zaktualizowany zasób Message w pliku danych zdarzenia.

Uwaga: w przypadku tego żądania pole permissionSettings nie jest zwracane w obiekcie Space w danych zdarzenia Space.

Wymaga uwierzytelniania użytkownika. Aby można było uzyskać zdarzenie, uwierzytelniony użytkownik musi być użytkownikiem pokoju.

Przykładem jest uzyskiwanie szczegółowych informacji o wydarzeniu z pokoju Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Pobiera ustawienia stanu powiadomień dla pokoju.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Zwraca informacje o stanie odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład: Uzyskiwanie informacji o stanie odczytu pokoju przez użytkownika.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Zwraca szczegóły dotyczące stanu odczytu przez użytkownika w wątku, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Instrukcje znajdziesz w sekcji Uzyskiwanie szczegółowych informacji o stanie odczytu wątku użytkownika.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Wyświetla niestandardowe emotikony widoczne dla uwierzytelnionego użytkownika.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Wyświetla listę użytkowników pokoju. Przykład: Lista użytkowników i aplikacji Google Chat w pokoju. Wyświetlanie członkostwa z autoryzacją aplikacji wyświetla członkostwo w pokojach, do których ma dostęp aplikacja Google Chat, ale wyklucza członkostwo w Google Chat, w tym własne. Wyświetlanie członkostwa z uwierzytelnieniem użytkownika wyświetla członkostwo w przestrzeniach, do których uwierzytelniony użytkownik ma dostęp.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Wyświetla listę wiadomości w pokoju, do którego należy dzwoniący, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Jeśli wyświetlasz listę wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. Jeśli używasz interfejsu REST/HTTP, odpowiedź zawiera pusty obiekt JSON, {}. Przykładem jest artykuł Lista wiadomości.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Lista reakcji na wiadomość. Przykład znajdziesz w artykule Wyświetlanie reakcji na wiadomość.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Lista zdarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. Jeśli na przykład wyświetlisz listę zdarzeń dotyczących nowych osób w pokoju, serwer zwróci zasoby Membership, które zawierają najnowsze szczegóły członkostwa. Jeśli w okresie objętym żądaniem usunięto nowych członków, ładunek wydarzenia zawiera pusty zasób Membership.

Wymaga uwierzytelniania użytkownika. Aby wyświetlić listę wydarzeń, uwierzytelniony użytkownik musi być członkiem pokoju.

Przykład znajdziesz w artykule Wyświetlanie listy zdarzeń z pokoju Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Lista pokoi, których użytkownik jest członkiem. Czaty grupowe i czaty bezpośrednie nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w sekcji Tworzenie listy pokoi.

Obsługuje te typy uwierzytelniania:

Aby wyświetlić listę wszystkich nazwanych pokoi w organizacji Google Workspace, użyj metody spaces.search(), korzystając z uprawnień administratora Workspace.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Zwraca listę pokoi w organizacji Google Workspace na podstawie wyszukiwania administratora.

Wymaga uwierzytelniania użytkowników z uprawnieniami administratora. W prośbie ustaw wartość use_admin_access na true.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik nawiązujący połączenie jest automatycznie dodawany do pokoju i nie powinien być określony jako członek w prośbie. Przykład znajdziesz w artykule Konfigurowanie pokoju z początkowymi członkami.

Aby określić osoby, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu membership.member.name. Aby dodać użytkownika, użyj wartości users/{user}, gdzie {user} może być adresem e-mail użytkownika. W przypadku użytkowników w tej samej organizacji Workspace {user} może też być id dla osoby z interfejsu People API lub id dla użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu użytkownika w interfejsie People API to 123456789, możesz dodać użytkownika do pokoju, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.

Aby określić grupy dyskusyjne Google, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu membership.group_member.name. Aby dodać lub zaprosić grupę dyskusyjną Google, użyj polecenia groups/{group}, gdzie {group} to id grupy z interfejsu Cloud Identity Groups API. Możesz na przykład użyć interfejsu Cloud Identity Groups lookup API, aby pobrać identyfikator 123456789 dla adresu e-mail grupy group@example.com. Następnie możesz dodać grupę do pokoju, ustawiając membership.group_member.name na groups/123456789. Adres e-mail grupy nie jest obsługiwany. Grupy dyskusyjne Google można dodawać tylko jako członków w pokojach nazwanych.

W przypadku nazwanego pokoju lub czatu grupowego: jeśli rozmówca zablokuje połączenie, jest zablokowany przez niektórych użytkowników lub nie ma uprawnień do dodawania niektórych osób, wtedy tacy użytkownicy nie zostaną dodani do utworzonego pokoju.

Aby utworzyć wiadomość bezpośrednią (DM) między użytkownikiem wywołującym a innym użytkownikiem, określ dokładnie 1 członkostwo reprezentujące użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie nie zostanie wysłane, a wiadomość prywatna nie zostanie utworzona.

Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw opcję Space.singleUserBotDm na true i nie określaj żadnych członkostwa. Tej metody możesz użyć tylko do skonfigurowania czatu w aplikacji do połączeń. Aby dodać aplikację do rozmów jako członka pokoju lub istniejącego czatu między 2 użytkownikami, przeczytaj artykuł Zapraszanie i dodawanie użytkownika lub aplikacji do pokoju.

Jeśli między dwoma użytkownikami istnieje już czat, nawet jeśli jeden z nich zablokuje drugiego w momencie wysłania żądania, zwrócony zostanie istniejący czat.

Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Aktualizuje subskrypcję. Przykład: Aktualizowanie członkostwa użytkownika w pokoju.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

aktualizuje wiadomość. Metody patch i update różnią się od siebie. Metoda patch używa żądania patch, a metoda update – put. Zalecamy użycie metody patch. Przykład: Aktualizowanie wiadomości

Obsługuje te typy uwierzytelniania:

Gdy używasz uwierzytelniania aplikacji, żądania mogą aktualizować tylko wiadomości utworzone przez wywołującą aplikację Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Aktualizuje pokój. Przykład znajdziesz w artykule Aktualizowanie pokoju.

Jeśli aktualizujesz pole displayName i widzisz komunikat o błędzie ALREADY_EXISTS, podaj inną wyświetlaną nazwę. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Zaktualizuje ustawienia stanu powiadomień o pokoju.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aktualizuje stan odczytu użytkownika w pokoju, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykładem jest aktualizowanie stanu odczytu pokoju przez użytkownika.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

AccessoryWidget

Co najmniej jeden interaktywny widżet wyświetlany u dołu wiadomości. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.

Pola
Pole unii action. Typ działania. action może być tylko jednym z tych elementów:
button_list

ButtonList

Lista przycisków.

ActionResponse

Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.

Pola
type

ResponseType

Tylko dane wejściowe. Typ odpowiedzi aplikacji Google Chat.
url

string

Tylko dane wejściowe. Adres URL, który użytkownicy mogą uwierzytelniać lub konfigurować. (Tylko w przypadku REQUEST_CONFIG typów odpowiedzi).
dialog_action

DialogAction

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z dialogiem. Musi być dołączony ResponseType.Dialog.
updated_widget

UpdatedWidget

Tylko dane wejściowe. Odpowiedź zaktualizowanego widżetu.

ResponseType

Typ odpowiedzi aplikacji Google Chat.

Wartości w polu enum
TYPE_UNSPECIFIED Domyślny typ obsługiwany jako NEW_MESSAGE.
NEW_MESSAGE Opublikuj jako nową wiadomość w temacie.
UPDATE_MESSAGE Zaktualizuj wiadomość w aplikacji Google Chat. Jest to dozwolone tylko w przypadku zdarzenia CARD_CLICKED, w którym typ nadawcy wiadomości to BOT.
UPDATE_USER_MESSAGE_CARDS Zaktualizuj karty w wiadomości użytkownika. Jest to dozwolone tylko w odpowiedzi na zdarzenie MESSAGE z dopasowanym adresem URL lub zdarzenie CARD_CLICKED, w którym typem nadawcy wiadomości jest HUMAN. Tekst jest ignorowany.
REQUEST_CONFIG Prywatnie poproś użytkownika o dodatkowe uwierzytelnienie lub konfigurację.
DIALOG Wyświetla okno.
UPDATE_WIDGET Zapytanie o opcje autouzupełniania tekstu widżetu.

SelectionItems

Lista wyników autouzupełniania widżetu.

Pola
items[]

SelectionItem

Tablica obiektów SelectionItem.

UpdatedWidget

Odpowiedź zaktualizowanego widżetu. Służy do udostępniania opcji autouzupełniania w widżetach.

Pola
widget

string

Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał żądanie aktualizacji.
Pole unii updated_widget. Widżet jest aktualizowany w odpowiedzi na działanie użytkownika. updated_widget może być tylko jednym z tych elementów:
suggestions

SelectionItems

Lista wyników autouzupełniania w widżetach

ActionStatus

Reprezentuje stan prośby o wywołanie lub przesłanie okna.

Pola
status_code

Code

Kod stanu.
user_facing_message

string

Treść wiadomości, która ma być wysłana do użytkowników w związku ze stanem ich prośby. Jeśli nie jest ustawiony, wysyłana jest ogólna wiadomość na podstawie status_code.

Adnotacja

Tylko dane wyjściowe. adnotacje powiązane z treścią wiadomości w postaci zwykłego tekstu; Aby dowiedzieć się, jak dodać podstawowe formatowanie do SMS-a, przeczytaj artykuł Formatowanie SMS-ów.

Przykład treści wiadomości w postaci zwykłego tekstu:

Hello @FooBot how are you!"

Odpowiednie metadane adnotacji:

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

AnnotationType

Typ adnotacji.
length

int32

Długość podłańcucha w treści wiadomości zwykłego tekstu, której odpowiada ta adnotacja.
start_index

int32

Indeks początkowy (od 0 włącznie) w zwykłym tekście treści wiadomości, do której odnosi się ta adnotacja.
Pole sumy metadata. dodatkowe metadane dotyczące adnotacji; metadata może być tylko jednym z tych elementów:
user_mention

UserMentionMetadata

Metadane wzmianki o użytkowniku.
slash_command

SlashCommandMetadata

Metadane polecenia po ukośniku.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
USER_MENTION Wzmianka o użytkowniku.
SLASH_COMMAND Wywołano polecenie po ukośniku.

AttachedGif

Obraz GIF określony za pomocą adresu URL.

Pola
uri

string

Tylko dane wyjściowe. Adres URL hostujący obraz GIF.

Załącznik

załącznik w Google Chat.

Pola
name

string

Opcjonalnie: Nazwa zasobu załącznika, w formacie spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Tylko dane wyjściowe. Oryginalna nazwa pliku treści, a nie pełna ścieżka.
content_type

string

Tylko dane wyjściowe. Typ treści (typ MIME) pliku.
thumbnail_uri

string

Tylko dane wyjściowe. Adres URL miniatury, który powinien być używany do wyświetlania podglądu załącznika dla użytkownika. Aplikacje do czatu nie powinny używać tego adresu URL do pobierania treści załączników.
download_uri

string

Tylko dane wyjściowe. Adres URL do pobrania, który powinien być używany, aby umożliwić użytkownikowi pobranie załącznika. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania zawartości załączników.
source

Source

Tylko dane wyjściowe. Źródło załącznika.
Pole unii data_ref. Odwołania do załącznika. data_ref może być tylko jednym z tych elementów:
attachment_data_ref

AttachmentDataRef

Opcjonalnie: Odwołanie do danych załącznika. To pole służy do tworzenia i aktualizowania wiadomości z załącznikami lub do pobierania danych załączników za pomocą interfejsu Media API.
drive_data_ref

DriveDataRef

Tylko dane wyjściowe. Odniesienie do załącznika z Dysku Google. To pole jest używane w interfejsie Dysk Google API.

Źródło

Źródło załącznika.

Wartości w polu enum
SOURCE_UNSPECIFIED Zarezerwowane.
DRIVE_FILE Plik jest plikiem na Dysku Google.
UPLOADED_CONTENT Plik jest przesyłany do Google Chat.

AttachmentDataRef

Odwołanie do danych załącznika.

Pola
resource_name

string

Opcjonalnie: Nazwa zasobu danych załączników. To pole jest używane z interfejsem Media API do pobierania danych załączników.
attachment_upload_token

string

Opcjonalnie: Nieprzejrzysty token zawierający odwołanie do przesłanego załącznika. Jest traktowany przez klientów jako nieprzejrzysty ciąg znaków i używany do tworzenia lub aktualizowania wiadomości Google Chat z załącznikami.

CardWithId

Karta w wiadomości Google Chat.

Tylko aplikacje Google Chat mogą tworzyć karty. Jeśli aplikacja Google Chat uwierzytelnia użytkownika, wiadomość nie może zawierać kart.

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Otwórz kreator kart

Pola
card_id

string

Wymagane, jeśli wiadomość zawiera wiele kart. Unikalny identyfikator karty w wiadomości.
card

Card

Kartę Maksymalny rozmiar to 32 KB.

ChatSpaceLinkData

dane dotyczące linków do pokoi czatu;

Pola
space

string

Pokój powiązanego zasobu pokoju czatu.

Format: spaces/{space}
thread

string

Wątek zasobu połączonego pokoju czatu.

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

string

Wiadomość z powiązanego zasobu pokoju czatu.

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

CompleteImportSpaceRequest

Prośba o dokończenie procesu importowania pokoju

Pola
name

string

Wymagane. Nazwa zasobu pokoju w trybie importowania.

Format: spaces/{space}

CompleteImportSpaceResponse

Odpowiedź na wiadomość dotyczącą zakończenia procesu importowania pokoju.

Pola
space

Space

Pokój w trybie importowania.

ContextualAddOnMarkup

Ten typ nie ma pól.

znaczniki dla deweloperów, które umożliwiają określenie zawartości kontekstowego dodatku;

Karta

Karta to element interfejsu, który może zawierać widżety interfejsu, takie jak tekst i obrazy.

Pola
header

CardHeader

Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz.
sections[]

Section

Sekcje są rozdzielane linią.
card_actions[]

CardAction

Czynności związane z tą kartą.
name

string

Nazwa karty.

CardAction

Działanie na karcie to działanie powiązane z kartą. W przypadku karty faktury typowe działania to: usuwanie faktury, wysyłanie faktury e-mailem lub otwieranie faktury w przeglądarce.

Nieobsługiwane przez aplikacje Google Chat.

Pola
action_label

string

Etykieta wyświetlana w menu czynności.
on_click

OnClick

Działanie onclick dla tego elementu działania.

CardHeader

Pola
title

string

Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli podasz tytuł i podtytuł, każdy z nich zajmie jeden wiersz. Jeśli podany jest tylko tytuł, zajmuje on obie linie.
subtitle

string

Podtytuł nagłówka karty.
image_style

ImageStyle

Typ obrazu (np. kwadratowe lub okrągłe obramowanie).
image_url

string

Adres URL obrazu w nagłówku karty.

ImageStyle

Wartości w polu enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Kwadratowe obramowanie.
AVATAR Okrągłe obramowanie.

Sekcja

Sekcja zawiera zbiór widżetów, które są renderowane (w pionie) w określonej kolejności. Na wszystkich platformach karty mają wąską stałą szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).

Pola
header

string

Nagłówek sekcji. Obsługiwany jest tekst sformatowany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
widgets[]

WidgetMarkup

Sekcja musi zawierać co najmniej 1 widżet.

CreateCustomEmojiRequest

prośba o utworzenie niestandardowego emotikonu;

Pola
custom_emoji

CustomEmoji

Wymagane. Niestandardowy emotikon do utworzenia.

CreateMembershipRequest

wiadomość z prośbą o utworzenie subskrypcji.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, dla którego chcesz utworzyć członkostwo.

Format: spaces/{space}
membership

Membership

Wymagane. Relacja członkostwa do utworzenia.

Pole memberType musi zawierać użytkownika z wypełnionymi polami user.name i user.type. Serwer przypisze nazwę zasobu i zastąpi wszystkie inne podane nazwy.

Gdy aplikacja do czatu tworzy relację członkostwa dla użytkownika, musi użyć określonych zakresów autoryzacji i ustawić określone wartości w pewnych polach:

  • Podczas uwierzytelniania się jako użytkownik wymagany jest zakres autoryzacji chat.memberships.

  • W przypadku uwierzytelniania jako aplikacji wymagany jest zakres autoryzacji chat.app.memberships. Uwierzytelnianie jako aplikacja jest dostępne w:

  • Ustaw user.type na HUMAN i ustaw user.name z formatem users/{user}, gdzie {user} może być adresem e-mail użytkownika. W przypadku użytkowników w tej samej organizacji Workspace {user} może być też id osoby z interfejsu People API lub id użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu użytkownika w interfejsie People API to 123456789, możesz dodać użytkownika do pokoju, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.

Gdy aplikacja do czatu tworzy dla siebie relację członkostwa, musi uwierzytelnić się jako użytkownik i użyć zakresu chat.memberships.app, ustawić user.type na BOT i ustawić user.name na users/app.
use_admin_access

bool

Jeśli zasada jest true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Przy użyciu dostępu administracyjnego nie można tworzyć subskrypcji w aplikacjach ani tworzyć subskrypcji dla użytkowników spoza organizacji Google Workspace administratora.

CreateMessageRequest

Tworzy wiadomość.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, w którym chcesz utworzyć wiadomość.

Format: spaces/{space}
message

Message

Wymagane. Treść wiadomości.
thread_key
(deprecated)

string

Opcjonalnie: Wycofane: użyj w zastępstwie zasady thread.thread_key. Identyfikator wątku. Maksymalna długość tekstu to 4000 znaków. Aby rozpocząć wątek lub dodać do niego wiadomość, utwórz wiadomość i określ threadKey lub thread.name. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
request_id

string

Opcjonalnie: Unikalny identyfikator żądania dla tej wiadomości. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie wiadomości utworzonej z tym identyfikatorem, a nie utworzenie nowej wiadomości.
message_reply_option

MessageReplyOption

Opcjonalnie: Określa, czy wiadomość rozpoczyna wątek, czy na niego odpowiada. Obsługiwane są tylko nazwane pokoje.

Gdy reagujesz na interakcje użytkowników, to pole jest ignorowane. W przypadku interakcji w wątku odpowiedź jest tworzona w tym samym wątku. W przeciwnym razie odpowiedź zostanie utworzona jako nowy wątek.
message_id

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Umożliwia aplikacjom Google Chat pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności przechowywania przypisanego przez system identyfikatora w nazwie zasobu wiadomości (reprezentowanej w polu name wiadomości).

Wartość w tym polu musi spełniać te wymagania:

  • Zaczyna się od client-. Na przykład client-custom-name jest prawidłowym identyfikatorem niestandardowym, ale custom-name już nie.
  • Może zawierać do 63 znaków i tylko małe litery, cyfry oraz łączniki.
  • jest niepowtarzalna w obrębie przestrzeni; Aplikacja do obsługi czatu nie może używać tego samego niestandardowego identyfikatora dla różnych wiadomości.

Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.

MessageReplyOption

Określa sposób odpowiedzi na wiadomość. W przyszłości możemy dodać więcej stanów.

Wartości w polu enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Domyślny: rozpoczyna nowy wątek. Ta opcja ignoruje wszystkie uwzględnione wartości thread ID lub thread_key.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub thread_key. Jeśli się nie uda, wiadomość rozpocznie nowy wątek.
REPLY_MESSAGE_OR_FAIL Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub thread_key. Jeśli użyto nowego thread_key, zostanie utworzony nowy wątek. Jeśli nie uda się utworzyć wiadomości, zamiast tego zostanie zwrócony błąd NOT_FOUND.

CreateReactionRequest

tworzy reakcję na wiadomość.

Pola
parent

string

Wymagane. Wiadomość, w której utworzono reakcję.

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

Reaction

Wymagane. Reakcja do utworzenia.

CreateSpaceRequest

prośba o utworzenie pokoju o nazwie bez użytkowników;

Pola
space

Space

Wymagane. Pola displayName i spaceType muszą być wypełnione. Obsługiwane są tylko wartości SpaceType.SPACE i SpaceType.GROUP_CHAT. Funkcji SpaceType.GROUP_CHAT można używać tylko wtedy, gdy zasada importMode ma wartość Prawda.

Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Przecinek name jest przypisany na serwerze, więc wszystko określone w tym polu zostanie zignorowane.
request_id

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd.

CustomEmoji

Reprezentuje niestandardowy emotikon.

Pola
name

string

Identyfikator. Nazwa zasobu niestandardowego emotikona przypisana przez serwer.

Format: customEmojis/{customEmoji}

uid

string

Tylko dane wyjściowe. Unikalny klucz zasobu niestandardowego emotikonu.
emoji_name

string

Niezmienna. Podana przez użytkownika nazwa niestandardowego emotikonu, która jest unikalna w organizacji.

Wymagane podczas tworzenia niestandardowego emotikonu, w przeciwnym razie tylko dane wyjściowe.

Nazwy emotikonów muszą zaczynać się i kończyć dwukropkiem, muszą być zapisane małymi literami i mogą zawierać tylko znaki alfanumeryczne, łączniki i podkreślenia. Łączniki i podkreślenia powinny być używane do oddzielania słów i nie mogą być używane jeden po drugim.

Przykład: :valid-emoji-name:

temporary_image_uri

string

Tylko dane wyjściowe. Adres URL obrazu niestandardowego emotikonu, który jest ważny przez co najmniej 10 minut. Pamiętaj, że niestandardowe emotikony nie są wypełniane w odpowiedzi podczas tworzenia.

payload

CustomEmojiPayload

Tylko dane wejściowe. Dane ładunku.

CustomEmojiPayload

Dane ładunku niestandardowego emotikonu.

Pola
file_content

bytes

Wymagane. Tylko dane wejściowe. Obraz użyty do emotikonu niestandardowego.

Dane ładunku nie mogą przekraczać 256 KB, a wymiar obrazu musi mieścić się w zakresie od 64 do 500 pikseli. Ograniczenia mogą ulec zmianie.
filename

string

Wymagane. Tylko dane wejściowe. Nazwa pliku obrazu.

Obsługiwane rozszerzenia pliku: .png, .jpg oraz .gif.

DeleteCustomEmojiRequest

prośba o usunięcie niestandardowego emotikonu;

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emotikona do usunięcia.

Format: customEmojis/{customEmoji}

Możesz użyć nazwy emotikonu jako aliasu elementu {customEmoji}. Na przykład customEmojis/:example-emoji:, gdzie :example-emoji: to nazwa niestandardowego emotikonu.

DeleteMembershipRequest

prośba o usunięcie użytkownika z pokoju;

Pola
name

string

Wymagane. Nazwa zasobu członkostwa, które chcesz usunąć. Aplikacje do czatu mogą usuwać członkostwa użytkowników lub własne. Aplikacje do obsługi czatu nie mogą usuwać członkostwa w innych aplikacjach.

Podczas usuwania subskrypcji użytkownika wymagany jest zakres chat.memberships i format spaces/{space}/members/{member}. Możesz użyć adresu e-mail jako aliasu dla {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

Podczas usuwania członkostwa w aplikacji wymagany jest zakres chat.memberships.app i format spaces/{space}/members/app.

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

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju.

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Usuwanie członkostwa w aplikacjach w pokoju nie jest możliwe w przypadku dostępu administracyjnego.

DeleteMessageRequest

Prośba o usunięcie wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu {message} możesz użyć wartości z pola clientAssignedMessageId. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.
force

bool

Gdy true, usunięcie wiadomości powoduje też usunięcie odpowiedzi na niej. Jeśli false, a wiadomość ma odpowiedzi w wątku, usunięcie się nie powiedzie.

Dotyczy tylko uwierzytelniania jako użytkownik. nie ma wpływu w przypadku uwierzytelniania jako aplikacja Google Chat.

DeleteReactionRequest

Usuwa reakcję na wiadomość.

Pola
name

string

Wymagane. Nazwa reakcji do usunięcia.

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

DeleteSpaceRequest

Prośba o usunięcie pokoju

Pola
name

string

Wymagane. Nazwa zasobu pokoju do usunięcia.

Format: spaces/{space}
use_admin_access

bool

Jeśli zasada jest true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga chat.admin.delete zakresu OAuth 2.0.

DeletionMetadata

Informacje o usuniętej wiadomości. Wiadomość jest usuwana, gdy ustawiona jest wartość delete_time.

Pola
deletion_type

DeletionType

Wskazuje, kto usunął wiadomość.

DeletionType

Kto i w jaki sposób usunął wiadomość. W przyszłości możemy dodać więcej wartości.

Wartości w polu enum
DELETION_TYPE_UNSPECIFIED Ta wartość nie jest używana.
CREATOR Użytkownik usunął własną wiadomość.
SPACE_OWNER Właściciel pokoju usunął wiadomość.
ADMIN Administrator Google Workspace usunął wiadomość.
APP_MESSAGE_EXPIRY Aplikacja Google Chat usunęła własną wiadomość po wygaśnięciu.
CREATOR_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu użytkownika.
SPACE_OWNER_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu właściciela pokoju.

Dialog

Opakowanie na karcie w dialogu.

Pola
body

Card

Tylko dane wejściowe. Treść okna, renderowana w formacie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: DateTimePicker, OnChangeAction.

DialogAction

Zawiera dialog i kod stanu żądania.

Pola
action_status

ActionStatus

Tylko dane wejściowe. Stan prośby o wywołanie lub przesłanie dialogu. W razie potrzeby wyświetla stan i komunikat użytkownikom. Na przykład w przypadku błędu lub sukcesu.
Pole unii action. Działanie do wykonania. action może mieć tylko jedną z tych wartości:
dialog

Dialog

Tylko dane wejściowe. Okno dialogowe żądania.

DriveDataRef

Odwołuje się do danych załącznika na dysku.

Pola
drive_file_id

string

Identyfikator pliku na Dysku. Używaj go z interfejsem Drive API.

DriveLinkData

dane dotyczące linków na Dysku Google.

Pola
drive_data_ref

DriveDataRef

DriveDataRef, który odwołuje się do pliku na Dysku Google.
mime_type

string

Typ MIME połączonego zasobu Dysku Google.

Emotikony

Emotikon używany jako reakcja na wiadomość.

Pola
Pole unii content. Treść emotikonu. content może być tylko jednym z tych elementów:
unicode

string

Podstawowy emotikon reprezentowany przez ciąg znaków Unicode.
custom_emoji

CustomEmoji

Tylko dane wyjściowe. Własny emotikon

EmojiReactionSummary

Liczba osób, które zareagowały na wiadomość przy użyciu określonego emotikona.

Pola
emoji

Emoji

Emotikony powiązane z reakcjami.
reaction_count

int32

Łączna liczba reakcji z użyciem powiązanego emotikona.

FindDirectMessageRequest

Prośba o przesłanie wiadomości na czacie na podstawie zasobu użytkownika.

Pola
name

string

Wymagane. Nazwa zasobu użytkownika, z którym chcesz znaleźć czat.

Format: users/{user}, gdzie {user} to id dla osoby w interfejsie People API lub id dla użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu w People API to 123456789, możesz znaleźć wiadomość bezpośrednią z tą osobą, podając users/123456789 jako name. Po uwierzytelnieniu się jako użytkownik możesz używać adresu e-mail jako aliasu {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

GetAttachmentRequest

Prośba o załącznik.

Pola
name

string

Wymagane. Nazwa zasobu załącznika, w formacie spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

żądanie zwrócenia jednego niestandardowego emotikonu;

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emotikonu.

Format: customEmojis/{customEmoji}

Możesz użyć nazwy emotikonu jako aliasu elementu {customEmoji}. Na przykład customEmojis/:example-emoji:, gdzie :example-emoji: to nazwa niestandardowego emotikonu.

GetMembershipRequest

wysłać prośbę o członkostwo w pokoju;

Pola
name

string

Wymagane. Nazwa zasobu subskrypcji do pobrania.

Aby uzyskać członkostwo w aplikacji za pomocą uwierzytelnienia użytkownika, możesz opcjonalnie użyć spaces/{space}/members/app.

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

Możesz użyć adresu e-mail użytkownika jako aliasu {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.
use_admin_access

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga zakresów OAuth 2.0 chat.admin.memberships lub chat.admin.memberships.readonly.

Wspieranie aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administracyjnego.

GetMessageRequest

Poproś o otrzymanie wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu {message} możesz użyć wartości z pola clientAssignedMessageId. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.

GetSpaceEventRequest

Prośba o wiadomość dotyczącą otrzymania wydarzenia w pokoju.

Pola
name

string

Wymagane. Nazwa zasobu zdarzenia dotyczącego pokoju.

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

GetSpaceNotificationSettingRequest

wiadomość z prośbą o ustawienie powiadomień o miejscu Obsługuje tylko pobieranie ustawień powiadomień dla dzwoniącego użytkownika.

Pola
name

string

Wymagane. Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/ustawienie_powiadomienia_przestrzeni

  • users/me/spaces/{space}/spaceNotificationSetting LUB
  • users/user@example.com/spaces/{space}/spaceNotificationSetting LUB
  • users/123456789/spaces/{space}/spaceNotificationSetting. Uwaga: w ścieżce może się znajdować tylko identyfikator użytkownika lub adres e-mail dzwoniącego.

GetSpaceReadStateRequest

Komunikat żądania do interfejsu API GetSpaceReadState.

Pola
name

string

Wymagane. Nazwa zasobu z czytaniem stanu pokoju do pobrania.

Obsługuje tylko pobieranie stanu odczytu dla dzwoniącego użytkownika.

Aby odwołać się do użytkownika dzwoniącego, ustaw jedną z tych opcji:

  • Alias me. Na przykład: users/me/spaces/{space}/spaceReadState.

  • adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/spaceReadState.

  • Identyfikator użytkownika. Na przykład: users/123456789/spaces/{space}/spaceReadState.

Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni

GetSpaceRequest

Żądanie zwrócenia pojedynej spacji.

Pola
name

string

Wymagane. Nazwa zasobu pokoju w formacie spaces/{space}.

Format: spaces/{space}
use_admin_access

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga zakresów OAuth 2.0 chat.admin.spaces lub chat.admin.spaces.readonly.

GetThreadReadStateRequest

Treść żądania interfejsu GetThreadReadStateRequest API.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu wątku do pobrania.

Obsługuje tylko pobieranie stanu odczytu dla dzwoniącego użytkownika.

Aby odwołać się do użytkownika dzwoniącego, ustaw jedną z tych opcji:

  • Alias me. Na przykład: users/me/spaces/{space}/threads/{thread}/threadReadState.

  • adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • Identyfikator użytkownika. Na przykład: users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Format: users/{użytkownik}/pokoje/{spacja}/wątki/{wątek}/threadReadState

Grupa

Grupa dyskusyjna Google w Google Chat.

Pola
name

string

Nazwa zasobu grupy Google.

Reprezentuje grupę w Cloud Identity Groups API.

Format: groups/{group}

HistoryState

Stan historii wiadomości i pokoi. Określa, jak długo wiadomości i wątki rozmów są przechowywane po utworzeniu.

Wartości w polu enum
HISTORY_STATE_UNSPECIFIED Wartość domyślna. Nie używać.
HISTORY_OFF Historia wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny.
HISTORY_ON Historia jest włączona. Okres przechowywania wiadomości i wątków określają reguły przechowywania w Vault obowiązujące w organizacji.

ListCustomEmojisRequest

Żądanie zwrócenia listy niestandardowych emotikonów.

Pola
page_size

int32

Opcjonalnie: Maksymalna liczba zwracanych niestandardowych emotikonów. Usługa może zwrócić mniej niestandardowych emotikonów niż ta wartość. Jeśli nie zostanie podana, wartością domyślną jest 25. Maksymalna wartość to 200; wartości powyżej 200 są zmieniane na 200.
page_token

string

Opcjonalnie: (jeśli wznawiasz działanie po poprzednim zapytaniu).

Token strony otrzymany z poprzedniego wywołania listy niestandardowych emotikonów. Podaj ten parametr, aby pobrać kolejną stronę.

Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem podanym dla tokena strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Umożliwia filtrowanie według twórcy.

Aby filtrować według twórcy, musisz podać prawidłową wartość. Obecnie tylko creator("users/me") i NOT creator("users/me") mogą filtrować niestandardowe emotikony według tego, czy zostały utworzone przez dzwoniącego czy nie.

Na przykład to zapytanie zwraca niestandardowy emotikon utworzony przez rozmówcę:

creator("users/me")

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

ListCustomEmojisResponse

Odpowiedź na listę niestandardowych emotikonów.

Pola
custom_emojis[]

CustomEmoji

Lista nieuporządkowana. Lista emotikonów niestandardowych na żądanej (lub pierwszej) stronie.
next_page_token

string

Token, który możesz wysłać jako pageToken, aby pobrać następną stronę wyników. Jeśli jest puste, nie ma kolejnych stron.

ListMembershipsRequest

Prośba o wyświetlenie wiadomości o wspieraniu.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, z którego chcesz pobrać listę członków.

Format: spaces/{space}
page_size

int32

Opcjonalnie: Maksymalna liczba wspierających do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie podasz tej wartości, zwróci się maksymalnie 100 subskrypcji.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania listy członkostwa. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Wspieranie możesz filtrować według roli (role) i typu (member.type).

Aby filtrować według roli, ustaw wartość role na ROLE_MEMBER lub ROLE_MANAGER.

Aby filtrować według typu, ustaw wartość member.type na HUMAN lub BOT. Możesz też filtrować według member.type, używając operatora !=.

Aby filtrować według roli i typu, użyj operatora AND. Aby filtrować według roli lub typu, użyj operatora OR.

Gdy element use_admin_access ma wartość Prawda, wymagana jest właściwość member.type = "HUMAN" lub member.type != "BOT". Inne filtry typu członka zostaną odrzucone.

Na przykład te zapytania są prawidłowe:

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

member.type != "BOT"

Te zapytania są nieprawidłowe:

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

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.
show_groups

bool

Opcjonalnie: Gdy true, oprócz innych typów wspierania zwraca także informacje o wspieraniu powiązane z elementem Google Group. Jeśli ustawiona jest wartość filter, subskrypcje z kategorii Google Group, które nie pasują do kryteriów filtra, nie są zwracane.
show_invited

bool

Opcjonalnie: Jeśli true, zwraca również subskrypcje powiązane z użytkownikami invited, oprócz innych typów subskrypcji. Jeśli ustawiony jest filtr, nie są zwracane subskrypcje invited, które nie spełniają kryteriów filtra.

Obecnie wymaga uwierzytelnienia użytkownika.
use_admin_access

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga zakresu chat.admin.memberships.readonly lub chat.admin.memberships OAuth 2.0.

Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane, gdy używasz dostępu administratora.

ListMembershipsResponse

Odpowiedź na listę osób w pokoju

Pola
memberships[]

Membership

Lista nieuporządkowana. Lista członkostw na stronie, której dotyczy żądanie (lub pierwszej stronie).
next_page_token

string

Token, który możesz wysłać jako pageToken, aby pobrać następną stronę wyników. Jeśli pole jest puste, nie ma kolejnych stron.

ListMessagesRequest

Wyświetla wiadomości w określonym pokoju, którego użytkownik jest członkiem.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, z którego mają być wyświetlane wiadomości.

Format: spaces/{space}
page_size

int32

Maksymalna liczba zwracanych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość.

Jeśli nie zostanie podana wartość, zwróci się maksymalnie 25 wyników.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
page_token

string

Opcjonalne, jeśli wznawiasz działanie po poprzednim zapytaniu.

Token strony otrzymany z poprzedniego wywołania listy wiadomości. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Filtr zapytania.

Wiadomości możesz filtrować według daty (create_time) i wątku (thread.name).

Aby filtrować wiadomości według daty ich utworzenia, określ create_time za pomocą sygnatury czasowej w formacie RFC-3339 i podwójnych cudzysłowów. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większego >, aby wyświetlić wiadomości utworzone po sygnaturze czasowej, lub operatora mniejszego <, aby wyświetlić wiadomości utworzone przed sygnaturą czasową. Aby filtrować wiadomości w określonym przedziale czasu, między 2 sygnaturami czasowymi użyj operatora AND.

Aby filtrować według wątku, określ pole thread.name w formacie spaces/{space}/threads/{thread}. W przypadku każdej zapytania możesz określić tylko 1 element thread.name.

Aby filtrować według wątku i daty, użyj w zapytaniu operatora AND.

Prawidłowe są na przykład te zapytania:

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

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.
order_by

string

Opcjonalne, jeśli wznawiasz działanie po poprzednim zapytaniu.

kolejność wyświetlania listy wiadomości; Określ wartość do posortowania za pomocą operacji sortowania. Prawidłowe wartości operacji sortowania:

  • ASC w kolejności rosnącej.

  • DESC – malejąco.

Domyślna kolejność to create_time ASC.
show_deleted

bool

Określa, czy mają być uwzględniane usunięte wiadomości. Usunięte wiadomości zawierają informacje o czasie usunięcia i metadane dotyczące jego usunięcia, ale treść wiadomości jest niedostępna.

ListMessagesResponse

Odpowiedź na wiadomość o wyświetleniu wiadomości.

Pola
messages[]

Message

Lista wiadomości.
next_page_token

string

Aby pobrać kolejną stronę wyników, możesz wysłać token jako pageToken. Jeśli pole jest puste, nie ma kolejnych stron.

ListReactionsRequest

Lista reakcji na wiadomość.

Pola
parent

string

Wymagane. Wiadomość, na którą zareagowali użytkownicy.

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

int32

Opcjonalnie: Maksymalna liczba zwróconych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie zostanie podana, wartością domyślną jest 25. Maksymalna wartość to 200; wartości powyżej 200 są zmieniane na 200.
page_token

string

Opcjonalnie: (W przypadku wznawiania poprzedniego zapytania).

Token strony otrzymany z poprzedniego wywołania reakcji na listę. Podaj ten parametr, aby pobrać kolejną stronę.

Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem podanym dla tokena strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Reakcje możesz filtrować według emotikonów (emoji.unicode lub emoji.custom_emoji.uid) oraz użytkowników (user.name).

Aby filtrować reakcje według wielu emotikonów lub użytkowników, złącz podobne pola za pomocą operatora OR, np. emoji.unicode = "🙂" OR emoji.unicode = "👍" i user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Aby filtrować reakcje według emotikona i użytkownika, użyj operatora AND, np. emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Jeśli w zapytaniu występują zarówno AND, jak i OR, zgrupuj je za pomocą nawiasów.

Na przykład te zapytania są prawidłowe:

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}"

Te zapytania są nieprawidłowe:

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}"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

ListReactionsResponse

Odpowiedź na żądanie wyświetlenia reakcji na liście.

Pola
reactions[]

Reaction

Lista reakcji na żądanej (lub pierwszej) stronie.
next_page_token

string

token kontynuacji do pobrania następnej strony wyników. Na ostatniej stronie wyników jest puste.

ListSpaceEventsRequest

Wiadomość z prośbą o wyświetlenie listy zdarzeń w pokoju.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju Google Chat, w którym wystąpiły zdarzenia.

Format: spaces/{space}.
page_size

int32

Opcjonalnie: Maksymalna liczba zwracanych zdarzeń dotyczących przestrzeni. Usługa może zwrócić mniej niż ta wartość.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
page_token

string

Token strony otrzymany z poprzedniego wywołania zdarzeń w pokoju listy. Podaj go, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry podawane do zdarzeń listowania miejsc na stronie muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Wymagane. Filtr zapytania.

Musisz określić co najmniej 1 typ zdarzenia (event_type) za pomocą operatora has :. Aby filtrować według wielu typów zdarzeń, użyj operatora OR. Pomiń w filtrze typy zdarzeń zbiorczych. Żądanie automatycznie zwraca wszystkie powiązane zdarzenia zbiorcze. Jeśli na przykład filtrujesz według nowych reakcji (google.workspace.chat.reaction.v1.created), serwer zwraca też zdarzenia dotyczące nowych reakcji (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w SpaceEvents dokumentacji odwołującej się do innych dokumentów.

Opcjonalnie możesz też filtrować według czasu rozpoczęcia (start_time) i czasu zakończenia (end_time):

  • start_time: unikalna sygnatura czasowa, od której rozpoczyna się wyświetlanie listy zdarzeń dotyczących pokoju. Możesz wyświetlić zdarzenia, które miały miejsce do 28 dni temu. Jeśli nie jest określone, wyświetla się lista zdarzeń w pokoju z ostatnich 28 dni.
  • end_time: sygnatura czasowa, do której są wyświetlane zdarzenia w pokoju. Jeśli nie określono inaczej, wyświetla listę zdarzeń do momentu przesłania żądania.

Aby określić czas rozpoczęcia lub zakończenia, użyj operatora równa się = i formatu RFC-3339. Aby filtrować wyniki zarówno według parametru start_time, jak i end_time, użyj operatora AND.

Na przykład te zapytania są prawidłowe:

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")

Te zapytania są nieprawidłowe:

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"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

ListSpaceEventsResponse

Komunikat z odpowiedzią na listę zdarzeń w pokoju.

Pola
space_events[]

SpaceEvent

Wyniki są zwracane w kolejności chronologicznej (najpierw najstarsze zdarzenie). Uwaga: w przypadku żądań listy pole permissionSettings nie jest zwracane w obiekcie pokoju.
next_page_token

string

Token kontynuacji służący do pobierania kolejnych zdarzeń. Jeśli pominiesz to pole, nie będzie kolejnych stron.

ListSpacesRequest

prośba o wyświetlenie listy pokoi, do których należy dzwoniący;

Pola
page_size

int32

Opcjonalnie: Maksymalna liczba miejsc do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania listy pokoi. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Podanie innej wartości może spowodować nieoczekiwane wyniki.
filter

string

Opcjonalnie: Filtr zapytania.

Możesz filtrować pokoje według typu pokoju (space_type).

Aby filtrować według typu pokoju, musisz podać prawidłową wartość z użyciem listy wyliczeń, np. SPACE lub GROUP_CHAT (wartość space_type nie może być równa SPACE_TYPE_UNSPECIFIED). Aby przesłać zapytanie dotyczące wielu typów pokoi, użyj operatora OR.

Na przykład te zapytania są prawidłowe:

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

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

ListSpacesResponse

Odpowiedź na żądanie listy pokoi.

Pola
spaces[]

Space

Lista pokoi na stronie, której dotyczy żądanie (lub na pierwszej stronie). Uwaga: w przypadku żądań listy pole permissionSettings nie jest zwracane w obiekcie pokoju.
next_page_token

string

Aby pobrać kolejną stronę wyników, możesz wysłać token jako pageToken. Jeśli jest puste, nie ma kolejnych stron.

MatchedUrl

pasujący adres URL w wiadomości w Google Chat, Aplikacje do czatu mogą wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w artykule Podgląd linków.

Pola
url

string

Tylko dane wyjściowe. Adres URL, który został dopasowany.

Członkostwo

Reprezentuje relację członkostwa w Google Chat, na przykład to, czy użytkownik lub aplikacja do obsługi czatu został zaproszony do pokoju, jego część lub osoba w nim nie ma.

Pola
name

string

Nazwa zasobu członkostwa przypisana przez serwer.

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

MembershipState

Tylko dane wyjściowe. Stan członkostwa.
role

MembershipRole

Opcjonalnie: Rola użytkownika w pokoju czatu, która określa jego uprawnienia w pokoju.

To pole może być używane tylko w przypadku UpdateMembership.
create_time

Timestamp

Opcjonalnie: Niezmienna. Czas utworzenia subskrypcji, na przykład kiedy użytkownik dołączył do pokoju lub został zaproszony do pokoju. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.
delete_time

Timestamp

Opcjonalnie: Niezmienna. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest używane tylko do wprowadzania danych wyjściowych, chyba że jest używane do importowania wcześniejszych danych o członkostwie w pokojach w trybie importowania.
Pole unii memberType. Użytkownik powiązany z tym członkostwem. W przyszłości możemy obsługiwać inne typy użytkowników. memberType może mieć tylko jedną z tych wartości:
member

User

Użytkownik lub aplikacja Google Chat, do których należy członkostwo. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user name i type.
group_member

Group

Grupa dyskusyjna Google, do której należy członkostwo.

Odczytywanie lub modyfikowanie członkostwa w Grupach dyskusyjnych Google wymaga uwierzytelniania użytkownika.

MembershipRole

Reprezentuje dozwolone działania użytkownika w pokoju czatu. W przyszłości możemy dodać więcej wartości typu wyliczeniowego.

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. users: nie jest on użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups: zawsze przypisana jest im ta rola (w przyszłości mogą być używane inne wartości).
ROLE_MEMBER Użytkownik jest członkiem pokoju. Użytkownik ma podstawowe uprawnienia, takie jak wysyłanie wiadomości do pokoju. W rozmowach 1:1 i rozmowach grupowych bez nazwy wszyscy mają tę rolę.
ROLE_MANAGER menedżer pokoju. Użytkownik ma wszystkie podstawowe uprawnienia oraz uprawnienia administracyjne, które umożliwiają zarządzanie pokojem, np. dodawanie i usuwanie użytkowników. Obsługiwane tylko w SpaceType.SPACE.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości możemy obsługiwać inne stany członkostwa.

Wartości w polu enum
MEMBERSHIP_STATE_UNSPECIFIED Wartość domyślna. Nie używaj.
JOINED Użytkownik zostaje dodany do pokoju i może w nim uczestniczyć.
INVITED Użytkownik został zaproszony do pokoju, ale nie dołączył do niego.
NOT_A_MEMBER Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do niego.

MembershipBatchCreatedEventData

Ładunek zdarzeń dla wielu nowych użytkowników.

Typ zdarzenia: google.workspace.chat.membership.v1.batchCreated

Pola
memberships[]

MembershipCreatedEventData

Listę nowych subskrypcji.

MembershipBatchDeletedEventData

Ładunek zdarzeń dla wielu usuniętych subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.batchDeleted

Pola
memberships[]

MembershipDeletedEventData

lista usuniętych wspierań;

MembershipBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.batchUpdated

Pola
memberships[]

MembershipUpdatedEventData

lista zaktualizowanych wspierań;

MembershipCreatedEventData

ładunek zdarzeń dla nowego wspierania kanału;

Typ zdarzenia: google.workspace.chat.membership.v1.created.

Pola
membership

Membership

Nowa subskrypcja.

MembershipDeletedEventData

Ładunek zdarzenia dotyczący usuniętej subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.deleted

Pola
membership

Membership

Usunięta subskrypcja. Wypełnij tylko pola name i state.

MembershipUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.updated

Pola
membership

Membership

Zaktualizowane członkostwo.

Wiadomość

Wiadomość w pokoju Google Chat.

Pola
name

string

Nazwa zasobu wiadomości.

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

Gdzie {space} to identyfikator pokoju, w którym opublikowano wiadomość, a {message} to przypisany do niej identyfikator systemu. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz niestandardowy identyfikator, możesz użyć tego identyfikatora do określenia wiadomości w żądaniu, zastępując {message} wartością z pola clientAssignedMessageId. Na przykład: spaces/AAAAAAAAAAA/messages/client-custom-name. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.
sender

User

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user name i type.
create_time

Timestamp

Opcjonalnie: Niezmienna. w przypadku pokoi utworzonych w Google Chat – data utworzenia wiadomości; To pole dotyczy tylko danych wyjściowych, chyba że jest używane w pokojach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw to pole na historyczny znacznik czasu, w którym wiadomość została utworzona w źródle, aby zachować pierwotny czas utworzenia.
last_update_time

Timestamp

Tylko dane wyjściowe. Czas ostatniej modyfikacji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie została edytowana, to pole jest puste.
delete_time

Timestamp

Tylko dane wyjściowe. Godzina usunięcia wiadomości z Google Chat. Jeśli wiadomość nigdy nie została usunięta, to pole jest puste.
text

string

Treść wiadomości w postaci zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej generuje element podglądu. Możesz też wzmiankować użytkownika Google Chat lub wszystkich użytkowników pokoju.

Więcej informacji o tworzeniu wiadomości tekstowych znajdziesz w artykule Wysyłanie wiadomości.
formatted_text

string

Tylko dane wyjściowe. Zawiera wiadomość text ze znacznikami dodanymi w celu komunikowania formatowania. To pole może nie zawierać całego formatowania widocznego w interfejsie, ale zawiera:

  • Składnia znaczników do pogrubienia, kursywy, przekreślenia, czcionki monospace, bloku czcionki monospace i listy punktowanej.

  • Wzmianki użytkowników w formacie <users/{user}>.

  • niestandardowe hiperlinki w formacie <{url}|{rendered_text}>, gdzie pierwszy ciąg to adres URL, a drugi – renderowany tekst (np. <http://example.com|custom text>);

  • niestandardowe emotikony w formacie :{emoji_name}:, na przykład :smile:; Nie dotyczy to emotikonów Unicode, takich jak U+1F600 w przypadku emotikonu uśmiechniętej buźki.

Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości.
cards[]
(deprecated)

Card

Wycofane: użyj w zastępstwie zasady cards_v2.

bogate, sformatowane i interaktywne karty, które możesz wykorzystać do wyświetlania elementów UI, takich jak sformatowany tekst, przyciski i klikalne obrazy; Karty są zwykle wyświetlane pod zwykłym tekstem treści wiadomości. Pliki cards i cards_v2 mogą mieć maksymalny rozmiar 32 KB.
cards_v2[]

CardWithId

Tablica kart.

Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli aplikacja Czat uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart.

Aby dowiedzieć się, jak utworzyć wiadomość zawierającą karty, przeczytaj artykuł Wysyłanie wiadomości.

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Otwórz kreator kart
annotations[]

Annotation

Tylko dane wyjściowe. Adnotacje powiązane z text w tej wiadomości.
thread

Thread

Wątek, do którego należy wiadomość. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
space

Space

Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe pojawią się w pokoju name.
fallback_text

string

Tekstowy opis kart wiadomości, używany, gdy nie można wyświetlić samych kart (np. w przypadku powiadomień mobilnych).
action_response

ActionResponse

Tylko dane wejściowe. Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.
argument_text

string

Tylko dane wyjściowe. Treść wiadomości w postaci zwykłego tekstu bez wzmianek o aplikacji do obsługi czatu.
slash_command

SlashCommand

Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (w stosownych przypadkach).
attachment[]

Attachment

Załącznik przesłany przez użytkownika.
matched_url

MatchedUrl

Tylko dane wyjściowe. Adres URL w spaces.messages.text, który pasuje do wzorca podglądu linku. Więcej informacji znajdziesz w artykule Podgląd linków.
thread_reply

bool

Tylko dane wyjściowe. Jeśli true, wiadomość jest odpowiedzią w wątku odpowiedzi. Gdy false, wiadomość jest widoczna w rozmowie na najwyższym poziomie pokoju jako pierwsza wiadomość w wątku lub wiadomość bez odpowiedzi w wątkach.

Jeśli pokój nie obsługuje odpowiadania w wątkach, to pole jest zawsze false.
client_assigned_message_id

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Możesz użyć pola, aby zidentyfikować wiadomość lub ją pobrać, usunąć lub zaktualizować. Aby ustawić niestandardowy identyfikator, podczas tworzenia wiadomości użyj pola messageId. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.
emoji_reaction_summaries[]

EmojiReactionSummary

Tylko dane wyjściowe. Lista podsumowań reakcji emotikonów w wiadomości.
private_message_viewer

User

Niezmienna. Dane wejściowe do tworzenia wiadomości, w przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. W przypadku ustawienia wiadomości będzie ona prywatna i widoczna tylko dla określonego użytkownika oraz aplikacji Google Chat. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API za pomocą uwierzytelniania aplikacji i pominąć te informacje:

Szczegółowe informacje znajdziesz w artykule Wysyłanie wiadomości prywatnych.
deletion_metadata

DeletionMetadata

Tylko dane wyjściowe. informacje o usuniętej wiadomości; Wiadomość zostanie usunięta po ustawieniu funkcji delete_time.
quoted_message_metadata

QuotedMessageMetadata

Tylko dane wyjściowe. Informacje o wiadomości, którą użytkownik Google Chat zacytował w pokoju. Użytkownicy Google Chat mogą zacytować wiadomość, aby na nią odpowiedzieć.
attached_gifs[]

AttachedGif

Tylko dane wyjściowe. GIF-y dołączone do wiadomości.
accessory_widgets[]

AccessoryWidget

Co najmniej jeden interaktywny widżet wyświetlany u dołu wiadomości. Widżety akcesorium możesz dodawać do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nieobsługiwane w przypadku wiadomości zawierających okna dialogowe. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.

Utworzenie wiadomości z widżetami akcesoriów wymaga uwierzytelniania aplikacji.

MessageBatchCreatedEventData

Ładunek zdarzeń dla wielu nowych wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.batchCreated

Pola
messages[]

MessageCreatedEventData

Listę nowych wiadomości.

MessageBatchDeletedEventData

Payload zdarzenia dla wielu usuniętych wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.batchDeleted

Pola
messages[]

MessageDeletedEventData

lista usuniętych wiadomości;

MessageBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych komunikatów.

Typ zdarzenia: google.workspace.chat.message.v1.batchUpdated

Pola
messages[]

MessageUpdatedEventData

Lista zaktualizowanych wiadomości.

MessageCreatedEventData

ładunek zdarzeń dla nowej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.created

Pola
message

Message

Nowa wiadomość.

MessageDeletedEventData

Ładunek zdarzenia dla usuniętej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.deleted

Pola
message

Message

Usunięta wiadomość. Wypełnione są tylko pola name, createTime, deleteTime i deletionMetadata.

MessageUpdatedEventData

Ładunek zdarzenia dla zaktualizowanej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.updated

Pola
message

Message

Zaktualizowana wiadomość.

QuotedMessageMetadata

Informacje o cytowanej wiadomości.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu cytowanej wiadomości.

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

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy cytowany komunikat został utworzony lub zaktualizowany.

Reakcja

reakcja na wiadomość.

Pola
name

string

Nazwa zasobu reakcji.

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

User

Tylko dane wyjściowe. Użytkownik, który utworzył reakcję.
emoji

Emoji

Emotikon użyty w reakcji.

ReactionBatchCreatedEventData

Ładunek zdarzenia na potrzeby wielu nowych reakcji.

Typ zdarzenia: google.workspace.chat.reaction.v1.batchCreated

Pola
reactions[]

ReactionCreatedEventData

lista nowych reakcji;

ReactionBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych reakcji.

Typ zdarzenia: google.workspace.chat.reaction.v1.batchDeleted

Pola
reactions[]

ReactionDeletedEventData

lista usuniętych reakcji;

ReactionCreatedEventData

Ładunek zdarzenia dla nowej reakcji.

Typ zdarzenia: google.workspace.chat.reaction.v1.created

Pola
reaction

Reaction

Nowa reakcja.

ReactionDeletedEventData

Ładunek zdarzenia dotyczący usuniętej reakcji.

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

Pola
reaction

Reaction

Usunięta reakcja.

RichLinkMetadata

Precyzyjny link do zasobu.

Pola
uri

string

Identyfikator URI tego linku.
Pole unii data. Dane połączonego zasobu. data może być tylko jednym z tych elementów:

RichLinkType

Typ linku rozszerzonego. W przyszłości możemy dodać więcej typów.

Wartości w polu enum
DRIVE_FILE Typ linku na Dysku Google.
CHAT_SPACE Typ linku rozszerzonego pokoju czatu. Może to być na przykład element inteligentny pokoju.

SearchSpacesRequest

Prośba o wyszukanie listy pokoi na podstawie zapytania.

Pola
use_admin_access

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga zakresu chat.admin.spaces.readonly lub chat.admin.spaces OAuth 2.0.

Ta metoda obsługuje obecnie tylko dostęp administracyjny, dlatego w tym polu akceptowana jest tylko wartość true.
page_size

int32

Maksymalna liczba spacji do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie zostanie podany, zwróci się maksymalnie 100 miejsc.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.
page_token

string

Token otrzymany z poprzedniego wywołania metody searchSpaces. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
query

string

Wymagane. zapytanie;

Możesz wyszukiwać za pomocą tych parametrów:

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

create_time i last_active_time akceptują sygnaturę czasową w formacie RFC-3339, a obsługiwane operatory porównania to: =, <, >, <=, >=.

Parametr customer jest wymagany i służy do wskazywania klienta, od którego mają być pobierane pokoje. customers/my_customer to jedyna obsługiwana wartość.

Funkcja display_name akceptuje tylko operator HAS (:). Tekst dopasowywania jest najpierw dzielony na tokeny, a każdy z nich jest dopasowywany do prefiksu niezależnie od wielkości liter. Na przykład Fun Eve pasuje do Fun event lub The evening was fun, ale nie notFun event ani even.

external_user_allowed może przyjmować wartość true lub false.

space_history_state akceptuje tylko wartości z pola historyState zasobu space.

Wymagane jest pole space_type, a jedyną prawidłową wartością jest SPACE.

W różnych polach obsługiwane są tylko operatory AND. Prawidłowy przykład to space_type = "SPACE" AND display_name:"Hello", a nieprawidłowy – space_type = "SPACE" OR display_name:"Hello".

Wśród tego samego pola space_type nie obsługuje operatorów AND ani OR. display_name, 'space_history_state' i 'external_user_allowed' obsługują tylko operatory OR. Atrybuty last_active_time i create_time obsługują operatory AND i OR. AND może być używane tylko do reprezentowania przedziału, np. last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Prawidłowe są te przykładowe zapytania:

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

Opcjonalnie: kolejność listy pokoi.

Obsługiwane atrybuty, według których można sortować:

  • membership_count.joined_direct_human_user_count – oznacza liczbę użytkowników, którzy bezpośrednio dołączyli do pokoju.
  • last_active_time – wskazuje czas dodania ostatniego kwalifikującego się elementu do dowolnego tematu w tym pokoju.
  • create_time – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji sortowania:

  • ASC w kolejności rosnącej. Wartość domyślna.

  • DESC – malejąco.

Obsługiwane składnie:

  • 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

Odpowiedź z listą pokoi odpowiadających żądaniu wyszukiwania pokoi.

Pola
spaces[]

Space

Strona z żądanymi pokojami.
next_page_token

string

Token, którego można użyć do pobrania następnej strony. Jeśli to pole jest puste, nie ma kolejnych stron.
total_size

int32

Łączna liczba pokoi pasujących do zapytania na wszystkich stronach. Jeśli wynik przekracza 10 tys. miejsc, jest to wartość szacunkowa.

SetUpSpaceRequest

Prośba o utworzenie pokoju i dodanie do niego określonych użytkowników.

Pola
space

Space

Wymagane. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw Space.spaceType na SPACE, a Space.displayName na . Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego elementu displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Aby utworzyć czat grupowy, ustaw wartość Space.spaceType na GROUP_CHAT. Nie ustawiaj opcji Space.displayName.

Aby utworzyć rozmowę 1:1 między ludźmi, ustaw Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na false. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Aby utworzyć rozmowę 1:1 między osobą a dzwoniącym aplikacją Google Chat, ustaw opcję Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na true. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Jeśli pokój DIRECT_MESSAGE już istnieje, zostanie on zwrócony, a nie zostanie utworzony nowy.
request_id

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat z innym uwierzytelnionym użytkownikiem zwraca błąd.
memberships[]

Membership

Opcjonalnie: Użytkownicy lub grupy Google Chat, których chcesz zaprosić do pokoju. Pomiń użytkownika wywołującego, ponieważ zostanie on dodany automatycznie.

Obecnie zestaw pozwala na maksymalnie 20 członków (oprócz dzwoniącego).

W przypadku członkostwa osoby fizycznej pole Membership.member musi zawierać user z wypełnionym name (format: users/{user}), a type musi być ustawiony na User.Type.HUMAN. Podczas konfigurowania pokoju możesz dodawać tylko użytkowników będących ludźmi (dodawanie aplikacji Google Chat jest obsługiwane tylko w przypadku konfigurowania wiadomości bezpośrednich za pomocą aplikacji do połączeń). Możesz też dodać członków, używając adresu e-mail użytkownika jako aliasu użytkownika {user}. Na przykład pole user.name może być polem users/example@gmail.com. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, musisz użyć adresu e-mail użytkownika do {user}.

W przypadku członkostwa w Grupach dyskusyjnych Google pole Membership.group_member musi zawierać group z wypełnionym name (format groups/{group}). Grupy Google możesz dodawać tylko wtedy, gdy ustawisz wartość Space.spaceType na SPACE.

Opcjonalny, gdy wartość Space.spaceType to SPACE.

Wymagane, gdy Space.spaceType ma wartość GROUP_CHAT, oraz co najmniej 2 uczestnictwa.

Jest on wymagany, jeśli ustawisz wartość Space.spaceType na DIRECT_MESSAGE dla użytkownika będącego osobą fizyczną, a także dokładnie 1 subskrypcję.

Musi być pusty podczas tworzenia rozmowy 1:1 między człowiekiem a aplikacją Google Chat (gdy Space.spaceType to DIRECT_MESSAGE, a Space.singleUserBotDm to true).

SlashCommand

Polecenie po ukośniku w Google Chat.

Pola
command_id

int64

Identyfikator wywołanego polecenia po ukośniku.

SlashCommandMetadata

Metadane adnotacji poleceń po ukośniku (/).

Pola
bot

User

Aplikacja Google Chat, której dotyczy wywołane polecenie.
type

Type

Typ polecenia po ukośniku.
command_name

string

Nazwa wywołanego polecenia po ukośniku.
command_id

int64

Identyfikator wywołanego polecenia po ukośniku.
triggers_dialog

bool

Wskazuje, czy polecenie po ukośniku jest przeznaczone do dialogu.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna dla typu enum. Nie używaj.
ADD Dodaj aplikację Google Chat do pokoju.
INVOKE wywołać polecenie po ukośniku w pokoju,

Spacja

Pokoju w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1 na 1 między użytkownikiem a aplikacją do czatu.

Pola
name

string

Nazwa zasobu pokoju.

Format: spaces/{space}

Gdzie {space} to identyfikator przypisany do pokoju przez system. Identyfikator pokoju możesz uzyskać, wywołując metodę spaces.list() lub korzystając z adresu URL pokoju. Jeśli na przykład adres URL pokoju to https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, jego identyfikator to AAAAAAAAA.
type
(deprecated)

Type

Tylko dane wyjściowe. Wycofane: użyj w zastępstwie zasady space_type. Typ pokoju.
space_type

SpaceType

Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania typu pokoju. Dane wyjściowe tylko do innych zastosowań.
single_user_bot_dm

bool

Opcjonalnie: Określa, czy pokój jest czatem między aplikacją Google Chat a jednym człowiekiem.
threaded
(deprecated)

bool

Tylko dane wyjściowe. Wycofane: użyj atrybutu spaceThreadingState. czy wiadomości są w tym pokoju w wątkach.
display_name

string

Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju z ustawieniem spaceType o wartości SPACE. Jeśli podczas tworzenia pokoju lub aktualizowania displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

W przypadku czatów to pole może być puste.

Obsługuje do 128 znaków.
external_user_allowed

bool

Stały. Określa, czy ten pokój pozwala na dodawanie dowolnego użytkownika Google Chat jako członka. Wprowadź podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych przypadkach:

  • Użytkownik uwierzytelniony korzysta z konta klienta (niezarządzanego konta użytkownika). Domyślnie pokój utworzony przez konto użytkownika indywidualnego jest dostępny dla wszystkich użytkowników Google Chat.

W przypadku istniejących pokoi to pole jest tylko do odczytu.
space_threading_state

SpaceThreadingState

Tylko dane wyjściowe. Stan wątku w pokoju czatu.
space_details

SpaceDetails

Szczegóły dotyczące pokoju, w tym opis i zasady.
space_history_state

HistoryState

stan historii wiadomości i wątków w tym pokoju;
import_mode

bool

Opcjonalnie: Czy ten pokój został utworzony w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi są one niewidoczne dla użytkowników, dopóki proces nie zostanie ukończony.

Tworzenie pokoju w Import Mode wymaga uwierzytelniania użytkownika.
create_time

Timestamp

Opcjonalnie: Niezmienna. w przypadku pokoi utworzonych w Google Chat – czas utworzenia pokoju; To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane w pomieszczeniach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw to pole na historyczny znacznik czasu, w którym pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia.

Wartość podawana w danych wyjściowych tylko wtedy, gdy spaceType ma wartość GROUP_CHAT lub SPACE.
last_active_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa ostatniej wiadomości w pokoju.

admin_installed

bool

Tylko dane wyjściowe. W przypadku czatów z poziomu aplikacji Google Chat określ, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat w aplikacji Google Chat w imieniu użytkowników w organizacji.

Aby umożliwić instalację przez administratora, aplikacja Google Chat musi obsługiwać wiadomości bezpośrednie.
membership_count

MembershipCount

Tylko dane wyjściowe. Liczba wspierających pogrupowanych według typu wspierającego. Wartość wypełniana, gdy space_type ma wartość SPACE, DIRECT_MESSAGE lub GROUP_CHAT.

access_settings

AccessSettings

Opcjonalnie: Określa ustawienie dostępu pokoju. Wypełniane tylko wtedy, gdy wartość space_type to SPACE.
space_uri

string

Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju.
customer

string

Opcjonalnie: Stały. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i wartością SpaceType SPACE, w przeciwnym razie nie należy go ustawiać.

W formacie customers/{customer}, gdzie customer to id z [zasobu klienta w Admin SDK](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Aplikacje prywatne mogą też używać aliasu customers/my_customer do tworzenia pokoju w tej samej organizacji Google Workspace co aplikacja.

W przypadku czatów to pole nie jest wypełniane.

Pole unii space_permission_settings. Reprezentuje ustawienia uprawnień pokoju. Wartość jest podawana tylko wtedy, gdy space_type ma wartość SPACE.

Wymaga uwierzytelniania użytkownika. space_permission_settings może być tylko jednym z tych elementów:
predefined_permission_settings

PredefinedPermissionSettings

Opcjonalnie: Tylko dane wejściowe. wstępnie zdefiniowane ustawienia uprawnień pokoju, które można określić tylko podczas tworzenia pokoju; Jeśli pole nie jest ustawione, tworzony jest pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.
permission_settings

PermissionSettings

Opcjonalnie: ustawienia uprawnień pokoju dla istniejących pokoi; Dane wejściowe do aktualizowania dokładnych ustawień uprawnień pokoju, w których zastępuje się dotychczasowe ustawienia uprawnień. Wyjście zawiera listę bieżących ustawień uprawnień.

AccessSettings

Reprezentuje ustawienie dostępu pokoju.

Pola
access_state

AccessState

Tylko dane wyjściowe. Wskazuje stan dostępu do pokoju.
audience

string

Opcjonalnie: Nazwa zasobu grupy odbiorców, która może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w pokoju. Jeśli nie jest ustawiona, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, które zostały zaproszone indywidualnie lub dodane do pokoju. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako dostępnego dla grupy odbiorców.

Format: audiences/{audience}

Aby użyć domyślnej grupy odbiorców organizacji Google Workspace, ustaw wartość audiences/default.

Odczytywanie odbiorców docelowych pomaga:

To pole nie jest wypełniane, gdy używasz zakresu chat.bot z uwierzytelnianiem aplikacji.

Aby ustawić grupę odbiorców, musisz uwierzytelnić użytkownika.

AccessState

Reprezentuje stan dostępu do pokoju.

Wartości w polu enum
ACCESS_STATE_UNSPECIFIED Stan dostępu jest nieznany lub nieobsługiwany w tym interfejsie API.
PRIVATE Tylko użytkownicy i Grupy dyskusyjne Google, którzy zostali dodani lub zaproszeni przez innych użytkowników albo administratorów Google Workspace, mogą odkryć pokój i uzyskać do niego dostęp.
DISCOVERABLE

Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, które zostały dodane indywidualnie lub zaproszone do pokoju, mogą również znaleźć pokój i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników.

Tworzenie pokoi możliwych do znalezienia wymaga uwierzytelniania użytkownika.

MembershipCount

Reprezentuje liczbę członkostw w pokoju, pogrupowanych według kategorii.

Pola
joined_direct_human_user_count

int32

Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględnienia użytkowników, którzy dołączyli do pokoju jako członkowie grupy.
joined_group_count

int32

Liczba wszystkich grup, które bezpośrednio dołączyły do pokoju.

PermissionSetting

Reprezentuje ustawienie uprawnień pokoju.

Pola
managers_allowed

bool

czy menedżerowie pokoju mają to uprawnienie.
members_allowed

bool

Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie.

PermissionSettings

Ustawienia uprawnień, które możesz określić podczas aktualizowania istniejącego pokoju o nazwie.

Aby ustawić ustawienia uprawnień podczas tworzenia pokoju, w żądaniu podaj pole PredefinedPermissionSettings.

Pola
manage_members_and_groups

PermissionSetting

Ustawienie dotyczące zarządzania użytkownikami i grupami w pokoju.
modify_space_details

PermissionSetting

Ustawienie umożliwiające aktualizowanie nazwy pokoju, awatara, opisu i wytycznych.
toggle_history

PermissionSetting

Ustawienie włączania i wyłączania historii pokoju.
use_at_mention_all

PermissionSetting

Ustawienie używania @all w pokoju.
manage_apps

PermissionSetting

Ustawienie zarządzania aplikacjami w pokoju.
manage_webhooks

PermissionSetting

Ustawienie zarządzania webhookami w pokoju.
post_messages

PermissionSetting

Tylko dane wyjściowe. Ustawienie dotyczące publikowania wiadomości w pokoju.
reply_messages

PermissionSetting

Ustawienie odpowiadania na wiadomości w pokoju.

PredefinedPermissionSettings

wstępnie zdefiniowane ustawienia uprawnień, które możesz określić tylko podczas tworzenia pokoju o nazwie; W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień do nazwanych pokoi znajdziesz w artykule Więcej informacji o pokojach.

Wartości w polu enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Nie określono. Nie używaj.
COLLABORATION_SPACE Ustawienie, które powoduje, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, które powoduje, że pokój staje się pokojem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

SpaceDetails

Szczegóły dotyczące pokoju, w tym opis i zasady.

Pola
description

string

Opcjonalnie: Opis pokoju. Możesz na przykład opisać temat dyskusji, cel lub uczestników pokoju.

Obsługuje do 150 znaków.
guidelines

string

Opcjonalnie: zasady, oczekiwania i etykietę pokoju;

Może mieć do 5000 znaków.

SpaceThreadingState

Określa typ stanu wątku w pokoju czatu.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowane.
THREADED_MESSAGES Nazwane pokoje, które obsługują wątki wiadomości. Gdy użytkownicy odpowiadają na wiadomość, mogą to zrobić w wątku, dzięki czemu ich odpowiedź będzie miała kontekst oryginalnej wiadomości.
GROUPED_MESSAGES Nazwane pokoje, w których rozmowy są uporządkowane według tematu. Tematy i odpowiedzi na nie są grupowane.
UNTHREADED_MESSAGES czaty między 2 osobami oraz rozmowy grupowe z co najmniej 3 osobami.

SpaceType

Typ pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. Dane wyjściowe tylko do innych zastosowań.

Wartości w polu enum
SPACE_TYPE_UNSPECIFIED Zarezerwowane.
SPACE Miejsce, w którym użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują. SPACE może zawierać aplikacje Google Chat.
GROUP_CHAT rozmowy grupowe z co najmniej 3 osobami; GROUP_CHAT może zawierać aplikacje Google Chat.
DIRECT_MESSAGE wiadomości 1:1 między dwiema osobami lub między osobą a aplikacją Google Chat;

Typ

Wycofane: użyj w zastępstwie zasady SpaceType.

Wartości w polu enum
TYPE_UNSPECIFIED Zarezerwowane.
ROOM Rozmowy między co najmniej 2 osobami.
DM Czat indywidualny między człowiekiem a aplikacją do obsługi czatu, w którym wszystkie wiadomości są płaskie. Pamiętaj, że nie dotyczy to wiadomości na czacie między dwoma osobami.

SpaceBatchUpdatedEventData

Ładunek zdarzeń dla wielu aktualizacji pokoju.

Typ zdarzenia: google.workspace.chat.space.v1.batchUpdated

Pola
spaces[]

SpaceUpdatedEventData

lista zaktualizowanych pokoi;

SpaceEvent

Zdarzenie, które reprezentuje zmianę lub aktywność w pokoju Google Chat. Więcej informacji znajdziesz w artykule Praca z wydarzeniami z Google Chat.

Pola
name

string

Nazwa zasobu zdarzenia dla pokoju.

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

Timestamp

Czas wystąpienia zdarzenia.
event_type

string

Typ zdarzenia dotyczącego pokoju. Każdy typ zdarzenia ma wersję zbiorczą, która reprezentuje wiele wystąpień danego typu zdarzenia, które wystąpiły w krótkim czasie. W przypadku żądań spaceEvents.list() pomiń typy zdarzeń zbiorczych w filtrze zapytania. Domyślnie serwer zwraca zarówno typ zdarzenia, jak i jego wersję zbiorczą.

Obsługiwane typy zdarzeń messages:

  • Nowa wiadomość: google.workspace.chat.message.v1.created
  • Zaktualizowana wiadomość: google.workspace.chat.message.v1.updated
  • Usunięta wiadomość: google.workspace.chat.message.v1.deleted
  • Wiele nowych wiadomości: google.workspace.chat.message.v1.batchCreated
  • Wiele zaktualizowanych wiadomości: google.workspace.chat.message.v1.batchUpdated
  • Wiele usuniętych wiadomości: google.workspace.chat.message.v1.batchDeleted

Obsługiwane typy zdarzeń w przypadku wspierania:

  • Nowa subskrypcja: google.workspace.chat.membership.v1.created
  • Zaktualizowana subskrypcja: google.workspace.chat.membership.v1.updated
  • Usunięto subskrypcję: google.workspace.chat.membership.v1.deleted
  • Wiele nowych subskrypcji: google.workspace.chat.membership.v1.batchCreated
  • Wiele zaktualizowanych subskrypcji: google.workspace.chat.membership.v1.batchUpdated
  • Usunięcie wielu członkostw: google.workspace.chat.membership.v1.batchDeleted

Obsługiwane typy zdarzeń w przypadku reakcji:

  • Nowa reakcja: google.workspace.chat.reaction.v1.created
  • Usunięta reakcja: google.workspace.chat.reaction.v1.deleted
  • Wiele nowych reakcji: google.workspace.chat.reaction.v1.batchCreated
  • Wiele usuniętych reakcji: google.workspace.chat.reaction.v1.batchDeleted

Obsługiwane typy zdarzeń dotyczących pokoju:

  • Zaktualizowany pokój: google.workspace.chat.space.v1.updated
  • Wiele aktualizacji pokoju: google.workspace.chat.space.v1.batchUpdated

Pole unii payload.

payload może być tylko jednym z tych elementów:
message_created_event_data

MessageCreatedEventData

Ładunek zdarzenia dla nowej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

Ładunek zdarzenia dla zaktualizowanej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

Ładunek zdarzenia dotyczący usuniętej wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

Ładunek zdarzeń dla wielu nowych wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

Ładunek zdarzeń dla wielu zaktualizowanych wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

Payload zdarzenia dla wielu usuniętych wiadomości.

Typ zdarzenia: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

ładunek zdarzeń dla aktualizacji pokoju;

Typ zdarzenia: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

Ładunek zdarzeń dla wielu aktualizacji pokoju.

Typ zdarzenia: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

Ładunek zdarzenia dla nowej subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

Ładunek zdarzenia dotyczący usuniętej subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

Ładunek zdarzeń dotyczącego wielu nowych subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Ładunek zdarzeń dla wielu usuniętych subskrypcji.

Typ zdarzenia: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

ładunek zdarzeń dla nowej reakcji;

Typ zdarzenia: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

Ładunek zdarzenia dotyczący usuniętej reakcji.

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

ReactionBatchCreatedEventData

Payload zdarzenia dla wielu nowych reakcji.

Typ zdarzenia: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych reakcji.

Typ zdarzenia: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Ustawienia powiadomień użytkownika w pokoju.

Pola
name

string

Identyfikator. Nazwa zasobu ustawień powiadomień w pokoju. Format: users/{user}/spaces/{space}/spaceNotificationSetting.
notification_setting

NotificationSetting

Ustawienie powiadomień.
mute_setting

MuteSetting

Ustawienie wyciszenia powiadomień o pokoju.

MuteSetting

Typy ustawień ignorowania powiadomień w pokoju.

Wartości w polu enum
MUTE_SETTING_UNSPECIFIED Zarezerwowane.
UNMUTED Użytkownik będzie otrzymywać powiadomienia o pokoju zgodnie z ustawieniami powiadomień.
MUTED Użytkownik nie będzie otrzymywać żadnych powiadomień dotyczących pokoju bez względu na ustawienie powiadomień.

NotificationSetting

Typy ustawień powiadomień.

Wartości w polu enum
NOTIFICATION_SETTING_UNSPECIFIED Zarezerwowane.
ALL Powiadomienia są wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Automatycznie obserwowane są wszystkie nowe wątki, chyba że użytkownik przestanie je obserwować.
MAIN_CONVERSATIONS Powiadomienie jest wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Niedostępne w przypadku czatów 1:1.
FOR_YOU Powiadomienie jest wywoływane przez @wzmianki i obserwowane wątki. Niedostępne w przypadku czatów 1:1.
OFF Powiadomienie jest wyłączone.

SpaceReadState

Stan odczytania wiadomości w pokoju, służący do identyfikowania przeczytanych i nieprzeczytanych wiadomości.

Pola
name

string

Nazwa zasobu z informacją o stanie odczytu pokoju.

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

Timestamp

Opcjonalnie: Czas zaktualizowania stanu odczytu pokoju przez użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości lub sygnaturze czasowej określonej przez użytkownika oznaczającej ostatnią przeczytaną wiadomość w pokoju.

SpaceUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanego miejsca.

Typ zdarzenia: google.workspace.chat.space.v1.updated

Pola
space

Space

Zaktualizowany pokój.

Wątek

Wątek w pokoju Google Chat. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

Jeśli podczas tworzenia wiadomości określisz wątek, możesz ustawić pole messageReplyOption, aby określić, co się stanie, jeśli nie zostanie znaleziony żaden pasujący wątek.

Pola
name

string

Nazwa zasobu wątku.

Przykład: spaces/{space}/threads/{thread}
thread_key

string

Opcjonalnie: Dane wejściowe do tworzenia lub aktualizowania wątku. W przeciwnym razie tylko dane wyjściowe. Identyfikator wątku. Obsługuje maksymalnie 4000 znaków.

Ten identyfikator jest unikalny dla aplikacji czatu, która go ustawia. Jeśli na przykład wiele aplikacji Google Chat utworzy wiadomość przy użyciu tego samego klucza wątku, zostaną one opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez inną osobę lub inną aplikację Google Chat, podaj pole wątku name.

ThreadReadState

Stan przeczytania wątku przez użytkownika używany do identyfikowania przeczytanych i nieprzeczytanych wiadomości.

Pola
name

string

Nazwa zasobu stanu odczytu wątku.

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

Timestamp

Czas zaktualizowania stanu odczytu wątku użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku.

UpdateMembershipRequest

Prośba o wiadomość dotyczącą aktualizacji subskrypcji.

Pola
membership

Membership

Wymagane. Subskrypcja do zaktualizowania. Zaktualizowane zostaną tylko pola określone przez update_mask.
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Jeśli jest wiele wartości, rozdziel je przecinkami lub użyj *, aby zaktualizować wszystkie ścieżki pól.

Obecnie obsługiwane ścieżki pól:

  • role
use_admin_access

bool

Jeśli zasada jest true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju.

Wymaga chat.admin.memberships zakresu OAuth 2.0.

UpdateMessageRequest

Prośba o zaktualizowanie wiadomości

Pola
message

Message

Wymagane. Wiadomość z zaktualizowanymi polami.
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Jeśli jest wiele wartości, rozdziel je przecinkami lub użyj *, aby zaktualizować wszystkie ścieżki pól.

Obecnie obsługiwane ścieżki pól:
allow_missing

bool

Opcjonalnie: Jeśli true i wiadomość nie zostaną znalezione, zostanie utworzona nowa wiadomość, a wartość updateMask zostanie zignorowana. Podany identyfikator wiadomości musi być przypisany przez klienta, w przeciwnym razie żądanie się nie powiedzie.

UpdateSpaceNotificationSettingRequest

Prośba o zaktualizowanie ustawień powiadomień dla pokoju. Obsługuje tylko aktualizowanie ustawień powiadomień dla użytkownika dzwoniącego.

Pola
space_notification_setting

SpaceNotificationSetting

Wymagane. Nazwa zasobu w ustawieniach powiadomień w pokoju musi być podana w formacie users/{user}/spaces/{space}/spaceNotificationSetting. Zaktualizowane zostaną tylko pola określone przez update_mask.
update_mask

FieldMask

Wymagane. Obsługiwane ścieżki pól: – notification_setting – mute_setting

UpdateSpaceReadStateRequest

Komunikat żądania interfejsu UpdateSpaceReadState API.

Pola
space_read_state

SpaceReadState

Wymagane. Stan odczytu pokoju i pola do zaktualizowania.

Obsługuje tylko aktualizowanie stanu odczytu użytkownika wywołującego.

Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:

  • Alias me. Na przykład: users/me/spaces/{space}/spaceReadState.

  • adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/spaceReadState.

  • Identyfikator użytkownika. Na przykład: users/123456789/spaces/{space}/spaceReadState.

Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Obecnie obsługiwane ścieżki pól:

  • last_read_time

Jeśli last_read_time jest wcześniejsza niż czas utworzenia ostatniej wiadomości, pokój jest widoczny jako nieprzeczytany w interfejsie.

Aby oznaczyć pokój jako przeczytany, ustaw last_read_time na dowolną wartość później (większą) niż czas utworzenia ostatniej wiadomości. Wartość last_read_time jest dopasowywana do czasu utworzenia ostatniej wiadomości. Pamiętaj, że stan odczytania pokoju wpływa tylko na stan odczytania wiadomości widocznych w rozmowie na najwyższym poziomie pokoju. Odpowiedzi w wątkach nie mają wpływu na tę sygnaturę czasową, a zależą one od stanu przeczytanego wątku.

UpdateSpaceRequest

prośba o aktualizację pojedynczego pokoju;

Pola
space

Space

Wymagane. Pokój z polami do zaktualizowania. Pole Space.name musi być wypełnione w formie spaces/{space}. Zaktualizowane zostaną tylko pola określone przez update_mask.
update_mask

FieldMask

Wymagane. zaktualizowane ścieżki pól, rozdzielone przecinkami, jeśli jest ich więcej niż 1.

Możesz zaktualizować te pola pokoju:

space_details: zaktualizuje opis pokoju. Obsługuje do 150 znaków.

display_name: obsługuje tylko aktualizowanie wyświetlanej nazwy w przypadku pokoi, w których pole spaceType ma wartość SPACE. Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wartości. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

space_type: obsługuje tylko zmianę typu pokoju GROUP_CHAT na SPACE. Uwzględnij w masce aktualizacji parametr display_name razem z atrybutem space_type i upewnij się, że wskazane miejsce ma niepustą wyświetlaną nazwę i typ pokoju SPACE. Dodanie maski space_type i typu SPACE w określonym pokoju podczas aktualizowania wyświetlanej nazwy jest opcjonalne, jeśli istniejący pokój ma już typ SPACE. Próba zaktualizowania typu pokoju w inny sposób powoduje błąd nieprawidłowego argumentu. Funkcja space_type nie jest obsługiwana w przypadku useAdminAccess.

space_history_state: aktualizuje ustawienia historii pokoju, włączając lub wyłączając historię pokoju. Obsługiwane tylko wtedy, gdy w organizacji Google Workspace są włączone ustawienia historii. Aby zaktualizować stan historii pokoju, musisz pominąć wszystkie inne maski pól w żądaniu. Funkcja space_history_state nie jest obsługiwana w przypadku useAdminAccess.

access_settings.audience: aktualizuje ustawienie dostępu, aby określić, kto może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w pokoju o nazwie, w którym pole spaceType ma wartość SPACE. Jeśli w istniejącym pokoju znajduje się grupa odbiorców, możesz ją usunąć i ograniczyć dostęp do pokoju, pomijając wartość tej maski pola. Aby zaktualizować ustawienia dostępu do pokoju, użytkownik uwierzytelniający musi być menedżerem pokoju i pominąć wszystkie inne maski pól w Twojej prośbie. Nie możesz zaktualizować tego pola, jeśli pokój jest w trybie importowania. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników. Funkcja access_settings.audience nie jest obsługiwana w przypadku useAdminAccess.

permission_settings: umożliwia zmianę ustawień uprawnień pokoju. Podczas aktualizowania ustawień uprawnień możesz określić tylko maski pól permissionSettings. Nie możesz jednocześnie aktualizować innych masek pól. Funkcja permissionSettings nie jest obsługiwana w przypadku useAdminAccess. Obsługiwane maski pól:

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

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju.

Wymaga chat.admin.spaces zakresu OAuth 2.0.

Niektóre wartości FieldMask nie są obsługiwane przy użyciu dostępu administracyjnego. Więcej informacji znajdziesz w opisie update_mask.

Użytkownik

Użytkownik w Google Chat. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe zasobu User pojawią się jako dane wyjściowe żądania, a w wartościach name i type użytkownika pojawią się tylko te dane.

Pola
name

string

Nazwa zasobu w Google Chat user.

Format: users/{user}. users/app może być używany jako alias użytkownika aplikacji do połączeń bot.

W przypadku human users identyfikator {user} jest taki sam jak identyfikator użytkownika w:

  • id osoby w People API. Na przykład users/123456789 w Chat API reprezentuje tę samą osobę co identyfikator profilu osoby 123456789 w People API.

  • id użytkownika w interfejsie Directory API z pakietu Admin SDK.

  • adres e-mail użytkownika może być używany jako alias dla {user} w żądaniach interfejsu API; Jeśli na przykład identyfikator profilu użytkownika w People API dla user@example.com to 123456789, możesz użyć users/user@example.com jako aliasu do odwołania do users/123456789. Zwrócona zostanie tylko kanoniczna nazwa zasobu (np. users/123456789).
display_name

string

Tylko dane wyjściowe. Wyświetlana nazwa użytkownika.
domain_id

string

Unikalny identyfikator domeny Google Workspace użytkownika.
type

Type

Typ użytkownika.
is_anonymous

bool

Tylko dane wyjściowe. Gdy true, użytkownik zostaje usunięty lub jego profil jest niewidoczny.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna dla typu enum. NIE UŻYWAJ.
HUMAN Użytkownik.
BOT Użytkownik aplikacji do obsługi czatu.

UserMentionMetadata

Metadane adnotacji dla wzmianek o użytkownikach (@).

Pola
user

User

Wspomniał użytkownik.
type

Type

Rodzaj wzmianki użytkownika.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna dla typu enum. Nie używaj.
ADD Dodaj użytkownika do pokoju.
MENTION Wspomnienie użytkownika w pokoju.

WidgetMarkup

Widżet to element interfejsu użytkownika, który zawiera tekst i obrazy.

Pola
buttons[]

Button

Lista przycisków. Pola przycisków mają też wartość oneof data i tylko jedno z tych pól powinno być ustawione.
Pole unii data. WidgetMarkup może zawierać tylko jeden z tych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól WidgetMarkup. data może być tylko jednym z tych elementów:
text_paragraph

TextParagraph

Wyświetlanie akapitu tekstu w tym widżecie.
image

Image

wyświetlać obraz w tym widżecie.
key_value

KeyValue

Wyświetlanie w tym widżecie elementu klucz-wartość.

Przycisk

Przycisk. Może to być przycisk tekstowy lub przycisk z obrazem.

Pola

Pole sumy type.

type może być tylko jednym z tych elementów:
text_button

TextButton

Przycisk z tekstem i działaniem onclick.
image_button

ImageButton

Przycisk z obrazem i działaniem onclick.

FormAction

Działanie formularza określa, co się dzieje, gdy formularz zostanie przesłany. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.

Pola
action_method_name

string

Nazwa metody służy do identyfikowania, która część formularza spowodowała jego przesłanie. Te informacje są odsyłane do aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Tej samej nazwy metody możesz użyć w przypadku kilku elementów, które wywołują typowe zachowanie.
parameters[]

ActionParameter

Lista parametrów działania.

ActionParameter

Lista parametrów ciągu, które należy podać podczas wywołania metody działania. Weźmy na przykład 3 przyciski drzemki: Odłóż teraz, Odłóż jeden dzień i Odłóż w przyszłym tygodniu. Możesz użyć action method = snooze(), przekazując typ i czas drzemki na liście parametrów ciągu znaków.

Pola
key

string

Nazwa parametru skryptu działania.
value

string

Wartość parametru.

Ikona

Zestaw obsługiwanych ikon.

Wartości w polu enum
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

Obraz

Obraz określony za pomocą adresu URL, który może zawierać działanie onclick.

Pola
image_url

string

Adres URL obrazu.
on_click

OnClick

Działanie onclick.
aspect_ratio

double

Format obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości dla obrazu podczas oczekiwania na jego załadowanie. Nie zastępuje on wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go, pobierając obraz z pamięci podręcznej.

ImageButton

Przycisk graficzny z działaniem onclick.

Pola
on_click

OnClick

Działanie onclick.
name

string

Nazwa tego image_button, który jest używany w ułatwieniach dostępu. Jeśli nie podasz tej nazwy, zostanie podana wartość domyślna.
Pole unii icons. Ikonę można określić za pomocą właściwości enum Icon lub adresu URL. icons może być tylko jednym z tych elementów:
icon

Icon

Ikona określona przez enum, która odwołuje się do ikony dostarczonej przez interfejs Chat API.
icon_url

string

Ikona określona za pomocą adresu URL.

KeyValue

Element interfejsu użytkownika zawiera klucz (etykieta) i wartość (treść). Element ten może też zawierać pewne działania, np. przycisk onclick.

Pola
top_label

string

Tekst górnej etykiety. Sformatowany tekst jest obsługiwany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
content

string

Tekst treści. Formatowany tekst jest obsługiwany i zawsze wymagany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
content_multiline

bool

czy treść powinna być wielowierszowa;
bottom_label

string

Tekst dolnej etykiety. Obsługiwany jest tekst sformatowany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
on_click

OnClick

Działanie onclick. Klikalne mogą być tylko etykieta górna, dolna oraz region treści.
Pole unii icons. Musisz zdefiniować co najmniej 1 z ikon: top_label i bottom_label. icons może mieć tylko jedną z tych wartości:
icon

Icon

Wartość wyliczeniowa, którą zastępuje Chat API odpowiednim obrazem ikony.
icon_url

string

Ikona określona za pomocą adresu URL.
Pole sumy control. Widżet sterujący. Możesz ustawić wartość button lub switch_widget, ale nie obie jednocześnie. control może być tylko jednym z tych elementów:
button

Button

Przycisk, który można kliknąć, aby wywołać działanie.

OnClick

działanie onclick (np. otwarcie linku).

Pola

Pole unii data.

data może być tylko jednym z tych elementów:
action

FormAction

Jeśli jest określone, to działanie onclick powoduje działanie formularza.

TextButton

Przycisk z tekstem i działaniem onclick.

Pola
text

string

Tekst na przycisku.
on_click

OnClick

Działanie onclick przycisku.

TextParagraph

Akapit tekstu. Obsługiwany jest tekst sformatowany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

Pola
text

string