Package google.chat.v1

Indeks

ChatService

Umożliwia deweloperom tworzenie aplikacji Google Chat 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 importowania danych przez aplikacje Google Chat.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tworzy członkostwo człowieka lub członkostwo w aplikacji na potrzeby aplikacji do rozmów. Wspieranie kanału w innych aplikacjach nie jest obsługiwane. Przykład znajdziesz w artykule Zapraszanie i dodawanie użytkownika lub aplikacji Google Chat do pokoju. 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. Wymaga uwierzytelniania użytkownika.

Aby wskazać użytkownika do dodania, ustaw membership.member.name dla użytkownika lub użytkownika aplikacji albo ustaw membership.group_member.name dla członka grupy.

  • Aby dodać aplikację do rozmów do pokoju lub czatu między 2 osobami, użyj funkcji users/app. Nie udało się dodać innych aplikacji do pokoju.

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

  • Aby dodać lub zaprosić grupę dyskusyjną Google do nazwanego pokoju, użyj pola 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 do pobrania identyfikatora 123456789 adresu e-mail grupy group@example.com, a następnie dodać grupę lub zaprosić ją do nazwanego 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.

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

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

rpc CreateMessage(CreateMessageRequest) returns (Message)

Tworzy wiadomość w pokoju Google Chat. Maksymalny rozmiar wiadomości, w tym tekstu i kart, to 32 000 bajtów. Przykład: Wysyłanie wiadomości.

Wywołanie tej metody wymaga uwierzytelniania i obsługuje następujące typy uwierzytelniania:

  • W przypadku SMS-ów obsługiwane jest uwierzytelnianie użytkownika lub uwierzytelnianie aplikacji.
  • W przypadku wiadomości dotyczących kart obsługiwane jest tylko uwierzytelnianie aplikacji. Tylko aplikacje do obsługi czatu mogą tworzyć wiadomości do kart.
Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 znajdziesz w sekcji Dodawanie reakcji do wiadomości. Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Tworzy nazwany pokój. Pokoje pogrupowane według tematów nie są obsługiwane. Przykład znajdziesz w artykule Tworzenie pokoju.

Jeśli podczas tworzenia pokoju zobaczysz 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.

Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

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

  • 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 na temat autoryzacji.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Wymaga uwierzytelniania użytkownika.

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

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

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Usuwa wiadomość. Przykład: Usuwanie wiadomości

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. Gdy używasz uwierzytelniania aplikacji, żądania mogą usuwać tylko wiadomości utworzone przez wywołującą aplikację Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Usuwa reakcję na wiadomość. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład znajdziesz w sekcji Usuwanie reakcji. Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 wykonywane jest kaskadowe usuwanie, co oznacza, że zasoby podrzędne pokoju – takie jak wiadomości opublikowane w pokoju i informacje o członkostwie w pokoju – również są usuwane. Przykład: Usuwanie pokoju. Wymaga uwierzytelnienia użytkownika przez użytkownika, który ma uprawnienia do usunięcia pokoju.

Zakresy autoryzacji

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

  • 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 na temat autoryzacji.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

Uwierzytelnianie użytkownika zwraca przestrzeń czatu między określonym użytkownikiem a uwierzytelnionym użytkownikiem.

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

Wymaga uwierzytelniania użytkownika lub uwierzytelniania aplikacji.

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 na temat autoryzacji.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Pobiera metadane załącznika do wiadomości. Dane załącznika są pobierane za pomocą interfejsu media API. Przykład znajdziesz w sekcji 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 na temat autoryzacji.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Zwraca informacje o subskrypcji. Przykład znajdziesz w artykule Uzyskiwanie informacji o subskrypcji użytkownika lub aplikacji Google Chat.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

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 na temat autoryzacji.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Zwraca informacje o wiadomości. Przykład: Uzyskiwanie informacji o wiadomości.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

Uwaga: może to spowodować wysłanie wiadomości od zablokowanego użytkownika lub pokoju.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Zwraca informacje o pokoju. Przykład: Uzyskiwanie informacji o pokoju.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

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

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Zwraca wydarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zasobu, która uległa zmianie. Jeśli na przykład zażądasz zdarzenia dotyczącego nowej wiadomości, ale wiadomość zostanie później zaktualizowana, serwer zwróci zaktualizowany zasób Message w ładunku zdarzenia.

Wymaga uwierzytelniania użytkownika. Aby uzyskać dostęp do wydarzenia, uwierzytelniony użytkownik musi być członkiem pokoju.

Przykład znajdziesz w artykule Uzyskiwanie informacji o wydarzeniu 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.
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 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 informacje o stanie odczytu użytkownika w wątku, używane 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 na temat autoryzacji.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Wyświetla listę użytkowników w pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Lista użytkowników korzystających z uwierzytelniania aplikacji zawiera listę użytkowników w pokojach, do których aplikacja Google Chat ma dostęp. Nie uwzględnia przynależności do aplikacji Google Chat, w tym własnych. Lista użytkowników z ustawieniem Uwierzytelnianie użytkowników zawiera listę użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

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.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 z pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Przykład: Wyświetlanie listy wiadomości. Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Wyświetla listę reakcji na wiadomość. Więcej informacji znajdziesz w sekcji Wyświetlanie listy reakcji na wiadomość. Wymaga uwierzytelniania użytkownika.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Wyświetla listę zdarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu Google Chat. 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 wybranym okresie nowi użytkownicy zostali usunięci, ładunek zdarzenia będzie zawierał pusty zasób Membership.

Wymaga uwierzytelniania użytkownika. Aby wyświetlić listę zdarzeń, 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)

Wyświetla listę pokoi, do których należy rozmówca. Czaty grupowe i czaty nie zostaną wyświetlone, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w sekcji Tworzenie listy pokoi.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

Wyświetla listę pokoi widocznych dla rozmówcy lub uwierzytelnionego użytkownika. Czaty grupowe i czaty nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość.

Aby wyświetlić wszystkie nazwane pokoje według organizacji Google Workspace, użyj metody spaces.search() z uprawnieniami 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 na temat autoryzacji.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Zwraca listę pokoi na podstawie wyszukiwania użytkownika. Wymaga uwierzytelniania użytkownika. Użytkownik musi być administratorem organizacji Google Workspace. W żądaniu ustaw use_admin_access na true.

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

Więcej informacji znajdziesz w przewodniku na temat 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 sekcji Konfigurowanie pokoju z początkowymi użytkownikami.

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

