Package google.chat.v1

Indeks

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Kończy proces importowania w przypadku określonego pokoju i udostępnia go użytkownikom.

Wymaga uwierzytelniania użytkownika i przekazywania dostępu w całej domenie z zakresem autoryzacji:

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

Więcej informacji znajdziesz w artykule Autoryzowanie aplikacji Google Chat do importowania danych.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Tworzy niestandardowy emotikon.

Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tworzy członkostwo w aplikacji do połączeń Chat, użytkownika lub grupy Google. Tworzenie subskrypcji dla innych aplikacji do obsługi czatu nie jest obsługiwane. Jeśli podczas tworzenia członkostwa określony członek ma wyłączone automatyczne akceptowanie, zostanie zaproszony i musi zaakceptować zaproszenie do przestrzeni, zanim do niej dołączy. W przeciwnym razie utworzenie członkostwa spowoduje dodanie użytkownika bezpośrednio do wybranego pokoju.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i zakresem autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (aby dodać aplikację do połączeń do pokoju);
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, use_admin_access jest true i używany jest ten zakres autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships

Uwierzytelnianie aplikacji nie jest obsługiwane w tych przypadkach:

  • zapraszanie użytkowników spoza organizacji Workspace, do której należy pokój;
  • Dodawanie grupy dyskusyjnej Google do pokoju.
  • Dodawanie aplikacji do Google Chat do pokoju.

Przykłady użycia znajdziesz w tych artykułach:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zakresem autoryzacji:
    • https://www.googleapis.com/auth/chat.bot
  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

Chat przypisuje nadawcę wiadomości w różny sposób w zależności od typu uwierzytelniania użytego w żądaniu.

Ilustracja pokazująca, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawcę wiadomości. Treść wiadomości może zawierać tekst (text), karty (cardsV2) i widżety dodatkowe (accessoryWidgets).

Wiadomość wysłana z uwierzytelnianiem aplikacji

Ilustracja poniżej pokazuje, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje aplikację do obsługi czatu do wiadomości, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst (text).

Wiadomość wysłana z uwierzytelnianiem użytkownika

Maksymalny rozmiar wiadomości, w tym jej zawartość, to 32 000 bajtów.

W przypadku żądań webhooka odpowiedź nie zawiera pełnej wiadomości. Odpowiedź zawiera tylko pola name i thread.name oraz informacje, które były w żądaniu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Tworzy reakcję i dodaje ją do wiadomości. Przykład znajdziesz w artykule Dodawanie reakcji na wiadomość.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Tworzy pokój. Można go używać do tworzenia nazwanego pokoju lub czatu grupowego w Import mode. Przykład znajdziesz w artykule Tworzenie pokoju.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

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

Podczas uwierzytelniania jako aplikacja aplikacja Google Chat jest dodawana jako członek pokoju. W przeciwieństwie do uwierzytelniania przez człowieka aplikacja do czatu nie jest dodawana jako menedżer pokoju. Domyślnie aplikację Chat mogą usunąć z pokoju wszyscy jego użytkownicy. Aby zezwolić na usuwanie aplikacji z pokoju tylko menedżerom pokoju, ustaw space.permission_settings.manage_apps na managers_allowed.

Członkostwo w pokoju po jego utworzeniu zależy od tego, czy pokój został utworzony w Import mode:

  • Tryb importu: nie są tworzeni żadni użytkownicy.
  • Wszystkie pozostałe tryby: użytkownik dzwoniący jest dodawany jako członek. Jest to:
    • sama aplikacja, gdy używasz uwierzytelniania aplikacji;
    • użytkownik, gdy korzysta z uwierzytelniania użytkownika;

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Usuwa niestandardowy emotikon. Domyślnie użytkownicy mogą usuwać tylko utworzone przez siebie niestandardowe emotikony. Menedżerowie emotikonów wyznaczeni przez administratora mogą usuwać dowolne niestandardowe emotikony w organizacji. Więcej informacji znajdziesz w artykule Więcej informacji o niestandardowych emotikonach w Google Chat.

Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i zakresem autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (aby usunąć aplikację do połączeń z pokoju);
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, use_admin_access jest true i używany jest ten zakres autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships

Uwierzytelnianie aplikacji nie jest obsługiwane w tych przypadkach:

  • Usuwanie grupy dyskusyjnej Google z pokoju.
  • Usuwanie aplikacji Chat z pokoju.

Aby usunąć członkostwo menedżerów pokoju, osoba wysyłająca prośbę musi być menedżerem pokoju. Jeśli używasz uwierzytelniania aplikacji, twórcą pokoju musi być aplikacja Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zakresem autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

W przypadku uwierzytelniania aplikacji żądania mogą usuwać tylko wiadomości utworzone przez aplikację Chat, która wysyła żądanie.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Usuwa reakcję na wiadomość. Przykład znajdziesz w artykule Usuwanie reakcji.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i zakresem autoryzacji:

    • https://www.googleapis.com/auth/chat.app.delete (tylko w pokojach utworzonych przez aplikację)

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, use_admin_access jest true i używany jest ten zakres autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.delete
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Zwraca istniejącą wiadomość na czacie z określonym użytkownikiem. Jeśli nie zostanie znalezione miejsce na czat, zwraca błąd 404 NOT_FOUND. Przykład znajdziesz w artykule Znajdowanie wiadomości na czacie.

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

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

Obsługuje te typy uwierzytelniania:

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Pobiera metadane załącznika wiadomości. Dane załącznika są pobierane za pomocą interfejsu Media API. Przykład znajdziesz w artykule Pobieranie metadanych załącznika do wiadomości.

Wymaga uwierzytelnienia aplikacji z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Zwraca szczegóły niestandardowego emotikonu.

Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Zwraca szczegóły subskrypcji. Przykład znajdziesz w artykule Pobieranie szczegółowych informacji o członkostwie użytkownika lub aplikacji Google Chat.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z jednym z tych zakresów autoryzacji:

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora zostanie uwierzytelnione, use_admin_access jest true i używany jest jeden z tych zakresów autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

