Package google.chat.v1

ButtonList

Lista przycisków.

ResponseType

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

string

Tylko dane wejściowe. Adres URL, którego użytkownicy używają do uwierzytelniania lub konfigurowania. (Dotyczy tylko typów odpowiedzi REQUEST_CONFIG).

DialogAction

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z dialogiem. Musi być dołączony ResponseType.Dialog.

UpdatedWidget

Tylko dane wejściowe. Odpowiedź zaktualizowanego widżetu.

SelectionItem

Tablica obiektów SelectionItem.

string

Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał prośbę o aktualizację.

SelectionItems

Lista wyników autouzupełniania w widżetach

Code

Kod stanu.

string

Treść wiadomości, która ma być wysłana do użytkowników w związku ze stanem ich prośby. Jeśli nie jest ustawiony, wysyłana jest ogólna wiadomość na podstawie status_code.

AnnotationType

Typ adnotacji.

int32

Długość podciągu w treści wiadomości w postaci zwykłego tekstu, do której odnosi się ta adnotacja.

int32

Indeks początkowy (od 0 włącznie) w zwykłym tekście treści wiadomości, do której odnosi się ta adnotacja.

UserMentionMetadata

Metadane wzmianki o użytkowniku.

SlashCommandMetadata

Metadane polecenia po ukośniku.

RichLinkMetadata

Metadane linku rozszerzonego.

string

Tylko dane wyjściowe. Adres URL hostujący obraz GIF.

string

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

string

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

string

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

string

Tylko dane wyjściowe. Adres URL miniatury, który powinien być używany do wyświetlania podglądu załącznika dla użytkownika. Aplikacje do czatu nie powinny używać tego adresu URL do pobierania treści załączników.

string

Tylko dane wyjściowe. Adres URL do pobrania, który należy użyć, aby umożliwić użytkownikowi pobranie załącznika. Aplikacje do czatu nie powinny używać tego adresu URL do pobierania treści załączników.

Source

Tylko dane wyjściowe. Źródło załącznika.

AttachmentDataRef

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

DriveDataRef

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

string

Opcjonalnie: Nazwa zasobu danych załącznika. To pole jest używane z interfejsem Media API do pobierania danych załączonych.

string

Opcjonalnie: Nieprzejrzysty token zawierający odwołanie do przesłanego załącznika. Jest traktowany przez klientów jako nieprzejrzysty ciąg znaków i używany do tworzenia lub aktualizowania wiadomości Google Chat z załącznikami.

string

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

Card

Kartę Maksymalny rozmiar to 32 KB.

string

Pokój powiązanego zasobu pokoju czatu.

Format: spaces/{space}

string

Wątek powiązanego zasobu pokoju czatu.

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

string

Wiadomość z powiązanego zasobu pokoju czatu.

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

string

Wymagane. Nazwa zasobu pokoju w trybie importowania.

Format: spaces/{space}

Space

Pokój w trybie importowania.

CardHeader

Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz.

Section

Sekcje są rozdzielane linią.

CardAction

Czynności związane z tą kartą.

string

Nazwa karty.

string

Etykieta wyświetlana w menu czynności.

OnClick

Działanie onclick dla tego elementu działania.

string

Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli określony jest zarówno tytuł, jak i podtytuł, każdy z nich zajmuje jeden wiersz. Jeśli podany jest tylko tytuł, zajmuje on obie linie.

string

Podtytuł nagłówka karty.

ImageStyle

Typ obrazu (np. kwadratowe lub okrągłe obramowanie).

string

Adres URL obrazu w nagłówku karty.

string

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

WidgetMarkup

Sekcja musi zawierać co najmniej 1 widżet.

CustomEmoji

Wymagane. Niestandardowy emotikon do utworzenia.

string

Wymagane. Nazwa zasobu pokoju, dla którego chcesz utworzyć członkostwo.

Format: spaces/{space}

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 inne podane nazwy.

Gdy aplikacja do czatu tworzy relację członkostwa dla użytkownika, musi użyć określonych zakresów autoryzacji i ustawić określone wartości w pewnych polach:

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

• Podczas uwierzytelniania się jako aplikacja wymagany jest zakres autoryzacji chat.app.memberships. Uwierzytelnianie się jako aplikacja jest dostępne w tych usługach:

• Ustaw user.type na HUMAN, a user.name na 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 też być id osoby z interfejsu People API lub id użytkownika z interfejsu Directory API. Jeśli na przykład identyfikator profilu użytkownika w interfejsie People API to 123456789, możesz dodać użytkownika do pokoju, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.user@example.com

Gdy aplikacja do czatu 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.

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Tworzenie subskrypcji aplikacji lub subskrypcji dla użytkowników spoza organizacji Google Workspace administratora nie jest obsługiwane przy użyciu dostępu administratora.

string

Wymagane. Nazwa zasobu pokoju, w którym chcesz utworzyć wiadomość.

