Package google.chat.v1

Indeks

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Kończy proces importowania 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 emotikony są dostępne tylko na kontach Google Workspace, a administrator musi je włączyć w organizacji. Więcej informacji znajdziesz w artykułach Informacje o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Tworzy subskrypcję dla wywołującej aplikacji Google Chat, użytkownika lub grupy dyskusyjnej Google. Tworzenie subskrypcji innych aplikacji do Google Chat nie jest obsługiwane. Jeśli podczas tworzenia członkostwa określony użytkownik ma wyłączone zasady automatycznej akceptacji, zostanie zaproszony i musi zaakceptować zaproszenie do pokoju, zanim do niego dołączy. W przeciwnym razie utworzenie członkostwa spowoduje dodanie użytkownika bezpośrednio do określonego pokoju.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem administratora i zakresem autoryzacji:

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

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

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

Uwierzytelnianie aplikacji nie jest obsługiwane w tych przypadkach:

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

Przykłady użycia:

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

Poniższy obraz pokazuje, jak Google 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

Poniższy obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje aplikację do Google Chat 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ści, to 32 000 bajtów.

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

Przypina wiadomość.

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

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

Wymaga jednego z tych zakresów OAuth:

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

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 do wiadomości.

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

rpc CreateSection(CreateSectionRequest) returns (Section)

Tworzy sekcję w Google Chat. Sekcje pomagają użytkownikom grupować rozmowy i dostosowywać listę pokoi wyświetlanych w panelu użytkownika Google Chat. Można tworzyć tylko sekcje typu CUSTOM_SECTION. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Tworzy pokój. Można go użyć do utworzenia pokoju z nazwą lub czatu grupowego w Import mode. Przykład znajdziesz w artykule Tworzenie pokoju.

Obsługuje te typy uwierzytelniania:

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

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

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

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

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

Podczas uwierzytelniania jako aplikacja aplikacja Google Chat jest dodawana jako użytkownik pokoju. Jednak w przeciwieństwie do uwierzytelniania przez człowieka aplikacja Google Chat nie jest dodawana jako menedżer pokoju. Domyślnie aplikację do Google Chat mogą usunąć z pokoju wszyscy jego uczestnicy. Aby zezwolić tylko menedżerom pokoju na usuwanie aplikacji z pokoju, ustaw parametr 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 importowania: nie są tworzeni żadni użytkownicy.
  • Wszystkie inne tryby: użytkownik wywołujący jest dodawany jako użytkownik. Oto:
    • sama aplikacja, gdy używa uwierzytelniania aplikacji.
    • użytkownik, gdy używane jest uwierzytelnianie 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 niestandardowe emotikony utworzone przez siebie. Menedżerowie emotikonów przypisani przez administratora mogą usuwać dowolne niestandardowe emotikony w organizacji. Więcej informacji znajdziesz w artykule Niestandardowe emotikony w Google Chat.

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

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem administratora i zakresem autoryzacji:

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

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

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (aby usunąć aplikację do połączeń z pokoju).
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora jest uwierzytelnione, use_admin_access to 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 Google Chat z pokoju,

Aby usunąć członkostwa menedżerów pokoju, zgłaszający musi być menedżerem pokoju. Jeśli używasz uwierzytelniania aplikacji, aplikacja Google Chat musi być twórcą pokoju.

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

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

Usuwa przypięcie wiadomości.

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Usuwa reakcję na wiadomość. Przykład znajdziesz w sekcji 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.
DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

Usuwa sekcję typu CUSTOM_SECTION.

Jeśli sekcja zawiera elementy, takie jak pokoje, zostaną one przeniesione do domyślnych sekcji Google Chat i nie zostaną usunięte.

Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem administratora i zakresem autoryzacji:

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

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

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora jest uwierzytelnione, use_admin_access to 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 znajdzie takiego pokoju, zwraca błąd 404 NOT_FOUND. Przykład znajdziesz w sekcji Znajdowanie czatu.

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

W przypadku uwierzytelniania użytkownika zwraca pokój czatu 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.
FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

Zwraca wszystkie pokoje z spaceType == GROUP_CHAT, których użytkownicy to dokładnie wywołujący użytkownik i użytkownicy określeni w FindGroupChatsRequest.users. Obsługiwani są tylko uczestnicy, którzy dołączyli do rozmowy. Przykład znajdziesz w sekcji Znajdowanie czatów grupowych.

Jeśli użytkownik dzwoniący blokuje niektórych użytkowników lub jest przez nich blokowany i nie znaleziono żadnych pokoi z całym określonym zestawem użytkowników, ta metoda zwraca pokoje, które nie zawierają zablokowanych lub blokujących użytkowników.

Określony zbiór użytkowników musi zawierać tylko osoby (nie aplikacje). Żądanie, które zawiera użytkowników niebędących ludźmi, nie zwraca żadnych pokoi.

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

Wymaga uwierzytelniania aplikacji z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

Zwraca informacje o dostępności użytkownika w Google Chat. Można na przykład sprawdzić, czy użytkownik jest online, czy nie, lub pobrać jego niestandardowy komunikat o stanie.

Ta metoda pobiera tylko dostępność uwierzytelnionego użytkownika.

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Zwraca szczegółowe informacje o niestandardowym emotikonie.

Niestandardowe emotikony są dostępne tylko na kontach Google Workspace, a administrator musi je włączyć w organizacji. Więcej informacji znajdziesz w artykułach Informacje 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ółowe informacje o członkostwie. Przykład znajdziesz w artykule Uzyskiwanie informacji o subskrypcji użytkownika lub aplikacji Google Chat.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji za pomocą jednego z tych zakresów autoryzacji:

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Zwraca szczegółowe informacje o wiadomości. Przykład znajdziesz w sekcji Uzyskiwanie szczegółowych informacji o wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji za pomocą jednego z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.bot: gdy używasz tego zakresu autoryzacji, ta metoda zwraca szczegółowe informacje o wiadomości, do której aplikacja Google Chat ma dostęp, np. o czatach i poleceniach po ukośniku, które wywołują aplikację Google Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly z zatwierdzeniem administratora. Jeśli używasz tego zakresu uwierzytelniania, ta metoda zwraca szczegółowe informacje o wiadomości publicznej w pokoju.

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

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

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Zwraca szczegółowe informacje o pokoju. Przykład znajdziesz w sekcji Uzyskiwanie szczegółowych informacji o pokoju.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji za pomocą jednego z tych zakresów autoryzacji:

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

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora jest uwierzytelnione, use_admin_access to 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:

  • Wartość space.access_settings jest wypełniana tylko wtedy, gdy używany jest zakres chat.app.spaces.
  • Pola space.predefind_permission_settings i space.permission_settings są wypełniane tylko wtedy, gdy używany jest zakres 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ę zasobu, który uległ zmianie. Jeśli na przykład poprosisz o zdarzenie dotyczące nowej wiadomości, ale wiadomość została później zaktualizowana, serwer zwróci zaktualizowany zasób Message w ładunku zdarzenia.

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

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

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

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

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

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

Aby pobrać zdarzenie, uwierzytelniony element wywołujący musi być członkiem pokoju.

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Zwraca szczegółowe informacje o stanie odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w artykule Uzyskiwanie informacji o stanie odczytu pokoju przez 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ółowe informacje o stanie odczytu użytkownika w wątku, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w sekcji Uzyskiwanie informacji o stanie przeczytania wątku przez 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 emotikony są dostępne tylko na kontach Google Workspace, a administrator musi je włączyć w organizacji. Więcej informacji znajdziesz w artykułach Informacje 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. Wyświetlanie listy subskrypcji z uwierzytelnianiem aplikacji powoduje wyświetlenie listy subskrypcji w pokojach, do których aplikacja Google Chat ma dostęp, ale nie obejmuje subskrypcji aplikacji Google Chat, w tym jej własnych. Wyświetlanie listy subskrypcji z uwierzytelnianiem użytkownika powoduje wyświetlenie listy subskrypcji w pokojach, do których uwierzytelniony użytkownik ma dostęp.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji za pomocą jednego z tych zakresów autoryzacji:

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

Wyświetla listę przypiętych wiadomości w pokoju. Użytkownicy mogą przypinać ważne wiadomości w pokojach, aby mieć do nich łatwy dostęp. Więcej informacji znajdziesz w artykule Przypinanie i odpinanie rozmowy w Google Chat.

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Wyświetla listę wiadomości w pokoju, którego członkiem jest rozmówca, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Nie obejmuje to wiadomości systemowych, np. informujących o nowych użytkownikach pokoju. 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 sekcji Wyświetlanie listy wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem administratora i zakresem autoryzacji:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Gdy używasz tego zakresu uwierzytelniania, ta metoda zwraca tylko wiadomości publiczne w pokoju. Nie obejmuje wiadomości prywatnych.

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Wyświetla listę reakcji na wiadomość. Przykład znajdziesz w sekcji Wyświetlanie listy 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.
ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

Wyświetla listę elementów w sekcji.

Elementami sekcji mogą być tylko pokoje. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

Wyświetla listę sekcji dostępnych dla użytkownika Google Chat. Sekcje pomagają użytkownikom grupować rozmowy i dostosowywać listę pokoi wyświetlanych w panelu użytkownika Google Chat. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.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 Google Chat. Jeśli na przykład wyświetlisz listę zdarzeń dotyczących nowych użytkowników pokoju, serwer zwróci zasoby Membership zawierające najnowsze informacje o użytkownikach. Jeśli w wybranym okresie usunięto nowych członków społeczności, ładunek zdarzenia zawiera pusty zasób Membership.

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

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

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

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

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

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

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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 listę pokoi, do których należy rozmówca. Czaty grupowe i czaty nie są widoczne, 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.
MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

Oznacza użytkownika jako ACTIVE w Google Chat.

Ustawia stan dostępności użytkownika na ACTIVE. Stan ACTIVE trwa do określonego terminu, po którym stan użytkownika zmienia się na AWAY. Pamiętaj, że jeśli użytkownik aktywnie korzysta z Google Chat, czas trwania stanu ACTIVE może przekroczyć podany termin ważności.

Ta metoda aktualizuje tylko dostępność uwierzytelnionego użytkownika.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
MarkAsAway

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

Oznacza użytkownika jako AWAY w Google Chat.

Ustawia stan użytkownika na „Poza biurem” i nie ma na niego wpływu aktywność użytkownika.

Ta metoda aktualizuje tylko dostępność uwierzytelnionego użytkownika.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

Oznacza użytkownika jako DO_NOT_DISTURB w Google Chat.

Ustawia stan dostępności użytkownika na DO_NOT_DISTURB do określonego czasu wygaśnięcia. W trybie DO_NOT_DISTURB użytkownicy zwykle nie otrzymują powiadomień.

Ta metoda aktualizuje tylko dostępność uwierzytelnionego użytkownika.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
MoveSectionItem

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

Przenosi element z jednej sekcji do innej. Jeśli na przykład sekcja zawiera pokoje, możesz użyć tej metody, aby przenieść pokój do innej sekcji. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
PositionSection

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

Zmienia kolejność sortowania sekcji. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

Zastępuje karty zawarte w wiadomości.

Aplikacja do Google Chat może zastępować karty w wiadomości utworzonej przez człowieka tylko wtedy, gdy wiadomość zawiera już karty, a karty zostały utworzone przez aplikację.

Jeśli aplikacja zastąpi karty pustą listą, karty zostaną usunięte. Po usunięciu kart aplikacja nie może ich ponownie dodać do wiadomości.

Wymaga uwierzytelniania aplikacji z zakresem autoryzacji: - https://www.googleapis.com/auth/chat.bot

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

Wyszukuje wiadomości w Google Chat, do których użytkownik dzwoniący ma dostęp. Zwraca listę wiadomości pasujących do kryteriów wyszukiwania.

Aby wyszukać we wszystkich pokojach, do których użytkownik ma dostęp, ustaw parent na spaces/-. Użycie innej wartości w polu parent spowoduje błąd INVALID_ARGUMENT. Zwrócone wiadomości mają pole name wypełnione pełną nazwą zasobu, która zawiera konkretny element space, w którym znajduje się wiadomość.

Ten interfejs API nie zwraca wszystkich typów wiadomości. Wymienione poniżej typy wiadomości nie są uwzględniane w odpowiedzi. Użyj ListMessages, aby wyświetlić listę wszystkich wiadomości.

  • Wiadomości prywatne, które są widoczne dla uwierzytelnionego użytkownika.
  • wiadomości opublikowane przez aplikacje do Google Chat w pokojach lub czatach grupowych;
  • wiadomości w czacie z aplikacją do Google Chat,
  • wiadomości od zablokowanych użytkowników;
  • wiadomości w pokojach, które rozmówca wyciszył;

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Zwraca listę pokoi w organizacji Google Workspace. Przykład znajdziesz w artykule Wyszukiwanie pokoi i zarządzanie nimi.

Gdy parametr use_admin_access ma wartość false, wyniki są ograniczone do pokoi, do których dołączył użytkownik wywołujący. Aby wyszukiwać z uprawnieniami administratora, ustaw use_admin_access na true.

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.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 dzwoniący jest automatycznie dodawany do pokoju i nie powinien być określany jako członek w żądaniu. Przykład znajdziesz w artykule Konfigurowanie pokoju z początkowymi użytkownikami.

Aby określić użytkowników, których chcesz dodać, dodaj subskrypcje 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ć również id osoby z interfejsu People API lub id użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu osobistego user@example.com w interfejsie People API to 123456789, możesz dodać użytkownika do pokoju, ustawiając membership.member.name na users/user@example.com lub users/123456789.

Aby określić grupy dyskusyjne Google, które chcesz dodać, dodaj członkostwa z odpowiednim membership.group_member.name. Aby dodać lub zaprosić grupę dyskusyjną 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 membership.group_member.name na groups/123456789. Adresy e-mail grup nie są obsługiwane, a grupy dyskusyjne Google można dodawać tylko jako członków w pokojach z nazwą.

Jeśli w przypadku pokoju z nazwą lub czatu grupowego rozmówca zablokuje niektórych członków lub zostanie przez nich zablokowany albo nie ma uprawnień do dodawania niektórych członków, nie zostaną oni dodani do utworzonego pokoju.

Aby utworzyć czat między użytkownikiem wywołującym a innym użytkownikiem, określ dokładnie 1 subskrypcję reprezentującą użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie się nie powiedzie, a czat nie zostanie utworzony.

Aby utworzyć czat między użytkownikiem wywołującym a aplikacją wywołującą, ustaw Space.singleUserBotDm na true i nie określaj żadnych subskrypcji. Tej metody możesz używać tylko do konfigurowania czatu 1:1 z aplikacją do dzwonienia. Aby dodać aplikację do dzwonienia jako użytkownika pokoju lub istniejącego czatu 1:1 między 2 użytkownikami, przeczytaj artykuł Zapraszanie i dodawanie użytkowników lub aplikacji do pokoju.