rpc GetMessage(GetMessageRequest) returns (Message)

Zwraca szczegółowe informacje o wiadomości. Przykład znajdziesz w artykule Wyświetlanie szczegółowych informacji o wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.bot: w przypadku użycia tego zakresu autoryzacji ta metoda zwraca szczegóły wiadomości, do których aplikacja Google Chat ma dostęp, np. wiadomości bezpośrednie i polecenia po ukośniku, które wywołują aplikację Google Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly z zatwierdzeniem przez administratora (dostępne w wersji przedpremierowej dla programistów); W przypadku użycia tego zakresu uwierzytelniania ta metoda zwraca szczegóły dotyczące publicznej wiadomości w pokoju.

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

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

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Zwraca szczegóły pokoju. Przykład znajdziesz w artykule Wyświetlanie szczegółów pokoju.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z jednym z tych zakresów autoryzacji:

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora zostanie uwierzytelnione, use_admin_access jest true i używany jest jeden z tych zakresów autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

Uwierzytelnianie aplikacji ma te ograniczenia:

  • Pole space.access_settings jest wypełniane tylko wtedy, gdy używany jest zakres chat.app.spaces.
  • Parametry space.predefind_permission_settings i space.permission_settings są wypełniane tylko w przypadku zakresu chat.app.spaces i tylko w przypadku pokoi utworzonych przez aplikację.
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Zwraca zdarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zmienionego zasobu. Jeśli na przykład poprosisz o zdarzenie dotyczące nowej wiadomości, ale wiadomość zostanie później zaktualizowana, serwer zwróci zaktualizowany zasób Message w ładunku zdarzenia.

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

Obsługuje te typy uwierzytelniania z zakresem autoryzacji odpowiednim do odczytywania żądanych danych:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora w wersji przedpremierowej z jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

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

Aby otrzymać zdarzenie, uwierzytelniony dzwoniący musi być członkiem pokoju.

Przykład znajdziesz w artykule Uzyskiwanie szczegółowych informacji o wydarzeniu z pokoju w Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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 po autoryzacji.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Pobiera ustawienie powiadomień o pokoju. Przykład znajdziesz w sekcji Pobieranie ustawień powiadomień o przestrzeni rozmówcy.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Zwraca szczegóły dotyczące stanu odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w artykule Pobieranie szczegółowych informacji o stanie odczytu przestrzeni użytkownika.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Zawiera listę niestandardowych emotikonów widocznych dla uwierzytelnionego użytkownika.

Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Wyświetla listę użytkowników pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Wymienianie członkostw z uwierzytelnianiem aplikacji obejmuje członkostwa w pokojach, do których aplikacja Google Chat ma dostęp, ale wyklucza członkostwa w aplikacji Google Chat, w tym własne. Wymienianie członkostw z uwierzytelnianiem użytkownika zawiera członkostwa w przestrzeniach, do których ma dostęp uwierzytelniony użytkownik.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z jednym z tych zakresów autoryzacji:

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora zostanie uwierzytelnione, use_admin_access jest true i używany jest jeden z tych zakresów autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Wyświetla listę wiadomości w pokoju, którego użytkownikiem jest wywołujący, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Nie są uwzględniane wiadomości systemowe, np. te, które informują o nowych członkach pokoju. Jeśli wyświetlisz listę wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. Jeśli używasz interfejsu REST/HTTP, odpowiedź zawiera pusty obiekt JSON, {}. Przykład znajdziesz w artykule Wyświetlanie listy wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzaniem przez administratora w wersji przedpremierowej z zakresem autoryzacji:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. W przypadku używania tego zakresu uwierzytelniania ta metoda zwraca tylko publiczne wiadomości na czacie. Nie obejmuje to wiadomości prywatnych.

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Zawiera listę reakcji na wiadomość. Przykład znajdziesz w artykule Wyświetlanie reakcji na wiadomość.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Wyświetla listę wydarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. Jeśli na przykład wymienisz wydarzenia dotyczące nowych członków przestrzeni, serwer zwróci zasoby Membership zawierające najnowsze informacje o członkostwie. Jeśli w okresie objętym żądaniem usunięto nowych członków, ładunek zdarzenia zawiera pusty zasób Membership.

Obsługuje te typy uwierzytelniania z zakresem autoryzacji odpowiednim do odczytywania żądanych danych:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora w wersji przedpremierowej z jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

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

Aby wyświetlać listę zdarzeń, uwierzytelniony wywołujący musi być członkiem pokoju.

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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 po autoryzacji.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Wyświetla pokoje, których element wywołujący jest członkiem. Czaty grupowe i czaty nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w artykule Wyświetlanie listy pokoi.

Obsługuje te typy uwierzytelniania:

Aby wyświetlić listę wszystkich nazwanych pokoi według organizacji Google Workspace, użyj metody spaces.search() z uprawnieniami administratora Workspace.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Zwraca listę przestrzeni w organizacji Google Workspace na podstawie wyszukiwania administratora. W prośbie ustaw wartość use_admin_access na true. Przykład znajdziesz w artykule Wyszukiwanie pokoi i zarządzanie nimi.

Wymaga uwierzytelnienia użytkownika z uprawnieniami administratora i jednego z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

Aby określić osoby, które chcesz dodać, dodaj członkostwo z odpowiednim membership.member.name. Aby dodać użytkownika, użyj 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 z interfejsu Directory API. Jeśli na przykład identyfikator profilu osoby w interfejsie People API dla [email protected] to 123456789, możesz dodać użytkownika do przestrzeni, ustawiając wartość membership.member.name na users/[email protected] lub users/123456789.

Aby określić grupy dyskusyjne Google do dodania, dodaj członkostwo z odpowiednim membership.group_member.name. Aby dodać lub zaprosić grupę Google, użyj 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 adresu e-mail grupy [email protected], a następnie dodać grupę do pokoju, ustawiając wartość membership.group_member.name na groups/123456789. E-mail grupowy nie jest obsługiwany, a grupy Google można dodawać tylko jako członków w pokojach z nazwą.