Format: spaces/{space}

Message

Wymagane. Treść wiadomości.

string

Opcjonalnie: Wycofane: użyj w zastępstwie zasady thread.thread_key. Identyfikator wątku. Obsługuje maksymalnie 4000 znaków. Aby rozpocząć wątek lub dodać do niego wiadomość, utwórz wiadomość i określ threadKey lub thread.name. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

string

Opcjonalnie: Unikalny identyfikator żądania dla tej wiadomości. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie wiadomości utworzonej z tym identyfikatorem, a nie utworzenie nowej wiadomości.

MessageReplyOption

Opcjonalnie: Określa, czy wiadomość rozpoczyna wątek, czy na niego odpowiada. Obsługiwane są tylko nazwane pokoje.

Gdy reagujesz na interakcje użytkowników, to pole jest ignorowane. W przypadku interakcji w wątku odpowiedź jest tworzona w tym samym wątku. W przeciwnym razie odpowiedź zostanie utworzona jako nowy wątek.

string

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

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

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

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

string

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

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

Reaction

Wymagane. Reakcja do utworzenia.

Space

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

Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

Przecinek name jest przypisany na serwerze, więc wszystko określone w tym polu zostanie zignorowane.

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora żądania spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd.

string

Identyfikator. Nazwa zasobu niestandardowego emotikonu przypisanego przez serwer.

Format: customEmojis/{customEmoji}

string

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

string

Opcjonalnie: Niezmienna. Podana przez użytkownika nazwa niestandardowego emotikonu, która jest unikalna w organizacji.

Wymagane podczas tworzenia niestandardowego emotikonu, w przeciwnym razie tylko dane wyjściowe.

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

Przykład: :valid-emoji-name:

string

Tylko dane wyjściowe. Adres URL obrazu niestandardowego emotikonu, który jest ważny przez co najmniej 10 minut. Pamiętaj, że niestandardowe emotikony nie są wypełniane w odpowiedzi podczas tworzenia.

CustomEmojiPayload

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

bytes

Wymagane. Tylko dane wejściowe. Obraz użyty do emotikonu niestandardowego.

Dane ładunku nie mogą przekraczać 256 KB, a wymiar obrazu musi mieścić się w zakresie od 64 do 500 pikseli. Ograniczenia mogą ulec zmianie.

string

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

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

string

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

Format: customEmojis/{customEmoji}

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

string

Wymagane. Nazwa zasobu członkostwa, które chcesz usunąć. Aplikacje do czatu mogą usuwać członkostwa użytkowników lub własne. Aplikacje do obsługi czatu nie mogą usuwać członkostwa w innych aplikacjach.

