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