Aby określić grupy dyskusyjne Google, które chcesz dodać, dodaj członków za pomocą odpowiednich właściwości 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ć czat między dzwoniącym a innym użytkownikiem, określ dokładnie jedną subskrypcję, która będzie reprezentować tego użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie nie powiedzie się, a czat nie zostanie utworzony.

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 rozmów. Aby dowiedzieć się, jak 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 istnieje już czat pomiędzy 2 użytkownikami, nawet jeśli jeden z nich zablokuje drugiego w momencie wysyłania żądania, to istniejący czat zostanie zwrócony.

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 elementu displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

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 znajdziesz w artykule Aktualizowanie użytkowników pokoju w pokoju.

Wymaga uwierzytelniania użytkownika.

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

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

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. 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 protokołu 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 na temat autoryzacji.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

Wymaga uwierzytelniania użytkownika.

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

Więcej informacji znajdziesz w przewodniku na temat 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ład znajdziesz w sekcji Aktualizowanie stanu odczytu pokoju 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 na temat 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 sumy action. Typ działania. action może mieć tylko jedną z tych wartości:
button_list

ButtonList

Lista przycisków.

ActionResponse

Parametry, których aplikacja do obsługi czatu 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 powiązane z oknem. Wymagany jest dokument 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 Typ domyślny 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 zdarzeniu CARD_CLICKED, w którym typ nadawcy wiadomości to BOT.
UPDATE_USER_MESSAGE_CARDS Zaktualizuj karty w wiadomości do użytkownika. Jest to dozwolone tylko w odpowiedzi na zdarzenie MESSAGE z pasującym adresem URL lub zdarzenie CARD_CLICKED, w którym typ nadawcy wiadomości to 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żetów.

Pola
items[]

SelectionItem

Tablica obiektów SelectionItem.

UpdatedWidget

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

Pola
widget

string

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

SelectionItems

Lista wyników autouzupełniania widżetów

ActionStatus

Reprezentuje stan żądania wywołania lub przesłania okna.

Pola
status_code

Code

Kod stanu.
user_facing_message

string

Wiadomość wysyłana do użytkowników z informacją o stanie prośby. Jeśli zasada jest nieskonfigurowana, wysyłana jest ogólna wiadomość na podstawie status_code.

Adnotacja

Tylko dane wyjściowe. Adnotacje powiązane z główną treścią wiadomości. 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 tej 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 (w postaci 0, włącznie) w treści wiadomości tekstowej, której odpowiada ta adnotacja.
Pole sumy metadata. Dodatkowe metadane adnotacji. metadata może mieć tylko jedną z tych wartości:
user_mention

UserMentionMetadata

Metadane wzmianki użytkownika.
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 Ktoś dodał wzmiankę o użytkowniku.
SLASH_COMMAND Wywoływane jest polecenie po ukośniku.

AttachedGif

Obraz GIF określony za pomocą adresu URL.

Pola
uri

string

Tylko dane wyjściowe. Adres URL, pod którym znajduje się obraz GIF.

Załącznik

załącznik w Google Chat.

Pola
name

string

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

string

Tylko dane wyjściowe. Pierwotna 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 użytkownikowi. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania zawartości załączników.
download_uri

string

Tylko dane wyjściowe. Adres URL pobierania, który umożliwia 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 sumy data_ref. Odwołanie do danych do załącznika. data_ref może mieć tylko jedną z tych wartości:
attachment_data_ref

AttachmentDataRef

Odwołanie do danych załącznika. To pole jest używane przez interfejs Media API do pobierania danych załącznika.
drive_data_ref

DriveDataRef

Tylko dane wyjściowe. Odwołanie do załącznika z Dysku Google. To pole jest używane w interfejsie Google Drive 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 zostanie przesłany do Google Chat.

AttachmentDataRef

Odwołanie do danych załącznika.

Pola
resource_name

string

Nazwa zasobu danych załączników. To pole jest używane przez interfejs Media API do pobierania danych załącznika.
attachment_upload_token

string

Nieprzezroczysty token zawierający odwołanie do przesłanego załącznika. Traktowane przez klientów jako nieprzejrzysty ciąg znaków i używane do tworzenia lub aktualizowania wiadomości z Google Chat z załącznikami.

CardWithId

Karta w wiadomości w Google Chat.

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

Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora kart.

Otwórz kreator kart

Pola
card_id

string

Wymagany, jeśli wiadomość zawiera kilka 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 zasobu połączonego pokoju czatu.

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

CompleteImportSpaceRequest

Komunikat z prośbą o ukończenie procesu importowania pokoju.

Pola
name

string

Wymagane. Nazwa zasobu pokoju trybu importu.

Format: spaces/{space}

CompleteImportSpaceResponse

Komunikat z odpowiedzią na zakończenie procesu importowania pokoju.

Pola
space

Space

Obszar trybu importu.

ContextualAddOnMarkup

Ten typ nie zawiera pól.

Znaczniki dla programistów służące do określania zawartości dodatku kontekstowego.

Karta

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

Pola
header

CardHeader

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

Section

Sekcje są rozdzielone linią.
card_actions[]

CardAction

Działania na tej karcie.
name

string

Nazwa karty.

CardAction

Działanie związane z kartą to działanie powiązane z kartą. W przypadku karty faktury typowe działanie to: usunięcie faktury, wysłanie jej e-mailem lub otwarcie faktury w przeglądarce.

Nie są obsługiwane przez aplikacje Google Chat.

Pola
action_label

string

Etykieta, która była wyświetlana w menu czynności.
on_click

OnClick

Działanie „onclick” dla tego działania.

CardHeader

Pola
title

string

Należy podać tytuł. Nagłówek ma stałą wysokość: jeśli określono zarówno tytuł, jak i podtytuł, każdy z nich zajmuje po jednym wierszu. Jeśli określono tylko tytuł, tekst zajmuje oba wiersze.
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 Obramowanie okrągłe.

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 trzeba stosować właściwości układu (np. kreacji zmiennoprzecinkowych).

Pola
header

string

Nagłówek sekcji. Tekst sformatowany 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.
widgets[]

WidgetMarkup

Sekcja musi zawierać co najmniej jeden widżet.

CreateMembershipRequest

Poproś o wiadomość dotyczącą utworzenia członkostwa.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, do którego chcesz dodać członkostwo.