Podczas usuwania subskrypcji użytkownika wymagany jest zakres chat.memberships i format spaces/{space}/members/{member}. Możesz użyć adresu e-mail jako aliasu dla {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

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

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

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

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

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu {message} możesz użyć wartości z pola clientAssignedMessageId. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.

bool

Opcjonalnie: Gdy true, usunięcie wiadomości powoduje też usunięcie odpowiedzi na niej. Jeśli false, a wiadomość ma odpowiedzi w wątku, usunięcie się nie powiedzie.

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

string

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

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

string

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

Format: spaces/{space}

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga chat.admin.delete zakresu OAuth 2.0.

DeletionType

Wskazuje, kto usunął wiadomość.

Card

Tylko dane wejściowe. Treść dialogu, który jest renderowany w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: DateTimePicker, OnChangeAction.

ActionStatus

Tylko dane wejściowe. Stan prośby o wywołanie lub przesłanie dialogu. W razie potrzeby wyświetla stan i komunikat dla użytkowników. Na przykład w przypadku błędu lub sukcesu.

Dialog

Tylko dane wejściowe. Dialog dotyczący prośby.

string

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

DriveDataRef

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

string

Typ MIME połączonego zasobu na Dysku Google.

string

Opcjonalnie: Podstawowy emotikon reprezentowany przez ciąg znaków Unicode.

CustomEmoji

Tylko dane wyjściowe. niestandardowy emotikon;

Emoji

Tylko dane wyjściowe. emotikony powiązane z reakcjami.

int32

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

string

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

Format: users/{user}, gdzie {user} to albo id dla osoby z People API albo id dla użytkownika w Directory API. Jeśli na przykład identyfikator profilu w People API to 123456789, możesz znaleźć wiadomość bezpośrednią z tą osobą, podając users/123456789 jako name. Po uwierzytelnieniu się jako użytkownik możesz używać adresu e-mail jako aliasu {user}. Na przykład users/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

string

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

string

Wymagane. Nazwa zasobu niestandardowego emotikonu.

Format: customEmojis/{customEmoji}

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

string

Wymagane. Nazwa zasobu subskrypcji do pobrania.

Aby uzyskać członkostwo w aplikacji za pomocą uwierzytelnienia 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 {member}. Na przykład spaces/{space}/members/example@gmail.com, gdzie example@gmail.com to adres e-mail użytkownika Google Chat.

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

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

Uzyskiwanie członkostwa w aplikacji w przestrzeni nie jest obsługiwane, gdy używasz dostępu administratora.

string

Wymagane. Nazwa zasobu wiadomości.

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

Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu {message} możesz użyć wartości z pola clientAssignedMessageId. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.

string

Wymagane. Nazwa zasobu zdarzenia dotyczącego pokoju.

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

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 może się znajdować tylko identyfikator użytkownika lub adres e-mail dzwoniącego.

string

Wymagane. Nazwa zasobu z czytaniem stanu pokoju do pobrania.

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

Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:

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

• adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/spaceReadState.

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

Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni

string

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

Format: spaces/{space}

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

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

string

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

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

Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:

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

• adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

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

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

string

Nazwa zasobu grupy Google.

Reprezentuje grupę w Cloud Identity Groups API.

Format: groups/{group}

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 podana, wartość domyślna to 25. Maksymalna wartość to 200; wartości powyżej 200 są zmieniane na 200.

string

Opcjonalnie: (jeśli wznawiasz działanie po poprzednim zapytaniu).

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

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

string

Opcjonalnie: Filtr zapytania.

Obsługuje filtrowanie według twórcy.

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

Na przykład to zapytanie zwraca niestandardowy emotikon utworzony przez wywołującego:

creator("users/me")

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

CustomEmoji

Lista nieuporządkowana. Lista niestandardowych emotikonów na żądanej (lub pierwszej) stronie.

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.

string

Wymagane. Nazwa zasobu pokoju, z którego chcesz pobrać listę członków.

Format: spaces/{space}

int32

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

Jeśli nie podasz tej wartości, zwróci się 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.

string

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

Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

string

Opcjonalnie: Filtr zapytania.

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

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

Aby filtrować według typu, ustaw wartość member.type na HUMAN lub BOT. Możesz też filtrować 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.

Gdy element use_admin_access ma wartość Prawda, wymagana jest właściwość member.type = "HUMAN" lub member.type != "BOT". Inne filtry typu członka 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"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

bool

Opcjonalnie: Gdy true, zwraca również wspieranie powiązane z Google Group, oprócz innych typów wspierania. Jeśli ustawiona jest opcja filter, Google Group subskrypcje, które nie pasują do kryteriów filtra, nie są zwracane.

bool

Opcjonalnie: Jeśli true, zwraca również wspierających powiązanych z invited, oprócz innych typów wspierających. Jeśli ustawisz filtr, invitednie zwracane są subskrypcje, które nie spełniają kryteriów filtra.

Obecnie wymaga uwierzytelnienia użytkownika.

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

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

Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane, gdy używasz dostępu administratora.

Membership

Lista nieuporządkowana. Lista członkostw na stronie, której dotyczy żądanie (lub pierwszej stronie).

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.

string

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

Format: spaces/{space}

int32

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

Jeśli nie podano tej wartości, zwracana jest maksymalna liczba 25.

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

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

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 inne parametry powinny być takie same jak w wywołaniu, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

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 za pomocą sygnatury czasowej w formacie RFC-3339 i podwójnych cudzysłowów. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większego >, aby wyświetlić wiadomości utworzone po podanej sygnaturze czasowej, lub operatora mniejszego <, aby wyświetlić wiadomości utworzone przed podaną sygnaturą czasową. Aby odfiltrować wiadomości w okresie czasu, użyj operatora AND między dwoma sygnaturami czasowymi.

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

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

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

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

string

Opcjonalnie: kolejność wyświetlania listy wiadomości; Określ wartość do posortowania za pomocą operacji sortowania. Prawidłowe wartości operacji sortowania:

• ASC w kolejności rosnącej.

• DESC, aby je posortować malejąco.

Domyślne sortowanie to create_time ASC.

bool

Opcjonalnie: Określa, czy mają być uwzględniane usunięte wiadomości. Usuwane wiadomości zawierają czas usunięcia i metadane dotyczące ich usunięcia, ale ich treść jest niedostępna.

Message

Lista wiadomości.

string

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

string

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

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

int32

Opcjonalnie: Maksymalna liczba zwróconych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie zostanie podana, wartość domyślna to 25. Maksymalna wartość to 200; wartości powyżej 200 są zmieniane na 200.

string

Opcjonalnie: (jeśli wznawiasz działanie po poprzednim zapytaniu).

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

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

string

Opcjonalnie: Filtr zapytania.

Reakcje możesz filtrować według emotikonów (emoji.unicode lub emoji.custom_emoji.uid) oraz użytkowników (user.name).

Aby filtrować reakcje na wiele emotikonów lub użytkowników, złącz podobne pola za pomocą operatora OR, takiego jak 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 w zapytaniu występują 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}"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

