Package google.chat.v1

Indeks

ChatService

Umożliwia programistom tworzenie aplikacji i integracji 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 użyciem zakresu 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 aplikacjizatwierdzeniem przez administratorawersji przedpremierowej i zakres 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 pokoju w Google Chat.

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 namethread.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 pokoju nazwanego lub czatu grupowego w Import mode. Przykład znajdziesz w artykule Tworzenie pokoju.

Obsługuje te typy uwierzytelniania:

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 Google Chat 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 użyciem zakresu 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 aplikacjizatwierdzeniem przez administratorawersji przedpremierowej i zakres 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 aplikacjizatwierdzeniem przez administratorawersji przedpremierowej i zakres 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 znaleziono miejsca 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 aplikacjizakresem 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 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.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy uwierzytelnione jest konto administratora use_admin_access, 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.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:

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku 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 uwierzytelnione jest konto administratora use_admin_access, 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_settingsspace.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.

Wymaga uwierzytelnienia użytkownikazakresem autoryzacji odpowiednim do odczytywania żądanych danych:

  • 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 użytkownik 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.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 ustawienia powiadomień o pokoju. Przykład znajdziesz w sekcji Pobieranie ustawień powiadomień o przestrzeni rozmówcy.

Wymaga uwierzytelnienia użytkownika z użyciem zakresu 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, używane 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)

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Wyświetla listę wiadomości w pokoju, którego użytkownikiem jest osoba wywołująca, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Jeśli wyświetlisz listę wiadomości z pokoju, w którym nie ma 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.

Wymaga uwierzytelnienia 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

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 Membership zasoby 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.

Wymaga uwierzytelnienia użytkownikazakresem autoryzacji odpowiednim do odczytywania żądanych danych:

  • 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ę wydarzeń, uwierzytelniony użytkownik musi być członkiem przestrzeni.

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

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

W prośbie ustaw wartość use_admin_access na true.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku 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 user@example.com to 123456789, możesz dodać użytkownika do przestrzeni, ustawiając wartość membership.member.name na users/user@example.com 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 group@example.com, 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 użytkownika pokoju lub istniejącej wiadomości bezpośredniej między 2 osobami, 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 aplikacjizatwierdzeniem przez administratorawersji przedpremierowej i zakres 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 patchupdate 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 pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wyświetlanej nazwy. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacjizatwierdzeniem przez administratorawersji przedpremierowej 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.
  • Aktualizacja space.access_settings.audience nie jest obsługiwana 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 użyciem zakresu 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 rozróżniać przeczytane i nieprzeczytane wiadomości. Przykład znajdziesz w artykule Aktualizowanie stanu odczytu pokoju użytkownika.

Wymaga uwierzytelnienia użytkownika z użyciem zakresu 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 unii 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 Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.

Pola
type

ResponseType

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

url

string

Tylko dane wejściowe. Adres URL, 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 zdarzenie z pasującym adresem URL lub CARD_CLICKED zdarzenie, 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 unii 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łana jest ogólna wiadomość na podstawie status_code.

Adnotacja

Tylko dane wyjściowe. Adnotacje powiązane z treścią wiadomości w formacie zwykłego tekstu. 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.

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 unii 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 unii 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 nieprzezroczysty ciąg znaków i używany do tworzenia lub aktualizowania wiadomości na czacie z załącznikami.

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

Pokój w trybie importowania.

ContextualAddOnMarkup

Ten typ nie ma pól.

Znaczniki, które deweloperzy mogą stosować, aby określać zawartość 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: usuń fakturę, wyślij fakturę e-mailem lub otwórz fakturę w przeglądarce.

Nieobsł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 onclick dla 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. kwadratowa lub okrągła ramka).

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 określonej kolejności. Na wszystkich platformach karty mają wąską, stałą szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).

Pola
header

string

Nagłówek sekcji. Obsługiwany jest 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 członkostwo.

Format: spaces/{space}

membership

Membership

Wymagane. Relacja subskrypcji do utworzenia.

Pole memberType musi zawierać użytkownika z wypełnionymi polami user.nameuser.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 przypadku niektórych pól:

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

  • Podczas uwierzytelniania jako aplikacja wymagany jest chat.app.membershipszakres autoryzacji. Uwierzytelnianie jako aplikacja jest dostępne w

  • Ustaw user.type na HUMAN, a user.name na format 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 user@example.com to 123456789, możesz dodać użytkownika do przestrzeni, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.

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

Gdy aplikacja Chat 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 pokoju.

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 chcesz utworzyć wiadomość.

Format: spaces/{space}

message

Message

Wymagane. Treść wiadomości.

thread_key
(deprecated)

string

Opcjonalnie. Wycofana: 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 lub odpowiadanie w wątku.

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.SPACESpaceType.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 identyfikatora istniejącej 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.membershipsuwierzytelnianiem użytkownika lub zakresu chat.memberships.appuwierzytelnianiem 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/example@gmail.com, gdzie example@gmail.com 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 pokoju.

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

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 okno dialogowe 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 unii 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żywanie 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 unii 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ści 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/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

GetAttachmentRequest

Prośba o pobranie załącznika.

Pola
name