Jeśli między 2 użytkownikami istnieje już czat, nawet jeśli jeden z nich zablokuje drugiego w momencie wysłania żądania, zwracany jest istniejący czat.

Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. 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.
UpdateAvailability

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

Aktualizuje informacje o dostępności użytkownika. Tą metodą można zaktualizować tylko pole custom_status.

Ta metoda aktualizuje tylko dostępność uwierzytelnionego użytkownika.

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

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem administratora i zakresem autoryzacji:

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

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

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Aktualizuje wiadomość. Metody patch i update różnią się od siebie. Metoda patch używa żądania patch, a metoda update – żądania put. Zalecamy użycie metody patch. Przykład znajdziesz w sekcji 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.
UpdateSection

rpc UpdateSection(UpdateSectionRequest) returns (Section)

Aktualizuje sekcję. Można aktualizować tylko sekcje typu CUSTOM_SECTION. Więcej informacji znajdziesz w artykule Tworzenie i porządkowanie sekcji w Google Chat.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

Jeśli aktualizujesz pole displayName i wyświetla 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 aplikacji z zatwierdzeniem administratora i jednym z tych zakresów autoryzacji:

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

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

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

Uwierzytelnianie aplikacji ma te ograniczenia:

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

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Aktualizuje ustawienie powiadomień w pokoju. Przykład znajdziesz w sekcji Aktualizowanie ustawienia powiadomień o pokoju rozmówcy.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aktualizuje stan odczytu użytkownika w pokoju, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w artykule Aktualizowanie stanu odczytu pokoju użytkownika.

Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji:

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

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

AccessoryWidget

Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Szczegółowe informacje znajdziesz w sekcji Dodawanie interaktywnych widżetów u dołu wiadomości.

Pola
Pole zbiorcze action. Typ działania. action może mieć tylko jedną z tych wartości:
button_list

ButtonList

Lista przycisków.

ActionResponse

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

Pola
type

ResponseType

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

string

Tylko dane wejściowe. URL, pod którym użytkownicy mogą się uwierzytelnić lub skonfigurować usługę. (Tylko w przypadku 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ź zaktualizowanego widżetu.

ResponseType

Typ odpowiedzi aplikacji do Google Chat.

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

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ł prośbę o aktualizację.
Pole zbiorcze updated_widget. Widżet został zaktualizowany w odpowiedzi na działanie użytkownika. updated_widget może mieć tylko jedną z tych wartości:
suggestions

SelectionItems

Lista wyników autouzupełniania widżetu

ActionStatus

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

Pola
status_code

Code

Kod stanu.
user_facing_message

string

Wiadomość, którą chcesz wysłać użytkownikom, aby poinformować ich o stanie ich prośby. Jeśli nie zostanie ustawiona, wysyłana jest ogólna wiadomość na podstawie status_code.

Adnotacja

Adnotacje mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub z elementami, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami start_index i length równymi 0. Aby dodać podstawowe formatowanie do SMS-a, zapoznaj się z artykułem Formatowanie SMS-ów.

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ść podłańcucha w treści wiadomości w formacie zwykłego tekstu, której dotyczy ta adnotacja. Jeśli nie jest obecny, oznacza długość 0.
start_index

int32

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

UserMentionMetadata

Metadane wzmianki o użytkowniku.
slash_command

SlashCommandMetadata

Metadane polecenia po ukośniku.
custom_emoji_metadata

CustomEmojiMetadata

Metadane niestandardowego emotikonu.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
USER_MENTION użytkownik zostanie wspomniany,
SLASH_COMMAND wywołanie polecenia po ukośniku,
CUSTOM_EMOJI Adnotacja niestandardowego emotikonu.

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 do Google Chat.

AppCommandType

Typ polecenia aplikacji do Google Chat. Więcej informacji znajdziesz w artykule Typy poleceń aplikacji Google Chat.

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ść.
MESSAGE_ACTION Działanie związane z wiadomością. Użytkownik wybiera polecenie z menu kontekstowego wiadomości w Google Chat.

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

Identyfikator. Nazwa zasobu załącznika.

Format: spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

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

string

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

string

Tylko dane wyjściowe. Adres URL miniatury, który powinien być używany do wyświetlania podglądu załącznika użytkownikowi. Aplikacje do Google Chat nie powinny używać tego adresu URL do pobierania zawartości załącznika.
download_uri

string

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

Source

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

AttachmentDataRef

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

DriveDataRef

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

Źródło

Źródło załącznika.

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

AttachmentDataRef

Odwołanie do danych załącznika.

Pola
resource_name

string

Opcjonalnie: Nazwa zasobu danych załącznika. To pole jest używane z interfejsem 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.

Odbiorcy

docelowych odbiorców w Google Chat, Docelowi odbiorcy to grupa użytkowników w organizacji Google Workspace zdefiniowana przez administratora. Grupy odbiorców służą do konfigurowania ustawień dostępu i widoczności zasobów, np. do udostępniania pokoju określonej grupie użytkowników.

Więcej informacji znajdziesz w artykułach Docelowi odbiorcy i Udostępnianie pokoju docelowym odbiorcom.

Pola
name

string

Nazwa zasobu docelowych odbiorców, którzy mogą znaleźć pokój lub do niego dołączyć. Więcej informacji znajdziesz w artykule Udostępnianie pokoju docelowym odbiorcom. Format: audiences/{audience}

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

Dostępność

Reprezentuje informacje o bieżącej dostępności użytkownika w Google Chat, w tym jego stan (np. Aktywny, Nieobecny, Nie przeszkadzać) i dowolny stan niestandardowy.

Pola
name

string

Identyfikator. Nazwa zasobu dostępności użytkownika.

Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub interfejsie Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być też używany jako alias do odwoływania się do elementu wywołującego. Na przykład users/user@example.com lub users/me.
state

State

Tylko dane wyjściowe. Bieżący stan dostępności użytkownika.
custom_status

CustomStatus

Opcjonalnie: Niestandardowy stan użytkownika.
Pole zbiorcze state_metadata. Dodatkowe metadane powiązane ze stanem dostępności użytkownika. state_metadata może mieć tylko jedną z tych wartości:
do_not_disturb_metadata

DoNotDisturbMetadata

Tylko dane wyjściowe. Metadane, jeśli stan użytkownika jest ustawiony na DO_NOT_DISTURB.

Stan

Reprezentuje bieżący stan dostępności użytkownika.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Stan jest nieokreślony.
ACTIVE Użytkownik jest obecnie aktywny na podstawie ostatniej aktywności.
IDLE Użytkownik jest obecnie nieaktywny. Ten stan oznacza okres bezczynności po stanie AKTYWNY, przed potencjalnym przejściem do stanu NIE MA.
AWAY Użytkownik jest obecnie nieobecny. Może on zostać ustawiony automatycznie po okresie braku aktywności w stanie AKTYWNY lub BEZCZYNNY albo ręcznie przez użytkownika. Jeśli stan zostanie ustawiony ręcznie za pomocą MarkAsAway, będzie on utrzymywany niezależnie od aktywności użytkownika.
DO_NOT_DISTURB Użytkownik jest w trybie Nie przeszkadzać, który został ustawiony ręcznie.

CalendarEventLinkData

Dane linków do wydarzeń w Kalendarzu.

Pola
calendar_id

string

Identyfikator kalendarza połączonego kalendarza.
event_id

string

Identyfikator wydarzenia powiązanego wydarzenia w Kalendarzu.

CardWithId

karta w wiadomości na czacie w Google Chat.

Aplikacje do obsługi czatu mogą tworzyć karty z uwierzytelnianiem aplikacji. W ramach programu wersji przedpremierowych dla programistów, jeśli Twoja aplikacja do Google Chat uwierzytelnia się jako użytkownik, może tworzyć wiadomości z kartami. Jeśli Twoja aplikacja do Google Chat nie jest częścią programu wersji przedpremierowych dla programistów, nie może tworzyć kart z uwierzytelnianiem użytkownika.

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

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

Otwieranie Kreatora 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.
owner_user

User

Tylko dane wyjściowe. Aplikacja, do której należy karta.

ChatSpaceLinkData

Dane dotyczące linków do pokoi czatu.

Pola
space

string

Pokój połączonego zasobu pokoju czatu.

Format: spaces/{space}
thread

string

Wątek połączonego zasobu pokoju czatu.

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

string

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

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

Cytat

Cytaty to odwołania w tekście, które mogą dostarczać użytkownikom bardziej szczegółowych informacji. Odpowiednie cytaty w tekście powinny być obecne w tekście wiadomości w formacie znaczników <chat-citation data-id="{id}">{text}</chat-citation>. Cytaty są obsługiwane tylko wtedy, gdy parametr markup_syntax wiadomości jest ustawiony na MARKDOWN.

Cytaty bez odniesień w Elements.citations (te bez pasującego tagu <chat-citation> w tekście wiadomości) są ignorowane i nie powodują odrzucenia wiadomości.

Pola
id

string

Wymagane. Identyfikator zdefiniowany przez aplikację. Może zawierać tylko litery i cyfry ASCII oraz mieć mniej niż 63 znaki.
cited_sources[]

CitedSource

Opcjonalnie: Lista źródeł powiązanych z cytatem. Źródła są wyświetlane na karcie informacyjnej cytatu.

CitedSource

Odniesienie do źródła informacji.

Pola
title

string

Wymagane. Tytuł CitedSource w postaci zwykłego tekstu. To pole nie obsługuje formatowania.
uri

string

Wymagane. Identyfikator URI wskazujący zasób, do którego odwołuje się ten element CitedSource.
snippet

Snippet

Opcjonalnie: Fragment zawierający informacje bezpośrednio ze źródła.
footer

Footer

Opcjonalnie: Dodatkowe informacje wyświetlane obok fragmentu w formie stopki.

Stopka źródła używana do atrybucji.

Pola
text

string

Opcjonalnie: Tekst do wyświetlenia w stopce.

Krótki opis

Obiekt fragmentu kodu reprezentujący fragment większego korpusu.

Pola
text

string

Opcjonalnie: Krótki fragment tekstu bezpośrednio z korpusu, który może być renderowany w Google Chat. Nie obsługuje formatu Markdown.
image_preview

ElementsImage

Opcjonalnie: Podgląd obrazu fragmentu podanego jako dane wejściowe podczas tworzenia cytatu.

CompleteImportSpaceRequest

Komunikat żądania dotyczący zakończenia procesu importowania pokoju.

Pola
name

string

Wymagane. Nazwa zasobu pokoju w trybie importowania.

Format: spaces/{space}

CompleteImportSpaceResponse

Komunikat odpowiedzi dotyczący zakończenia procesu importowania pokoju.

Pola
space

Space

Pokój w trybie importowania.

ContextualAddOnMarkup

Ten typ nie ma pól.

Znaczniki dla deweloperów, które umożliwiają określenie zawartości 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

Działania tej karty.
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 działania.

CardHeader

Pola
title

string

Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli podano zarówno tytuł, jak i podtytuł, każdy z nich zajmuje 1 wiersz. Jeśli podany jest tylko tytuł, zajmuje 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 kolekcję widżetów, które są renderowane (pionowo) w kolejności, w jakiej zostały określone. Na wszystkich platformach karty mają stałą, niewielką szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).

Pola
header

string

Nagłówek sekcji. Sformatowany tekst jest obsługiwany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
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

Komunikat żądania utworzenia subskrypcji.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzone członkostwo.

Format: spaces/{space}
membership

Membership

Wymagane. Relacja członkostwa do utworzenia.

Pole memberType musi zawierać użytkownika z wypełnionymi polami user.name i user.type. Serwer przypisze nazwę zasobu i zastąpi wszystkie określone wartości.

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

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

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

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

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

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu OAuth 2.0 chat.admin.memberships.

Dostęp administracyjny nie umożliwia tworzenia subskrypcji aplikacji ani subskrypcji dla użytkowników spoza organizacji Google Workspace administratora.

CreateMessageNotificationOptions

Opcje zachowania powiadomienia po opublikowaniu wiadomości.

Pola
notification_type

NotificationType

Typ powiadomienia dotyczącego wiadomości.

NotificationType

Opcje typów powiadomień dla wiadomości.

Wartości w polu enum
NOTIFICATION_TYPE_NONE Działanie domyślne. Powiadomienia działają podobnie jak w przypadku wysyłania wiadomości przez użytkownika za pomocą interfejsu Google Chat: do nadawcy nie jest wysyłane żadne powiadomienie.
NOTIFICATION_TYPE_FORCE_NOTIFY

Wymuś powiadomienie odbiorców. Spowoduje to zignorowanie ustawień powiadomień w pokoju i ustawień trybu Nie przeszkadzać w Google Chat. Ta opcja nie powoduje pominięcia ustawień trybu Nie przeszkadzać na poziomie urządzenia.

Wymaga uwierzytelniania aplikacji.
NOTIFICATION_TYPE_SILENT

Nie powiadamiaj odbiorców i nie oznaczaj wiadomości jako nieprzeczytanej. Działa to podobnie do wyciszenia rozmowy przez użytkownika lub włączenia opcji Nie przeszkadzać w Google Chat.

Wymaga uwierzytelniania aplikacji.

CreateMessagePinRequest

Komunikat żądania dotyczący tworzenia przypięcia wiadomości.

Pola
parent

string

Wymagane. Pokój nadrzędny, w którym ma zostać utworzona przypięta wiadomość. Format: spaces/{space}
message_pin

MessagePin

Wymagane. Przypięta wiadomość, którą chcesz utworzyć.

CreateMessageRequest

Tworzy wiadomość.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzona wiadomość.

Format: spaces/{space}
message

Message

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

string

Opcjonalnie: Wycofana: użyj zasady thread.thread_key. Identyfikator wątku. Może zawierać maksymalnie 4000 znaków. Aby rozpocząć wątek lub dodać do niego wiadomość, utwórz wiadomość i określ threadKey lub thread.name. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na niego.
request_id

string

Opcjonalnie: Unikalny identyfikator tej prośby. Zalecany jest losowy identyfikator UUID. Określenie identyfikatora żądania sprawia, że żądanie jest idempotentne, co gwarantuje, że wiele identycznych żądań z tym samym identyfikatorem żądania spowoduje utworzenie tylko jednej wiadomości. Kolejne żądania z tym samym identyfikatorem zwracają istniejącą wiadomość i nie aktualizują jej, nawet jeśli żądane szczegóły różnią się od bieżącego stanu.

Aby skutecznie korzystać z tego pola:

  • Upewnij się, że kolejne żądania są identyczne i używają tych samych danych uwierzytelniających co pierwotne żądanie.
  • Jeśli wiadomość została już utworzona z podanym identyfikatorem żądania, żądanie zwraca tę wiadomość. Zwrócona wiadomość może nie być w pełni wypełniona. Interfejs API powtarza wiadomość z żądania z wypełnionymi nazwami zasobów przypisanymi przez system. Aby pobrać najnowsze metadane wiadomości, wywołaj GetMessage.
  • Ponowne użycie istniejącego identyfikatora żądania z innym uwierzytelnionym użytkownikiem spowoduje błąd.