Reaction

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

string

token kontynuacji do pobrania następnej strony wyników. Na ostatniej stronie wyników jest puste.

string

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

Format: spaces/{space}.

int32

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

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

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania zdarzenia dotyczącego miejsca na liście. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry podawane do zdarzeń listowania miejsc na stronie muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

string

Wymagane. Filtr zapytania.

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

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

• start_time: sygnatura czasowa, od której należy zacząć wyświetlać wydarzenia dotyczące miejsca. Możesz wyświetlić listę zdarzeń, które miały miejsce do 28 dni temu. Jeśli nie jest określone, wyświetla się lista zdarzeń w czasie rzeczywistym z ostatnich 28 dni.
• end_time: sygnatura czasowa, do której są wyświetlane zdarzenia w pokoju. Jeśli nie zostanie podany, wyświetli zdarzenia do momentu wysłania żądania.

Aby określić czas rozpoczęcia lub zakończenia, użyj operatora równa się = i formatu RFC-3339. Aby filtrować według właściwości 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"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

SpaceEvent

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

string

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

int32

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

Jeśli nie zostanie podany, zwróci maksymalnie 100 miejsc.

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

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

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. Podanie innej wartości może prowadzić do nieoczekiwanych wyników.

string

Opcjonalnie: Filtr zapytania.

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

Aby filtrować według typu pokoju, musisz podać prawidłową wartość z układu, np. SPACE lub GROUP_CHAT (wartość space_type nie może być równa SPACE_TYPE_UNSPECIFIED). Aby zapytać o kilka 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"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

Space

Lista pokoi na stronie, której dotyczy żądanie (lub na pierwszej stronie). Uwaga: w przypadku żądań listy pole permissionSettings nie jest zwracane w obiekcie pokoju.

string

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

string

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

string

Identyfikator. Nazwa zasobu członkostwa przypisana przez serwer.

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

MembershipState

Tylko dane wyjściowe. Stan członkostwa.

MembershipRole

Opcjonalnie: Rola użytkownika w pokoju czatu, która określa jego uprawnienia w pokoju.

To pole może być używane tylko w przypadku UpdateMembership.

Timestamp

Opcjonalnie: Niezmienna. Czas utworzenia członkostwa, np. kiedy użytkownik dołączył do pokoju lub został do niego zaproszony. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

Timestamp

Opcjonalnie: Niezmienna. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

User

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

Group

Opcjonalnie: Grupa Google, do której należy użytkownik.

Aby odczytać lub zmienić członkostwo w Grupach dyskusyjnych Google, musisz uwierzytelnić użytkownika.

MembershipCreatedEventData

Lista nowych wspierających.

MembershipDeletedEventData

Lista usuniętych wspierań.

MembershipUpdatedEventData

lista zaktualizowanych wspierań;

Membership

Nowe członkostwo.

Membership

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

Membership

Zaktualizowane członkostwo.

string

Identyfikator. Nazwa zasobu wiadomości.

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

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

Jeśli podczas tworzenia wiadomości ustawisz niestandardowy identyfikator, możesz użyć tego identyfikatora, aby określić wiadomość 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 Nazywanie wiadomości.

User

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user name i type.

Timestamp

Opcjonalnie: Niezmienna. W przypadku pokoi utworzonych w Google Chat – czas utworzenia wiadomości. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane w pomieszczeniach w trybie importowania.

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

Timestamp

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

Timestamp

Tylko dane wyjściowe. Czas usunięcia wiadomości z Google Chat. Jeśli wiadomość nigdy nie została usunięta, to pole jest puste.

string

Opcjonalnie: Treść wiadomości w postaci zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wyświetlenie elementu prowadzącego do podglądu. Możesz też wzmiankować użytkownika Google Chat lub wszystkich użytkowników pokoju.

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

string

Tylko dane wyjściowe. Zawiera wiadomość text z dodanymi znacznikami, które wskazują formatowanie. To pole może nie uwzględniać całego formatowania widocznego w interfejsie użytkownika, ale obejmuje:

• Składnia znaczników do pogrubienia, kursywy, przekreślenia, czcionki monospace, bloku czcionki monospace i listy punktowanej.

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

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

• niestandardowe emotikony w formacie :{emoji_name}:, na przykład :smile:; Nie dotyczy to emotikonów Unicode, takich jak U+1F600, które oznaczają uśmiechniętą buźkę.

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

Card

Wycofane: użyj w zastępstwie zasady cards_v2.

bogate, sformatowane i interaktywne karty, które możesz wykorzystać do wyświetlania elementów UI, takich jak sformatowany tekst, przyciski i klikalne obrazy; Karty są zwykle wyświetlane pod zwykłym tekstem treści wiadomości. cards i cards_v2 mogą mieć maksymalny rozmiar 32 KB.

CardWithId

Opcjonalnie: Tablica kart.

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

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

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Annotation

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