Format: spacje/{spacja}
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 określone dane. Gdy aplikacja do obsługi czatu tworzy relację członkostwa użytkownika, musi użyć zakresu chat.memberships, ustawić user.type na HUMAN i ustawić user.name w formacie 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 osoby w interfejsie People API w aplikacji user@example.com to 123456789, możesz dodać użytkownika do pokoju, ustawiając membership.member.name na users/user@example.com lub users/123456789. Gdy aplikacja do obsługi czatu tworzy własną relację członkostwa, musi używać zakresu chat.memberships.app, ustawienia user.type na BOT i ustawienia 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 pokoju.

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 ma zostać utworzona wiadomość.

Format: spaces/{space}
message

Message

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

string

Opcjonalnie: Wycofano: użyj atrybutu thread.thread_key. Identyfikator wątku. Maksymalna długość tekstu to 4000 znaków. Aby rozpocząć wątek lub coś do niego dodać, utwórz wiadomość i podaj threadKey lub thread.name. Przykładowe użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
request_id

string

Opcjonalnie: Unikalny identyfikator żądania dla tej wiadomości. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócona wiadomość utworzona z tym identyfikatorem, zamiast tworzyć nową.
message_reply_option

MessageReplyOption

Opcjonalnie: Określa, czy wiadomość rozpoczyna wątek, czy odpowiada w nim. Obsługiwane tylko w przypadku nazwanych pokoi.
message_id

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Pozwala aplikacjom Google Chat na pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności zapisywania identyfikatora przypisanego przez system 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 unikalna w obrębie pokoju. 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, jak odpowiedzieć 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. Użycie tej opcji powoduje zignorowanie wszystkich uwzględnionych elementów thread ID i 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 to się nie uda, zostanie otwarta nowy wątek.
REPLY_MESSAGE_OR_FAIL Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub thread_key. Jeśli użyjesz nowego pola 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 tworzona jest reakcja.

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

Reaction

Wymagane. Reakcja do utworzenia.

CreateSpaceRequest

prośbę o utworzenie nazwanego pokoju.

Pola
space

Space

Wymagane. Pola displayName i spaceType muszą być wypełnione. Obsługiwana jest tylko wartość SpaceType.SPACE.

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

Pokój name jest przypisany na serwerze, więc wszystkie informacje podane w tym polu zostaną zignorowane.
request_id

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócony pokój utworzony z tym identyfikatorem, zamiast tworzyć nowy pokój. Podanie istniejącego identyfikatora żądania z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem zwraca błąd.

CustomEmoji

Reprezentuje niestandardowy emotikon.

Pola
uid

string

Tylko dane wyjściowe. Unikalny klucz zasobu niestandardowych emotikonów.

DeleteMembershipRequest

Prośba o usunięcie członkostwa w pokoju.

Pola
name

string

Wymagane. Nazwa zasobu subskrypcji do usunięcia. Aplikacje do obsługi czatu mogą usuwać użytkowników lub własnych subskrypcji. Aplikacje do obsługi czatu nie mogą usuwać innych aplikacji subskrypcji.

W przypadku usuwania członkostwa człowieka wymagany jest zakres chat.memberships i format spaces/{space}/members/{member}. Możesz użyć tego 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 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.

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 masz ustawiony dla wiadomości niestandardowy identyfikator, możesz dla {message} użyć wartości z pola clientAssignedMessageId. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.
force

bool

W przypadku funkcji true usunięcie wiadomości powoduje też usunięcie jej odpowiedzi w wątkach. Nie uda się usunąć false, jeśli wiadomość ma odpowiedzi w wątkach.

Ma zastosowanie tylko podczas 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 pokoju.

Wymaga chat.admin.delete zakresu OAuth 2.0.

DeletionMetadata

Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu funkcji delete_time.

Pola
deletion_type

DeletionType

Wskazuje, kto usunął wiadomość.

DeletionType

kto i w jaki sposób usunął wiadomość,

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 do obsługi czatu usunęła własną wiadomość po wygaśnięciu.
CREATOR_VIA_APP Aplikacja do obsługi czatu usunęła wiadomość w imieniu użytkownika.
SPACE_OWNER_VIA_APP Aplikacja do obsługi czatu usunęła wiadomość w imieniu właściciela pokoju.

Dialog

Zawijaj wokół treści karty w oknie.

Pola
body

Card

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

DialogAction

Zawiera okno i kod stanu żądania.

Pola
action_status

ActionStatus

Tylko dane wejściowe. Stan żądania wywołania lub przesłania okna. W razie potrzeby wyświetla stan i komunikat dla użytkowników. np. w przypadku błędu lub powodzenia.
Pole sumy 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łanie do danych przyłącza dysku.

Pola
drive_file_id

string

Identyfikator pliku na Dysku. Do użytku z interfejsem Drive API.

DriveLinkData

Dane dotyczące linków do Dysku Google.

Pola
drive_data_ref

DriveDataRef

DriveDataRef odwołujący 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 sumy content. Zawartość emotikona. content może mieć tylko jedną z tych wartości:
unicode

string

Podstawowy emotikon reprezentowany przez ciąg 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 przy użyciu powiązanego emotikona.

FindDirectMessageRequest

Prośba o pobranie pokoju 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 People API to 123456789, możesz znaleźć czat z tą osobą, używając parametru users/123456789 jako name. Po zalogowaniu się jako użytkownik możesz używać tego adresu e-mail jako aliasu dla {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

GetAttachmentRequest

Prośba o pobranie załącznika.

Pola
name

string

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

GetMembershipRequest

Poproś o dołączenie do pokoju.

Pola
name

string

Wymagane. Nazwa zasobu subskrypcji do pobrania.

Aby uzyskać własną subskrypcję aplikacji przez uwierzytelnianie użytkownika, możesz opcjonalnie użyć spaces/{space}/members/app.

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

Po uwierzytelnionym jako użytkownik możesz używać adresu e-mail użytkownika 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.
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 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

Prośba o odebranie wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli masz ustawiony dla wiadomości niestandardowy identyfikator, możesz dla {message} 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 wydarzenia w pokoju.

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

GetSpaceReadStateRequest

Komunikat żądania do interfejsu API GetSpaceReadState.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu pokoju do pobrania.

Obsługuje tylko pobieranie stanu odczytu w przypadku 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 konta 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}/spaces/{spacja}/spaceReadState

GetSpaceRequest

prośba o zwrócenie 1 pokoju,

Pola
name

string

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

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 pokoju.

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

GetThreadReadStateRequest

Komunikat żądania do interfejsu API GetThreadReadStateRequest.

Pola
name

string

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

Obsługuje tylko pobieranie stanu odczytu w przypadku 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 konta 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 dyskusyjnej Google.

Reprezentuje grupę w Cloud Identity Groups API.