string

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

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 adresu {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

use_admin_access

bool

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

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}/spaceNotificationSetting LUB
  • users/user@example.com/spaces/{space}/spaceNotificationSettingLUB
  • users/123456789/spaces/{space}/spaceNotificationSetting. Uwaga: w ścieżce dozwolony jest tylko identyfikator użytkownika lub adres e-mail osoby dzwoniącej.

GetSpaceReadStateRequest

Komunikat żądania interfejsu API GetSpaceReadState.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu przestrzeni 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/user@example.com/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 pokoju.

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/user@example.com/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 użytkownika dzwoniącego, czy nie, 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 zwracanych wspierań. 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 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 pokoju.

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 chcesz wyświetlić listę 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ększe niż” >, aby wyświetlić listę wiadomości utworzonych po sygnaturze czasowej, lub operatora „mniejsze niż” <, 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 wartość 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ć przeprowadzona operacja porządkowania. Prawidłowe wartości operacji zamawiania są następujące:

  • 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

Wiadomość z prośbą o wyświetlanie wydarzeń dotyczących przestrzeni reklamowej.

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 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ąć listowanie wydarzeń w przestrzeni. Możesz wyświetlać wydarzenia, które miały miejsce maksymalnie 28 dni temu. Jeśli nie podasz żadnych informacji, wyświetli listę wydarzeń związanych z przestrzenią z ostatnich 28 dni.
  • end_time: sygnatura czasowa, do której włącznie wymienione są wydarzenia w przestrzeni. 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.

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 jest w nim obecny.

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

To pole może być używane jako dane wejściowe tylko w przypadku 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 polem wyjściowym, 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 polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

Pole unii memberType. Uczestnik powiązany z tym członkostwem. W przyszłości możemy wprowadzić 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 nametype.

group_member

Group

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

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

MembershipRole

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

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. W przypadku users: nie jest użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups: zawsze przypisana jest ta rola (w przyszłości mogą być używane inne wartości wyliczeniowe).
ROLE_MEMBER osoba w pokoju, Użytkownik ma podstawowe uprawnienia, takie jak wysyłanie wiadomości na czacie. W rozmowach 1:1 i grupowych bez nazwy każda osoba ma tę rolę.
ROLE_MANAGER menedżerem pokoju, Użytkownik ma wszystkie podstawowe uprawnienia oraz uprawnienia administracyjne, które pozwalają mu zarządzać pokojem, np. dodawać i usuwać użytkowników. Obsługiwane tylko w SpaceType.SPACE.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości możemy zacząć obsługiwać inne kraje członkowskie.

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 wspierań.

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 członkostwo;

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

MembershipUpdatedEventData

Ładunek zdarzenia w przypadku zaktualizowanej subskrypcji.

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

Pola
membership

Membership

Zaktualizowane członkostwo.

Wiadomość

Wiadomość w pokoju Google Chat.

Pola
name

string

Identyfikator. Nazwa zasobu wiadomości.

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

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

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

sender

User

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user nametype.

create_time

Timestamp

Opcjonalnie. Niezmienne. W przypadku pokoi utworzonych w Chat jest to czas utworzenia wiadomości. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane w pokojach w trybie importowania.

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

last_update_time

Timestamp

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

delete_time

Timestamp

Tylko dane wyjściowe. Czas, w którym wiadomość została usunięta z Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole będzie puste.

text

string

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

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

formatted_text

string

Tylko dane wyjściowe. Zawiera wiadomość text ze znacznikami dodanymi w celu przekazania informacji o formatowaniu. To pole może nie zawierać wszystkich elementów formatowania widocznych w interfejsie, ale obejmuje:

  • Składnia znaczników dla pogrubienia, kursywy, przekreślenia, czcionki o stałej szerokości znaków, bloku czcionki o stałej szerokości znaków i listy punktowanej.

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

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

  • niestandardowe emotikony w formacie :{emoji_name}:, np. :smile:; Nie dotyczy to emotikonów Unicode, takich jak U+1F600 (uśmiechnięta buźka).

Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości.

cards[]
(deprecated)

Card

Wycofana: zamiast niej używaj zasady cards_v2.

Karty sformatowane, interaktywne i zawierające elementy multimedialne, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowany tekst, przyciski i obrazy, które można kliknąć. Karty są zwykle wyświetlane pod treścią wiadomości w formacie zwykłego tekstu. cardscards_v2 mogą mieć maksymalny rozmiar 32 KB.

cards_v2[]

CardWithId

Opcjonalnie. Tablica kart.

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

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

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

Otwórz narzędzie do tworzenia kart

annotations[]

Annotation

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

thread

Thread

Wątek, do którego należy wiadomość. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku lub odpowiadanie w wątku.

space

Space

Tylko dane wyjściowe. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pole space name.

fallback_text

string

Opcjonalnie. Opis kart wiadomości w formie zwykłego tekstu, używany, gdy nie można wyświetlić rzeczywistych kart, np. w powiadomieniach na urządzeniach mobilnych.

action_response

ActionResponse

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

argument_text

string

Tylko dane wyjściowe. Treść wiadomości w formacie zwykłego tekstu, z której usunięto wszystkie wzmianki o aplikacji do obsługi czatu.

slash_command

SlashCommand

Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (w stosownych przypadkach).

attachment[]

Attachment

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

matched_url

MatchedUrl

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

thread_reply

bool