Thread

Wątek, do którego należy wiadomość. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

Space

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

string

Opcjonalnie: Tekstowy opis kart wiadomości, używany, gdy nie można wyświetlić samych kart (np. w przypadku powiadomień mobilnych).

ActionResponse

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

string

Tylko dane wyjściowe. Treść wiadomości w postaci zwykłego tekstu bez wzmianek o aplikacji do obsługi czatu.

SlashCommand

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

Attachment

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

MatchedUrl

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

bool

Tylko dane wyjściowe. Jeśli true, wiadomość jest odpowiedzią w wątku odpowiedzi. Jeśli false, wiadomość jest widoczna w rozmowie na najwyższym poziomie pokoju jako pierwsza wiadomość wątku lub wiadomość bez wątków.

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

string

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

EmojiReactionSummary

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

User

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

• Przyłącza
• Widżety akcesoriów

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

DeletionMetadata

Tylko dane wyjściowe. informacje o usuniętej wiadomości; Wiadomość jest usuwana, gdy ustawiona jest wartość delete_time.

QuotedMessageMetadata

Tylko dane wyjściowe. Informacje o wiadomości, którą użytkownik Google Chat zacytował w pokoju. Użytkownicy Google Chat mogą zacytować wiadomość, aby na nią odpowiedzieć.

AttachedGif

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

AccessoryWidget

Opcjonalnie: Co najmniej 1 interaktywna widżet, który pojawia się u dołu wiadomości. Do wiadomości, które zawierają tekst, karty lub tekst i karty, możesz dodawać widżety dodatkowe. Nieobsługiwane w przypadku wiadomości zawierających dialogi. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów na dole wiadomości.

Tworzenie wiadomości z widżetami akcesoriów wymaga uwierzytelniania aplikacji.

MessageCreatedEventData

lista nowych wiadomości;

MessageDeletedEventData

lista usuniętych wiadomości;

MessageUpdatedEventData

Lista zaktualizowanych wiadomości.

Message

Nowa wiadomość.

Message

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

Message

Zaktualizowana wiadomość.

string

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

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

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy wiadomość cytowana została utworzona lub zaktualizowana.

string

Identyfikator. Nazwa zasobu reakcji.

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

User

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

Emoji

Wymagane. Emotikon użyty w reakcji.

ReactionCreatedEventData

lista nowych reakcji;

ReactionDeletedEventData

lista usuniętych reakcji;

Reaction

Nowa reakcja.

Reaction

Usunięta reakcja.

string

Identyfikator URI tego linku.

RichLinkType

Typ linku rozszerzonego.

DriveLinkData

Dane linku do Dysku.

ChatSpaceLinkData

Dane dotyczące linku do pokoju czatu.

bool

Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

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

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

int32

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

Jeśli nie zostanie podany, zwróci maksymalnie 100 miejsc.

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

string

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

Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

string

Wymagane. zapytanie;

Możesz wyszukiwać za pomocą tych parametrów:

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

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

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

Funkcja display_name akceptuje tylko operator HAS (:). Tekst dopasowywania jest najpierw dzielony na tokeny, a każdy z nich jest dopasowywany do prefiksu niezależnie od wielkości liter.display_name Na przykład reguła Fun Eve pasuje do Fun event lub The evening was fun, ale nie do notFun event ani even.

external_user_allowed może przyjmować wartość true lub false.

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

Wymagana jest wartość space_type, 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 funkcja space_type nie obsługuje operatorów AND ani OR. display_name, 'space_history_state' i 'external_user_allowed' obsługują tylko operatory OR. Atrybuty last_active_time i create_time obsługują operatory AND i OR. AND może być używane tylko do reprezentowania przedziału, np. last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Prawidłowe są te przykładowe zapytania:

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

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

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

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

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

string

Opcjonalnie: kolejność listy pokoi.

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

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

Prawidłowe wartości operacji sortowania:

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

• DESC, aby je posortować malejąco.

Obsługiwane składnie:

• 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

Space

strona z żądanymi pokojami.

string

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

int32

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

Space

Wymagane. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw Space.spaceType na SPACE, a Space.displayName na. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

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

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

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

Jeśli pokój DIRECT_MESSAGE już istnieje, zamiast tworzyć nowy pokój, zwracany jest ten pokój.

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora żądania spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd.

Membership

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

Obecnie zestaw pozwala na maksymalnie 20 członków (oprócz dzwoniącego).

W przypadku członkostwa osoby fizycznej pole Membership.member musi zawierać user z wypełnionym name (format: users/{user}), a type musi być ustawiony na User.Type.HUMAN. Podczas konfigurowania pokoju możesz dodawać tylko użytkowników będących ludźmi (dodawanie aplikacji Google Chat jest obsługiwane tylko w przypadku konfigurowania wiadomości bezpośrednich za pomocą aplikacji do połączeń). Możesz też dodać użytkowników, używając adresu e-mail jako aliasu dla {user}. Na przykład pole user.name może być polem users/example@gmail.com. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, musisz użyć adresu e-mail użytkownika do {user}.

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