Format: grupy/{grupa}

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 włączona. Okres przechowywania wiadomości i wątków określają reguły przechowywania w Vault obowiązujące w organizacji.

ListMembershipsRequest

Prośba o wiadomość dotyczącą członkostwa w wizytówce.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, do którego ma zostać pobrana lista użytkowników.

Format: spacje/{spacja}
page_size

int32

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

Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 członkó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

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania listy członkostwa. 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 innych 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 role na ROLE_MEMBER lub ROLE_MANAGER.

Aby filtrować według typu, ustaw member.type na HUMAN lub BOT. Podgląd dla programistów: możesz też filtrować tabelę member.type, używając operatora !=.

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

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

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

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"

Nieprawidłowe zapytania są odrzucane przez serwer z błędem 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: Gdy true, oprócz innych typów wspierania zwraca także wspieranie powiązane z invited członkami grupy. Jeśli ustawiony jest filtr, subskrypcje z invited, które nie pasują do kryteriów filtra, nie są zwracane.

Obecnie wymaga uwierzytelniania użytkownika.
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 zakresu OAuth 2.0 chat.admin.memberships.readonly lub chat.admin.memberships.

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

ListMembershipsResponse

Odpowiedź na listę osób w pokoju.

Pola
memberships[]

Membership

Lista nieuporządkowana. Lista użytkowników 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 pole jest puste, nie ma kolejnych stron.

ListMessagesRequest

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

Pola
parent

string

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

Format: spaces/{space}
page_size

int32

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

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

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 wznawiam działanie od poprzedniego zapytania.

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 innych 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, wpisz create_time z sygnaturą czasową w formacie RFC-3339 i cudzysłowami podwójnymi. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większego niż >, aby wyświetlić listę wiadomości, które zostały utworzone po określonej sygnaturze czasowej, lub operatora mniej niż <, aby wyświetlić wiadomości, które zostały 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, podaj element thread.name w formacie spaces/{space}/threads/{thread}. Możesz określić tylko 1 thread.name na zapytanie.

Aby filtrować wyniki zarówno według wątku, jak 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

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.
order_by

string

Opcjonalne, jeśli wznawiam działanie od poprzedniego zapytania.

Określ kolejność wyświetlania wiadomości. Określ wartość do zamówienia według operacji porządkowania. Prawidłowe wartości operacji porządkowania są następujące:

  • ASC w kolejności rosnącej.

  • DESC malejąco.

Domyślna kolejność to create_time ASC.
show_deleted

bool

Określa, czy uwzględniać 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

Komunikat z odpowiedzią na listę wiadomości.

Pola
messages[]

Message

Lista wiadomości.
next_page_token

string

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

ListReactionsRequest