W przypadku pokoju z nazwą lub czatu grupowego, jeśli dzwoniący zablokuje niektórych członków lub zostanie przez nich zablokowany albo nie ma uprawnień do dodania niektórych członków, ci członkowie nie zostaną dodani do utworzonego pokoju.

Aby utworzyć czat między użytkownikiem dzwoniącym a innym użytkownikiem, określ dokładnie 1 członkostwo, które będzie reprezentować tego użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie się nie powiedzie, a wiadomość nie zostanie utworzona.

Aby utworzyć wiadomość bezpośrednią między użytkownikiem dzwoniącym a aplikacją dzwoniącą, ustaw wartość Space.singleUserBotDm na true i nie określaj żadnych członkostw. Za pomocą tej metody możesz skonfigurować tylko wiadomość bezpośrednią z aplikacją do dzwonienia. Aby dodać aplikację do dzwonienia jako członka pokoju lub istniejącej wiadomości bezpośredniej między 2 użytkownikami, przeczytaj artykuł Zapraszanie lub dodawanie użytkownika lub aplikacji do pokoju.

Jeśli między 2 użytkownikami istnieje już wiadomość na czacie, zostanie ona zwrócona, nawet jeśli w momencie wysłania żądania jeden z użytkowników zablokuje drugiego.

Przestrzenie z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i zakresem autoryzacji:

    • https://www.googleapis.com/auth/chat.app.memberships (tylko w pokojach utworzonych przez aplikację)

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, use_admin_access jest true i używany jest ten zakres autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zakresem autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

W przypadku uwierzytelniania aplikacji żądania mogą aktualizować tylko wiadomości utworzone przez wywołującą aplikację Google Chat.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

Jeśli aktualizujesz pole displayName i otrzymujesz 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.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora i jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora, use_admin_access jest true i używane są te zakresy autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.spaces

Uwierzytelnianie aplikacji ma te ograniczenia:

  • Aby zaktualizować space.predefined_permission_settings lub space.permission_settings, aplikacja musi być twórcą pokoju.
  • Aktualizowanie space.access_settings.audience nie jest obsługiwane w przypadku uwierzytelniania aplikacji.
Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Aktualizuje ustawienie powiadomień o pokoju. Przykład znajdziesz w artykule Aktualizowanie ustawień powiadomień o przestrzeni rozmówcy.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aktualizuje stan odczytu użytkownika w pokoju, aby można było określić, które wiadomości zostały przeczytane, a które nie. Przykład znajdziesz w artykule Aktualizowanie stanu odczytu pokoju użytkownika.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

AccessoryWidget

Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.

Pola
Pole zbiorcze 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, pod którym użytkownicy mogą się uwierzytelnić lub dokonać konfiguracji. (Dotyczy tylko typów odpowiedzi REQUEST_CONFIG).
dialog_action

DialogAction

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z oknem. Musi mu towarzyszyć ResponseType.Dialog.
updated_widget

UpdatedWidget

Tylko dane wejściowe. Odpowiedź z informacjami o zaktualizowanym widżecie.

ResponseType

Typ odpowiedzi aplikacji Google Chat.

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

SelectionItems

Lista wyników autouzupełniania widżetu.

Pola
items[]

SelectionItem

Tablica obiektów SelectionItem.

UpdatedWidget

W przypadku widżetów selectionInput zwraca sugestie autouzupełniania dla menu wielokrotnego wyboru.

Pola
widget

string

Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał żądanie aktualizacji.
Pole zbiorcze updated_widget. Widżet został zaktualizowany 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żetu

ActionStatus

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

Pola
status_code

Code

Kod stanu.
user_facing_message

string

Wiadomość, którą należy wysłać użytkownikom w sprawie stanu ich prośby. Jeśli nie jest ustawiony, wysyłany jest ogólny komunikat na podstawie status_code.

Adnotacja

Tylko dane wyjściowe. Adnotacje mogą być powiązane z treścią wiadomości w postaci zwykłego tekstu lub z elementami, które zawierają linki do zasobów Google Workspace, takich jak Dokumenty lub Arkusze Google, z wartościami start_index i length równymi 0. Aby dodać podstawowe formatowanie do wiadomości tekstowej, przeczytaj artykuł Formatowanie wiadomości tekstowych.

Przykładowa treść wiadomości w formacie 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ść podciągu w treści wiadomości w formie zwykłego tekstu, do którego odnosi się ta adnotacja. Jeśli nie jest obecny, oznacza długość 0.
start_index

int32

Indeks początkowy (liczony od zera, włącznie) w treści wiadomości w formacie zwykłego tekstu, do którego odnosi się ta adnotacja.
Pole zbiorcze metadata. Dodatkowe metadane dotyczące adnotacji. metadata może mieć tylko jedną z tych wartości:
user_mention

UserMentionMetadata

Metadane wzmianki o użytkowniku.
slash_command

SlashCommandMetadata

Metadane polecenia po ukośniku.
custom_emoji_metadata

CustomEmojiMetadata

Metadane niestandardowego emotikona.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
USER_MENTION Użytkownik jest wymieniony.
SLASH_COMMAND Wywoływane jest polecenie po ukośniku.
CUSTOM_EMOJI Adnotacja niestandardowego emotikona.

AppCommandMetadata

Metadane dotyczące polecenia aplikacji Google Chat.

Pola
app_command_id

int32

Identyfikator polecenia określony w konfiguracji interfejsu Chat API.
app_command_type

AppCommandType

Typ polecenia aplikacji Google Chat.

AppCommandType

Typ polecenia aplikacji Google Chat. Więcej informacji znajdziesz w artykule Rodzaje poleceń aplikacji na czacie.

Wartości w polu enum
APP_COMMAND_TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
SLASH_COMMAND polecenie po ukośniku, Użytkownik wysyła polecenie w wiadomości na czacie.
QUICK_COMMAND szybkie polecenie, Użytkownik wybiera polecenie z menu Google Chat w obszarze odpowiedzi na wiadomość.

AttachedGif

Obraz GIF określony przez adres 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

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

string

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

string

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

string