Opcjonalny, gdy wartość Space.spaceType to SPACE.

Wymagane, gdy Space.spaceType ma wartość GROUP_CHAT, oraz co najmniej 2 uczestnictwa.

Jest on wymagany, jeśli ustawisz wartość Space.spaceType na DIRECT_MESSAGE dla użytkownika będącego osobą fizyczną, a także dokładnie 1 subskrypcję.

Musi być pusty podczas tworzenia rozmowy 1:1 między człowiekiem a aplikacją Google Chat (gdy Space.spaceType to DIRECT_MESSAGE, a Space.singleUserBotDm to true).

int64

Identyfikator wywołanego polecenia po ukośniku.

User

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

Type

Typ polecenia po ukośniku.

string

Nazwa wywołanego polecenia po ukośniku.

int64

Identyfikator wywołanego polecenia po ukośniku.

bool

Wskazuje, czy polecenie po ukośniku jest przeznaczone do dialogu.

string

Identyfikator. Nazwa zasobu pokoju.

Format: spaces/{space}

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

Type

Tylko dane wyjściowe. Wycofane: użyj w zastępstwie zasady space_type. Typ pokoju.

SpaceType

Opcjonalnie: Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania typu pokoju. Dane wyjściowe tylko do innych zastosowań.

bool

Opcjonalnie: Czy pokój to czat między botem a jedną osobą.

bool

Tylko dane wyjściowe. Wycofane: użyj w zastępstwie zasady spaceThreadingState. czy wiadomości są w tym pokoju uporządkowane w wątki.

string

Opcjonalnie: Wyświetlana nazwa pokoju. Wymagany 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. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

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

Obsługuje do 128 znaków.

bool

Opcjonalnie: Niezmienna. Określa, czy ten pokój pozwala na dodawanie dowolnego użytkownika Google Chat jako członka. Dane wprowadzane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych przypadkach:

• Użytkownik uwierzytelniony korzysta z konta klienta (niezarządzanego konta użytkownika). Domyślnie pokój utworzony przez konto użytkownika indywidualnego jest dostępny dla wszystkich użytkowników Google Chat.

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

SpaceThreadingState

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

SpaceDetails

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

HistoryState

Opcjonalnie: stan historii wiadomości i wątków w tym pokoju;

bool

Opcjonalnie: Czy ten pokój został utworzony w Import Mode w ramach migracji danych do Google Workspace. Podczas importowania pokoi są one niewidoczne dla użytkowników, dopóki proces importowania nie zostanie ukończony.

Tworzenie pokoju w Import Mode wymaga uwierzytelniania użytkownika.

Timestamp

Opcjonalnie: Niezmienna. w przypadku pokoi utworzonych w Google Chat – czas utworzenia pokoju; To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane w pomieszczeniach w trybie importowania.

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

Jest wypełniane w wyniku tylko wtedy, gdy wartość spaceType to GROUP_CHAT lub SPACE.

Timestamp

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

bool

Tylko dane wyjściowe. W przypadku czatów z pojedynczymi osobami w aplikacji Google Chat sprawdzaj, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat w aplikacji Chat w imieniu użytkowników w organizacji.

Aby umożliwić instalację przez administratora, aplikacja Google Chat musi obsługiwać wiadomości bezpośrednie.

MembershipCount

Tylko dane wyjściowe. Liczba wspierających pogrupowanych według typu wspierającego. Wypełniane, gdy wartość space_type to SPACE, DIRECT_MESSAGE lub GROUP_CHAT.

AccessSettings

Opcjonalnie: Określa ustawienie dostępu pokoju. Wypełniane tylko wtedy, gdy wartość space_type to SPACE.

string

Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju.

string

Opcjonalnie: Niezmienna. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i wartością SpaceType SPACE. W przeciwnym razie nie należy go ustawiać.

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

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

PredefinedPermissionSettings

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

PermissionSettings

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

AccessState

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

string

Opcjonalnie: Nazwa zasobu grupy odbiorców, która może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w pokoju. Jeśli nie jest ustawiona, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, które zostały zaproszone indywidualnie lub dodane do pokoju. Więcej informacji znajdziesz w artykule Ustawianie pokoju w taki sposób, aby był on możliwy do znalezienia przez grupę odbiorców.

Format: audiences/{audience}

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

Czytanie informacji o grupie odbiorców umożliwia:

• Uwierzytelnianie użytkowników

• Uwierzytelnianie w aplikacji z zatwierdzaniem przez administratora w zakresie chat.app.spaces

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

Aby ustawić grupę odbiorców, musisz uwierzytelnić użytkownika.

int32

Tylko dane wyjściowe. Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględnienia użytkowników, którzy dołączyli do pokoju jako członkowie grupy.