message_reply_option

MessageReplyOption

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

To pole jest ignorowane podczas odpowiadania na interakcje użytkowników. 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 do Google Chat pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności przechowywania przypisanego przez system identyfikatora w nazwie zasobu wiadomości (reprezentowanej w polu wiadomości name).

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

  • Zaczyna się od client-. Na przykład client-custom-name jest prawidłowym identyfikatorem niestandardowym, ale custom-name już nie.
  • Może zawierać maksymalnie 63 znaki i tylko małe litery, cyfry oraz łączniki.
  • jest unikalny w obrębie pokoju, Aplikacja Google Chat nie może używać tego samego identyfikatora niestandardowego w różnych wiadomościach.

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

CreateMessageNotificationOptions

Opcjonalnie: Określa zachowanie powiadomień po opublikowaniu wiadomości. Więcej informacji znajdziesz w artykule Wymuszanie powiadomień i wysyłanie cichych wiadomości.

MessageReplyOption

Określa, jak odpowiedzieć na wiadomość. W przyszłości możemy dodać więcej stanów.

Wartości w polu enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Domyślny: Rozpoczyna nowy wątek. Jeśli użyjesz tej opcji, wszystkie uwzględnione parametry thread ID i thread_key zostaną zignorowane.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub thread_key. Jeśli się nie uda, wiadomość rozpocznie nowy wątek.
REPLY_MESSAGE_OR_FAIL Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub thread_key. Jeśli użyjesz nowego thread_key, zostanie utworzony nowy wątek. Jeśli nie uda się utworzyć wiadomości, 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.

CreateSectionRequest

Komunikat żądania dotyczący tworzenia sekcji.

Pola
parent

string

Wymagane. Nazwa zasobu nadrzędnego, w którym tworzona jest sekcja.

Format: users/{user}
section

Section

Wymagane. Sekcja do utworzenia.

CreateSpaceRequest

Prośba o utworzenie pokoju z nazwą bez użytkowników.

Pola
space

Space

Wymagane. Pola displayName i spaceType muszą być wypełnione. Obsługiwane są tylko wartości SpaceType.SPACE i SpaceType.GROUP_CHAT. Z opcji SpaceType.GROUP_CHAT można korzystać tylko wtedy, gdy opcja 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.

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

string

Opcjonalnie: Unikalny identyfikator tej prośby. Zalecany jest losowy identyfikator UUID. Podanie identyfikatora żądania sprawia, że żądanie jest idempotentne, co gwarantuje, że wiele identycznych żądań z tym samym identyfikatorem żądania spowoduje utworzenie tylko jednego pokoju. Kolejne żądania z tym samym identyfikatorem żądania zwracają istniejący pokój i nie aktualizują go, nawet jeśli żądane szczegóły różnią się od bieżącego stanu.

Aby skutecznie korzystać z tego pola:

  • Upewnij się, że kolejne żądania są identyczne i używają tych samych danych uwierzytelniających co pierwotne żądanie.
  • Jeśli pokój został już utworzony z podanym identyfikatorem żądania, żądanie zwraca ten pokój. Zwrócony pokój może nie być w pełni wypełniony. Interfejs API zwraca pokój z Twojego żądania z wypełnioną nazwą zasobu przypisaną przez system. Aby pobrać najnowsze metadane pokoju, wywołaj metodę GetSpace.
  • Ponowne użycie istniejącego identyfikatora żądania z innym uwierzytelnionym użytkownikiem spowoduje błąd.

CustomEmoji

Reprezentuje niestandardowy emotikon.

Pola
name

string

Identyfikator. Nazwa zasobu niestandardowego emotikonu przypisana przez serwer.

Format: customEmojis/{customEmoji}
uid

string

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

string

Opcjonalnie: Wartość niezmienna. Podana przez użytkownika nazwa niestandardowego emotikonu, która jest unikalna w organizacji.

Wymagane podczas tworzenia niestandardowego emotikonu, w przeciwnym razie tylko do odczytu.

Nazwy emotikonów muszą zaczynać się i kończyć dwukropkiem, muszą być zapisane małymi literami i mogą zawierać tylko znaki alfanumeryczne, podkreślenia i łączniki. 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 emotikonu, ważny przez co najmniej 10 minut. Pamiętaj, że to pole nie jest wypełniane w odpowiedzi, gdy tworzony jest niestandardowy emotikon.
payload

CustomEmojiPayload

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

CustomEmojiPayload

Dane ładunku niestandardowego emotikonu.

Pola
file_content

bytes

Wymagane. Tylko dane wejściowe. Obraz używany jako niestandardowy emotikon.

Ładunek musi być mniejszy niż 256 KB, a obraz musi być kwadratowy i mieć wymiary 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 niestandardowego emotikonu.

Pola
custom_emoji

CustomEmoji

Niestandardowy emotikon.

CustomStatus

Reprezentuje niestandardowy stan użytkownika w Google Chat. Obejmuje to krótką wiadomość tekstową z opcjonalnym emotikonem, którą użytkownik ustawia, aby podać więcej informacji o swojej dostępności.

Pola
text

string

Wymagane. Tekst stanu niestandardowego. Będzie to ciąg znaków o maksymalnej długości 64.
emoji

Emoji

Wymagane. Emotikon stanu niestandardowego. Obsługiwane są tylko emotikony Unicode. Niestandardowe emotikony nie są obsługiwane.
Pole zbiorcze expiration. Czas ważności stanu niestandardowego. Można go określić jako bezwzględną sygnaturę czasową lub czas życia danych. expiration może mieć tylko jedną z tych wartości:
expire_time

Timestamp

Sygnatura czasowa określająca, kiedy stan niestandardowy wygasa.
ttl

Duration

Tylko dane wejściowe. Czas, po którym stan niestandardowy wygasa.

DeleteCustomEmojiRequest

Prośba o usunięcie niestandardowego emotikona.

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emotikona, który chcesz usunąć.

Format: customEmojis/{customEmoji}

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

DeleteMembershipRequest

Prośba o usunięcie użytkownika z pokoju.

Pola
name

string

Wymagane. Nazwa zasobu subskrypcji, którą chcesz usunąć. Aplikacje do Google Chat mogą usuwać subskrypcje użytkowników lub własne. Aplikacje do obsługi czatu nie mogą usuwać subskrypcji innych aplikacji.