Tylko dane wyjściowe. Adres URL miniatury, która powinna być używana do wyświetlania podglądu załącznika użytkownikowi. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania treści załączników.
download_uri

string

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

Source

Tylko dane wyjściowe. Źródło załącznika.
Pole zbiorcze data_ref. Odwołanie do danych załącznika. data_ref może mieć tylko jedną z tych wartości:
attachment_data_ref

AttachmentDataRef

Opcjonalnie. Odwołanie do danych załącznika. To pole służy do tworzenia lub aktualizowania wiadomości z załącznikami albo do pobierania danych załączników za pomocą interfejsu Media API.
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 z Dysku Google.
UPLOADED_CONTENT Plik zostanie przesłany do Google Chat.

AttachmentDataRef

Odwołanie do danych załącznika.

Pola
resource_name

string

Opcjonalnie. Nazwa zasobu danych załącznika. To pole jest używane w interfejsie Media API do pobierania danych załącznika.
attachment_upload_token

string

Opcjonalnie. Nieprzezroczysty token zawierający odniesienie do przesłanego załącznika. Traktowany przez klientów jako nieprzejrzysty ciąg znaków i używany do tworzenia lub aktualizowania wiadomości na czacie z załącznikami.

CalendarEventLinkData

Dane dotyczące linków do wydarzeń w Kalendarzu.

Pola
calendar_id

string

Identyfikator kalendarza połączonego kalendarza.
event_id

string

Identyfikator wydarzenia powiązanego wydarzenia w Kalendarzu.

CardWithId

Karta w wiadomości Google Chat.

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

Projektuj i wyświetlaj podgląd kart za pomocą narzędzia do tworzenia kart.

Otwórz narzędzie do tworzenia kart

Pola
card_id

string

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

Card

Kartę Maksymalny rozmiar to 32 KB.

ChatSpaceLinkData

Dane dotyczące linków do pokoi czatu.

Pola
space

string

Pokój powiązanego zasobu pokoju Google Chat.

Format: spaces/{space}
thread

string

Wątek połączonego zasobu pokoju Google Chat.

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

string

Wiadomość z połączonego zasobu pokoju czatu.

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

CompleteImportSpaceRequest

Wiadomość z prośbą o dokończenie procesu importowania w przypadku pokoju.

Pola
name

string

Wymagane. Nazwa zasobu pokoju w trybie importowania.

Format: spaces/{space}

CompleteImportSpaceResponse

Wiadomość z odpowiedzią po zakończeniu procesu importowania pokoju.

Pola
space

Space

Przestrzeń w trybie importowania.

ContextualAddOnMarkup

Ten typ nie ma pól.

Znaczniki, które deweloperzy mogą stosować do określania zawartości dodatku kontekstowego.

Karta

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

Pola
header

CardHeader

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

Section

Sekcje są oddzielone linią.
card_actions[]

CardAction

Czynności na tej karcie.
name

string

Nazwa karty.

CardAction

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

Nie są obsługiwane przez aplikacje Google Chat.

Pola
action_label

string

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

OnClick

Działanie po kliknięciu tego elementu działania.

CardHeader

Pola
title

string

Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli podasz zarówno tytuł, jak i podtytuł, każdy z nich zajmie jeden wiersz. Jeśli podasz tylko tytuł, zajmie on 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 Okrągłe obramowanie.

Sekcja

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

Pola
header

string

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

WidgetMarkup

Sekcja musi zawierać co najmniej 1 widżet.

CreateCustomEmojiRequest

Prośba o utworzenie niestandardowego emotikona.

Pola
custom_emoji

CustomEmoji

Wymagane. Niestandardowy emotikon do utworzenia.

CreateMembershipRequest

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

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzone uczestnictwo.

Format: spaces/{space}
membership

Membership

Wymagane. Relacja subskrypcji do utworzenia.

Pole memberType musi zawierać użytkownika z wypełnionymi polami user.name i user.type. Serwer przypisze nazwę zasobu i zastąpi wszystko, co zostało określone.

Gdy aplikacja do obsługi czatu tworzy relację członkostwa dla użytkownika, musi używać określonych zakresów autoryzacji i ustawiać określone wartości w niektórych polach:

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

  • Podczas uwierzytelniania jako aplikacja wymagany jest chat.app.memberships zakres autoryzacji.

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

Zapraszanie użytkowników spoza organizacji Workspace, do której należy pokój, wymaga uwierzytelnienia użytkownika.

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

bool

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Tworzenie członkostwa w aplikacji lub tworzenie członkostwa dla użytkowników spoza organizacji Google Workspace administratora nie jest obsługiwane w przypadku dostępu administracyjnego.

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: zamiast niej używaj zasady thread.thread_key. Identyfikator wątku. Obsługuje do 4000 znaków. Aby rozpocząć wątek lub dodać do niego wiadomość, utwórz wiadomość i określ threadKey lub thread.name. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie w nim.
request_id

string

Opcjonalnie. Unikalny identyfikator żądania dla tej wiadomości. Określenie istniejącego identyfikatora żądania spowoduje zwrócenie wiadomości utworzonej za pomocą tego identyfikatora zamiast utworzenia nowej wiadomości.
message_reply_option

MessageReplyOption

Opcjonalnie. Określa, czy wiadomość rozpoczyna wątek, czy jest odpowiedzią w wątku. Ta funkcja jest obsługiwana tylko w nazwanych pokojach.

Podczas odpowiadania na interakcje użytkownika to pole jest ignorowane. W przypadku interakcji w wątku odpowiedź jest tworzona w tym samym wątku. W przeciwnym razie odpowiedź zostanie utworzona jako nowy wątek.
message_id

string

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

Wartość tego pola 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.
  • Zawiera maksymalnie 63 znaki, w tym tylko małe litery, cyfry i łączniki.
  • Jest unikalny w obrębie przestrzeni. Aplikacja do czatu nie może używać tego samego identyfikatora niestandardowego w przypadku różnych wiadomości.

Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości.

MessageReplyOption