Tylko dane wyjściowe. Gdy pojawi się ikona true, oznacza to, że wiadomość jest odpowiedzią w wątku odpowiedzi. Gdy false, wiadomość jest widoczna w rozmowie najwyższego poziomu w pokoju jako pierwsza wiadomość w wątku lub wiadomość bez odpowiedzi w wątku.

Jeśli pokój nie obsługuje odpowiedzi w wątkach, to pole ma zawsze wartość false.

client_assigned_message_id

string

Opcjonalnie. Niestandardowy identyfikator wiadomości. Możesz użyć tego pola, aby zidentyfikować wiadomość lub ją pobrać, usunąć lub zaktualizować. Aby ustawić niestandardowy identyfikator, podczas tworzenia wiadomości określ pole messageId. Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości.

emoji_reaction_summaries[]

EmojiReactionSummary

Tylko dane wyjściowe. Lista podsumowań reakcji emotikonami na wiadomość.

private_message_viewer

User

Opcjonalnie. Niezmienne. Dane wejściowe do tworzenia wiadomości, w przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Gdy to pole jest ustawione, wiadomość jest prywatna i widoczna tylko dla określonego użytkownika i aplikacji do obsługi czatu. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API za pomocą uwierzytelniania aplikacji i pominąć te elementy:

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

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

Tylko dane wyjściowe. Informacje o wiadomości zacytowanej przez użytkownika Google Chat w pokoju. Użytkownicy Google Chat mogą cytować wiadomości, aby na nie odpowiadać.

attached_gifs[]

AttachedGif

Tylko dane wyjściowe. Obrazy GIF załączone do wiadomości.

accessory_widgets[]

AccessoryWidget

Opcjonalnie. Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Możesz dodawać widżety dodatkowe do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nie jest obsługiwana w przypadku wiadomości zawierających okna dialogowe. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.

Tworzenie wiadomości z widgetami akcesoriów wymaga uwierzytelnienia aplikacji.

MessageBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych wiadomości.

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

Pola
messages[]

MessageCreatedEventData

Lista nowych wiadomości.

MessageBatchDeletedEventData

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

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

Pola
messages[]

MessageDeletedEventData

Lista usuniętych wiadomości.

MessageBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych wiadomości.

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

Pola
messages[]

MessageUpdatedEventData

Lista zaktualizowanych wiadomości.

MessageCreatedEventData

Ładunek zdarzenia dla nowej wiadomości.

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

Pola
message

Message

Nowa wiadomość.

MessageDeletedEventData

Ładunek zdarzenia usuniętej wiadomości.

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

Pola
message

Message

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

MessageUpdatedEventData

Ładunek zdarzenia zaktualizowanej wiadomości.

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

Pola
message

Message

Zaktualizowana wiadomość.

QuotedMessageMetadata

Informacje o cytowanej wiadomości.

Pola
name

string

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

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

last_update_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa utworzenia cytowanej wiadomości lub jej ostatniej aktualizacji.

Reakcja

reakcja na wiadomość.

Pola
name

string

Identyfikator. Nazwa zasobu reakcji.

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

user

User

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

emoji

Emoji

Wymagane. Emotikon użyty w reakcji.

ReactionBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych reakcji.

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

Pola
reactions[]

ReactionCreatedEventData

Lista nowych reakcji.

ReactionBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych reakcji.

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

Pola
reactions[]

ReactionDeletedEventData

Lista usuniętych reakcji.

ReactionCreatedEventData

Ładunek zdarzenia dla nowej reakcji.

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

Pola
reaction

Reaction

Nowa reakcja.

ReactionDeletedEventData

Ładunek zdarzenia usuniętej reakcji.

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

Pola
reaction

Reaction

Usunięta reakcja.

RichLinkMetadata

Link do zasobu z elementami multimedialnymi.

Pola
uri

string

Identyfikator URI tego linku.

Pole unii data. Dane połączonego zasobu. data może mieć tylko jedną z tych wartości:

RichLinkType

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

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

SearchSpacesRequest

Żądanie wyszukania listy pokoi na podstawie zapytania.

Pola
use_admin_access

bool

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

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

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

page_size

int32

Maksymalna liczba 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.

page_token

string

Token otrzymany z poprzedniego wywołania przestrzeni wyszukiwania. 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.

query

string

Wymagane. Zapytanie.

Możesz wyszukiwać, korzystając z tych parametrów:

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

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

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

display_name akceptuje tylko operatora HAS (:). Tekst do dopasowania jest najpierw dzielony na tokeny, a każdy token jest dopasowywany do prefiksu bez uwzględniania wielkości liter i niezależnie jako podciąg w dowolnym miejscu w przestrzeni display_name. Na przykład wzorzec Fun Eve pasuje do wzorców Fun eventThe evening was fun, ale nie do wzorców notFun eventeven.

external_user_allowed akceptuje true lub false.

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

Pole space_type jest wymagane, a jedyną prawidłową wartością jest SPACE.

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

W ramach tego samego pola space_type nie obsługuje operatorów AND ani OR. display_name, 'space_history_state' i 'external_user_allowed' obsługują tylko operatory OR. Atrybuty last_active_timecreate_time obsługują operatory ANDOR. Symbolu AND można używać tylko do przedstawiania przedziału, np. last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Poniższe przykłady zapytań są prawidłowe:

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

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

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

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

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

string