Usuwanie użytkownika wymaga zakresu chat.memberships z uwierzytelnianiem użytkownika lub zakresu chat.memberships.app z uwierzytelnianiem aplikacji i formatu spaces/{space}/members/{member}. Możesz używać tego adresu e-mail jako aliasu dla konta {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

Podczas usuwania subskrypcji aplikacji wymagany jest zakres chat.memberships.app i format spaces/{space}/members/app.

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

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu OAuth 2.0 chat.admin.memberships.

Usuwanie subskrypcji aplikacji w pokoju nie jest obsługiwane przy użyciu dostępu administracyjnego.

DeleteMessagePinRequest

Komunikat z prośbą o usunięcie przypięcia wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu przypiętej wiadomości, którą chcesz usunąć. Format: spaces/{space}/messagePins/{message_pin}

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 identyfikator niestandardowy wiadomości, możesz użyć wartości z pola clientAssignedMessageId dla {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. Jeśli false, a wiadomość ma odpowiedzi w wątkach, usunięcie się nie powiedzie.

Ma zastosowanie tylko podczas uwierzytelniania jako użytkownik. Nie ma wpływu na uwierzytelnianie jako aplikacja Google Chat.

DeleteReactionRequest

Usuwa reakcję na wiadomość.

Pola
name

string

Wymagane. Nazwa reakcji do usunięcia.

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

DeleteSectionRequest

Komunikat z prośbą o usunięcie sekcji.

Pola
name

string

Wymagane. Nazwa sekcji, którą chcesz usunąć.

Format: users/{user}/sections/{section}

DeleteSpaceRequest

Żądanie usunięcia pokoju.

Pola
name

string

Wymagane. Nazwa zasobu pokoju, który chcesz usunąć.

Format: spaces/{space}
use_admin_access

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu OAuth 2.0 chat.admin.delete.

DeletionMetadata

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

Pola
deletion_type

DeletionType

Wskazuje, kto usunął wiadomość.

DeletionType

kto usunął wiadomość i w jaki sposób; W przyszłości możemy dodać więcej wartości. Szczegółowe informacje o tym, kiedy można usuwać 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 Wiadomość została usunięta przez właściciela lub menedżera.
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ę do Google Chat.
APP_MESSAGE_EXPIRY Aplikacja do Google Chat usunęła własną wiadomość, gdy wygasła.
CREATOR_VIA_APP Aplikacja do Google Chat usunęła wiadomość w imieniu twórcy (przy użyciu uwierzytelniania użytkownika).
SPACE_OWNER_VIA_APP Aplikacja do Google Chat usunęła wiadomość w imieniu menedżera pokoju (przy użyciu uwierzytelniania użytkownika).
SPACE_MEMBER Wiadomość została usunięta przez użytkownika pokoju. Użytkownicy mogą usuwać wiadomości wysyłane przez aplikacje.

Dialog

Opakowanie 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 i kod stanu żądania.

Pola
action_status

ActionStatus

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

Dialog

Tylko dane wejściowe. Dialog dla żądania.

DoNotDisturbMetadata

Metadane powiązane ze stanem dostępności DO_NOT_DISTURB, określające, kiedy stan ma wygasnąć.

Pola
expiration_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa, do której użytkownik powinien być oznaczony jako DO_NOT_DISTURB. Może to być maksymalnie 1 rok w przyszłość.

DriveDataRef

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

Pola
drive_file_id

string

Identyfikator pliku na Dysku. Używaj 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 na Dysku Google.

Elementy

Elementy to dodatkowe komponenty, które mogą, ale nie muszą być powiązane z tekstem wiadomości podanym podczas jej tworzenia.

Pola
cited_sources[]

CitedSource

Lista źródeł, które mają być wyświetlane pod wiadomością jako linki w stopce. Nie są one przywoływane w tekście. W przypadku odwołań w tekście użyj citations.
citations[]

Citation

Lista cytatów w tekście, do których odwołuje się tekst wiadomości (za pomocą tagów <chat-citation>), które są renderowane jako interaktywne wizytówki.

ElementsImage

Obiekt zawierający różne sposoby reprezentowania obrazu. Obecnie obsługiwane reprezentacje: – obraz pobrany z identyfikatora URI. W przyszłości możemy dodać obsługę innych reprezentacji.

Pola
Pole zbiorcze image. Wymagane. Jedna z obsługiwanych reprezentacji obrazu. image może mieć tylko jedną z tych wartości:
image_uri

string

Wymagane. Publicznie dostępny identyfikator URI obrazu.

Emotikony

Emotikon używany jako reakcja na wiadomość.

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

string

Opcjonalnie: Podstawowy emotikon 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 emotikonu.

Pola
emoji

Emoji

Tylko dane wyjściowe. Emotikony powiązane z reakcjami.
reaction_count

int32

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

FindDirectMessageRequest

Żądanie pobrania pokoju czatu na podstawie zasobu użytkownika.

Pola
name

string

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

Format: users/{user}, gdzie {user} to id osoby z interfejsu People API lub id użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu w interfejsie People API to 123456789, możesz znaleźć czat z tą osobą, używając users/123456789 jako name. Po uwierzytelnieniu jako użytkownik 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.

FindGroupChatsRequest

Żądanie pobrania pokoi czatu grupowego na podstawie zasobów użytkownika.

Pola
users[]

string

Opcjonalnie: Nazwy zasobów wszystkich użytkowników w czacie grupowym z użytkownikiem dzwoniącym. Aplikacje do obsługi czatu nie mogą być uwzględnione w prośbie.

Maksymalna liczba użytkowników, których można określić w jednym żądaniu, to 49.

Format: users/{user}, gdzie {user} to id osoby z interfejsu People API lub id użytkownika w interfejsie Directory API. Aby na przykład znaleźć wszystkie czaty grupowe z użytkownikiem wywołującym i 2 innymi użytkownikami, których identyfikatory profili w interfejsie People API to 123456789 i 987654321, możesz użyć users/123456789 i users/987654321. Możesz też używać tego adresu e-mail jako aliasu dla {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.
page_size

int32

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

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

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

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

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania w celu znalezienia czatów grupowych. Podaj ten parametr, aby pobrać kolejną stronę.

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

SpaceView

Typ widoku żądanego pokoju. Jeśli nie jest ustawiony, przyjmuje się domyślnie SPACE_VIEW_RESOURCE_NAME_ONLY. Żądania, które określają SPACE_VIEW_EXPANDED, muszą zawierać zakresy, które umożliwiają odczyt danych pokoju, np. https://www.googleapis.com/auth/chat.spaces lub https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Odpowiedź zawierająca pokoje czatu grupowego, w których znajdują się dokładnie użytkownik dzwoniący i użytkownicy, do których dzwoniono.

Pola
spaces[]

Space

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

ForwardedMetadata

Metadane dotyczące pokoju źródłowego, z którego przekazano wiadomość.

Pola
space

string

Tylko dane wyjściowe. Nazwa zasobu pokoju źródłowego. Format: spaces/{space}
space_display_name

string

Tylko dane wyjściowe. Wyświetlana nazwa źródłowego pokoju lub czatu prywatnego w momencie przekazywania. W przypadku SPACE jest to nazwa pokoju. W przypadku DIRECT_MESSAGE jest to nazwa drugiego uczestnika (np. „Użytkownik A”). W przypadku GROUP_CHAT jest to nazwa wygenerowana na podstawie imion uczestników, ograniczona do 5 osób, w tym twórcy (np. „Użytkownik A, Użytkownik B”).

GetAttachmentRequest

Prośba o pobranie załącznika.

Pola
name

string

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

GetAvailabilityRequest

Komunikat żądania dla metody GetAvailability.

Pola
name

string

Wymagane. Nazwa zasobu dostępności do pobrania.

Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub interfejsie Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być też używany jako alias do odwoływania się do elementu wywołującego. Na przykład users/user@example.com lub users/me.

GetCustomEmojiRequest

Żądanie zwrócenia pojedynczego niestandardowego emotikonu.

Pola
name

string

Wymagane. Nazwa zasobu niestandardowego emotikonu.

Format: customEmojis/{customEmoji}

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

GetMembershipRequest

Poproś o dołączenie do pokoju.

Pola
name

string

Wymagane. Nazwa zasobu subskrypcji, którą chcesz pobrać.

Aby uzyskać członkostwo aplikacji przy użyciu uwierzytelniania użytkownika, możesz opcjonalnie użyć spaces/{space}/members/app.

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

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

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

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

Pobieranie subskrypcji aplikacji w pokoju nie jest obsługiwane, gdy używasz dostępu administracyjnego.

GetMessageRequest

Poproś o wiadomość.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

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

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

MarkupSyntax

Opcjonalnie: Określa żądaną składnię wyjściową pola formatted_text wiadomości na czacie.

GetSpaceEventRequest

Komunikat żądania pobrania zdarzenia dotyczącego pokoju.

Pola
name

string

Wymagane. Nazwa zasobu zdarzenia w pokoju.

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

GetSpaceNotificationSettingRequest

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

Pola
name

string

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

  • users/me/spaces/{space}/spaceNotificationSetting, LUB
  • users/user@example.com/spaces/{space}/spaceNotificationSetting, LUB
  • users/123456789/spaces/{space}/spaceNotificationSetting. Uwaga: w ścieżce dozwolony jest tylko identyfikator użytkownika lub adres e-mail elementu wywołującego.

GetSpaceReadStateRequest

Komunikat żądania dla interfejsu GetSpaceReadState API.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu pokoju, który chcesz pobrać.

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

Aby odwołać się do użytkownika, który dzwoni, ustaw jedną z tych wartości:

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

  • adres e-mail Workspace tej osoby, 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 jednego pokoju.

Pola
name

string

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

Format: spaces/{space}
use_admin_access

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

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

GetThreadReadStateRequest

Komunikat żądania dla interfejsu API GetThreadReadStateRequest.

Pola
name

string

Wymagane. Nazwa zasobu stanu odczytu wątku, który chcesz pobrać.

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

Aby odwołać się do użytkownika, który dzwoni, ustaw jedną z tych wartości:

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

  • adres e-mail Workspace tej osoby, 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

Grupa dyskusyjna Google w Google Chat.

Pola
name

string

Nazwa zasobu grupy dyskusyjnej Google.

Reprezentuje grupę w interfejsie 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 jest wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny.
HISTORY_ON Historia jest włączona. Reguły przechowywania w Vault 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 emotikonów niż ta wartość. Jeśli nie zostanie określona, domyślna wartość to 25. Maksymalna wartość 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 go, aby pobrać kolejną stronę.

Podczas stronicowania wartość filtra powinna odpowiadać wywołaniu, 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 akceptowane są tylko wartości creator("users/me") i NOT creator("users/me"), które umożliwiają filtrowanie niestandardowych emotikonów według tego, czy zostały utworzone przez użytkownika wywołującego.

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

creator("users/me")

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

ListCustomEmojisResponse

Odpowiedź na 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

Komunikat żądania dotyczący wyświetlania subskrypcji.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, dla którego chcesz pobrać listę użytkowników.

Format: spaces/{space}
page_size

int32

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

Jeśli nie podano tego argumentu, 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 subskrypcji. Podaj ten parametr, aby pobrać kolejną stronę.

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

string

Opcjonalnie: Filtr zapytania.

Możesz filtrować subskrypcje według roli (role) i typu (member.type) subskrybenta.

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

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

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

Jeśli właściwość use_admin_access ma wartość true, wymagana jest właściwość member.type = "HUMAN" lub member.type != "BOT". Inne filtry typu użytkownika 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: Jeśli parametr ma wartość true, zwracane są też subskrypcje powiązane z Google Group, a także inne typy subskrypcji. Jeśli ustawiono filter, subskrypcje Google Group, które nie spełniają kryteriów filtra, nie są zwracane.
show_invited

bool

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

Obecnie wymaga uwierzytelniania użytkownika.
use_admin_access

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

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

Wyświetlanie listy subskrypcji aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administracyjnego.

ListMembershipsResponse

Odpowiedź na prośbę o wyświetlenie listy użytkowników pokoju.

Pola
memberships[]

Membership

Lista nieuporządkowana. Lista subskrypcji 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.

ListMessagePinsRequest

Komunikat żądania dotyczący wyświetlania przypiętych wiadomości.

Pola
parent

string

Wymagane. Pokój nadrzędny, do którego należy kolekcja przypiętych elementów. Format: spaces/{space}
page_size

int32

Opcjonalnie: Maksymalna liczba zwracanych przypiętych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość. Maksymalna wartość to 100. Jeśli wpiszesz wartość większą niż 100, zostanie ona automatycznie zmieniona na 100. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 100 przypiętych wiadomości. Wartości ujemne zwracają błąd INVALID_ARGUMENT.
page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania przypiętych wiadomości na liście. Podaj ten parametr, aby pobrać kolejną stronę.

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

ListMessagePinsResponse

Komunikat odpowiedzi dotyczący wyświetlania przypiętych wiadomości.

Pola
message_pins[]

MessagePin

Przypięte wiadomości z określonego pokoju.
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.

ListMessagesRequest

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

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, z którego mają zostać wyświetlone 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ć kolejną stronę.

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

string

Opcjonalnie: Filtr zapytania.

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

Aby filtrować wiadomości według daty ich utworzenia, określ create_time z sygnaturą czasową w formacie RFC-3339 i podwójnymi cudzysłowami. 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 danym przedziale czasu, użyj operatora AND między 2 sygnaturami czasowymi.

Aby filtrować według wątku, podaj thread.name w formacie spaces/{space}/threads/{thread}. W każdym zapytaniu możesz określić tylko jeden 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: Sposób uporządkowania listy wiadomości. Podaj wartość, aby uporządkować według operacji porządkowania. Prawidłowe wartości operacji porządkowania:

  • ASC, aby posortować rosnąco.

  • DESC, aby posortować malejąco.

Domyślna kolejność to create_time ASC.
show_deleted

bool

Opcjonalnie: Określa, 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.
markup_syntax

MarkupSyntax

Opcjonalnie: Określa żądaną składnię wyjściową pola formatted_text wiadomości na czacie.

ListMessagesResponse

Komunikat odpowiedzi na potrzeby wyświetlania listy 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

Wyświetla listę reakcji na wiadomość.

Pola
parent

string

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

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

int32

Opcjonalnie: Maksymalna liczba zwracanych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie zostanie określona, domyślna wartość to 25. Maksymalna wartość 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 go, aby pobrać kolejną stronę.

Podczas stronicowania wartość filtra powinna odpowiadać wywołaniu, 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 emotikonów (emoji.unicode lub emoji.custom_emoji.uid) i użytkowników (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 emotikonów i użytkowników, użyj operatora AND, np. emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

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

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

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

Te zapytania są nieprawidłowe:

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

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

ListReactionsResponse

Odpowiedź na żądanie wyświetlenia 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.

ListSectionItemsRequest

Komunikat żądania dotyczący wyświetlania elementów sekcji.

Pola
parent

string

Wymagane. Zasób nadrzędny, czyli nazwa zasobu sekcji, do którego należy ta kolekcja elementów sekcji. Obsługuje tylko wyświetlanie elementów sekcji dla dzwoniącego użytkownika.

Podczas filtrowania według pokoju użyj symbolu wieloznacznego -, aby wyszukiwać we wszystkich sekcjach. Na przykład: users/{user}/sections/-.

Format: users/{user}/sections/{section}
page_size

int32

Opcjonalnie: Maksymalna liczba elementów sekcji do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników.

Jeśli nie zostanie określona, zwracanych będzie maksymalnie 10 elementów sekcji.

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

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

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania elementów sekcji listy. Podaj go, aby pobrać kolejną stronę.

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

string

Opcjonalnie: Filtr zapytania.

Obecnie obsługiwane jest tylko filtrowanie według pokoju.

Na przykład: space = spaces/{space}.

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

ListSectionItemsResponse

Komunikat odpowiedzi dotyczący wyświetlania elementów sekcji.

Pola
section_items[]

SectionItem

Elementy sekcji z określonej sekcji.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

ListSectionsRequest

Komunikat żądania dotyczący wyświetlania sekcji.

Pola
parent

string

Wymagane. Element nadrzędny, czyli nazwa zasobu użytkownika, który jest właścicielem tej kolekcji sekcji. Obsługuje tylko wyświetlanie sekcji dla dzwoniącego użytkownika. Aby odwołać się do użytkownika, który dzwoni, ustaw jedną z tych wartości:

  • Alias me. Na przykład: users/me.

  • adres e-mail Workspace tej osoby, Na przykład: users/user@example.com.

  • identyfikator użytkownika, Na przykład: users/123456789.

Format: users/{user}
page_size

int32

Opcjonalnie: Maksymalna liczba sekcji do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 sekcji.

Maksymalna wartość to 100. Jeśli wpiszesz wartość większą niż 100, zostanie ona automatycznie zmieniona na 100.

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

string

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

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

ListSectionsResponse

Komunikat odpowiedzi dotyczący wyświetlania sekcji.

Pola
sections[]

Section

Sekcje określonego użytkownika.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

ListSpaceEventsRequest

Komunikat żądania dotyczący wyświetlania listy zdarzeń w pokoju.

Pola
parent

string

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

Format: spaces/{space}.
page_size

int32

Opcjonalnie: Maksymalna liczba zwracanych zdarzeń w pokoju. Usługa może zwrócić mniej wyników niż ta wartość.

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

string

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

Podczas stronicowania wszystkie inne parametry podane w wywołaniu list space events muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do pozostałych 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 :. Aby filtrować według wielu typów zdarzeń, użyj operatora OR. Pomiń w filtrze typy zdarzeń grupowych. Żądanie automatycznie zwraca wszystkie powiązane zdarzenia zbiorcze. Jeśli na przykład filtrujesz według nowych reakcji (google.workspace.chat.reaction.v1.created), serwer zwraca też zdarzenia nowych reakcji zbiorczych (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w dokumentacji referencyjnej SpaceEvents.

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

  • start_time: sygnatura czasowa, od której ma się rozpocząć wyświetlanie listy zdarzeń w pokoju. Możesz wyświetlić listę zdarzeń, które miały miejsce w ciągu ostatnich 28 dni. Jeśli nie zostanie określony, wyświetlane są zdarzenia z pokoju z ostatnich 28 dni.
  • end_time: sygnatura czasowa, do której wyświetlane są zdarzenia w pokoju. Jeśli nie zostanie określony, wyświetlane są zdarzenia do momentu wysłania żądania.

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

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

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

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

Te zapytania są nieprawidłowe:

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

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

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

ListSpaceEventsResponse

Komunikat odpowiedzi dotyczący wyświetlania zdarzeń w pokoju.

Pola
space_events[]

SpaceEvent

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

string

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

ListSpacesRequest

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

Pola
page_size

int32

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

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 100 pokoi.

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

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

string

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

Podczas podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

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

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

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

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

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

ListSpacesResponse

Odpowiedź na żądanie wyświetlenia 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.

MarkAsActiveRequest

Komunikat żądania dla metody MarkAsActive.

Pola
name

string

Wymagane. Nazwa zasobu dostępności, który ma zostać oznaczony jako aktywny. Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub interfejsie Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być też używany jako alias do odwoływania się do elementu wywołującego. Na przykład users/user@example.com lub users/me.
Pole zbiorcze expiration. Data ważności stanu dostępności ACTIVE. Po upływie tego czasu użytkownik zostanie oznaczony jako Nieobecny. Jeśli nie podasz daty ważności, stan ACTIVE wygaśnie po 30 minutach od bieżącego czasu. expiration może mieć tylko jedną z tych wartości:
expire_time

Timestamp

Bezwzględna sygnatura czasowa wygaśnięcia stanu ACTIVE.
ttl

Duration

Czas od bieżącego momentu do wygaśnięcia stanu ACTIVE. Użycie krótkiego czasu TTL może skutecznie zresetować stan użytkownika, tak aby był on oparty na aktywności po tym krótkim czasie.

MarkAsAwayRequest

Komunikat żądania dla metody MarkAsAway.

Pola
name

string

Wymagane. Nazwa zasobu dostępności, który ma zostać oznaczony jako nieobecny. Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub interfejsie Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być też używany jako alias do odwoływania się do elementu wywołującego. Na przykład users/user@example.com lub users/me.

MarkAsDoNotDisturbRequest

Komunikat żądania dla metody MarkAsDoNotDisturb.

Pola
name

string

Wymagane. Nazwa zasobu dostępności, który ma zostać oznaczony jako „Nie przeszkadzać”. Format: users/{user}/availability

{user} to identyfikator osoby w interfejsie People API lub interfejsie Directory API z pakietu Admin SDK. Na przykład: users/123456789.

Adres e-mail użytkownika lub me może być też używany jako alias do odwoływania się do elementu wywołującego. Na przykład users/user@example.com lub users/me.
Pole zbiorcze expiration. Wymagane. Data ważności stanu dostępności Nie przeszkadzać. Po upływie tego czasu użytkownik zostanie oznaczony jako Nieobecny. Może to być maksymalnie 1 rok od bieżącego czasu. expiration może mieć tylko jedną z tych wartości:
expire_time

Timestamp

Bezwzględna sygnatura czasowa wygaśnięcia stanu Nie przeszkadzać.
ttl

Duration

Czas od bieżącej godziny do wygaśnięcia stanu Nie przeszkadzać.

MarkupSyntax

Określa składnię znaczników używaną do formatowania tekstu wiadomości na czacie. Dotyczy pola text zasobu Message.

Wartości w polu enum
MARKUP_SYNTAX_UNSPECIFIED Reprezentuje nieokreśloną wartość.
MARKUP_SYNTAX_CHAT Używa składni znaczników Google Chat. Więcej informacji znajdziesz na stronie https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Używa składni języka Markdown. Ta składnia jest oparta na specyfikacji CommonMark z dodatkowymi rozszerzeniami. Więcej informacji znajdziesz na stronie https://developers.google.com/workspace/chat/format-messages#format-texts.

MatchedUrl

Dopasowany adres URL w wiadomości na czacie. Aplikacje do Google Chat mogą wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków.

Pola
url

string

Tylko dane wyjściowe. Dopasowany adres URL.

MeetSpaceLinkData

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

Pola
meeting_code

string

Kod spotkania połączonego pokoju w Meet.
type

Type

Wskazuje typ pokoju w Meet.
huddle_status

HuddleStatus

Opcjonalnie: Tylko dane wyjściowe. Jeśli spotkanie w Meet jest szybką rozmową, wskazuje jej stan. W przeciwnym razie ta wartość nie jest ustawiona.

HuddleStatus

Stan spotkania

Wartości w polu enum
HUDDLE_STATUS_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
STARTED Szybkie spotkanie się rozpoczęło.
ENDED Szybkie spotkanie zostało zakończone. W takim przypadku identyfikator URI i identyfikatory pokoju Meet nie będą już ważne.
MISSED Masz nieodebraną rozmowę Huddle. W takim przypadku identyfikator URI i identyfikatory pokoju Meet nie będą już ważne.

Typ

Typ pokoju w Meet.

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
MEETING Pokój w Meet to spotkanie.
HUDDLE Pokój Meet to pokój do szybkich spotkań.

Członkostwo

Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja Google Chat są zaproszeni do pokoju, są jego członkami lub nie są w nim obecni.

Pola
name

string

Identyfikator. Nazwa zasobu członkostwa przypisana przez serwer.

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

MembershipState

Tylko dane wyjściowe. Stan subskrypcji.
role

MembershipRole

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

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

Timestamp

Opcjonalnie: Wartość niezmienna. Czas utworzenia członkostwa, np. gdy użytkownik dołączył do pokoju lub został do niego zaproszony. To pole jest tylko do odczytu, chyba że jest używane do importowania historycznych subskrypcji w pokojach w trybie importowania.
delete_time

Timestamp

Opcjonalnie: Wartość niezmienna. Czas usunięcia użytkownika, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko do odczytu, chyba że jest używane do importowania historycznych informacji o członkostwie w pokojach w trybie importowania.
affiliation

Affiliation

Tylko dane wyjściowe. Relacja użytkownika z organizacją Workspace, do której należy pokój. W pokojach należących do kont indywidualnych powiązanie wszystkich użytkowników to EXTERNAL.
Pole zbiorcze memberType. Użytkownik powiązany z tą subskrypcją. W przyszłości mogą być obsługiwane inne rodzaje subskrypcji. memberType może mieć tylko jedną z tych wartości:
member

User

Opcjonalnie: Użytkownik lub aplikacja Google Chat, do których odnosi się subskrypcja. Jeśli aplikacja do Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pola user name i type zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązania z użytkownikiem wywołującym, np. rozmowę na czacie.
group_member

Group

Opcjonalnie: Grupa dyskusyjna Google, której dotyczy członkostwo.

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

Przynależność

Reprezentuje powiązanie użytkownika z organizacją Google Workspace, do której należy pokój. W przyszłości do tego typu wyliczeniowego mogą zostać dodane kolejne wartości.

Wartości w polu enum
AFFILIATION_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
INTERNAL Konto zarządzane przez tę samą organizację Google Workspace, która jest właścicielem pokoju.
EXTERNAL konto spoza organizacji Google Workspace, która jest właścicielem pokoju (np. konto klienta lub konto zarządzane przez inną organizację Workspace);
MANAGED_EXTERNAL Konto zarządzane przez organizację Workspace, która jest właścicielem pokoju, ale udostępnione użytkownikowi spoza organizacji (np. gościowi). Więcej informacji o gościach znajdziesz na stronie https://support.google.com/chat/answer/16997417.

MembershipRole

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

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. users: nie jest 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

Użytkownik pokoju. W interfejsie Google Chat ta rola jest nazywana użytkownikiem.

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

  • dodawać i usuwać członków grup;
  • modyfikować szczegóły pokoju,
  • włączanie i wyłączanie historii,
  • Dodaj wzmiankę o wszystkich osobach w pokoju za pomocą @all.
  • zarządzać aplikacjami do Google Chat i webhookami zainstalowanymi w pokoju;

W czatach i rozmowach grupowych bez nazwy każdy ma tę rolę.
ROLE_MANAGER

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

Użytkownik ma pełny zestaw uprawnień do zarządzania pokojem, w tym:

  • zmieniać role innych osób w pokoju na użytkownika, menedżera lub właściciela;
  • usunąć pokój.

Ta funkcja jest obsługiwana tylko w SpaceType.SPACE (nazwane pokoje).

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

menedżerem pokoju; W interfejsie Google Chat ta rola nosi nazwę Menedżer.

Użytkownik ma wszystkie podstawowe uprawnienia ROLE_MEMBER, a właściciel może mu przyznać podzbiór uprawnień administracyjnych. Domyślnie menedżerowie mają wszystkie uprawnienia właściciela, ale nie mogą:

  • usunąć pokój.
  • Nadawanie innej osoby z pokoju roli właściciela.
  • Zmienianie roli właściciela.

Domyślnie uprawnienia menedżerów obejmują między innymi:

  • przypisać innemu użytkownikowi rolę menedżera,
  • usuwania wiadomości z pokoju.
  • zarządzać uprawnieniami pokoju;
  • otrzymywać powiadomienia o prośbach o dołączenie do pokoju, jeśli menedżer ma uprawnienie „Zarządzanie użytkownikami” w ustawieniach pokoju;
  • Ustaw miejsce jako wykrywalne.

Ta funkcja jest obsługiwana tylko w SpaceType.SPACE (nazwane pokoje).

Więcej informacji znajdziesz w artykule Zarządzanie ustawieniami pokoju.

MembershipState

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

Wartości w polu enum
MEMBERSHIP_STATE_UNSPECIFIED Wartość domyślna. Nie używaj.
JOINED Użytkownik zostanie dodany do pokoju i będzie mógł w nim uczestniczyć.
INVITED Użytkownik został zaproszony do pokoju, ale jeszcze do niego nie dołączył.
NOT_A_MEMBER Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do niego.

MembershipBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych subskrypcji.

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

Pola
memberships[]

MembershipCreatedEventData

Lista nowych subskrypcji.

MembershipBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych subskrypcji.

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

Pola
memberships[]

MembershipDeletedEventData

Lista usuniętych subskrypcji.

MembershipBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.

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

Pola
memberships[]

MembershipUpdatedEventData

Lista zaktualizowanych subskrypcji.

MembershipCreatedEventData

Ładunek zdarzenia dotyczący nowego członkostwa.

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

Pola
membership

Membership

Nowy członek społeczności.

MembershipDeletedEventData

Ładunek zdarzenia dotyczący usuniętej subskrypcji.

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

Pola
membership

Membership

Usunięta subskrypcja. Wypełnione są tylko pola name i state.

MembershipUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.

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

Pola
membership

Membership

Zaktualizowana subskrypcja.

Wiadomość

wiadomości 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 identyfikator niestandardowy, 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 Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pola user name i type zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązania z użytkownikiem wywołującym, np. rozmowę na czacie.
create_time

Timestamp

Opcjonalnie: Wartość niezmienna. W przypadku pokoi utworzonych w Google Chat – czas utworzenia wiadomości. To pole jest tylko do odczytu, chyba że jest używane w pokojach w trybie importowania.

W przypadku pokoi w trybie importu ustaw to pole na historyczną sygnaturę czasową, kiedy 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 usunięcia wiadomości w Google Chat. Jeśli wiadomość 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 wszystkie osoby w pokoju.

Aby dowiedzieć się, jak tworzyć SMS-y, przeczytaj artykuł Wysyłanie wiadomości.
formatted_text

string

Tylko dane wyjściowe. Zawiera wiadomość text ze znacznikami dodanymi w celu przekazania formatowania. To pole może nie obejmować wszystkich formatów widocznych w interfejsie, ale zawiera te elementy:

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

  • 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 oznaczający uśmiechniętą twarz.

  • Elementy listy punktowanej z gwiazdkami (*) – na przykład * item.

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

Card

Wycofana: użyj zasady cards_v2.

Rozbudowane, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowane teksty, przyciski i obrazy, które można kliknąć. Karty są zwykle wyświetlane pod treścią wiadomości w formacie zwykłego tekstu. Maksymalny rozmiar pól cards i cards_v2 to 32 KB.
cards_v2[]

CardWithId

Opcjonalnie: Tablica kart.

Aplikacje do obsługi czatu mogą tworzyć karty z uwierzytelnianiem aplikacji. W ramach programu wersji przedpremierowych dla programistów, jeśli Twoja aplikacja do Google Chat uwierzytelnia się jako użytkownik, może tworzyć wiadomości z kartami. Jeśli Twoja aplikacja do Google Chat nie jest częścią programu wersji przedpremierowych dla programistów, nie może tworzyć kart z uwierzytelnianiem użytkownika.

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

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

Otwieranie Kreatora kart
annotations[]

Annotation

Tylko dane wyjściowe. Adnotacje mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub z elementami, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami start_index i length równymi 0.
thread

Thread

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

Space

Tylko dane wyjściowe. Jeśli aplikacja do Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe zawierają tylko pokój name.
fallback_text

string

Opcjonalnie: Opis kart wiadomości w postaci 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 do 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 bez wzmianek o aplikacji do obsługi czatu.
slash_command

SlashCommand

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

Attachment

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

MatchedUrl

Tylko dane wyjściowe. Adres URL w polu text wiadomości na czacie, który pasuje do wzorca podglądu linku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków.
thread_reply

bool

Tylko dane wyjściowe. Gdy true, wiadomość jest odpowiedzią w wątku odpowiedzi. Gdy parametr ma wartość false, wiadomość jest widoczna w rozmowie na najwyższym poziomie 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.
silent

bool

Tylko dane wyjściowe. Czy jest to cicha wiadomość. Ciche wiadomości to wiadomości, w przypadku których Google Chat blokuje powiadomienia push dla odbiorców.
client_assigned_message_id

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Możesz użyć tego pola, aby zidentyfikować wiadomość lub ją pobrać, usunąć albo zaktualizować. Aby ustawić identyfikator niestandardowy, 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: Wartość niezmienna. Dane wejściowe do utworzenia 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 Google Chat. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API przy użyciu 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 ustawiona jest wartość delete_time.
quoted_message_metadata

QuotedMessageMetadata

Opcjonalnie: Informacje o wiadomości, którą cytuje inna wiadomość.

Podczas tworzenia wiadomości możesz cytować wiadomości w tym samym wątku lub zacytować wiadomość główną, aby utworzyć nową wiadomość główną. Nie możesz jednak cytować odpowiedzi na wiadomość z innego wątku.

Podczas aktualizowania wiadomości nie możesz dodać ani zastąpić pola quotedMessageMetadata, ale możesz je usunąć.

Przykłady użycia znajdziesz w artykule Cytowanie innej wiadomości.
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. Widżety dodatkowe możesz dodawać do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nie są obsługiwane w przypadku wiadomości zawierających okna. Szczegółowe informacje znajdziesz w sekcji Dodawanie interaktywnych widżetów u dołu wiadomości.

Tworzenie wiadomości z widżetami dodatkowymi wymaga uwierzytelniania aplikacji.
elements

Elements

Opcjonalnie: Elementy to dodatkowe komponenty udostępniane podczas tworzenia wiadomości, które mogą, ale nie muszą być powiązane z określonymi fragmentami tekstu wiadomości. Różnią się one od adnotacji, które są przeznaczone tylko do odczytu i zawierają dodatkowe informacje powiązane z fragmentami wiadomości lub całym tekstem wiadomości.

markup_syntax

MarkupSyntax

Opcjonalnie: Określa, jak serwer interpretuje zawartość pola text wiadomości.

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 dotyczący 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 dotyczący usuniętej wiadomości.

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

Pola
message

Message

usuniętą wiadomość, Wypełnione są tylko pola name, createTime i deletionMetadata.

MessagePin

Przypięcie wiadomości na czacie. Więcej informacji znajdziesz w artykule Przypinanie wiadomości.

Pola
name

string

Identyfikator. Nazwa zasobu przypiętej wiadomości. Format: spaces/{space}/messagePins/{message_pin} Komponent identyfikatora zasobu jest zgodny z komponentem identyfikatora zasobu wiadomości. Na przykład wiadomość z spaces/AAA/messages/bbb.ccc odpowiada przypiętej wiadomości o nazwie zasobu spaces/AAA/messagePins/bbb.ccc.
message

string

Wymagane. Wartość niezmienna. Nazwa zasobu przypiętej wiadomości. Format: spaces/{space}/messages/{message}

MessageUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej wiadomości.

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

Pola
message

Message

Zaktualizowana wiadomość.

MoveSectionItemRequest

Komunikat z prośbą o przeniesienie elementu sekcji między sekcjami.

Pola
name

string

Wymagane. Nazwa zasobu elementu sekcji, który chcesz przenieść.

Format: users/{user}/sections/{section}/items/{item}
target_section

string

Wymagane. Nazwa zasobu sekcji, do której ma zostać przeniesiony element sekcji.

Format: users/{user}/sections/{section}

MoveSectionItemResponse

Komunikat odpowiedzi dotyczący przenoszenia elementu sekcji.

Pola
section_item

SectionItem

Zaktualizowany element sekcji.

PositionSectionRequest

Komunikat z prośbą o ustawienie sekcji.

Pola
name

string

Wymagane. Nazwa zasobu sekcji, którą chcesz umieścić.

Format: users/{user}/sections/{section}
Pole zbiorcze position. Wymagane. Nowa pozycja sekcji. position może mieć tylko jedną z tych wartości:
sort_order

int32

Opcjonalnie: Bezwzględna pozycja sekcji na liście sekcji. Pozycja musi być większa niż 0. Jeśli pozycja jest większa niż liczba sekcji, sekcja zostanie dodana na końcu listy. Ta operacja wstawia sekcję w określonej pozycji i przesuwa pierwotną sekcję w tej pozycji oraz sekcje poniżej do następnej pozycji.
relative_position

Position

Opcjonalnie: Względna pozycja sekcji na liście sekcji.

Pozycja

Pozycja sekcji.

Wartości w polu enum
POSITION_UNSPECIFIED Nieokreślona pozycja.
START Początek listy sekcji.
END Koniec listy sekcji.

PositionSectionResponse

Komunikat odpowiedzi dotyczący pozycjonowania sekcji.

Pola
section

Section

Zaktualizowana sekcja.

QuotedMessageMetadata

Informacje o wiadomości, którą cytuje inna wiadomość.

Podczas aktualizowania wiadomości nie możesz dodać ani zastąpić pola quotedMessageMetadata, ale możesz je usunąć.

Przykłady użycia znajdziesz w artykule Cytowanie innej wiadomości.

Pola
name

string

Wymagane. Nazwa zasobu cytowanej wiadomości.

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

Timestamp

Wymagane. Sygnatura czasowa określająca, kiedy cytowana wiadomość została utworzona lub kiedy została ostatnio zaktualizowana.

Jeśli wiadomość została zmodyfikowana, użyj tego pola: last_update_time. Jeśli wiadomość nigdy nie była edytowana, użyj create_time.

Jeśli wartość last_update_time nie jest zgodna z najnowszą wersją cytowanej wiadomości, żądanie nie powiedzie się.
quote_type

QuoteType

Opcjonalnie: Określa typ cytatu. Jeśli nie jest ustawione, domyślnie przyjmuje wartość REPLY w ścieżce odczytu/zapisu wiadomości, aby zapewnić zgodność wsteczną.
quoted_message_snapshot

QuotedMessageSnapshot

Tylko dane wyjściowe. podgląd treści cytowanej wiadomości.
forwarded_metadata

ForwardedMetadata

Tylko dane wyjściowe. Metadane dotyczące pokoju źródłowego cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.

QuoteType

Typ cytatu cytowanej wiadomości.

Wartości w polu enum
QUOTE_TYPE_UNSPECIFIED Zarezerwowane. Ta wartość nie jest używana.
REPLY

Gdy quote_type jest REPLY, możesz wykonać te czynności:

  • Jeśli odpowiadasz w wątku, możesz zacytować inną wiadomość z tego wątku.

  • Jeśli tworzysz wiadomość główną, możesz zacytować inną wiadomość główną w tym pokoju.
FORWARD

Gdy quote_type jest FORWARD, możesz zacytować:

  • Wiadomość z innego pokoju.

  • odpowiedź na wiadomość z innego wątku w tym samym pokoju,

QuotedMessageSnapshot

zawiera podsumowanie treści cytowanej wiadomości w momencie cytowania lub przekazywania dalej;

Pola
sender

string

Tylko dane wyjściowe. Nazwa autora cytowanej wiadomości. Wypełniane w przypadku typów cytatów REPLY i FORWARD.
text

string

Tylko dane wyjściowe. Zrzut ekranu z treścią cytowanej wiadomości.
formatted_text

string

Tylko dane wyjściowe. Zawiera cytowaną wiadomość text ze znacznikami dodanymi w celu obsługi formatowania,takiego jak hiperlinki, niestandardowe emotikony, znaczniki itp. Wypełniane tylko w przypadku typu cytatu FORWARD.
annotations[]

Annotation

Tylko dane wyjściowe. Adnotacje przeanalizowane z treści cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.
attachments[]

Attachment

Tylko dane wyjściowe. Załączniki, które były częścią cytowanej wiadomości. Są to kopie metadanych załącznika cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.

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 dotyczący usuniętej reakcji.

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

Pola
reaction

Reaction

Usunięta reakcja.

ReplaceMessageCardsRequest

Komunikat żądania dla metody interfejsu API ReplaceMessageCards.

Pola
name

string

Wymagane. Nazwa zasobu wiadomości.

Format: spaces/{space}/messages/{message}
cards_v2[]

CardWithId

Opcjonalnie: Tablica kart, które mają zostać dołączone do wiadomości. Te karty zastąpią dotychczasowe karty wiadomości. Jeśli to pole jest puste, oryginalne karty zawarte w wiadomości zostaną usunięte.

ReplaceMessageCardsResponse

Ten typ nie ma pól.

Komunikat odpowiedzi dla interfejsu ReplaceMessageCards API.

RichLinkMetadata

Szczegółowy link do zasobu. Linki wzbogacone mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub reprezentować elementy, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami start_index i length równymi 0.

Pola
uri

string

Identyfikator URI tego linku.
Pole zbiorcze data. Dane połączonego zasobu. data może mieć tylko jedną z tych wartości:

RichLinkType

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

Wartości w polu enum
DRIVE_FILE Typ linku z informacjami na Dysku Google.
CHAT_SPACE Typ precyzyjnego linku do pokoju czatu. Na przykład element inteligentny pokoju.
GMAIL_MESSAGE Typ linku do wiadomości w Gmailu. Konkretnie element Gmaila z opcji Udostępnij w Google Chat. Interfejs API obsługuje tylko odczytywanie wiadomości z linkami GMAIL_MESSAGE.
MEET_SPACE Typ linku do wiadomości w Meet z elementami rozszerzonymi. Może to być na przykład element Meet.
CALENDAR_EVENT Typ linku z podglądem wiadomości z Kalendarza. Na przykład element Kalendarza.

SearchMessageResult

Pojedynczy wynik wyszukiwania wiadomości.

Pola
message

Message

Dopasowana wiadomość.
space_mute_setting

MuteSetting

Ustawienie wyciszenia użytkownika wywołującego w pokoju, w którym opublikowano wiadomość. Aplikacja do dzwonienia może użyć tych informacji, aby zdecydować, jak przetworzyć wiadomość, w zależności od tego, czy pokój jest wyciszony dla użytkownika.

Zwracane tylko wtedy, gdy widok żądania to SEARCH_MESSAGES_VIEW_FULL, a dane logowania wywołującego obejmują ten zakres autoryzacji:

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

bool

Wskazuje, czy dopasowana wiadomość została odczytana przez użytkownika, który nawiązał połączenie.

Zwracane tylko wtedy, gdy widok żądania to SEARCH_MESSAGES_VIEW_FULL, a dane logowania wywołującego obejmują jeden z tych zakresów autoryzacji:

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

SearchMessagesRequest

Komunikat żądania dotyczący wyszukiwania wiadomości.

Pola
parent

string

Wymagane. Nazwa zasobu pokoju, w którym ma zostać przeprowadzone wyszukiwanie.

Aby wyszukać we wszystkich pokojach, do których użytkownik ma dostęp, ustaw to pole na spaces/-. Użycie innej wartości w polu parent spowoduje błąd INVALID_ARGUMENT.

Aby ograniczyć wyszukiwanie do co najmniej jednego pokoju, użyj space.name lub space.display_name w filter.
filter

string

Wymagane. Wyszukiwane hasło.

Zapytanie może zawierać co najmniej 1 słowo kluczowe w sieci wyszukiwania, które służy do filtrowania wyników.

Możesz też filtrować wyniki, używając tych pól wiadomości:

  • create_time: akceptuje sygnaturę czasową w formacie RFC-3339, a obsługiwane operatory porównania to: < i >=.
  • sender.name: nazwa zasobu nadawcy (users/{user}). Obsługiwane są tylko =. Możesz używać tego adresu e-mail jako aliasu dla konta {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.
  • space.name: nazwa zasobu pokoju, w którym opublikowano wiadomość. (spaces/{space}). Obsługuje tylko =. Jeśli ten filtr nie jest ustawiony, wyszukiwanie jest przeprowadzane we wszystkich czatach i pokojach, do których użytkownik ma dostęp jako uczestnik pokoju.
  • space.display_name: obsługuje operator : (ma) i filtruje pokoje na podstawie częściowego dopasowania ich wyświetlanej nazwy. Wyniki są ograniczone do 5 najlepiej pasujących pokoi. Na przykład space.display_name:Project wyszukuje wiadomości w 5 najpopularniejszych pokojach, które w wyświetlanej nazwie zawierają słowo „Project”.
  • space.space_type: typ pokoju. Obsługuje tylko =. Na przykład space.space_type="DIRECT_MESSAGE" zwraca tylko wiadomości z czatów. Możliwe wartości to DIRECT_MESSAGE, GROUP_CHAT i SPACE.
  • attachment: obsługuje operator :* (ma dowolny), aby sprawdzić obecność załączników. Jeśli określono parametr attachment:*, zwracane są tylko wiadomości, które mają co najmniej 1 załącznik.
  • annotations.user_mentions.user.name: nazwa zasobu wspomnianego użytkownika (users/{user}). Obsługuje tylko : (has). Na przykład: annotations.user_mentions.user.name:"users/1234567890" zwraca tylko wiadomości, które zawierają wzmiankę o określonym użytkowniku. Możesz też użyć aliasu me, aby filtrować wiadomości, w których wspomniano o użytkowniku wywołującym, na przykład: annotations.user_mentions.user.name:users/me. Możesz też używać adresu e-mail jako aliasu dla domeny {user}, na przykład users/example@gmail.com.

W przypadku filtrowania zaawansowanego dostępne są też te funkcje:

  • has_link(): zwraca tylko wiadomości, które zawierają co najmniej 1 hiperlink w tekście wiadomości.
  • is_unread(): odfiltrowuje wiadomości, które zostały przeczytane przez użytkownika wywołującego.

Użycie filtrów space.display_name lub space.space_type wymaga, aby dane logowania wywołującego zawierały jeden z tych zakresów autoryzacji:

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

Aby użyć filtra is_unread(), dane logowania wywołującego muszą zawierać jeden z tych zakresów autoryzacji:

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

W różnych polach obsługiwane są tylko operatory AND. Prawidłowy przykład: sender.name = "users/1234567890" AND is_unread(). Słowo AND jest opcjonalne i jest domyślne, jeśli zostanie pominięte. Na przykład sender.name = "users/1234567890" is_unread() jest prawidłowy i odpowiada poprzedniemu przykładowi. Nieprawidłowy przykład to sender.name = "users/1234567890" OR is_unread(), ponieważ operator OR nie jest obsługiwany między różnymi polami.

W tym samym polu:

  • create_time obsługuje tylko AND i może być używany tylko do reprezentowania interwału, takiego jak create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00".
  • sender.name obsługuje tylko operator OR, na przykład: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
  • space.name obsługuje tylko operator OR, na przykład: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
  • space.display_name obsługuje operatory AND i OR, ale nie ich kombinację. Na przykład: space.display_name:Project AND space.display_name:Tasks zwraca wiadomości, które znajdują się w pokojach o wyświetlanych nazwach zawierających zarówno Project, jak i Tasks, natomiast space.display_name:Project OR space.display_name:Tasks zwraca wiadomości, które znajdują się w pokojach o wyświetlanych nazwach zawierających Project lub Tasks albo oba te ciągi znaków.
  • space.space_type obsługuje tylko operator OR, na przykład: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
  • annotations.user_mentions.user.name obsługuje operatory AND i OR, ale nie ich kombinację. Na przykład: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" zwraca tylko wiadomości, w których wspomniano o obu użytkownikach, a annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" zwraca wiadomości, w których wspomniano o jednym z użytkowników lub o obu.

Nawiasy są wymagane do uściślenia kolejności operatorów, gdy w tym samym zapytaniu łączysz operatory AND i OR. Przykład: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). W przeciwnym razie nawiasy są opcjonalne.

Poniższe przykładowe zapytania są prawidłowe:

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

Maksymalna długość zapytania to 1000 znaków.

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

int32

Opcjonalnie: Maksymalna liczba wyników do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników.

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

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

string

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

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

string

Opcjonalnie: Kolejność listy wyników.

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

Domyślna kolejność to create_time desc. Obsługiwane jest tylko 1 uporządkowanie na zapytanie (create_time lub relevance). Obsługiwane jest tylko sortowanie malejące (desc), które należy określić po atrybucie order.
markup_syntax

MarkupSyntax

Opcjonalnie: Określa żądaną składnię wyjściową pola formatted_text wiadomości na czacie.
view

SearchMessagesView

Opcjonalnie: Określa, jaki rodzaj widoku wyników wyszukiwania ma zostać zwrócony. Wartość domyślna to SEARCH_MESSAGES_VIEW_BASIC.

SearchMessagesView

Rodzaje widoków obsługiwanych w przypadku częściowych wyników wyszukiwania.

Wartości w polu enum
SEARCH_MESSAGES_VIEW_UNSPECIFIED Wartość domyślna lub nieustawiona. Interfejs API domyślnie używa widoku BASIC.
SEARCH_MESSAGES_VIEW_BASIC Uwzględnia w wynikach tylko pasujące wiadomości, ale nie zawiera dodatkowych metadanych. Jest to wartość domyślna.
SEARCH_MESSAGES_VIEW_FULL Obejmuje wszystkie wyniki: dopasowane wiadomości i dodatkowe metadane.

SearchMessagesResponse

Wiadomość z odpowiedzią na wyszukiwanie wiadomości.

Pola
results[]

SearchMessageResult

Lista wyników wyszukiwania pasujących do zapytania.
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.

SearchSpacesRequest

Żądanie wyszukania listy pokoi na podstawie zapytania.

Pola
use_admin_access

bool

Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

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

int32

Maksymalna liczba pokoi do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 100 pokoi.

Maksymalna wartość to 1000, gdy parametr useAdminAccess jest ustawiony na true. W przeciwnym razie maksymalna wartość to 100. Jeśli użyjesz wartości większej niż maksymalna, zostanie ona automatycznie zmieniona na wartość maksymalną.
page_token

string

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

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

string

Wymagane. Wyszukiwane hasło.

Gdy parametr useAdminAccess ma wartość true, możesz wyszukiwać za pomocą tych parametrów:

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

Gdy useAdminAccess ma wartość false:

  • display_name
  • external_user_allowed
  • space_type

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

Właściwość customer jest wymagana, gdy właściwość useAdminAccess jest ustawiona na true. Służy do wskazania, od którego klienta mają być pobierane pokoje. customers/my_customer to jedyna obsługiwana wartość.

display_name akceptuje tylko operator HAS (:). Tekst do dopasowania jest najpierw dzielony na tokeny, a każdy token jest dopasowywany do prefiksu bez rozróżniania wielkości liter i niezależnie jako podłańcuch w dowolnym miejscu w display_name pokoju. Na przykład Fun Eve pasuje do Fun event lub The evening was fun, ale nie do notFun event ani even. Gdy parametr useAdminAccess jest ustawiony na false, do uzyskania przydatnych wyników wymagany jest parametr display_name. W przeciwnym razie domyślnie zwracana jest pusta odpowiedź.

external_user_allowed może mieć wartość 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 – space_type = "SPACE" OR display_name:"Hello".

W tym samym polu space_type nie obsługuje operatorów AND ani OR. display_name, „space_history_state” i „external_user_allowed” obsługują tylko operatory OR. last_active_time i create_time obsługują operatory AND i OR. Atrybut AND może być używany tylko do reprezentowania przedziału, np. last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Gdy parametr useAdminAccess ma wartość true, prawidłowe są te przykładowe zapytania:

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

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

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

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

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

Gdy parametr useAdminAccess ma wartość false, prawidłowe są te przykładowe zapytania:

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

Maksymalna długość zapytania to 1000 znaków.

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

string

Opcjonalnie: Jak jest uporządkowana lista pokoi.

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

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

Gdy useAdminAccess to false, do porządkowania można używać tylko create_time i relevance. W przypadku tych pól w wyszukiwaniach innych niż administratora obsługiwana jest tylko wartość DESC.

Prawidłowe wartości operacji porządkowania:

  • ASC, aby posortować rosnąco. Wartość domyślna.

  • DESC, aby posortować malejąco.

Obsługiwana składnia, gdy useAdminAccess ma wartość true:

  • 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

Gdy useAdminAccess ma wartość false:

SearchSpacesResponse

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

Pola
spaces[]
(deprecated)

Space

Wycofane: użyj nowego pola results. Strona z żądanymi pokojami. To pole będzie wypełniane tylko wtedy, gdy pole useAdminAccess ma wartość true. Zostało ono wycofane na rzecz nowego pola results.
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.

Wartość jest podawana tylko wtedy, gdy parametr useAdminAccess ma wartość true.
total_size

int32

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

Wartość jest podawana tylko wtedy, gdy parametr useAdminAccess ma wartość true.
results[]

SearchSpaceResult

Tylko dane wyjściowe. Lista wyników wyszukiwania pasujących do zapytania.

SearchSpaceResult

Pojedynczy wynik wyszukiwania pokoju.

Pola
space

Space

Tylko dane wyjściowe. Dopasowany pokój.

Sekcja

Reprezentuje sekcję w Google Chat. Sekcje pomagają użytkownikom porządkować pokoje. Istnieją 2 rodzaje sekcji:

  1. Sekcje systemowe: są to wstępnie zdefiniowane sekcje zarządzane przez Google Chat. Nazwy zasobów są stałe i nie można ich tworzyć, usuwać ani modyfikować ich display_name. Przykłady:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. Własne sekcje: są to sekcje tworzone i zarządzane przez użytkownika. Tworzenie własnej sekcji za pomocą CreateSection wymaga display_name. Własne sekcje można aktualizować za pomocą UpdateSection i usuwać za pomocą DeleteSection.

Pola
name

string

Identyfikator. Nazwa zasobu sekcji.

W przypadku sekcji systemowych identyfikator sekcji jest stałym ciągiem znaków:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

Format: users/{user}/sections/{section}
display_name

string

Opcjonalnie: Wyświetlana nazwa sekcji. Wartość jest podawana tylko w przypadku sekcji typu CUSTOM_SECTION. Może zawierać maksymalnie 80 znaków. Wymagane podczas tworzenia CUSTOM_SECTION.
sort_order

int32

Tylko dane wyjściowe. Kolejność sekcji w stosunku do innych sekcji. Sekcje z niższą wartością sort_order pojawiają się przed sekcjami z wyższą wartością.
type

SectionType

Wymagane. Typ sekcji.

SectionType

Typy sekcji.

Wartości w polu enum
SECTION_TYPE_UNSPECIFIED Nieokreślony typ sekcji.
CUSTOM_SECTION Własna sekcja.
DEFAULT_DIRECT_MESSAGES Sekcja domyślna zawierająca DIRECT_MESSAGE między 2 użytkownikami lub pokoje GROUP_CHAT, które nie należą do żadnej własnej sekcji.
DEFAULT_SPACES Domyślne pokoje, które nie należą do żadnej własnej sekcji.
DEFAULT_APPS Domyślna sekcja zawierająca aplikacje zainstalowane przez użytkownika.

SectionItem

Element sekcji zdefiniowanej przez użytkownika. Służy do reprezentowania elementów sekcji, takich jak pokoje, pogrupowanych w sekcji.

Pola
name

string

Identyfikator. Nazwa zasobu elementu sekcji.

Format: users/{user}/sections/{section}/items/{item}
Pole zbiorcze item. Wymagane. Element sekcji. item może mieć tylko jedną z tych wartości:
space

string

Opcjonalnie: Nazwa zasobu pokoju.

Format: spaces/{space}

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 ludźmi, ustaw Space.spaceType na DIRECT_MESSAGE i Space.singleUserBotDm na false. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Aby utworzyć rozmowę 1:1 między człowiekiem a wywołującą aplikacją Google Chat, ustaw Space.spaceType na DIRECT_MESSAGE i Space.singleUserBotDm na true. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

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

string

Opcjonalnie: Unikalny identyfikator tej prośby. Zalecany jest losowy identyfikator UUID. Podanie identyfikatora żądania sprawia, że żądanie jest idempotentne, co gwarantuje, że wiele identycznych żądań z tym samym identyfikatorem żądania spowoduje utworzenie tylko jednego pokoju. Kolejne żądania z tym samym identyfikatorem żądania zwracają istniejący pokój i nie aktualizują go, nawet jeśli żądane szczegóły różnią się od bieżącego stanu.

Aby skutecznie korzystać z tego pola:

  • Upewnij się, że kolejne żądania są identyczne i używają tych samych danych uwierzytelniających co pierwotne żądanie.
  • Jeśli pokój został już utworzony z podanym identyfikatorem żądania, żądanie zwraca ten pokój. Zwrócony pokój może nie być w pełni wypełniony. Interfejs API zwraca pokój z Twojego żądania z wypełnioną nazwą zasobu przypisaną przez system. Aby pobrać najnowsze metadane pokoju, wywołaj metodę GetSpace.
  • Ponowne użycie istniejącego identyfikatora żądania z innym uwierzytelnionym użytkownikiem spowoduje błąd.
memberships[]

Membership

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

Zestaw obecnie zezwala na maksymalnie 49 członkostw (oprócz dzwoniącego).

W przypadku członkostwa człowieka 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 dzwonienia). Możesz też dodać 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, adres e-mail użytkownika musi być używany w {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 Space.spaceType na SPACE.

Opcjonalne, gdy parametr Space.spaceType ma wartość SPACE.

Wymagane, gdy ustawiasz Space.spaceType na GROUP_CHAT, wraz z co najmniej 2 subskrypcjami.

Wymagane, gdy ustawiasz Space.spaceType na DIRECT_MESSAGE z użytkownikiem i dokładnie 1 subskrypcją.

Musi być puste podczas tworzenia rozmowy 1:1 między człowiekiem a wywołującą aplikacją Google Chat (gdy ustawisz Space.spaceType na DIRECT_MESSAGE i Space.singleUserBotDm na true).

SlashCommand

Metadane dotyczące polecenia po ukośniku w Google Chat.

Pola
command_id

int64

Identyfikator polecenia po ukośniku.

SlashCommandMetadata

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

Pola
bot

User

Aplikacja do 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 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 typu wyliczeniowego. Nie używaj.
ADD Dodaj aplikację do Google Chat do pokoju.
INVOKE wywołać polecenie po ukośniku w pokoju,

Spacja

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

Pola
name

string

Identyfikator. Nazwa zasobu pokoju.

Format: spaces/{space}

{space} to przypisany przez system identyfikator pokoju. 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: użyj zasady space_type. Typ pokoju.
space_type

SpaceType

Opcjonalnie: Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. Tylko dane wyjściowe do innego wykorzystania.
single_user_bot_dm

bool

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

bool

Tylko dane wyjściowe. Wycofana: użyj zasady spaceThreadingState. Określa, czy wiadomości w tym pokoju są pogrupowane w wątki.
display_name

string

Opcjonalnie: Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju z spaceType o wartości SPACE. Jeśli podczas tworzenia pokoju lub aktualizowania displayName pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. 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: Wartość niezmienna. Określa, czy ten pokój może mieć jako członka dowolnego użytkownika Google Chat. Dane wejściowe podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:

  • Uwierzytelniony użytkownik korzysta z konta indywidualnego (niezarządzanego konta użytkownika). Domyślnie pokój utworzony przez konto indywidualne jest dostępny dla każdego użytkownika Google Chat.

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

SpaceThreadingState

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

SpaceDetails

Opcjonalnie: informacje o pokoju, w tym opis i zasady;
space_history_state

HistoryState

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

bool

Opcjonalnie: Czy ten pokój został utworzony w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoje nie są widoczne dla użytkowników, dopóki importowanie nie zostanie zakończone.

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

Timestamp

Opcjonalnie: Wartość niezmienna. W przypadku pokoi utworzonych w Google Chat – czas utworzenia pokoju. To pole jest tylko do odczytu, chyba że jest używane w pokojach w trybie importowania.

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

Wartość jest podawana w danych wyjściowych tylko wtedy, gdy 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 do czatów z aplikacją Google Chat – czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować aplikacje do obsługi czatu i konfigurować czaty z nimi w imieniu użytkowników w organizacji.

Aby obsługiwać instalację przez administratora, aplikacja Google Chat musi obsługiwać czaty.
membership_count

MembershipCount

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

AccessSettings

Opcjonalnie: Określa ustawienie dostępu do pokoju. Wartość jest podawana tylko wtedy, gdy space_type to 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 wyjść z tego trybu 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: Wartość niezmienna. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji, gdy SpaceType to SPACE. W przeciwnym razie nie należy ustawiać.

W formacie customers/{customer}, gdzie customer to id z zasobu klienta pakietu Admin SDK. Aplikacje prywatne mogą też używać aliasu customers/my_customer, aby utworzyć pokój w tej samej organizacji Google Workspace co aplikacja.

To pole nie jest wypełniane w przypadku czatów ani pokoi utworzonych przez użytkowników, którzy nie korzystają z Google Workspace.
Pole zbiorcze space_permission_settings. Reprezentuje zbiór uprawnień pokoju. Wartość jest podawana tylko wtedy, gdy space_type to SPACE. Pole space_permission_settings może mieć tylko jedną z tych wartości:
predefined_permission_settings

PredefinedPermissionSettings

Opcjonalnie: Tylko dane wejściowe. Wstępnie zdefiniowane zbiory uprawnień do pokoju, wprowadzane tylko podczas tworzenia pokoju. Jeśli pole nie jest ustawione, tworzony jest obszar współpracy. Po utworzeniu przestrzeni ustawienia zostaną wpisane w polu PermissionSettings.

Ustawienie wstępnie zdefiniowanych zbiorów uprawnień obsługuje:
permission_settings

PermissionSettings

Opcjonalnie: ustawienia uprawnień w dotychczasowych pokojach; Dane wejściowe do aktualizowania dokładnych ustawień uprawnień do pokoju, w których istniejące ustawienia uprawnień są zastępowane. Dane wyjściowe zawierają listę bieżących ustawień uprawnień.

Odczytywanie i aktualizowanie ustawień uprawnień obsługuje:

AccessPermissionSetting

ustawienie uprawnień dostępu,

Pola
principals[]

Principal

Opcjonalnie: Lista nieuporządkowana. Dozwolone podmioty zabezpieczeń dla tego uprawnienia.

AccessPermissionSettings

mieć dostęp do ustawień uprawnień pokoju;

Pola
discover_space_setting

AccessPermissionSetting

Opcjonalnie: Ustawienie uprawnień dostępu do znajdowania pokoju.
join_space_setting

AccessPermissionSetting

Opcjonalnie: Ustawienie uprawnień dostępu do pokoju.
view_space_membership_setting

AccessPermissionSetting

Opcjonalnie: Ustawienie uprawnień dostępu do wyświetlania użytkowników pokoju. Podczas aktualizowania informacji o tym, kto może wyświetlać subskrypcje pokoju, należy określić tę wartość razem z PermissionSettings.view_space_membership w masce aktualizacji i treści żądania. Przyznając uprawnienia do wyświetlania docelowym odbiorcom, musisz też przyznać uprawnienia PermissionSettings.view_space_membership wszystkim kontom (należącym do grupy/zbioru/zasobu) w tym samym żądaniu. Aby usunąć istniejących docelowych odbiorców (np. aby ograniczyć uprawnienia do wyświetlania tylko do menedżerów pokoju lub asystentów menedżera), podaj pustą wartość AccessPermissionSetting (bez principals).

AccessSettings

Reprezentuje ustawienie dostępu do pokoju.

Pola
access_state

AccessState

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

string

Opcjonalnie: Nazwa zasobu docelowych odbiorców, którzy mogą znaleźć pokój, dołączyć do niego i wyświetlać podgląd wiadomości w pokoju. Jeśli nie ustawisz tej opcji, dostęp do pokoju będą mieć 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 docelowym odbiorcom.

Format: audiences/{audience}

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

Odczytywanie docelowych odbiorców obsługuje:

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

Ustawienie docelowych odbiorców wymaga uwierzytelnienia użytkownika.
access_permission_settings

AccessPermissionSettings

Opcjonalnie: ustawienia uprawnień dostępu do pokoju;

Aby ustawić docelowych odbiorców podczas tworzenia pokoju, określ pole accessSettings.audience w żądaniu.

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órzy zostali dodani lub zaproszeni 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ł docelowym odbiorcom dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, którzy zostali dodani lub zaproszeni do pokoju, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Udostępnianie pokoju określonym użytkownikom.

Tworzenie pokoi możliwych do znalezienia wymaga uwierzytelniania użytkowników.

MembershipCount

Reprezentuje liczbę użytkowników pokoju pogrupowanych według kategorii.

Pola
joined_direct_human_user_count

int32

Tylko dane wyjściowe. Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, nie licząc użytkowników, którzy dołączyli do pokoju, ponieważ należą do grupy, która do niego dołączyła.
joined_group_count

int32

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

PermissionSetting

Reprezentuje ustawienie uprawnień pokoju.

Pola
managers_allowed

bool

Opcjonalnie: Czy właściciele pokoju (ROLE_MANAGER) mają to uprawnienie.
members_allowed

bool

Opcjonalnie: Czy zwykli użytkownicy pokoju (ROLE_MEMBER) mają to uprawnienie.
assistant_managers_allowed

bool

Opcjonalnie: Czy menedżerowie pokoju (ROLE_ASSISTANT_MANAGER) mają to uprawnienie.

PermissionSettings

Zbiór uprawnień, które możesz określić podczas aktualizowania istniejącej nazwanej przestrzeni.

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

Pola
manage_members_and_groups

PermissionSetting

Opcjonalnie: Ustawienie 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 umożliwiające włączanie i wyłączanie historii pokoju.
use_at_mention_all

PermissionSetting

Opcjonalnie: Ustawienie używania @all w pokoju.
manage_apps

PermissionSetting

Opcjonalnie: Ustawienie zarządzania aplikacjami w pokoju.
manage_webhooks

PermissionSetting

Opcjonalnie: Ustawienie 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.
view_space_membership

PermissionSetting

Opcjonalnie: Ustawienie wyświetlania członkostwa w pokoju. Podczas aktualizowania informacji o tym, kto może wyświetlać subskrypcję pokoju, należy określić tę wartość razem z AccessPermissionSettings.view_space_membership_setting w masce aktualizacji i treści żądania. Jeśli ograniczasz uprawnienia do wyświetlania do określonych ról (np. tylko menedżerów pokoju lub asystentów menedżera), określ tutaj uprawnienia do ról i podaj pusty parametr AccessPermissionSettings.view_space_membership_setting w tym samym żądaniu. Jeśli docelowi odbiorcy są skonfigurowani w usłudze AccessPermissionSettings.view_space_membership_setting, to ustawienie musi być przyznane wszystkim użytkownikom.

PredefinedPermissionSettings

Wstępnie zdefiniowane zbiory 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 pokojach nazwanych 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 jest pokojem do współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości.
ANNOUNCEMENT_SPACE Ustawienie, które pozwala przekształcić pokój w pokój z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości.

Podmiot zabezpieczeń

Podmiot zabezpieczeń reprezentujący podmiot, któremu przyznano dostęp.

Pola
Pole zbiorcze principal_type. Typ podmiotu zabezpieczeń. principal_type może mieć tylko jedną z tych wartości:
audience

Audience

Odbiorcy.

SpaceDetails

informacje o pokoju, w tym opis i zasady;

Pola
description

string

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

Może zawierać maksymalnie 4096 znaków.
guidelines

string

Opcjonalnie: zasady, oczekiwania i etykietę obowiązujące w pokoju;

Może zawierać maksymalnie 5000 znaków.

SpaceThreadingState

Określa typ stanu wątków w pokoju czatu.

Wartości w polu enum
SPACE_THREADING_STATE_UNSPECIFIED Zarezerwowane.
THREADED_MESSAGES pokoje, które obsługują wątki wiadomości; Gdy użytkownicy odpowiadają na wiadomość, mogą to zrobić w wątku, co pozwala zachować kontekst oryginalnej wiadomości.
GROUPED_MESSAGES pokoje nazwane, w których rozmowy są uporządkowane według tematów; Tematy i odpowiedzi na nie są połączone w grupy.
UNTHREADED_MESSAGES

pokoje, które nie obsługują wątków wiadomości; Ten stan wątków w pokoju jest używany tylko w szczególnych przypadkach, takich jak:

  • Ciągły czat spotkania, w którym wątki są celowo wyłączone.
  • starszych rozmów grupowych utworzonych przed 2022 r.

SpaceType

Typ pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. Tylko dane wyjściowe do innego wykorzystania.

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

Typ

Wycofana: użyj zasady SpaceType.

Wartości w polu enum
TYPE_UNSPECIFIED Zarezerwowane.
ROOM Rozmowy między co najmniej 2 osobami.
DM Czat indywidualny między człowiekiem a aplikacją do Google Chat, w którym wszystkie wiadomości są płaskie. Nie obejmuje to czatów między 2 osobami.

SpaceBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu aktualizacji pokoju.

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

Pola
spaces[]

SpaceUpdatedEventData

Lista zaktualizowanych pokoi.

SpaceEvent

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

Pola
name

string

Nazwa zasobu zdarzenia dotyczącego pokoju.

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

Timestamp

Czas wystąpienia zdarzenia.
event_type

string

Typ zdarzenia w pokoju. Każdy typ zdarzenia ma wersję grupową, która reprezentuje wiele wystąpień danego typu zdarzenia w krótkim czasie. W przypadku żądań spaceEvents.list() pomiń typy zdarzeń grupowych w filtrze zapytania. 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ęta wiadomość: google.workspace.chat.message.v1.deleted
  • Kilka 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:

  • Nowy członek społeczności: 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 kilka 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
  • Kilka nowych reakcji: google.workspace.chat.reaction.v1.batchCreated
  • Wiele usuniętych reakcji: google.workspace.chat.reaction.v1.batchDeleted

Obsługiwane typy zdarzeń dotyczących pokoju:

  • Zaktualizowano pokój: google.workspace.chat.space.v1.updated
  • Aktualizacje wielu pokoi: google.workspace.chat.space.v1.batchUpdated

Pole zbiorcze payload.

Pole 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 dotyczący zaktualizowanej wiadomości.

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

MessageDeletedEventData

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

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

MessageBatchCreatedEventData

Ładunek 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 dotyczący wielu aktualizacji pokoju.

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

MembershipCreatedEventData

Ładunek zdarzenia dotyczący nowego członkostwa.

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

MembershipUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.

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

MembershipDeletedEventData

Ładunek zdarzenia dotyczący usuniętej subskrypcji.

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

MembershipBatchCreatedEventData

Ładunek zdarzenia dla wielu nowych subskrypcji.

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

MembershipBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.

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

MembershipBatchDeletedEventData

Ładunek 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 dotyczący 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 wyciszenia powiadomień w pokoju.

MuteSetting

Typy ustawień wyciszania powiadomień w pokoju.

Wartości w polu enum
MUTE_SETTING_UNSPECIFIED Zarezerwowane.
UNMUTED Użytkownik będzie otrzymywać powiadomienia dotyczące pokoju zgodnie z ustawieniami 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 Zarezerwowane.
ALL Powiadomienia są wywoływane przez @wzmianki, obserwowane wątki i pierwsze wiadomości 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. Niedostępne w przypadku czatów 1:1.
FOR_YOU Powiadomienie jest wywoływane przez @wzmianki i obserwowane wątki. Nie są dostępne w przypadku czatów 1:1.
OFF Powiadomienie jest wyłączone.

SpaceReadState

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

Pola
name

string

Nazwa zasobu stanu odczytu pokoju.

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

Timestamp

Opcjonalnie: Czas zaktualizowania stanu odczytu pokoju użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości lub sygnaturze czasowej określonej przez użytkownika, która oznacza ostatnią przeczytaną pozycję w pokoju.

SpaceUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanego pokoju.

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

Pola
space

Space

Zaktualizowany pokój.

SpaceView

Widok określający, które pola powinny być wypełnione w zasobie Space. Aby zapewnić zgodność z przyszłymi wersjami, zalecamy uwzględnienie w kodzie dodatkowych wartości.

Wartości w polu enum
SPACE_VIEW_UNSPECIFIED Wartość domyślna lub nieustawiona.
SPACE_VIEW_RESOURCE_NAME_ONLY Wypełnia tylko nazwę zasobu Space.
SPACE_VIEW_EXPANDED Wypełnia pola zasobów pokoju. Uwaga: pole permissionSettings nie zostanie wypełnione. Żądania, które określają SPACE_VIEW_EXPANDED, muszą zawierać zakresy, które umożliwiają odczytywanie danych pokoju, np. https://www.googleapis.com/auth/chat.spaces lub https://www.googleapis.com/auth/chat.spaces.readonly.

Wątek

Wątek w pokoju Google Chat. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na niego.

Jeśli podczas tworzenia wiadomości określisz wątek, możesz ustawić pole messageReplyOption, aby określić, co się stanie, jeśli nie zostanie znaleziony 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. Może zawierać maksymalnie 4000 znaków.

Ten identyfikator jest unikalny dla aplikacji Google Chat, która go ustawia. Jeśli na przykład kilka aplikacji Google Chat 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, określ pole wątku name.

ThreadReadState

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

Pola
name

string

Nazwa zasobu stanu odczytu wątku.

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

Timestamp

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

UpdateAvailabilityRequest

Komunikat żądania dla metody UpdateAvailability.

Pola
availability

Availability

Wymagane. Dostępność do zaktualizowania.
update_mask

FieldMask

Wymagane. Lista pól do zaktualizowania. Jedynym polem, które można zaktualizować, jest custom_status.

UpdateMembershipRequest

Komunikat z prośbą o aktualizację subskrypcji.

Pola
membership

Membership

Wymagane. Subskrypcja, którą chcesz zaktualizować. Aktualizowane są tylko pola określone przez update_mask.
update_mask

FieldMask

Wymagane. Ścieżki pól do zaktualizowania. Rozdziel wartości przecinkami lub użyj *, aby zaktualizować wszystkie ścieżki pól.

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

  • role
use_admin_access

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu OAuth 2.0 chat.admin.memberships.

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. Rozdziel wartości przecinkami lub użyj *, aby zaktualizować wszystkie ścieżki pól.

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

bool

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

UpdateSectionRequest

Komunikat żądania dotyczący aktualizowania sekcji.

Pola
section

Section

Wymagane. Sekcja do zaktualizowania.
update_mask

FieldMask

Wymagane. Maska określająca, które pola mają zostać zaktualizowane.

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

  • display_name

UpdateSpaceNotificationSettingRequest

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

Pola
space_notification_setting

SpaceNotificationSetting

Wymagane. Nazwa zasobu ustawień powiadomień w 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 żądania dla 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 dzwoniącego.

Aby odwołać się do użytkownika, który dzwoni, ustaw jedną z tych wartości:

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

  • adres e-mail Workspace tej osoby, 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 najnowszej wiadomości, pokój jest wyświetlany w interfejsie jako nieprzeczytany.

Aby oznaczyć pokój jako przeczytany, ustaw last_read_time na dowolną wartość późniejszą (większą) niż czas utworzenia ostatniej wiadomości. Wartość last_read_time jest wymuszana, aby odpowiadała czasowi utworzenia ostatniej wiadomości. Pamiętaj, że stan odczytu pokoju wpływa tylko na stan odczytu wiadomości, które są widoczne w rozmowie na najwyższym poziomie pokoju. Ta sygnatura czasowa nie ma wpływu na odpowiedzi w wątkach, które zależą od stanu odczytu wątku.

UpdateSpaceRequest

Prośba o zaktualizowanie pojedynczego pokoju.

Pola
space

Space

Wymagane. Pokój z polami do zaktualizowania. Parametr Space.name musi mieć format 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 i wytyczne pokoju. W żądaniu aktualizacji musisz przekazać zarówno opis, jak i wytyczne jako SpaceDetails. Jeśli chcesz zaktualizować tylko jedno z tych pól, podaj dotychczasową wartość drugiego pola.

display_name: obsługuje tylko aktualizowanie wyświetlanej nazwy 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. Uwzględnij display_name razem z space_type w masce aktualizacji i upewnij się, że określony pokój ma niepustą wyświetlaną nazwę i typ pokoju SPACE. Uwzględnienie maski space_type i typu SPACE w określonym pokoju podczas aktualizowania wyświetlanej nazwy jest opcjonalne, jeśli istniejący pokój ma już typ SPACE. Próba zaktualizowania typu pokoju w inny sposób spowoduje błąd nieprawidłowego argumentu. space_type nie jest obsługiwany w przypadku useAdminAccess.

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

access_settings.audience: aktualizuje ustawienie dostępu określające, kto może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w nazwanym pokoju, w którym pole spaceType ma wartość SPACE. Jeśli istniejący pokój ma docelowych odbiorców, możesz usunąć odbiorców i ograniczyć dostęp do pokoju, pomijając wartość tej maski pola. Aby zaktualizować ustawienia dostępu do pokoju, uwierzytelniający 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 określonym użytkownikom. access_settings.audience nie jest obsługiwany w przypadku useAdminAccess.

access_settings.access_permission_settings: aktualizuje ustawienia uprawnień dostępu, które określają, kto może znaleźć pokój i do niego dołączyć, gdy pole spaceType ma wartość SPACE. Podmioty zabezpieczeń, które mogą dołączyć do pokoju, muszą też mieć możliwość jego znalezienia. Aby zaktualizować ustawienia uprawnień dostępu do pokoju, uwierzytelniający użytkownik musi być menedżerem pokoju lub asystentem menedżera 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 określonym użytkownikom. access_settings.access_permission_settings nie jest obsługiwany w przypadku useAdminAccess. Obsługiwane maski pól:

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

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. Obsługiwane maski pól:

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

bool

Opcjonalnie: Gdy parametr ma wartość true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik wywołujący musi być administratorem Google Workspace z uprawnieniami do zarządzania rozmowami na czacie i w pokojach.

Wymaga zakresu OAuth 2.0 chat.admin.spaces.

Niektóre wartości FieldMask nie są obsługiwane w przypadku dostępu administracyjnego. Szczegółowe informacje znajdziesz w opisie update_mask.

Użytkownik

Użytkownik w Google Chat.

Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe zasobu User (np. w interfejsach Messages i Memberships API) zwracane w odpowiedzi na żądanie zawierają tylko pola name i type zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązania z użytkownikiem wywołującym.

Pola
name

string

Nazwa zasobu user w Google Chat.

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

W przypadku human users {user} jest tym samym identyfikatorem użytkownika co:

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

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

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

string

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

Wypełniane zarówno w przypadku uwierzytelniania aplikacji, jak i uwierzytelniania użytkownika. To pole jest zawsze wypełniane w przypadku żądań wysyłanych z uwierzytelnianiem aplikacji. Podczas wywoływania interfejsów API Messages i Memberships z uwierzytelnianiem użytkownika to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązanie z wywołującym użytkownikiem.
avatar_url

string

Tylko dane wyjściowe. Adres URL awatara użytkownika.

Podczas wywoływania interfejsów API Messages i Memberships z uwierzytelnianiem użytkownika to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązanie z wywołującym użytkownikiem.
email

string

Tylko dane wyjściowe. To adres e-mail użytkownika.

Gdy interfejsy API Messages i Memberships są wywoływane z uwierzytelnianiem użytkownika, to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązanie z wywołującym użytkownikiem.
domain_id

string

Unikalny identyfikator domeny Google Workspace użytkownika.
type

Type

Typ użytkownika.
is_anonymous

bool

Tylko dane wyjściowe. Gdy true, konto użytkownika zostało usunięte lub jego profil nie jest widoczny, np. gdy użytkownik został wspomniany w pokoju, ale nie jest jego członkiem i nie ma wcześniejszych powiązań z użytkownikiem, który go wywołał.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. 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 typu wyliczeniowego. 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. Przyciski to również oneof data i tylko jedno z tych pól powinno być ustawione.
Pole zbiorcze data. WidgetMarkup może zawierać tylko jeden z tych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól WidgetMarkup. data może mieć tylko jedną z tych wartości:
text_paragraph

TextParagraph

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

Image

Wyświetl obraz w tym widżecie.
key_value

KeyValue

Wyświetl parę klucz-wartość w tym widżecie.

Przycisk

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

Pola

Pole zbiorcze type.

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

TextButton

Przycisk z tekstem i działaniem onclick.
image_button

ImageButton

Przycisk z obrazem i działaniem onclick.

FormAction

Działanie 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 identyfikacji części formularza, która spowodowała jego przesłanie. 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 ciągu znaków, które należy podać, gdy wywoływana jest metoda działania. Rozważmy na przykład 3 przyciski odłożenia: odłóż teraz, odłóż na 1 dzień, odłóż na następny tydzień. Możesz użyć zdarzenia action method = snooze(), przekazując typ i czas drzemki na liście parametrów ciągu znaków.

Pola
key

string

Nazwa parametru skryptu działania.
value

string

Wartość parametru.

Ikona

Zestaw obsługiwanych ikon.

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

Obraz

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

Format obrazu (szerokość i wysokość). To pole pozwala zarezerwować odpowiednią wysokość obrazu podczas oczekiwania na jego wczytanie. Nie ma on zastępować wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go, pobierając obraz z wyprzedzeniem.

ImageButton

Przycisk obrazu z działaniem onclick.

Pola
on_click

OnClick

Działanie onclick.
name

string

Nazwa tego elementu image_button używana na potrzeby ułatwień dostępu. Jeśli nie podasz tej nazwy, zostanie użyta wartość domyślna.
Pole zbiorcze icons. Ikonę można określić za pomocą Icon enum lub adresu URL. icons może mieć tylko jedną z tych wartości:
icon

Icon

Ikona określona przez enum, która wskazuje ikonę udostępnianą 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ć pewne działania, takie jak przycisk onclick.

Pola
top_label

string

Tekst górnej etykiety. 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. Sformatowany tekst jest obsługiwany i zawsze wymagany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
content_multiline

bool

Czy treść powinna być wielowierszowa.
bottom_label

string

Tekst dolnej etykiety. 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 górna etykieta, dolna etykieta i obszar treści.
Pole zbiorcze icons. Musisz zdefiniować co najmniej jedną z tych właściwości: ikony, top_label i bottom_label. icons może mieć tylko jedną z tych wartości:
icon

Icon

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

string

Ikona określona przez adres URL.
Pole zbiorcze control. Widżet sterujący. Możesz ustawić button lub switch_widget, ale nie obie te wartości. control może mieć tylko jedną z tych wartości:
button

Button

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

OnClick

onclick działanie (np. otwarcie linku).

Pola

Pole zbiorcze data.

Pole 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 działaniem onclick.

Pola
text

string

Tekst na przycisku.
on_click

OnClick

Działanie onclick 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