Określa sposób odpowiadania 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 lub thread_key.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub thread_key. Jeśli się nie uda, wiadomość rozpocznie nowy wątek.
REPLY_MESSAGE_OR_FAIL Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub thread_key. Jeśli użyjesz nowego kodu thread_key, utworzysz nowy wątek. Jeśli utworzenie wiadomości się nie powiedzie, zamiast tego zwracany jest błąd NOT_FOUND.

CreateReactionRequest

Tworzy reakcję na wiadomość.

Pola
parent

string

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

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

Reaction

Wymagane. Reakcja do utworzenia.

CreateSpaceRequest

Żądanie utworzenia nazwanego pokoju bez użytkowników.

Pola
space

Space

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

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

Miejsce name jest przypisywane na serwerze, więc wszystko, co zostanie określone w tym polu, zostanie zignorowane.
request_id

string

Opcjonalnie. Unikalny identyfikator tego żądania. Zalecany jest losowy identyfikator UUID. Określenie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego za pomocą tego identyfikatora zamiast utworzenia nowego pokoju. Określenie istniejącego identyfikatora prośby z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem spowoduje zwrócenie błędu.

CustomEmoji

Reprezentuje niestandardowy emotikon.

Pola
name

string

Identyfikator. Nazwa zasobu niestandardowego emoji przypisana przez serwer.

Format: customEmojis/{customEmoji}
uid

string

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

string

Opcjonalnie. Niezmienne. Nazwa niestandardowego emotikona podana przez użytkownika, która jest unikalna w organizacji.

Wymagane podczas tworzenia niestandardowego emotikona, w innych przypadkach tylko dane wyjściowe.

Nazwy emoji muszą zaczynać się i kończyć dwukropkiem, być zapisane małymi literami i mogą zawierać tylko znaki alfanumeryczne, łączniki i podkreślenia. Podkreślenia i łączniki powinny być używane do oddzielania słów i nie można ich wpisywać kolejno po sobie.

Przykład: :valid-emoji-name:
temporary_image_uri

string

Tylko dane wyjściowe. Tymczasowy adres URL obrazu niestandardowego emoji, ważny przez co najmniej 10 minut. Pamiętaj, że ta wartość nie jest wypełniana w odpowiedzi podczas tworzenia niestandardowego emotikona.
payload

CustomEmojiPayload

Opcjonalnie. Tylko dane wejściowe. Dane ładunku. Wymagane podczas tworzenia niestandardowego emotikona.

CustomEmojiPayload

Dane ładunku niestandardowego emotikona.

Pola
file_content

bytes

Wymagane. Tylko dane wejściowe. Obraz użyty w niestandardowym emotikonie.

Rozmiar ładunku musi być mniejszy niż 256 KB, a wymiary obrazu muszą być kwadratowe i mieścić się w zakresie od 64 do 500 pikseli. Ograniczenia mogą ulec zmianie.
filename

string

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

Obsługiwane rozszerzenia plików: .png, .jpg, .gif.

CustomEmojiMetadata

Metadane adnotacji dla niestandardowych emotikonów.

Pola
custom_emoji

CustomEmoji

Niestandardowy emotikon.

DeleteCustomEmojiRequest

Prośba o usunięcie niestandardowego emotikona.

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emotikona do usunięcia.

Format: customEmojis/{customEmoji}

Nazwy emoji możesz używać jako aliasu dla {customEmoji}. Na przykład customEmojis/:example-emoji:, gdzie :example-emoji: to nazwa niestandardowego emotikonu.

DeleteMembershipRequest

Prośba o usunięcie uczestnika z pokoju.

Pola
name

string

Wymagane. Nazwa zasobu uczestnictwa do usunięcia. Aplikacje do czatowania mogą usuwać członkostwo użytkowników lub własne. Aplikacje do obsługi czatu nie mogą usuwać członkostwa w innych aplikacjach.

Usuwanie członkostwa użytkownika wymaga zakresu chat.memberships z uwierzytelnianiem użytkownika lub zakresu chat.memberships.app z uwierzytelnianiem aplikacji i formatu spaces/{space}/members/{member}. Możesz użyć tego adresu e-mail jako aliasu dla {member}. Na przykład spaces/{space}/members/[email protected], gdzie [email protected] to adres e-mail użytkownika Google Chat.

Usuwanie członkostwa w aplikacji wymaga zakresu chat.memberships.app i formatu spaces/{space}/members/app.

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

bool

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Usuwanie członkostwa w aplikacji w pokoju nie jest obsługiwane 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 niestandardowy identyfikator wiadomości, możesz użyć wartości z pola clientAssignedMessageId w przypadku parametru {message}. Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości.
force

bool

Opcjonalnie. Gdy true, usunięcie wiadomości powoduje też usunięcie odpowiedzi w wątku. Gdy false, jeśli wiadomość zawiera odpowiedzi w wątku, usunięcie się nie powiedzie.

Dotyczy tylko uwierzytelniania jako użytkownik. Nie ma wpływu na uwierzytelnianie jako aplikacja do obsługi czatu.

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

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

Wymaga chat.admin.delete zakresu OAuth 2.0.

DeletionMetadata

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

Pola
deletion_type

DeletionType

Wskazuje, kto usunął wiadomość.

DeletionType

kto i w jaki sposób usunął wiadomość; W przyszłości możemy dodać więcej wartości. Szczegółowe informacje o tym, kiedy można usunąć wiadomości, znajdziesz w artykule Edytowanie i usuwanie wiadomości w Google Chat.

Wartości w polu enum
DELETION_TYPE_UNSPECIFIED Ta wartość nie jest używana.
CREATOR Użytkownik usunął własną wiadomość.
SPACE_OWNER Menedżer pokoju usunął wiadomość.
ADMIN Administrator Google Workspace usunął wiadomość. Administratorzy mogą usuwać dowolne wiadomości w pokoju, w tym wiadomości wysłane przez dowolnego członka pokoju lub aplikację Chat.
APP_MESSAGE_EXPIRY Aplikacja Google Chat usunęła swoją wiadomość po wygaśnięciu.
CREATOR_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu twórcy (przy użyciu uwierzytelniania użytkownika).
SPACE_OWNER_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu menedżera pokoju (przy użyciu uwierzytelniania użytkownika).
SPACE_MEMBER Wiadomość została usunięta przez osobę w pokoju. Użytkownicy mogą usuwać wiadomości wysłane przez aplikacje.