Opcjonalnie. Sposób uporządkowania listy pokoi.

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

  • membership_count.joined_direct_human_user_count – oznacza liczbę użytkowników, którzy bezpośrednio dołączyli do pokoju.
  • last_active_time – oznacza czas, w którym ostatni kwalifikujący się element został dodany do dowolnego tematu w tym pokoju.
  • create_time – oznacza czas utworzenia pokoju.

Prawidłowe wartości operacji sortowania to:

  • ASC – rosnąco. Wartość domyślna.

  • DESC – malejąco.

Obsługiwana składnia:

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

SearchSpacesResponse

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

Pola
spaces[]

Space

Strona z żądanymi przestrzeniami.

next_page_token

string

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

total_size

int32

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

SetUpSpaceRequest

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

Pola
space

Space

Wymagane. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw Space.spaceType na SPACE i ustaw Space.displayName. 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.

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

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

Aby utworzyć rozmowę 1:1 między osobą a aplikacją Google Chat, która inicjuje połączenie, ustaw Space.spaceType na DIRECT_MESSAGESpace.singleUserBotDm na true. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Jeśli pokój DIRECT_MESSAGE już istnieje, zostanie zwrócony zamiast tworzenia nowego pokoju.

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 identyfikatora istniejącej prośby z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem spowoduje zwrócenie błędu.

memberships[]

Membership

Opcjonalnie. Użytkownicy lub grupy Google Chat, których chcesz zaprosić do pokoju. Pomiń użytkownika, który dzwoni, ponieważ jest on dodawany automatycznie.

Obecnie zestaw umożliwia maksymalnie 49 członkostw (oprócz osoby dzwoniącej).

W przypadku członkostwa osoby fizycznej pole Membership.member musi zawierać user z wypełnionym polem name (format: users/{user}) i polem type ustawionym na User.Type.HUMAN. Podczas konfigurowania pokoju możesz dodawać tylko użytkowników. Dodawanie aplikacji Google Chat jest obsługiwane tylko w przypadku konfiguracji czatu z aplikacją do połączeń. Możesz też dodawać członków, używając adresu e-mail użytkownika jako aliasu dla {user}. Na przykład user.name może być users/example@gmail.com. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, musisz użyć ich adresów e-mail w polu {user}.

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

Opcjonalny, gdy atrybut Space.spaceType ma wartość SPACE.

Wymagane, gdy wartość parametru Space.spaceType to GROUP_CHAT, a także co najmniej 2 rodzaje członkostwa.

Wymagane, gdy ustawiasz wartość Space.spaceType na DIRECT_MESSAGE w przypadku użytkownika, wraz z dokładnie 1 subskrypcją.

Musi być puste podczas tworzenia rozmowy 1:1 między osobą a aplikacją Google Chat (gdy ustawisz Space.spaceType na DIRECT_MESSAGESpace.singleUserBotDm na true).

SlashCommand

Metadane dotyczące polecenia rozpoczynającego się ukośnikiem w Google Chat.

Pola
command_id

int64

Identyfikator polecenia po ukośniku.

SlashCommandMetadata

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

Pola
bot

User

Aplikacja Google Chat, której polecenie zostało wywołane.

type

Type

Typ polecenia po ukośniku.

command_name

string

Nazwa wywołanego polecenia po ukośniku.

command_id

int64

Identyfikator polecenia wywołanego polecenia po ukośniku.

triggers_dialog

bool

Wskazuje, czy polecenie po ukośniku dotyczy okna.

Typ

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

Spacja

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

Pola
name

string

Identyfikator. Nazwa zasobu pokoju.

Format: spaces/{space}

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

type
(deprecated)

Type

Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady space_type. Typ pokoju.

space_type

SpaceType

Opcjonalnie. Rodzaj pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. W przypadku innych zastosowań tylko dane wyjściowe.

single_user_bot_dm

bool

Opcjonalnie. Czy pokój to czat między aplikacją Chat a pojedynczym użytkownikiem.

threaded
(deprecated)

bool

Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady spaceThreadingState. czy wiadomości w tym pokoju są wątkowane;

display_name

string

Opcjonalnie. Wyświetlana nazwa pokoju. Wymagany podczas tworzenia pokoju z wartością spaceType równą SPACE. Jeśli podczas tworzenia pokoju lub aktualizowania displayName 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.

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

Może mieć do 128 znaków.

external_user_allowed

bool

Opcjonalnie. Niezmienne. Określa, czy w tym pokoju może być dowolny użytkownik Google Chat. Podawane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik korzysta z konta konsumenckiego (niezarządzanego konta użytkownika). Domyślnie pokój utworzony na koncie konsumenckim jest dostępny dla każdego użytkownika Google Chat.

W przypadku istniejących pokoi to pole jest tylko danymi wyjściowymi.

space_threading_state

SpaceThreadingState

Tylko dane wyjściowe. Stan wątków w pokoju czatu.

space_details

SpaceDetails

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

space_history_state

HistoryState

Opcjonalnie. Stan historii wiadomości w przypadku wiadomości i wątków w tym pokoju.

import_mode

bool

Opcjonalnie. Czy ta przestrzeń została utworzona w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoje są niewidoczne dla użytkowników, dopóki importowanie nie zostanie ukończone.

Tworzenie pokoju w Import Mode wymaga uwierzytelniania użytkownika.