int32

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

bool

Opcjonalnie: czy menedżerowie pokoju mają to uprawnienie.

bool

Opcjonalnie: Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie.

PermissionSetting

Opcjonalnie: Ustawienie dotyczące zarządzania użytkownikami i grupami w pokoju.

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

Opcjonalnie: Ustawienie zarządzania aplikacjami w pokoju.

PermissionSetting

Opcjonalnie: Ustawienie zarządzania webhookami w pokoju.

PermissionSetting

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

PermissionSetting

Opcjonalnie: Ustawienie odpowiadania na wiadomości w pokoju.

string

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

Obsługuje do 150 znaków.

string

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

Obsługuje do 5000 znaków.

SpaceUpdatedEventData

lista zaktualizowanych pokoi;

string

Nazwa zasobu zdarzenia dotyczącego pokoju.

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

Timestamp

Czas wystąpienia zdarzenia.

string

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

Obsługiwane typy zdarzeń messages:

• 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
• Wiele nowych wiadomości: google.workspace.chat.message.v1.batchCreated
• Wiele zaktualizowanych wiadomości: google.workspace.chat.message.v1.batchUpdated
• Wiele usuniętych wiadomości: google.workspace.chat.message.v1.batchDeleted

Obsługiwane typy zdarzeń memberships:

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

Obsługiwane typy zdarzeń w przypadku reakcji:

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

Obsługiwane typy zdarzeń dotyczących pokoju:

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

MessageCreatedEventData

ładunek zdarzeń dla nowej wiadomości.

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

MessageUpdatedEventData

Ładunek zdarzenia dla zaktualizowanej wiadomości.

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

MessageDeletedEventData

Ładunek zdarzenia dotyczący usuniętej wiadomości.

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

MessageBatchCreatedEventData

ładunek zdarzeń dla wielu nowych wiadomości.

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

MessageBatchUpdatedEventData

Ładunek zdarzeń dla wielu zaktualizowanych wiadomości.

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

MessageBatchDeletedEventData

Payload zdarzenia dla wielu usuniętych wiadomości.

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

SpaceUpdatedEventData

ładunek zdarzeń dla aktualizacji pokoju;

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

SpaceBatchUpdatedEventData

Ładunek zdarzeń dla wielu aktualizacji pokoju.

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

MembershipCreatedEventData

Ładunek zdarzenia dotyczący nowego wspierania.

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

MembershipUpdatedEventData

Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.

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

MembershipDeletedEventData

Ładunek zdarzenia dotyczący usuniętej subskrypcji.

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

MembershipBatchCreatedEventData

Ładunek zdarzeń dotyczącego wielu nowych subskrypcji.

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

MembershipBatchUpdatedEventData

Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.

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

MembershipBatchDeletedEventData

Ładunek zdarzenia dotyczący wielu usuniętych wspierań.

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

ReactionCreatedEventData

ładunek zdarzeń dla nowej reakcji;

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

ReactionDeletedEventData

Ładunek zdarzenia dotyczący usuniętej reakcji.

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

ReactionBatchCreatedEventData

Ładunek zdarzeń dla wielu nowych reakcji.

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

ReactionBatchDeletedEventData

Ładunek zdarzenia dla wielu usuniętych reakcji.

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

string

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

NotificationSetting

Ustawienie powiadomień.

MuteSetting

Ustawienie wyciszenia powiadomień z pokoju.

string

Nazwa zasobu z informacją o stanie odczytu pokoju.

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

Timestamp

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

Space

zaktualizowany pokój.

string

Identyfikator. Nazwa zasobu wątku.

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

string

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

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

string

Nazwa zasobu stanu odczytu wątku.

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

Timestamp

Czas zaktualizowania stanu przeczytania wątku przez użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku.

Membership

Wymagane. Subskrypcja do zaktualizowania. Zaktualizowane są tylko pola określone przez update_mask.

FieldMask

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

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

• role

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga chat.admin.memberships zakresu OAuth 2.0.

Message

Wymagane. Wiadomość z zaktualizowanymi polami.

FieldMask

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

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

• text

• attachment

• cards (wymaga uwierzytelniania w aplikacji).

• cards_v2 (wymaga uwierzytelniania w aplikacji).

• accessory_widgets (wymaga uwierzytelniania w aplikacji).

bool

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

SpaceNotificationSetting

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

FieldMask

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

SpaceReadState

Wymagane. Stan odczytu pokoju i pola do zaktualizowania.

Obsługuje tylko aktualizowanie stanu odczytania przez dzwoniącego użytkownika.

Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:

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

• adres e-mail Workspace, Na przykład: users/user@example.com/spaces/{space}/spaceReadState.

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

Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni

FieldMask

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

• last_read_time

Jeśli last_read_time jest wcześniejsza niż czas utworzenia ostatniej wiadomości, pokój jest widoczny jako nieprzeczytany w interfejsie.