Dialog

Kontener wokół treści karty w oknie.

Pola
body

Card

Tylko dane wejściowe. Treść okna, która jest renderowana w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów karty: DateTimePicker, OnChangeAction.

DialogAction

Zawiera dialog i kod stanu żądania.

Pola
action_status

ActionStatus

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

Dialog

Tylko dane wejściowe. Okno dotyczące prośby.

DriveDataRef

Odwołanie do danych załącznika z Dysku.

Pola
drive_file_id

string

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

DriveLinkData

Dane dotyczące linków do Dysku Google.

Pola
drive_data_ref

DriveDataRef

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

string

Typ MIME połączonego zasobu Dysku Google.

Emotikony

Emotikon używany jako reakcja na wiadomość.

Pola
Pole zbiorcze content. Wymagane. Treść emotikona. content może mieć tylko jedną z tych wartości:
unicode

string

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

CustomEmoji

niestandardowy emotikon,

EmojiReactionSummary

Liczba osób, które zareagowały na wiadomość za pomocą określonego emotikona.

Pola
emoji

Emoji

Tylko dane wyjściowe. Emotikon powiązany z reakcjami.
reaction_count

int32

Tylko dane wyjściowe. Łączna liczba reakcji z użyciem powiązanego emotikona.

FindDirectMessageRequest

Prośba o uzyskanie dostępu do pokoju na czacie na podstawie zasobu użytkownika.

Pola
name

string

Wymagane. Nazwa zasobu użytkownika, z którym chcesz znaleźć wiadomość na czacie.

Format: users/{user}, gdzie {user} to id dla osoby z interfejsu People API lub id dla użytkownika z interfejsu Directory API. Jeśli na przykład identyfikator profilu w interfejsie People API to 123456789, możesz znaleźć bezpośrednią wiadomość do tej osoby, używając users/123456789 jako name. Gdy uwierzytelniono Cię jako użytkownika, możesz używać adresu e-mail jako aliasu dla {user}. Na przykład users/[email protected], gdzie [email protected] to adres e-mail użytkownika Google Chat.

GetAttachmentRequest

Prośba o otrzymanie załącznika.

Pola
name

string

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

GetCustomEmojiRequest

Żądanie zwrócenia pojedynczego niestandardowego emotikona.

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emoji.

Format: customEmojis/{customEmoji}

Nazwy emoji możesz używać jako aliasu dla {customEmoji}. Na przykład customEmojis/:example-emoji:, gdzie :example-emoji: to nazwa niestandardowego emotikonu.

GetMembershipRequest

Wysyłanie prośby o dołączenie do pokoju.

Pola
name

string

Wymagane. Nazwa zasobu uczestnictwa do pobrania.

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

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

Możesz użyć adresu e-mail użytkownika jako aliasu dla {member}. Na przykład spaces/{space}/members/[email protected], gdzie [email protected] to adres e-mail użytkownika Google Chat.
use_admin_access

bool

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

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

Uzyskiwanie członkostwa w aplikacjach w przestrzeni nie jest obsługiwane w przypadku korzystania z dostępu administratora.

GetMessageRequest

Poproś o otrzymanie wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli masz ustawiony niestandardowy identyfikator wiadomości, możesz użyć wartości z pola clientAssignedMessageId w przypadku parametru {message}. Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości.

GetSpaceEventRequest

Wiadomość z prośbą o zdarzenie w pokoju.

Pola
name

string

Wymagane. Nazwa zasobu zdarzenia w pokoju.

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

GetSpaceNotificationSettingRequest

Wiadomość z prośbą o ustawienie powiadomień o miejscach. Obsługuje tylko pobieranie ustawień powiadomień dla użytkownika, który dzwoni.

Pola
name

string

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

  • users/me/spaces/{space}/spaceNotificationSettingLUB
  • users/[email protected]/spaces/{space}/spaceNotificationSettingLUB
  • users/123456789/spaces/{space}/spaceNotificationSetting. Uwaga: w ścieżce dozwolony jest tylko identyfikator użytkownika lub adres e-mail dzwoniącego.

GetSpaceReadStateRequest

Komunikat żądania interfejsu API GetSpaceReadState.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu pokoju do pobrania.

Obsługuje tylko pobieranie stanu odczytu dla użytkownika, który wywołuje funkcję.

Aby odwołać się do użytkownika wywołującego, ustaw jedną z tych wartości:

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

  • adres e-mail Workspace, Na przykład: users/[email protected]/spaces/{space}/spaceReadState.

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

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

GetSpaceRequest

Żądanie zwrócenia pojedynczego miejsca.

Pola
name

string

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

Format: spaces/{space}
use_admin_access

bool

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

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

GetThreadReadStateRequest

Komunikat żądania interfejsu API GetThreadReadStateRequest.

Pola
name

string

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

Obsługuje tylko pobieranie stanu odczytu dla użytkownika, który wywołuje funkcję.

Aby odwołać się do użytkownika wywołującego, ustaw jedną z tych wartości:

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

  • adres e-mail Workspace, Na przykład: users/[email protected]/spaces/{space}/threads/{thread}/threadReadState.

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

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

Grupa

Grupy dyskusyjnej Google w Google Chat.

Pola
name

string

Nazwa zasobu grupy Google.

Reprezentuje grupę w Cloud Identity Groups API.

Format: groups/{group}

HistoryState

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

Wartości w polu enum
HISTORY_STATE_UNSPECIFIED Wartość domyślna. Nie używać.
HISTORY_OFF Historia wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny.
HISTORY_ON Historia włączona. Reguły przechowywania w Vault organizacji określają, jak długo wiadomości i wątki są przechowywane.

ListCustomEmojisRequest

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

Pola
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych niestandardowych emotikonów. Usługa może zwrócić mniej niestandardowych emoji niż ta wartość. Jeśli nie podasz żadnej opcji, domyślna wartość to 25. Wartość maksymalna to 200. Wartości powyżej 200 są zmieniane na 200.
page_token