create_time

Timestamp

Opcjonalnie. Niezmienne. W przypadku pokoi utworzonych w Chat jest to czas utworzenia pokoju. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane w pokojach w trybie importowania.

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

Wypełniane w danych wyjściowych tylko wtedy, gdy wartość pola spaceType to GROUP_CHAT lub SPACE.

last_active_time

Timestamp

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

admin_installed

bool

Tylko dane wyjściowe. W przypadku pokoi na czacie z aplikacją Google Chat, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat z aplikacją do obsługi czatu w imieniu użytkowników w organizacji.

Aby obsługiwać instalację przez administratora, aplikacja do obsługi czatu musi mieć funkcję czatu.

membership_count

MembershipCount

Tylko dane wyjściowe. Liczba dołączonych subskrypcji pogrupowanych według typu członka. Wypełniane, gdy element space_type ma wartość SPACE, DIRECT_MESSAGE lub GROUP_CHAT.

access_settings

AccessSettings

Opcjonalnie. Określa ustawienie dostępu do pokoju. Wypełnione tylko wtedy, gdy pole space_type ma wartość SPACE.

space_uri

string

Tylko dane wyjściowe. Identyfikator URI, za pomocą którego użytkownik może uzyskać dostęp do pokoju.

import_mode_expire_time

Timestamp

Tylko dane wyjściowe. Czas, po którym pokój zostanie automatycznie usunięty przez system, jeśli pozostanie w trybie importowania.

Każdy pokój utworzony w trybie importowania musi opuścić ten tryb przed upływem tego czasu za pomocą spaces.completeImport.

To pole jest wypełniane tylko w przypadku pokoi utworzonych w trybie importowania.

customer

string

Opcjonalnie. Niezmienne. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i gdy SpaceType ma wartość SPACE. W przeciwnym razie nie należy ustawiać tego pola.

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

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

Pole unii space_permission_settings. Reprezentuje ustawienia uprawnień pokoju. Wypełnione tylko wtedy, gdy pole space_type ma wartość SPACE. space_permission_settings może mieć tylko jedną z tych wartości:
predefined_permission_settings

PredefinedPermissionSettings

Opcjonalnie. Tylko dane wejściowe. Wstępnie zdefiniowane ustawienia uprawnień w pokoju, które można wprowadzić tylko podczas tworzenia pokoju. Jeśli to pole nie zostanie ustawione, zostanie utworzony pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu PermissionSettings.

Ustawianie predefiniowanych ustawień uprawnień obsługuje:

permission_settings

PermissionSettings

Opcjonalnie. Ustawienia uprawnień pokoju w przypadku istniejących pokoi. Dane wejściowe do aktualizowania dokładnych ustawień uprawnień dotyczących pokoju, w których istniejące ustawienia uprawnień są zastępowane. Wynik zawiera listę bieżących ustawień uprawnień.

Odczytywanie i aktualizowanie ustawień uprawnień obsługuje:

AccessSettings

Określa ustawienie dostępu do pokoju.

Pola
access_state

AccessState

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

audience

string

Opcjonalnie. Nazwa zasobu grupy odbiorców, która może znaleźć pokój, do niego dołączyć i wyświetlić podgląd wiadomości w nim. Jeśli to ustawienie nie jest skonfigurowane, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, którzy zostali indywidualnie zaproszeni lub dodani do pokoju. Więcej informacji znajdziesz w artykule Udostępnianie pokoju grupie odbiorców.

Format: audiences/{audience}

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

Odczytywanie grupy docelowej obsługuje:

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

Ustawienie grupy docelowej wymaga uwierzytelnienia użytkownika.

AccessState

Reprezentuje stan dostępu do pokoju.

Wartości w polu enum
ACCESS_STATE_UNSPECIFIED Stan dostępu jest nieznany lub nieobsługiwany w tym interfejsie API.
PRIVATE Tylko użytkownicy lub grupy dyskusyjne Google, które zostały indywidualnie dodane lub zaproszone przez innych użytkowników lub administratorów Google Workspace, mogą znaleźć pokój i uzyskać do niego dostęp.
DISCOVERABLE

Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, którzy zostali indywidualnie dodani do pokoju lub zaproszeni do niego, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Udostępnianie pokoju konkretnym użytkownikom.

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

MembershipCount

Reprezentuje liczbę członkostw w pokoju pogrupowanych w kategorie.

Pola
joined_direct_human_user_count

int32

Tylko dane wyjściowe. Liczba użytkowników, którzy dołączyli do pokoju bezpośrednio, bez uwzględniania użytkowników, którzy dołączyli w ramach członkostwa w grupie.

joined_group_count

int32

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

PermissionSetting

Reprezentuje ustawienie uprawnień pokoju.

Pola
managers_allowed

bool

Opcjonalnie. Czy menedżerowie pokoju mają to uprawnienie.

members_allowed

bool

Opcjonalnie. Czy członkowie grupy, którzy nie są menedżerami, mają to uprawnienie.

PermissionSettings

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

Aby ustawić uprawnienia podczas tworzenia pokoju, w żądaniu określ pole PredefinedPermissionSettings.

Pola
manage_members_and_groups

PermissionSetting

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

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

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

use_at_mention_all

PermissionSetting

Opcjonalnie. Ustawienie dotyczące używania polecenia @all w pokoju.