Aby oznaczyć pokój jako przeczytany, ustaw wartość last_read_time na dowolną wartość późniejszą (większą) niż czas utworzenia ostatniej wiadomości. Wartość last_read_time jest dopasowywana do czasu utworzenia ostatniej wiadomości. Pamiętaj, że stan odczytania pokoju wpływa tylko na stan odczytania wiadomości widocznych w rozmowie na najwyższym poziomie pokoju. Ten sygnatura czasowa nie ma wpływu na odpowiedzi w wątkach, które są zależne od stanu odczytu wątku.

Space

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

FieldMask

Wymagane. zaktualizowane ścieżki pól, rozdzielone przecinkami (jeśli jest ich więcej).

Możesz zaktualizować te pola pokoju:

space_details: zaktualizuje opis pokoju. Obsługuje do 150 znaków.

display_name: obsługuje tylko aktualizowanie wyświetlanej nazwy w przypadku pokoi, w których pole spaceType ma wartość SPACE. Jeśli pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innej wartości. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

space_type: obsługuje tylko zmianę typu pokoju GROUP_CHAT na SPACE. Upewnij się, że w masce aktualizacji znajduje się opcja display_name oraz space_type, a wybrana przestrzeń ma niepustą nazwę i typ SPACE. Dodanie 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 powoduje błąd nieprawidłowego argumentu. Funkcja space_type nie jest obsługiwana w przypadku useAdminAccess.

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

access_settings.audience: aktualizuje ustawienia dostępu, aby określić, kto może znaleźć pokój, dołączyć do niego i wyświetlić podgląd wiadomości w pokoju o nazwie, w którym pole spaceType ma wartość SPACE. Jeśli istniejący pokój ma grupę odbiorców, możesz ją usunąć i ograniczyć dostęp do pokoju, pomijając wartość w polu maski. Aby zaktualizować ustawienia dostępu do pokoju, uwierzytelniający użytkownik musi być menedżerem pokoju i nie może pominąć żadnych innych pól w prośbie. Nie możesz zaktualizować tego pola, jeśli pokój jest w trybie importowania. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników. Funkcja access_settings.audience nie jest obsługiwana w przypadku useAdminAccess.

permission_settings: umożliwia zmianę ustawień uprawnień pokoju. Podczas aktualizowania ustawień uprawnień możesz określić tylko maski pól permissionSettings. Nie możesz jednocześnie aktualizować innych masek pól. Funkcja permissionSettings nie jest obsługiwana w przypadku useAdminAccess. 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

bool

Opcjonalnie: Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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

Wymaga chat.admin.spaces zakresu OAuth 2.0.

Niektóre wartości FieldMask nie są obsługiwane przy użyciu dostępu administratora. Więcej informacji znajdziesz w opisie update_mask.

string

Nazwa zasobu w Google Chat user.

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

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

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

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

• adres e-mail użytkownika może być używany jako alias dla {user} w żądaniach interfejsu API; Jeśli na przykład identyfikator profilu użytkownika w People API dla user@example.com to 123456789, możesz użyć users/user@example.com jako aliasu do odwołania do users/123456789. Zwrócona zostanie tylko kanoniczna nazwa zasobu (np. users/123456789).

string

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

string

Unikalny identyfikator domeny Google Workspace użytkownika.

Type

Typ użytkownika.

bool

Tylko dane wyjściowe. Gdy true, użytkownik zostaje usunięty lub jego profil jest niewidoczny.

User

Wspominany użytkownik.

Type

Typ wzmianki o użytkowniku.

Button

Lista przycisków. Pola przycisków mają też wartość oneof data i tylko jedno z tych pól powinno być ustawione.

TextParagraph

Wyświetlanie akapitu tekstu w tym widżecie.

Image

Wyświetlanie obrazu w tym widżecie.

KeyValue

Wyświetlanie w tym widżecie elementu klucz-wartość.

TextButton

Przycisk z tekstem i czynnością onclick.

ImageButton

Przycisk z obrazem i czynnością onclick

string

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

ActionParameter

Lista parametrów działania.

string

Nazwa parametru skryptu działania.

string

Wartość parametru.

string

Adres URL obrazu.

OnClick

Działanie onclick.

double

Współczynnik proporcji tego obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości dla obrazu podczas oczekiwania na jego załadowanie. Nie ma on na celu zastąpienia wbudowanego współczynnika proporcji obrazu. Jeśli nie jest ustawiony, serwer wypełnia go, pobierając obraz z pamięci podręcznej.

OnClick

Działanie onclick.

string

Nazwa tego image_button, który jest używany w ułatwieniach dostępu. Jeśli nie podasz tej nazwy, zostanie podana wartość domyślna.

Icon

Ikona określona przez enum, która odwołuje się do ikony dostarczonej przez interfejs Chat API.

string

Ikona określona za pomocą adresu URL.