string

Opcjonalnie. (Jeśli wznawiasz poprzednie zapytanie).

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

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

string

Opcjonalnie. filtr zapytania,

Obsługuje filtrowanie według twórcy.

Aby filtrować według twórcy, musisz podać prawidłową wartość. Obecnie do filtrowania niestandardowych emotikonów pod kątem tego, czy zostały utworzone przez dzwoniącego użytkownika, akceptowane są tylko wartości creator("users/me") i NOT creator("users/me").

Na przykład to zapytanie zwraca niestandardowe emotikony utworzone przez osobę wywołującą:

creator("users/me")

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

ListCustomEmojisResponse

Odpowiedź z listą niestandardowych emotikonów.

Pola
custom_emojis[]

CustomEmoji

Lista nieuporządkowana. Lista niestandardowych emotikonów.
next_page_token

string

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

ListMembershipsRequest

Wiadomość z prośbą o dodanie wspierania.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, dla którego chcesz pobrać listę osób.

Format: spaces/{space}
page_size

int32

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

Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 subskrypcji.

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

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

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wspierających. Podaj ten parametr, aby pobrać następną stronę.

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

string

Opcjonalnie. filtr zapytania,

Możesz filtrować członkostwa według roli (role) i typu (member.type) członka.

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

Aby filtrować według typu, ustaw wartość member.type na HUMAN lub BOT. Możesz też filtrować wyniki pod kątem member.type za pomocą operatora !=.

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

Jeśli parametr use_admin_access ma wartość „true”, wymagany jest parametr member.type = "HUMAN" lub member.type != "BOT". Filtry innych typów członków zostaną odrzucone.

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

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

member.type != "BOT"

Te zapytania są nieprawidłowe:

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

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

bool

Opcjonalnie. Gdy true, zwraca też wspieranie powiązane z Google Group, oprócz innych rodzajów wspierania. Jeśli ustawiono filter, nie są zwracane subskrypcje Google Group, które nie spełniają kryteriów filtra.
show_invited

bool

Opcjonalnie. Gdy true, zwraca też wspieranie kanału powiązane z invited, oprócz innych rodzajów wspierania. Jeśli filtr jest ustawiony, invited subskrypcje, które nie spełniają kryteriów filtra, nie są zwracane.

Obecnie wymaga uwierzytelnienia użytkownika.
use_admin_access

bool

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień administratora Google Workspace użytkownika.

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

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

Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane w przypadku korzystania z dostępu administracyjnego.

ListMembershipsResponse

Odpowiedź na listę osób w pokoju.

Pola
memberships[]

Membership

Lista nieuporządkowana. Lista członkostw na żądanej (lub pierwszej) stronie.
next_page_token

string

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

ListMessagesRequest

Wyświetla wiadomości w określonym pokoju, do którego należy użytkownik.

Pola
parent

string

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

Format: spaces/{space}
page_size

int32

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

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 25 wyników.

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

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

string

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

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

string

Opcjonalnie. 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, podaj create_time ze znacznikiem czasu w formacie RFC-3339 i cudzysłowem. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większości >, aby wyświetlić listę wiadomości utworzonych po sygnaturze czasowej, lub operatora mniejszości <, aby wyświetlić listę wiadomości utworzonych przed sygnaturą czasową. Aby filtrować wiadomości w przedziale czasu, użyj operatora AND między dwoma sygnaturami czasowymi.

Aby filtrować według wątku, podaj thread.name w formacie spaces/{space}/threads/{thread}. W każdym zapytaniu możesz określić tylko 1 element thread.name.

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

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

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

Opcjonalnie. Określa kolejność wyświetlania listy wiadomości. Określ wartość, według której ma być wykonane sortowanie. Prawidłowe wartości operacji zamawiania:

  • ASC – rosnąco.

  • DESC – malejąco.

Domyślna kolejność to create_time ASC.
show_deleted

bool

Opcjonalnie. Czy uwzględniać usunięte wiadomości. Usunięte wiadomości zawierają czas usunięcia i metadane dotyczące usunięcia, ale treść wiadomości jest niedostępna.

ListMessagesResponse

Wiadomość odpowiedzi dotycząca wyświetlania 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 jest puste, nie ma kolejnych stron.

ListReactionsRequest

Zawiera 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 zwracanych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie podasz żadnej opcji, domyślna wartość to 25. Wartość maksymalna to 200. Wartości powyżej 200 są zmieniane na 200.
page_token

string

Opcjonalnie. (Jeśli wznawiasz poprzednie zapytanie).

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

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

string

Opcjonalnie. filtr zapytania,

Możesz filtrować reakcje według emotikonu (emoji.unicode lub emoji.custom_emoji.uid) i użytkownika (user.name).

Aby filtrować reakcje według wielu emotikonów lub użytkowników, połą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 emotikonu i użytkownika, użyj operatora AND, np. emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Jeśli zapytanie zawiera zarówno symbol AND, jak i OR, zgrupuj je za pomocą nawiasów.

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

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

Te zapytania są nieprawidłowe:

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

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

ListReactionsResponse

Odpowiedź na żądanie listy reakcji.

Pola
reactions[]

Reaction

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

string

Token kontynuacji do pobrania następnej strony wyników. W przypadku ostatniej strony wyników jest puste.

ListSpaceEventsRequest

Prośba o wiadomość dotyczącą wydarzeń w przestrzeni na liście.

Pola
parent

string

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

Format: spaces/{space}.
page_size

int32

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

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

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wydarzeń w przestrzeni. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do zdarzeń przestrzeni listy muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Wymagane. filtr zapytania,

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

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

  • start_time: Wyłączna sygnatura czasowa, od której należy rozpocząć wyświetlanie wydarzeń w przestrzeni. Możesz wyświetlać wydarzenia, które miały miejsce maksymalnie 28 dni temu. Jeśli nie podasz żadnej wartości, wyświetli listę wydarzeń związanych z przestrzenią z ostatnich 28 dni.
  • end_time: sygnatura czasowa, do której włącznie są wymienione wydarzenia w pokoju. Jeśli nie określono tego parametru, wyświetlane są zdarzenia do momentu wysłania żądania.