manage_apps

PermissionSetting

Opcjonalnie. Ustawienie zarządzania aplikacjami w pokoju.

manage_webhooks

PermissionSetting

Opcjonalnie. Ustawienie do zarządzania webhookami w pokoju.

post_messages

PermissionSetting

Tylko dane wyjściowe. Ustawienie publikowania wiadomości w pokoju.

reply_messages

PermissionSetting

Opcjonalnie. Ustawienie odpowiadania na wiadomości w pokoju.

PredefinedPermissionSettings

Wstępnie zdefiniowane ustawienia uprawnień, które można określić tylko podczas tworzenia pokoju z nazwą. W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień w przypadku nazwanych pokoi znajdziesz w artykule Więcej informacji o pokojach.

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

SpaceDetails

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

Pola
description

string

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

Może zawierać maksymalnie 150 znaków.

guidelines

string

Opcjonalnie. zasady, oczekiwania i etykieta obowiązujące w pokoju;

Obsługuje do 5000 znaków.

SpaceThreadingState

Określa typ stanu wątku w pokoju Google Chat.

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

SpaceType

Rodzaj pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. W przypadku innych zastosowań tylko dane wyjściowe.

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

Typ

Wycofana: zamiast niej używaj zasady SpaceType.

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

SpaceBatchUpdatedEventData

Ładunek zdarzenia w przypadku wielu aktualizacji przestrzeni.

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

Pola
spaces[]

SpaceUpdatedEventData

Lista zaktualizowanych pokoi.

SpaceEvent

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

Pola
name

string

Nazwa zasobu zdarzenia w pokoju.

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

event_time

Timestamp

Czas wystąpienia zdarzenia.

event_type

string

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

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

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

Obsługiwane typy zdarzeń w przypadku subskrypcji:

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

Obsługiwane typy zdarzeń w przypadku reakcji:

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

Obsługiwane typy zdarzeń dotyczące przestrzeni:

  • Zaktualizowana przestrzeń: google.workspace.chat.space.v1.updated
  • Wiele aktualizacji pokoju: google.workspace.chat.space.v1.batchUpdated

Pole unii payload.

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

message_created_event_data

MessageCreatedEventData

Ładunek zdarzenia dla nowej wiadomości.

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

message_updated_event_data

MessageUpdatedEventData

Ładunek zdarzenia zaktualizowanej wiadomości.

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

message_deleted_event_data

MessageDeletedEventData

Ładunek zdarzenia usuniętej wiadomości.

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

message_batch_created_event_data

MessageBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych wiadomości.

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych wiadomości.

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

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

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

space_updated_event_data

SpaceUpdatedEventData

Ładunek zdarzenia dotyczący aktualizacji pokoju.

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Ładunek zdarzenia w przypadku wielu aktualizacji przestrzeni.

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

membership_created_event_data

MembershipCreatedEventData

Ładunek zdarzenia w przypadku nowej subskrypcji.

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

membership_updated_event_data

MembershipUpdatedEventData

Ładunek zdarzenia w przypadku zaktualizowanej subskrypcji.

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

membership_deleted_event_data

MembershipDeletedEventData

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

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych subskrypcji.

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Ładunek zdarzenia dla wielu zaktualizowanych subskrypcji.

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych subskrypcji.

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

reaction_created_event_data

ReactionCreatedEventData

Ładunek zdarzenia dla nowej reakcji.

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

reaction_deleted_event_data

ReactionDeletedEventData

Ładunek zdarzenia usuniętej reakcji.

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych reakcji.

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych reakcji.

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

SpaceNotificationSetting

Ustawienie powiadomień użytkownika w pokoju.

Pola
name

string

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

notification_setting

NotificationSetting

Ustawienie powiadomień.

mute_setting

MuteSetting

Ustawienie wyciszania powiadomień z pokoju.

MuteSetting

Typy ustawień wyciszania powiadomień z pokoju.

Wartości w polu enum
MUTE_SETTING_UNSPECIFIED Zarezerwowano.
UNMUTED Użytkownik będzie otrzymywać powiadomienia dotyczące przestrzeni na podstawie ustawień powiadomień.
MUTED Użytkownik nie będzie otrzymywać żadnych powiadomień z pokoju, niezależnie od ustawień powiadomień.

NotificationSetting

Typy ustawień powiadomień. W przyszłości możemy dodać obsługę innych typów.

Wartości w polu enum
NOTIFICATION_SETTING_UNSPECIFIED Zarezerwowano.
ALL Powiadomienia są wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Wszystkie nowe wątki są automatycznie obserwowane, chyba że użytkownik ręcznie przestanie je obserwować.
MAIN_CONVERSATIONS Powiadomienie jest wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Nie jest dostępna w przypadku czatów 1:1.
FOR_YOU Powiadomienie jest wywoływane przez @wzmianki i obserwowane wątki. Nie jest dostępna w przypadku czatów 1:1.
OFF Powiadomienia są wyłączone.

SpaceReadState

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

Pola
name

string

Nazwa zasobu stanu odczytu pokoju.

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

last_read_time

Timestamp

Opcjonalnie. Czas zaktualizowania stanu odczytu pokoju użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości lub sygnaturze czasowej określonej przez użytkownika w celu oznaczenia ostatniej przeczytanej pozycji w pokoju.