Wyświetla listę 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 wartość nie zostanie określona, przyjmuje się wartość domyślną 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 listy reakcji. Podaj go, aby pobrać kolejną stronę.

Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Możesz filtrować reakcje według emotikonów (emoji.unicode lub emoji.custom_emoji.uid) oraz użytkownika (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 używane są zarówno AND, jak i OR, pogrupuj je w nawiasach.

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

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

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.

ListReactionsResponse

Odpowiedź na prośbę o wyświetlenie listy reakcji.

Pola
reactions[]

Reaction

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

string

Token kontynuacji, który pozwala pobrać następną stronę wyników. Pole jest puste na ostatniej stronie wyników.

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 zwróconych zdarzeń dla pokoju. 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 dzielenia na strony wszystkie pozostałe parametry służące do wyświetlania listy zdarzeń pokoju muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych 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 zawiera :. 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 zbiorczo nowe reakcje (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w dokumentacji SpaceEvents.

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

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

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

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

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"

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.

ListSpaceEventsResponse

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

Pola
space_events[]

SpaceEvent

Wyniki są zwracane w porządku chronologicznym (od najstarszego zdarzenia).
next_page_token

string

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

ListSpacesRequest

Żądanie wyświetlenia listy pokoi, do których należy rozmówca.

Pola
page_size

int32

Opcjonalnie: Maksymalna liczba spacji 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ę.

Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Pokoje możesz filtrować według typu pokoju (space_type).

Aby filtrować według typu pokoju, musisz podać prawidłową wartość wyliczeniową, np. SPACE lub GROUP_CHAT (space_type nie może mieć wartości SPACE_TYPE_UNSPECIFIED). Aby wysłać zapytanie dotyczące wielu typów pokojów, użyj operatora OR.

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

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

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.

ListSpacesResponse

Odpowiedź na żądanie dotyczące pokoi z listą.

Pola
spaces[]

Space

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

string

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

MatchedUrl

Pasujący adres URL w wiadomości Google Chat. Aplikacje do obsługi czatu mogą wyświetlać podgląd pasujących adresów URL. Więcej informacji znajdziesz w sekcji Podgląd linków.

Pola
url

string

Tylko dane wyjściowe. Dopasowany adres URL.

Członkostwo

Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub komunikator został zaproszony do pokoju, jego część lub osoba w nim nie ma.

Pola
name

string

Nazwa zasobu subskrypcji przypisana przez serwer.

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

MembershipState

Tylko dane wyjściowe. Stan subskrypcji.
role

MembershipRole

Opcjonalnie: Rola użytkownika w pokoju czatu, która określa dozwolone działania w pokoju.

Tego pola można używać tylko jako danych wejściowych w usłudze UpdateMembership.
create_time

Timestamp

Opcjonalnie: Stała. Czas utworzenia subskrypcji, na przykład kiedy użytkownik dołączył do pokoju lub został zaproszony do pokoju. 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.
delete_time

Timestamp

Opcjonalnie: Stała. daty usunięcia subskrypcji, na przykład daty opuszczenia pokoju przez użytkownika lub jego usunięcia z pokoju. 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 sumy memberType. Członek powiązany z tą subskrypcją. W przyszłości mogą być obsługiwane inne typy członków. memberType może mieć tylko jedną z tych wartości:
member

User

Użytkownik lub aplikacja Google Chat, której dotyczy subskrypcja. Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pola name i type użytkownika.
group_member

Group

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

MembershipRole

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

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. W przypadku users: ta osoba nie jest członkiem pokoju, ale można ją zaprosić. W przypadku użytkowników Google Groups zawsze mają przypisaną tę rolę (w przyszłości mogą zostać użyte inne wartości wyliczeniowe).
ROLE_MEMBER Użytkownik 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ą mu zarządzanie pokojem, w tym dodawanie i usuwanie użytkowników. Funkcja obsługiwana tylko w tym kraju: SpaceType.SPACE.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości mogą być obsługiwane inne stany członkostwa.

Wartości w polu enum
MEMBERSHIP_STATE_UNSPECIFIED Wartość domyślna. Nie używaj.
JOINED Użytkownik zostanie dodany do pokoju i będzie mógł w nim uczestniczyć.
INVITED Użytkownik otrzymał zaproszenie do pokoju, ale jeszcze do niego nie dołączył.
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 subskrypcji.

MembershipBatchUpdatedEventData

Ładunek zdarzeń dla wielu zaktualizowanych subskrypcji.

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

Pola
memberships[]

MembershipUpdatedEventData

Listę zaktualizowanych subskrypcji.

MembershipCreatedEventData

Ładunek zdarzenia dla nowej subskrypcji.

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

Pola
membership

Membership

Nowa subskrypcja.

MembershipDeletedEventData

Ładunek zdarzenia dla 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 związanego ze zaktualizowanym członkostwem.

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

Pola
membership

Membership

Zaktualizowana subskrypcja.

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 została opublikowana wiadomość, a {message} to identyfikator przypisany przez system tej wiadomości. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz identyfikator niestandardowy, możesz go użyć do określenia komunikatu w żądaniu. W tym celu zastąp {message} wartością z pola clientAssignedMessageId. Na przykład: spaces/AAAAAAAAAAA/messages/client-custom-name. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.
sender

User

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pola name i type użytkownika.
create_time

Timestamp

Opcjonalnie: Stała. 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 w tym polu historyczną sygnaturę czasową, w której 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 był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 zostanie usunięta, to pole będzie puste.
text

string

Zwykły tekst wiadomości. Pierwszy link do obrazu, filmu lub strony internetowej generuje element podglądu. Możesz też dodać@wzmiankę o użytkowniku Google Chat lub każdej osobie w pokoju.

Aby dowiedzieć się, jak tworzyć SMS-y, zobacz Wysyłanie SMS-ów.
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 obsługi pogrubienia, kursywy, przekreślenia, bloku o stałej szerokości, bloków o stałej szerokości i listy punktowanej.

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

  • Niestandardowe hiperlinki w formacie <{url}|{rendered_text}>, w których pierwszy ciąg to adres URL, a drugi renderowany tekst – np. <http://example.com|custom text>.

  • Niestandardowe emotikony w formacie :{emoji_name}:, np. :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 w wiadomości.
cards[]
(deprecated)

Card

Wycofano: użyj atrybutu cards_v2.

Szczegółowe, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowany tekst, przyciski i klikalne obrazy. Zazwyczaj karty wyświetlają się pod zwykłym tekstem 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 Twoja aplikacja Google Chat uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart.

Więcej informacji o kartach i sposobach ich tworzenia znajdziesz w artykule Wysyłanie wiadomości dotyczących kart.

Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora kart.

Otwórz kreator kart
annotations[]

Annotation

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

Thread

Wątek, do którego należy wiadomość. Przykładowe użycie: 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

Zwykły tekst opisu kart wiadomości używany, gdy nie można wyświetlić odpowiednich kart – na przykład do powiadomień na urządzeniu mobilnym.
action_response

ActionResponse

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

string

Tylko dane wyjściowe. Zwykły tekst wiadomości z usuniętymi wszystkimi wzmiankami z aplikacji Google Chat.
slash_command

SlashCommand

Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (jeśli dotyczy).
attachment[]

Attachment

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

MatchedUrl

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

bool

Tylko dane wyjściowe. Gdy 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 odpowiedzi w wątkach, w tym polu jest zawsze false.
client_assigned_message_id

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Za pomocą tego pola możesz zidentyfikować wiadomość albo pobrać, usunąć lub zaktualizować wiadomość. Aby ustawić identyfikator niestandardowy, określ pole messageId podczas tworzenia wiadomości. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.
emoji_reaction_summaries[]

EmojiReactionSummary

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

User

Stała. Dane wejściowe do utworzenia wiadomości. W przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Po ustawieniu tego ustawienia wiadomość jest prywatna i widoczna tylko dla określonego użytkownika oraz aplikacji Google Chat. Podgląd linków ani załączników nie jest obsługiwany w przypadku wiadomości prywatnych.

Wiadomości prywatne mogą wysyłać tylko aplikacje do obsługi czatu. Jeśli Twoja aplikacja Google Chat uwierzytelnia się jako użytkownik przed wysłaniem wiadomości, wiadomość nie może być prywatna i musi pominąć to pole.

Więcej informacji znajdziesz w artykule Wysyłanie prywatnych wiadomości do użytkowników Google Chat.
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 cytowanej przez użytkownika Google Chat 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 akcesoriów 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 zdarzenia dla wielu nowych wiadomości.

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

Pola
messages[]

MessageCreatedEventData

Listę nowych wiadomości.

MessageBatchDeletedEventData

Ładunek 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 zdarzenia 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 związanego ze zaktualizowanym komunikatem.

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 cytowana wiadomość została utworzona lub kiedy została ostatnio zaktualizowana.

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 dla 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 sumy data. Dane dla połączonego zasobu. data może mieć tylko jedną z tych wartości:

RichLinkType

Rodzaj linku z elementami rozszerzonymi. W przyszłości możemy dodać więcej typów.

Wartości w polu enum
DRIVE_FILE Szczegółowy typ linku do Dysku Google.
CHAT_SPACE Szczegółowy typ linku do pokoju czatu. Na przykład element inteligentny dotyczący pokoju.

SearchSpacesRequest

Prośba o wyszukanie listy pokoi na podstawie zapytania.

Pola
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 zakresu OAuth 2.0 chat.admin.spaces.readonly lub chat.admin.spaces.

Ta metoda obsługuje obecnie tylko dostęp administracyjny, więc 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 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.
page_token

string

Token otrzymany z poprzedniego wywołania pokoi wyszukiwania. 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 innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
query

string

Wymagane. Zapytanie.

Możesz wyszukiwać przy użyciu 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: =, <, >, <= i >=.

Pole customer jest wymagane i służy do wskazywania, od którego klienta mają zostać pobrane pokoje. Jedyną obsługiwaną wartością jest customers/my_customer.

Funkcja display_name akceptuje tylko operator HAS (:). Tekst do dopasowania jest najpierw tokenizowany na tokeny, a każdy token jest dopasowywany w postaci prefiksu bez uwzględniania wielkości liter i jest traktowany niezależnie jako podłańcuch w dowolnym miejscu w elemencie display_name pokoju. Na przykład Fun Eve pasuje do Fun event lub The evening was fun, ale nie notFun event ani even.

external_user_allowed akceptuje true lub false.

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

Pole space_type jest wymagane, a jedyna prawidłowa wartość to 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. last_active_time i create_time obsługują zarówno operatory AND, jak i OR. Parametr AND może być używany 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: Sposób porządkowania listy pokoi.

Obsługiwane atrybuty, według których należy sortować:

  • membership_count.joined_direct_human_user_count – wskazuje 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 porządkowania to:

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

  • DESC malejąco.

Obsługiwana składnia to:

  • 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 pokoi, których dotyczy prośba.
next_page_token

string

Token, za pomocą którego można pobrać następną stronę. 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 obejmuje więcej niż 10 000 pokoi, jest to wartość szacunkowa.

SetUpSpaceRequest

Poproś 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 opcję Space.spaceType na SPACE i ustaw Space.displayName. 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 Space.spaceType na GROUP_CHAT. Nie ustawiaj pola 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. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócony pokój utworzony z tym identyfikatorem, zamiast tworzyć nowy pokój. Podanie istniejącego identyfikatora żądania z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem zwraca błąd.
memberships[]

Membership

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

Zestaw pozwala obecnie na maksymalnie 20 członków (oprócz wywołującego).

W przypadku członkostwa człowieka pole Membership.member musi zawierać pole user z wypełnionymi wartościami name (format: users/{user}) i wartością type ustawioną na User.Type.HUMAN. Użytkowników można dodawać tylko podczas konfigurowania pokoju (dodawanie aplikacji do obsługi czatu jest obsługiwane tylko w przypadku konfigurowania czatu w 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 user.name może mieć wartość users/example@gmail.com. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, {user} musi mieć adres e-mail użytkownika.

W przypadku członkostwa w grupie dyskusyjnej Google pole Membership.group_member musi zawierać pole group z wypełnioną wartością name (format groups/{group}). Grupy dyskusyjne Google możesz dodawać tylko wtedy, gdy Space.spaceType ma wartość SPACE.

Opcjonalne przy ustawianiu Space.spaceType na SPACE.

Wymagany w przypadku ustawienia zasady Space.spaceType na GROUP_CHAT i co najmniej 2 subskrypcji.

Wymagane, gdy Space.spaceType ma wartość DIRECT_MESSAGE wraz z człowiekiem i dokładnie 1 subskrypcją.

To pole musi być puste podczas tworzenia rozmowy 1:1 między osobą a dzwoniącym aplikacją Google Chat (gdy Space.spaceType ma wartość DIRECT_MESSAGE, a Space.singleUserBotDm na true).

SlashCommand

Polecenie po ukośniku w Google Chat.

Pola
command_id

int64

Identyfikator wywołanego polecenia po ukośniku.

SlashCommandMetadata

Metadane adnotacji w poleceniach po ukośniku (/).

Pola
bot

User

Aplikacja do obsługi czatu, której polecenie zostało wywołane.
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 okna.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
ADD Dodaj aplikację Google Chat do pokoju.
INVOKE Wywołaj polecenie po ukośniku w spacji.

Spacja

Pokój w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1:1 między użytkownikiem a aplikacją Google Chat.

Pola
name

string

Nazwa zasobu pokoju.

Format: spaces/{space}
type
(deprecated)

Type

Tylko dane wyjściowe. Wycofane: użyj atrybutu space_type. Typ pokoju.
space_type

SpaceType

Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. 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. Określa, czy wiadomości są podzielone na wątki w tym pokoju.
display_name

string

Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju. Jeśli podczas tworzenia pokoju lub aktualizowania pokoju displayName zobaczysz 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.

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

Może mieć do 128 znaków.
external_user_allowed

bool

Stała. Określa, czy ten pokój pozwala na dołączenie dowolnego użytkownika Google Chat. Wprowadź podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik używa konta klienta (niezarządzanego konta użytkownika). Domyślnie w pokoju utworzonym przez konto dla użytkowników indywidualnych zezwala każdy użytkownik Google Chat.

W przypadku dotychczasowych pokoi to pole zawiera tylko dane wyjściowe.
space_threading_state

SpaceThreadingState

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

SpaceDetails

Informacje o pokoju, w tym opis i reguły.
space_history_state

HistoryState

Stan historii wiadomości dla wiadomości i wątków w tym pokoju.
import_mode

bool

Opcjonalnie: Określa, czy ten pokój został utworzony w usłudze Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi nie są one widoczne dla użytkowników, dopóki import się nie zakończy.
create_time

Timestamp

Opcjonalnie: Stała. W przypadku pokoi utworzonych w Google Chat jest to czas utworzenia pokoju. To pole dotyczy tylko danych wyjściowych, chyba że jest używane w pokojach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową, w której pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia pokoju.

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 pokoi czatu z aplikacją Google Chat – informacja o tym, czy pokój został utworzony przez administratora Google Workspace; Administratorzy mogą zainstalować i skonfigurować czat w aplikacji Google Chat w imieniu użytkowników w swojej organizacji.

Aby instalacja była obsługiwana przez administratora, aplikacja Google Chat musi obsługiwać czat.
membership_count

MembershipCount

Tylko dane wyjściowe. Liczba osób, które dołączyły, pogrupowane 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 do pokoju. Wartość jest podawana tylko wtedy, gdy space_type ma wartość SPACE.
space_uri

string

Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju.
Pole sumy space_permission_settings. Reprezentuje ustawienia uprawnień pokoju. Wartość jest podawana tylko wtedy, gdy space_type ma wartość SPACE. space_permission_settings może mieć tylko jedną z tych wartości:
predefined_permission_settings

PredefinedPermissionSettings

Opcjonalnie: Tylko dane wejściowe. Ustawienia uprawnień pokoju. Dane wejściowe do utworzenia pokoju. Jeśli to pole nie jest skonfigurowane, tworzony jest pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.

permission_settings

PermissionSettings

Opcjonalnie: Dokładne ustawienia uprawnień, które można skonfigurować w celu aktualizowania pokoju. Pole na aktualizowanie pokoju. W przeciwnym razie tylko dane wyjściowe. Aby utworzyć pokój, użyj predefined_permission_settings.

AccessSettings

Reprezentuje ustawienie dostępu do 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 wykryć pokój, dołączyć do pokoju i wyświetlić podgląd wiadomości w pokoju. Jeśli zasada jest nieskonfigurowana, dostęp do pokoju mają tylko użytkownicy lub Grupy dyskusyjne Google, którzy zostali indywidualnie zaproszeni lub dodani do pokoju. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego dla grupy odbiorców.

Format: audiences/{audience}

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

AccessState

Reprezentuje stan dostępu do pokoju.

Wartości w polu enum
ACCESS_STATE_UNSPECIFIED Stan dostępu jest nieznany lub nieobsługiwany przez ten interfejs 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órzy zostali indywidualnie dodani do pokoju lub zostali do niego zaproszeni, też mogą odkrywać pokój i uzyskiwać do niego dostęp. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego dla określonych użytkowników.

MembershipCount

Reprezentuje liczbę osób w pokoju pogrupowanych w kategorie.

Pola
joined_direct_human_user_count

int32

Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględniania użytkowników, którzy zostali członkami 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

Określa, 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ń do nazwanego pokoju. Aby skonfigurować ustawienia uprawnień podczas tworzenia pokoju, podaj w prośbie pole PredefinedPermissionSettings.

Pola
manage_members_and_groups

PermissionSetting

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

PermissionSetting

Ustawienie do aktualizowania nazwy, awatara, opisu i wytycznych pokoju.
toggle_history

PermissionSetting

Ustawienie do 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 publikowania wiadomości w pokoju.
reply_messages

PermissionSetting

Ustawienie odpowiadania na wiadomości w pokoju.

PredefinedPermissionSettings

Ustawienia uprawnień pokoju, które możesz określić podczas tworzenia nazwanego pokoju. 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, dzięki któremu pokój stanie się przestrzenią współpracy, w której wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, aby ten pokój stał się miejscem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

SpaceDetails

Informacje o pokoju, w tym opis i reguły.

Pola
description

string

Opcjonalnie: Opis pokoju. Na przykład opisz temat rozmowy, przeznaczenie lub uczestników pokoju.

Może mieć do 150 znaków.
guidelines

string

Opcjonalnie: Zasady, oczekiwania i etykieta

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 Pokoje z nazwami obsługujące wątki wiadomości. Gdy użytkownicy odpowiedzą na wiadomość, będą mogli odpowiedzieć w wątku, co zachowa zgodność z kontekstem oryginalnej wiadomości.
GROUPED_MESSAGES Nazwane pokoje, w których rozmowa jest uporządkowana według tematów. Tematy i odpowiedzi na nie są grupowane.
UNTHREADED_MESSAGES Czaty z dwiema osobami i rozmowy grupowe z udziałem co najmniej 3 osób.

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 mogą wysyłać wiadomości, udostępniać pliki i współpracować. Element SPACE może obejmować aplikacje Google Chat.
GROUP_CHAT rozmów grupowych z co najmniej 3 osobami, Element GROUP_CHAT może obejmować aplikacje Google Chat.
DIRECT_MESSAGE 1:1 wiadomości między 2 osobami lub człowiekiem i aplikacją Google Chat.

Typ

Wycofane: użyj atrybutu SpaceType.

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

SpaceBatchUpdatedEventData

Ładunek zdarzenia do wielu aktualizacji pokoju.

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

Pola
spaces[]

SpaceUpdatedEventData

Lista zaktualizowanych pokoi.

SpaceEvent

Zdarzenie reprezentujące zmianę lub aktywność w pokoju Google Chat. Więcej informacji znajdziesz w artykule Praca z wydarzeniami w 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 wydarzenia dotyczącego miejsca. 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ń w filtrze zapytań typy zdarzeń zbiorczych. Domyślnie serwer zwraca zarówno typ zdarzenia, jak i wersję wsadową.

Obsługiwane typy zdarzeń w przypadku wiadomości:

  • Nowa wiadomość: google.workspace.chat.message.v1.created
  • Zaktualizowano 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
  • Zaktualizowano subskrypcję 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
  • Kilka usuniętych subskrypcji: google.workspace.chat.membership.v1.batchDeleted

Obsługiwane typy zdarzeń w przypadku reakcji:

  • Nowa reakcja: google.workspace.chat.reaction.v1.created
  • Usunięto reakcję: 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:

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

Pole sumy payload.

payload może mieć tylko jedną z tych wartości:
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 związanego ze zaktualizowanym komunikatem.

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

MessageDeletedEventData

Ładunek zdarzenia dla usuniętej wiadomości.

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

MessageBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych wiadomości.

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

MessageBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych komunikatów.

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

MessageBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych wiadomości.

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

SpaceUpdatedEventData

Ładunek zdarzenia dotyczącego aktualizacji pokoju.

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

SpaceBatchUpdatedEventData

Ładunek zdarzenia do 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 związanego ze zaktualizowanym członkostwem.

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

MembershipDeletedEventData

Ładunek zdarzenia dla usuniętej subskrypcji.

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

MembershipBatchCreatedEventData

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

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

MembershipBatchUpdatedEventData

Ładunek zdarzeń dla 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 zdarzenia dla nowej reakcji.

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

ReactionDeletedEventData

Ładunek zdarzenia dla usuniętej reakcji.

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

ReactionBatchCreatedEventData

Ładunek zdarzenia na potrzeby 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

SpaceReadState

Stan odczytu użytkownika w pokoju używany do identyfikowania przeczytanych i nieprzeczytanych wiadomości.

Pola
name

string

Nazwa zasobu stanu odczytu pokoju.

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

Timestamp

Opcjonalnie: Czas zaktualizowania stanu odczytu pokoju 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 użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

Jeśli podczas tworzenia wiadomości określisz wątek, w polu messageReplyOption możesz określić, co się stanie, jeśli nie znajdziesz pasującego wątku.

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. Maksymalna długość tekstu to 4000 znaków.

Jest to unikalny identyfikator aplikacji Google Chat, 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 osobę lub inną aplikację Google Chat, zamiast tego użyj pola 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. Aktualizowane są tylko pola określone przez funkcję update_mask.
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Oddziel wartości 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. Komunikat z polami został zaktualizowany.
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Oddziel wartości 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 zostanie znaleziona, zostanie utworzona nowa wiadomość, a updateMask zostanie zignorowany. Podany identyfikator wiadomości musi być przypisany do klienta. W przeciwnym razie żądanie nie zostanie zrealizowane.

UpdateSpaceReadStateRequest

Komunikat żądania dotyczącego 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ł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 konta 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}/spaces/{spacja}/spaceReadState
update_mask

FieldMask

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

  • last_read_time

Gdy last_read_time przypada przed czasem utworzenia ostatniej wiadomości, pokój będzie wyświetlany w interfejsie jako nieprzeczytany.

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 przekształcona tak, aby pasowała do ostatniego czasu utworzenia wiadomości. Pamiętaj, że stan odczytu pokoju wpływa tylko na stan przeczytania wiadomości widocznych w rozmowie najwyższego poziomu w 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 zaktualizowanie jednego pokoju;

Pola
space

Space

Wymagane. Pokój z polami do zaktualizowania. Pole Space.name należy wypełnić w formacie spaces/{space}. Aktualizowane są tylko pola określone przez funkcję update_mask.
update_mask

FieldMask

Wymagane. Zaktualizowane ścieżki pól, jeśli jest ich kilka, rozdziel je przecinkami.

Możesz zaktualizować te pola pokoju:

  • space_details

  • display_name: obsługuje aktualizowanie wyświetlanej nazwy tylko 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. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

  • 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. Podczas aktualizowania wyświetlanej nazwy uwzględnienie maski space_type i typu SPACE w określonym obszarze jest opcjonalne, jeśli istniejący pokój ma już typ SPACE. Próba zaktualizowania typu pokoju w inny sposób skutkuje błędem nieprawidłowego argumentu. Usługa space_type nie jest obsługiwana z dostępem administracyjnym.

  • space_history_state: zmienia ustawienia historii pokoju przez włączenie lub wyłączenie historii w pokoju. Obsługiwane tylko wtedy, gdy w organizacji Google Workspace są włączone ustawienia historii. Aby zaktualizować stan historii pokoju, musisz pominąć w żądaniu wszystkie inne maski pól. Usługa space_history_state nie jest obsługiwana z dostępem administracyjnym.

  • access_settings.audience: aktualizuje ustawienie dostępu określające, kto może odkrywać pokój, dołączać do pokoju i wyświetlać podgląd wiadomości w nazwanym pokoju, 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 wykrywalnego dla określonych użytkowników. Usługa access_settings.audience nie jest obsługiwana z dostępem administracyjnym.

  • Podgląd dla programistów: umożliwia zmianę ustawień uprawnień pokoju. Obsługiwane ścieżki pól to między innymi: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (ostrzeżenie: wzajemnie wyklucza się ze wszystkimi pozostałymi ścieżkami pól niezawierającymi uprawnień). Usługa permission_settings nie jest obsługiwana z dostępem administracyjnym.
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.spaces zakresu OAuth 2.0.

Niektóre wartości FieldMask nie są obsługiwane w przypadku dostępu administracyjnego. Aby dowiedzieć się więcej, przeczytaj opis usługi 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 dla: user w Google Chat.

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

W przypadku usługi human users {user} to ten sam identyfikator użytkownika co:

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

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

  • Adres e-mail użytkownika może być używany jako alias dla {user} w żądaniach do interfejsu API. Jeśli na przykład identyfikator profilu osoby w interfejsie People API dla user@example.com to 123456789, możesz użyć users/user@example.com jako aliasu, aby odwołać się do users/123456789. Interfejs API zwróci tylko kanoniczną nazwę 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 jest usuwany lub jego profil nie jest widoczny.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. NIE UŻYWAĆ.
HUMAN Człowiek.
BOT Użytkownik aplikacji Google Chat.

UserMentionMetadata

Metadane adnotacji w przypadku wzmianek użytkowników (@).

Pola
user

User

Wspomniał użytkownik.
type

Type

Rodzaj wzmianki użytkownika.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
ADD Dodaj użytkownika do pokoju.
MENTION Dodaj wzmiankę w pokoju.

WidgetMarkup

Widżet to element interfejsu, który prezentuje tekst i obrazy.

Pola
buttons[]

Button

Lista przycisków. Przyciski mają też wartość oneof data i należy ustawić tylko jedno z tych pól.
Pole sumy data. Element 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 mieć tylko jedną z tych wartości:
text_paragraph

TextParagraph

Wyświetla akapit tekstu w tym widżecie.
image

Image

Wyświetlaj obraz w tym widżecie.
key_value

KeyValue

Wyświetla element pary klucz-wartość w tym widżecie.

Przycisk

Przycisk. Może to być przycisk tekstowy lub graficzny.

Pola

Pole sumy type.

type może mieć tylko jedną z tych wartości:
text_button

TextButton

Przycisk z tekstem i działaniem onclick.
image_button

ImageButton

Przycisk z obrazem i działaniem onclick.

FormAction

Działanie związane z formularzem opisuje zachowanie po przesłaniu formularza. 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 określenia, która część formularza spowodowała jego przesłanie. Te informacje są odczytywane w 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łań.

ActionParameter

Lista parametrów ciągu znaków, które mają być podawane po wywołaniu 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ć funkcji action method = snooze(), która przekazuje typ drzemki i czas drzemki na liście parametrów ciągu.

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 i może mieć 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 obrazu podczas oczekiwania na jego wczytanie. Nie zastępuje on wbudowanego formatu obrazu. Jeśli zasada jest nieskonfigurowana, serwer wypełnia ją, pobierając obraz z wyprzedzeniem.

ImageButton

Przycisk obrazu z działaniem onclick.

Pola
on_click

OnClick

Działanie onclick.
name

string

Nazwa tego elementu (image_button) używana w ułatwieniach dostępu. Jeśli nie podasz tej nazwy, zostanie podana wartość domyślna.
Pole sumy icons. Ikonę można określić za pomocą właściwości enum Icon lub adresu URL. icons może mieć tylko jedną z tych wartości:
icon

Icon

Ikona wskazana przez atrybut enum wskazujący ikonę dostarczaną przez interfejs Chat API.
icon_url

string

Ikona określona przez adres URL.

KeyValue

Element interfejsu zawiera klucz (etykietę) i wartość (treść). Ten element może też zawierać niektóre działania, np. przycisk onclick.

Pola
top_label

string

Tekst etykiety u góry. 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. Sformatowany 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. 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.
on_click

OnClick

Działanie onclick. Klikalne mogą być tylko etykieta górna, dolna oraz region treści.
Pole sumy 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 przez adres URL.
Pole sumy control. Widżet sterujący. Możesz ustawić button lub switch_widget, ale nie oba jednocześnie. control może mieć tylko jedną z tych wartości:
button

Button

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

OnClick

działanie onclick (np. otwarcie linku);

Pola

Pole sumy data.

data może mieć tylko jedną z tych wartości:
action

FormAction

Działanie związane z formularzem jest wywoływane przez to działanie onclick, jeśli zostało określone.

TextButton

Przycisk z tekstem i działaniem onclick.

Pola
text

string

Tekst na przycisku.
on_click

OnClick

Działanie onclick przycisku.

TextParagraph

Akapit tekstu. 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.

Pola
text

string