Aby określić godzinę rozpoczęcia lub zakończenia, użyj operatora równości = i formatu RFC-3339. Aby filtrować według obu tych wartości, użyj operatora AND.start_timeend_time

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

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

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

Te zapytania są nieprawidłowe:

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

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

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

ListSpaceEventsResponse

Wiadomość z odpowiedzią dotyczącą wyświetlania wydarzeń w przestrzeni.

Pola
space_events[]

SpaceEvent

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

string

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

ListSpacesRequest

Prośba o wyświetlenie listy pokoi, w których użytkownik jest członkiem.

Pola
page_size

int32

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

Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 miejsc.

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ć następną stronę.

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

string

Opcjonalnie. filtr zapytania,

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

Aby filtrować według typu miejsca, musisz podać prawidłową wartość wyliczeniową, np. SPACE lub GROUP_CHAT (wartość space_type nie może być równa SPACE_TYPE_UNSPECIFIED). Aby wysłać zapytanie o wiele typów miejsc, użyj operatora OR.

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

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 listy pokoi.

Pola
spaces[]

Space

Lista pokoi na żądanej (lub pierwszej) stronie. Uwaga: pole permissionSettings nie jest zwracane w obiekcie Space w przypadku żądań listy.
next_page_token

string

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

MatchedUrl

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

Pola
url

string

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

MeetSpaceLinkData

Dane dotyczące linków do pokoi w Meet.

Pola
meeting_code

string

Kod spotkania w połączonym pokoju w Meet.
type

Type

Wskazuje typ pokoju w Meet.
huddle_status

HuddleStatus

Opcjonalnie. Tylko dane wyjściowe. Jeśli Meet to spotkanie Huddle, wskazuje stan spotkania. W przeciwnym razie to pole nie jest ustawione.

HuddleStatus

Stan spotkania

Wartości w polu enum
HUDDLE_STATUS_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
STARTED Rozpoczęto szybkie spotkanie.
ENDED Szybkie spotkanie zostało zakończone. W takim przypadku identyfikator URI i identyfikatory pokoju w Meet przestaną być ważne.
MISSED Rozmowa Huddle została pominięta. W takim przypadku identyfikator URI i identyfikatory pokoju w Meet przestaną być ważne.

Typ

Typ pokoju w Meet.

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
MEETING Przestrzeń Meet to spotkanie.
HUDDLE Przestrzeń Meet to mała sala konferencyjna.

Członkostwo

Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja Google Chat jest zaproszony do pokoju, należy do niego czy nie.

Pola
name

string

Identyfikator. Nazwa zasobu uczestnictwa 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, jakie działania może on wykonywać w tym pokoju.

To pole może być używane jako dane wejściowe tylko w UpdateMembership.
create_time

Timestamp

Opcjonalnie. Niezmienne. Czas utworzenia członkostwa, np. gdy użytkownik dołączył do pokoju lub otrzymał zaproszenie do dołączenia do niego. To pole jest tylko danymi wyjściowymi, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.
delete_time

Timestamp

Opcjonalnie. Niezmienne. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko danymi wyjściowymi, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.
Pole zbiorcze memberType. Uczestnik powiązany z tym członkostwem. W przyszłości możemy dodać obsługę innych typów użytkowników. memberType może mieć tylko jedną z tych wartości:
member

User

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

Group

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

Odczytywanie lub zmienianie członkostwa w grupach dyskusyjnych Google wymaga uwierzytelnienia użytkownika.

MembershipRole

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

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. W przypadku users: nie jest użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups: zawsze przypisana jest do nich ta rola (w przyszłości mogą być używane inne wartości wyliczeniowe).
ROLE_MEMBER

osoba w pokoju, W interfejsie czatu ta rola nosi nazwę Uczestnik.

Użytkownik ma podstawowe uprawnienia, takie jak wysyłanie wiadomości na czacie. Menedżerowie i właściciele mogą przyznawać użytkownikom dodatkowe uprawnienia w pokoju, w tym:

  • Dodaj lub usuń członków.
  • modyfikować szczegóły pokoju,
  • włączanie i wyłączanie historii,
  • Wzmianka o wszystkich osobach w pokoju za pomocą @all.
  • zarządzać aplikacjami i webhookami Google Chat zainstalowanymi w pokoju.

Na czatach i czatach grupowych bez nazwy każda osoba ma tę rolę.
ROLE_MANAGER

właściciel pokoju, W interfejsie czatu ta rola jest nazywana właścicielem.

Użytkownik ma pełny zestaw uprawnień do pokoju, w tym:

  • zmieniać rolę innych członków pokoju na członka, menedżera lub właściciela;
  • usunąć pokój.

Obsługiwane tylko w SpaceType.SPACE (nazwane pokoje).

Więcej informacji znajdziesz w artykule Więcej informacji o roli właściciela lub menedżera pokoju.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości możemy dodać obsługę innych stanów członkowskich.

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 został zaproszony do pokoju, ale nie dołączył do niego.
NOT_A_MEMBER Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do niego.

MembershipBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych subskrypcji.

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

Pola
memberships[]

MembershipCreatedEventData

Lista nowych wspierających.

MembershipBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych subskrypcji.

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

Pola
memberships[]

MembershipDeletedEventData

Lista usuniętych wsparć.

MembershipBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych subskrypcji.

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

Pola
memberships[]

MembershipUpdatedEventData

Lista zaktualizowanych wspierań.

MembershipCreatedEventData

Ładunek zdarzenia w przypadku nowej subskrypcji.

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

Pola
membership

Membership

nowe Wspieranie,

MembershipDeletedEventData

Ładunek zdarzenia w przypadku usuniętego członkostwa.

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

Pola
membership

Membership

Usunięte wspieranie. Wypełnione są tylko pola name i state.

MembershipUpdatedEventData

Ładunek zdarzenia w przypadku zaktualizowanej subskrypcji.

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

Pola
membership