SpaceUpdatedEventData

Ładunek zdarzenia w przypadku zaktualizowanego pokoju.

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

Pola
space

Space

zaktualizowany pokój.

Wątek

wątku w pokoju Google Chat; Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku lub odpowiadanie w wątku.

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

Pola
name

string

Identyfikator. Nazwa zasobu wątku.

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

thread_key

string

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

Ten identyfikator jest unikalny dla aplikacji do obsługi czatu, która go ustawia. Jeśli na przykład kilka aplikacji do obsługi czatu utworzy wiadomość przy użyciu tego samego klucza wątku, wiadomości zostaną opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez osobę lub inną aplikację Google Chat, zamiast tego określ pole namewątkuname.

ThreadReadState

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

Pola
name

string

Nazwa zasobu stanu odczytu wątku.

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

last_read_time

Timestamp

Czas, w którym zaktualizowano stan wątku użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku.

UpdateMembershipRequest

Prośba o aktualizację subskrypcji.

Pola
membership

Membership

Wymagane. Członkostwo do zaktualizowania. Aktualizowane są tylko pola określone przez update_mask.

update_mask

FieldMask

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

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

  • role
use_admin_access

bool

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

UpdateMessageRequest

Prośba o zaktualizowanie wiadomości.

Pola
message

Message

Wymagane. Wiadomość ze zaktualizowanymi polami.

update_mask

FieldMask

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

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

allow_missing

bool

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

UpdateSpaceNotificationSettingRequest

Prośba o zaktualizowanie ustawień powiadomień dotyczących pokoju. Obsługuje tylko aktualizowanie ustawień powiadomień dla użytkownika, który dzwoni.

Pola
space_notification_setting

SpaceNotificationSetting

Wymagane. Nazwa zasobu ustawień powiadomień dotyczących pokoju musi być podana w formacie users/{user}/spaces/{space}/spaceNotificationSetting. Aktualizowane są tylko pola określone przez update_mask.

update_mask

FieldMask

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

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

Komunikat z prośbą o wywołanie interfejsu UpdateSpaceReadState API.

Pola
space_read_state

SpaceReadState

Wymagane. Stan odczytu pokoju i pola do zaktualizowania.

Obsługuje tylko aktualizowanie 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/user@example.com/spaces/{space}/spaceReadState.

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

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

update_mask

FieldMask

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

  • last_read_time

Jeśli last_read_time jest wcześniejsza niż czas utworzenia ostatniej wiadomości, pokój będzie wyświetlany w interfejsie jako nieprzeczytany.

Aby oznaczyć pokój jako przeczytany, ustaw wartość last_read_time na dowolną wartość późniejszą (większą) niż czas utworzenia ostatniej wiadomości. Wartość last_read_time jest dopasowywana do czasu utworzenia ostatniej wiadomości. Stan odczytu pokoju wpływa tylko na stan odczytu wiadomości widocznych w rozmowie najwyższego poziomu w pokoju. Ten znacznik czasu nie ma wpływu na odpowiedzi w wątkach. Zamiast tego zależą one od stanu odczytu wątku.

UpdateSpaceRequest

Prośba o aktualizację pojedynczego pokoju.

Pola
space

Space

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

update_mask

FieldMask

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

W przypadku pokoju możesz zaktualizować te pola:

space_details: aktualizuje opis pokoju. Może zawierać maksymalnie 150 znaków.

display_name: obsługuje tylko aktualizowanie nazwy wyświetlanej w przypadku pokoi, w których pole spaceType ma wartość SPACE. Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wartości. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

space_type: obsługuje tylko zmianę typu pokoju z GROUP_CHAT na SPACE. W masce aktualizacji uwzględnij display_name wraz z space_type i upewnij się, że określona przestrzeń ma niepustą wyświetlaną nazwę i typ przestrzeni SPACE. Podczas aktualizowania wyświetlanej nazwy uwzględnienie maski space_type i typu SPACE w określonej przestrzeni jest opcjonalne, jeśli istniejąca przestrzeń ma już typ SPACE. Próba zmiany typu pokoju w inny sposób spowoduje błąd nieprawidłowego argumentu. space_type nie jest obsługiwane w przypadku useAdminAccess.

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

access_settings.audience: aktualizuje ustawienie dostępu określające, kto może odkrywać pokój, dołączać do niego i wyświetlać podgląd wiadomości w pokoju nazwanym, w którym pole spaceType ma wartość SPACE. Jeśli istniejący pokój ma grupę odbiorców, możesz ją usunąć i ograniczyć dostęp do pokoju, pomijając wartość w tej masce pola. Aby zaktualizować ustawienia dostępu do pokoju, uwierzytelniony użytkownik musi być menedżerem pokoju i pominąć wszystkie inne maski pól w żądaniu. Nie możesz zaktualizować tego pola, jeśli pokój jest w trybie importowania. Więcej informacji znajdziesz w artykule Udostępnianie pokoju konkretnym użytkownikom. access_settings.audience nie jest obsługiwane w przypadku useAdminAccess.

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

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

bool

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

Wymaga chat.admin.spaces zakresu OAuth 2.0.

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

Użytkownik

Użytkownik w Google Chat. Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, w przypadku zwrócenia jako dane wyjściowe żądania dane wyjściowe zasobu User wypełniają tylko pola nametype użytkownika.

Pola
name

string

Nazwa zasobu w Google Chat user.

Format: users/{user}. Adres users/app może być używany jako alias użytkownika aplikacji do dzwonienia bot.

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

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

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

  • adres e-mail użytkownika może być używany jako alias dla {user} w żądaniach interfejsu API. Jeśli na przykład identyfikator profilu osoby w interfejsie People API dla user@example.com to 123456789, możesz użyć users/user@example.com jako aliasu, aby odwoływać się do users/123456789. Interfejs API zwróci tylko kanoniczną nazwę zasobu (np. users/123456789).

display_name

string

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

domain_id

string

Unikalny identyfikator domeny Google Workspace użytkownika.

type

Type

Typ użytkownika.

is_anonymous

bool

Tylko dane wyjściowe. Gdy true, użytkownik zostanie usunięty lub jego profil nie będzie widoczny.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. NIE UŻYWAĆ.
HUMAN Użytkownik.
BOT użytkownik aplikacji do obsługi czatu,

UserMentionMetadata

Metadane adnotacji dotyczące wzmianek o użytkownikach (@).

Pola
user

User

Wspomniany użytkownik.

type

Type

Typ wzmianki o użytkowniku.

Typ

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

WidgetMarkup

Widżet to element interfejsu, który wyświetla tekst i obrazy.

Pola
buttons[]

Button

Lista przycisków. Pole Buttons jest też oneof data i należy ustawić tylko jedno z tych pól.

Pole unii data. WidgetMarkup może zawierać tylko jeden z tych elementów. Możesz użyć wielu pól WidgetMarkup, aby wyświetlić więcej produktów. data może mieć tylko jedną z tych wartości:
text_paragraph

TextParagraph

Wyświetla akapit tekstu w tym widżecie.

image

Image

Wyświetl obraz w tym widżecie.

key_value

KeyValue

Wyświetl w tym widżecie element z wartością kluczową.

Przycisk

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

Pola

Pole unii type.

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

text_button

TextButton

Przycisk z tekstem i onclick działaniem.

image_button

ImageButton

Przycisk z obrazem i działaniem onclick.

FormAction

Działanie formularza opisuje zachowanie po przesłaniu formularza. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.

Pola
action_method_name

string

Nazwa metody służy do identyfikowania części formularza, która spowodowała przesłanie formularza. Te informacje są przekazywane z powrotem do aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Możesz użyć tej samej nazwy metody w przypadku kilku elementów, które wywołują wspólne działanie.

parameters[]

ActionParameter

Lista parametrów działania.

ActionParameter

Lista parametrów tekstowych do podania podczas wywoływania metody działania. Na przykład możesz mieć 3 przyciski odkładania: odłóż teraz, odłóż o 1 dzień i odłóż o tydzień. Możesz użyć action method = snooze(), przekazując typ i czas odroczenia na liście parametrów ciągu znaków.

Pola
key

string

Nazwa parametru skryptu działania.

value

string

Wartość parametru.

Ikona

Zestaw obsługiwanych ikon.

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

Obraz

Obraz określony przez adres URL, który może mieć działanie onclick.

Pola
image_url

string

Adres URL obrazu.

on_click

OnClick

Działanie onclick.

aspect_ratio

double

Współczynnik proporcji tego obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości obrazu podczas oczekiwania na jego załadowanie. Nie ma on zastępować wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go przez wstępne pobranie obrazu.

ImageButton

Przycisk graficzny z działaniem onclick.

Pola
on_click

OnClick

Działanie onclick.

name

string

Nazwa tego image_button używana na potrzeby ułatwień dostępu. Jeśli ta nazwa nie zostanie podana, zostanie użyta wartość domyślna.

Pole unii icons. Ikonę można określić za pomocą elementu Icon enum lub adresu URL. icons może mieć tylko jedną z tych wartości:
icon

Icon

Ikona określona przez enum, która odnosi się do ikony udostępnianej przez interfejs Chat API.

icon_url

string

Ikona określona przez adres URL.

KeyValue

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

Pola
top_label

string

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

content

string

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

content_multiline

bool

Określa, czy treść powinna być wielowierszowa.

bottom_label

string

Tekst etykiety u dołu. 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.

on_click

OnClick

Działanie onclick. Klikalne są tylko etykieta u góry, etykieta u dołu i region treści.

Pole unii icons. Musisz zdefiniować co najmniej 1 z tych elementów: ikony, top_labelbottom_label. icons może mieć tylko jedną z tych wartości:
icon

Icon

Wartość wyliczeniowa, która jest zastępowana przez interfejs Chat API odpowiednim obrazem ikony.

icon_url

string

Ikona określona przez adres URL.

Pole unii control. widżet sterujący, Możesz ustawić wartość button lub switch_widget, ale nie obie jednocześnie. control może mieć tylko jedną z tych wartości:
button

Button

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

OnClick

działanie onclick (np. otwarcie linku);

Pola

Pole unii data.

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

action

FormAction

Jeśli określono działanie formularza, jest ono wywoływane przez to działanie onclick.

TextButton

Przycisk z tekstem i onclick działaniem.

Pola
text

string

Tekst na przycisku.

on_click

OnClick

onclickdziałanie przycisku;

TextParagraph

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

Pola
text

string