Indeks
ChatService
(interfejs)AccessoryWidget
(komunikat)ActionResponse
(komunikat)ActionResponse.ResponseType
(wyliczenie)ActionResponse.SelectionItems
(komunikat)ActionResponse.UpdatedWidget
(komunikat)ActionStatus
(komunikat)Annotation
(komunikat)AnnotationType
(wyliczenie)AttachedGif
(komunikat)Attachment
(komunikat)Attachment.Source
(wyliczenie)AttachmentDataRef
(komunikat)CardWithId
(komunikat)ChatSpaceLinkData
(komunikat)CompleteImportSpaceRequest
(komunikat)CompleteImportSpaceResponse
(komunikat)ContextualAddOnMarkup
(komunikat)ContextualAddOnMarkup.Card
(komunikat)ContextualAddOnMarkup.Card.CardAction
(komunikat)ContextualAddOnMarkup.Card.CardHeader
(komunikat)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(wyliczenie)ContextualAddOnMarkup.Card.Section
(komunikat)CreateMembershipRequest
(komunikat)CreateMessageRequest
(komunikat)CreateMessageRequest.MessageReplyOption
(wyliczenie)CreateReactionRequest
(komunikat)CreateSpaceRequest
(komunikat)CustomEmoji
(komunikat)DeleteMembershipRequest
(komunikat)DeleteMessageRequest
(komunikat)DeleteReactionRequest
(komunikat)DeleteSpaceRequest
(komunikat)DeletionMetadata
(komunikat)DeletionMetadata.DeletionType
(wyliczenie)Dialog
(komunikat)DialogAction
(komunikat)DriveDataRef
(komunikat)DriveLinkData
(komunikat)Emoji
(komunikat)EmojiReactionSummary
(komunikat)FindDirectMessageRequest
(komunikat)GetAttachmentRequest
(komunikat)GetMembershipRequest
(komunikat)GetMessageRequest
(komunikat)GetSpaceEventRequest
(komunikat)GetSpaceReadStateRequest
(komunikat)GetSpaceRequest
(komunikat)GetThreadReadStateRequest
(komunikat)Group
(komunikat)HistoryState
(wyliczenie)ListMembershipsRequest
(komunikat)ListMembershipsResponse
(komunikat)ListMessagesRequest
(komunikat)ListMessagesResponse
(komunikat)ListReactionsRequest
(komunikat)ListReactionsResponse
(komunikat)ListSpaceEventsRequest
(komunikat)ListSpaceEventsResponse
(komunikat)ListSpacesRequest
(komunikat)ListSpacesResponse
(komunikat)MatchedUrl
(komunikat)Membership
(komunikat)Membership.MembershipRole
(wyliczenie)Membership.MembershipState
(wyliczenie)MembershipBatchCreatedEventData
(komunikat)MembershipBatchDeletedEventData
(komunikat)MembershipBatchUpdatedEventData
(komunikat)MembershipCreatedEventData
(komunikat)MembershipDeletedEventData
(komunikat)MembershipUpdatedEventData
(komunikat)Message
(komunikat)MessageBatchCreatedEventData
(komunikat)MessageBatchDeletedEventData
(komunikat)MessageBatchUpdatedEventData
(komunikat)MessageCreatedEventData
(komunikat)MessageDeletedEventData
(komunikat)MessageUpdatedEventData
(komunikat)QuotedMessageMetadata
(komunikat)Reaction
(komunikat)ReactionBatchCreatedEventData
(komunikat)ReactionBatchDeletedEventData
(komunikat)ReactionCreatedEventData
(komunikat)ReactionDeletedEventData
(komunikat)RichLinkMetadata
(komunikat)RichLinkMetadata.RichLinkType
(wyliczenie)SearchSpacesRequest
(komunikat)SearchSpacesResponse
(komunikat)SetUpSpaceRequest
(komunikat)SlashCommand
(komunikat)SlashCommandMetadata
(komunikat)SlashCommandMetadata.Type
(wyliczenie)Space
(komunikat)Space.AccessSettings
(komunikat)Space.AccessSettings.AccessState
(wyliczenie)Space.MembershipCount
(komunikat)Space.PermissionSetting
(komunikat)Space.PermissionSettings
(komunikat)Space.PredefinedPermissionSettings
(wyliczenie)Space.SpaceDetails
(komunikat)Space.SpaceThreadingState
(wyliczenie)Space.SpaceType
(wyliczenie)Space.Type
(wyliczenie)SpaceBatchUpdatedEventData
(komunikat)SpaceEvent
(komunikat)SpaceReadState
(komunikat)SpaceUpdatedEventData
(komunikat)Thread
(komunikat)ThreadReadState
(komunikat)UpdateMembershipRequest
(komunikat)UpdateMessageRequest
(komunikat)UpdateSpaceReadStateRequest
(komunikat)UpdateSpaceRequest
(komunikat)User
(komunikat)User.Type
(wyliczenie)UserMentionMetadata
(komunikat)UserMentionMetadata.Type
(wyliczenie)WidgetMarkup
(komunikat)WidgetMarkup.Button
(komunikat)WidgetMarkup.FormAction
(komunikat)WidgetMarkup.FormAction.ActionParameter
(komunikat)WidgetMarkup.Icon
(wyliczenie)WidgetMarkup.Image
(komunikat)WidgetMarkup.ImageButton
(komunikat)WidgetMarkup.KeyValue
(komunikat)WidgetMarkup.OnClick
(komunikat)WidgetMarkup.OpenLink
(komunikat)WidgetMarkup.TextButton
(komunikat)WidgetMarkup.TextParagraph
(komunikat)
ChatService
Umożliwia deweloperom tworzenie aplikacji Google Chat i integracji na platformie Google Chat.
CompleteImportSpace |
---|
Wykonuje proces importowania do określonego pokoju i sprawia, że jest on widoczny dla użytkowników. Wymaga uwierzytelniania aplikacji i przekazywania dostępu w całej domenie. Więcej informacji znajdziesz w artykule Autoryzowanie importowania danych przez aplikacje Google Chat.
|
CreateMembership |
---|
Tworzy członkostwo dla aplikacji Google Chat, użytkownika lub grupy dyskusyjnej Google. Tworzenie wspierania kanału w innych aplikacjach do obsługi czatu nie jest obsługiwane. Jeśli podczas tworzenia członkostwa dany użytkownik ma wyłączoną zasadę automatycznego akceptowania, zostanie zaproszony i będzie musiał zaakceptować zaproszenie do pokoju, zanim dołączy. W przeciwnym razie utworzenie członkostwa spowoduje dodanie użytkownika bezpośrednio do określonego pokoju. Wymaga uwierzytelniania użytkownika. Przykłady użycia:
|
CreateMessage |
---|
Tworzy wiadomość w pokoju Google Chat. Przykład: Wysyłanie wiadomości. Metoda Ten obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelniania aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawca wiadomości. Treść wiadomości może zawierać tekst ( Ten obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkowników. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje wiadomości do aplikacji, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst ( Maksymalny rozmiar wiadomości wraz z jej treścią to 32 000 bajtów.
|
CreateReaction |
---|
Tworzy reakcję i dodaje ją do wiadomości. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład znajdziesz w sekcji Dodawanie reakcji do wiadomości. Wymaga uwierzytelniania użytkownika.
|
CreateSpace |
---|
Tworzy pokój bez użytkowników. Tej opcji można używać do tworzenia nazwanego pokoju. Pokoje pogrupowane według tematów nie są obsługiwane. Przykład znajdziesz w artykule Tworzenie pokoju. Jeśli podczas tworzenia pokoju zobaczysz komunikat o błędzie Jeśli jesteś uczestnikiem programu podglądu dla deweloperów, możesz utworzyć czat grupowy w trybie importowania za pomocą Wymaga uwierzytelniania użytkownika.
|
DeleteMembership |
---|
Usuwa subskrypcję. Przykład: usuwanie użytkownika lub aplikacji Google Chat z pokoju. Wymaga uwierzytelniania użytkownika.
|
DeleteMessage |
---|
Usuwa wiadomość. Przykład: Usuwanie wiadomości Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. Gdy używasz uwierzytelniania aplikacji, żądania mogą usuwać tylko wiadomości utworzone przez wywołującą aplikację Google Chat.
|
DeleteReaction |
---|
Usuwa reakcję na wiadomość. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład znajdziesz w sekcji Usuwanie reakcji. Wymaga uwierzytelniania użytkownika.
|
DeleteSpace |
---|
Usuwa nazwany pokój. Zawsze wykonywane jest kaskadowe usuwanie, co oznacza, że zasoby podrzędne pokoju – takie jak wiadomości opublikowane w pokoju i informacje o członkostwie w pokoju – również są usuwane. Przykład: Usuwanie pokoju. Wymaga uwierzytelnienia użytkownika przez użytkownika, który ma uprawnienia do usunięcia pokoju.
|
FindDirectMessage |
---|
Zwraca istniejące bezpośrednie wiadomości z określonym użytkownikiem. Jeśli nie znaleziono obszaru czatu, zwraca błąd Uwierzytelnianie użytkownika zwraca przestrzeń czatu między określonym użytkownikiem a uwierzytelnionym użytkownikiem. W przypadku uwierzytelniania aplikacji zwraca przestrzeń czatu między określonym użytkownikiem a wywołującą aplikację Google Chat. Wymaga uwierzytelniania użytkownika lub uwierzytelniania aplikacji.
|
GetAttachment |
---|
Pobiera metadane załącznika do wiadomości. Dane załącznika są pobierane za pomocą interfejsu media API. Przykład znajdziesz w artykule Pobieranie metadanych załącznika wiadomości. Wymaga uwierzytelniania aplikacji.
|
GetMembership |
---|
Zwraca informacje o subskrypcji. Przykład znajdziesz w artykule Uzyskiwanie informacji o subskrypcji użytkownika lub aplikacji Google Chat. Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.
|
GetMessage |
---|
Zwraca informacje o wiadomości. Przykład: Uzyskiwanie informacji o wiadomości. Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. Uwaga: może to spowodować wysłanie wiadomości od zablokowanego użytkownika lub pokoju.
|
GetSpace |
---|
Zwraca informacje o pokoju. Przykład: Uzyskiwanie informacji o pokoju. Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.
|
GetSpaceEvent |
---|
Zwraca wydarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zasobu, która uległa zmianie. Jeśli na przykład zażądasz zdarzenia dotyczącego nowej wiadomości, ale wiadomość zostanie później zaktualizowana, serwer zwróci zaktualizowany zasób Wymaga uwierzytelniania użytkownika. Aby uzyskać dostęp do wydarzenia, uwierzytelniony użytkownik musi być członkiem pokoju. Przykład znajdziesz w artykule Uzyskiwanie informacji o wydarzeniu z pokoju Google Chat.
|
GetSpaceReadState |
---|
Zwraca informacje o stanie odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład: uzyskiwanie informacji o stanie odczytu pokoju użytkownika. Wymaga uwierzytelniania użytkownika.
|
GetThreadReadState |
---|
Zwraca szczegóły dotyczące stanu odczytu przez użytkownika w wątku, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Instrukcje znajdziesz w sekcji Uzyskiwanie szczegółowych informacji o stanie odczytu wątku użytkownika. Wymaga uwierzytelniania użytkownika.
|
ListMemberships |
---|
Wyświetla listę użytkowników w pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Lista użytkowników korzystających z uwierzytelniania aplikacji zawiera listę użytkowników w pokojach, do których aplikacja Google Chat ma dostęp. Nie uwzględnia przynależności do aplikacji Google Chat, w tym własnych. Lista użytkowników z ustawieniem Uwierzytelnianie użytkowników zawiera listę użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik. Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.
|
ListMessages |
---|
Wyświetla listę wiadomości z pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Jeśli wyświetlisz wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. Jeśli używasz interfejsu REST/HTTP, odpowiedź zawiera pusty obiekt JSON,
|
ListReactions |
---|
Lista reakcji na wiadomość. Więcej informacji znajdziesz w sekcji Wyświetlanie listy reakcji na wiadomość. Wymaga uwierzytelniania użytkownika.
|
ListSpaceEvents |
---|
Wyświetla listę zdarzeń 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 osób w pokoju, serwer zwróci zasoby Wymaga uwierzytelniania użytkownika. Aby wyświetlić listę zdarzeń, uwierzytelniony użytkownik musi być członkiem pokoju. Przykład znajdziesz w artykule Wyświetlanie listy zdarzeń z pokoju Google Chat.
|
ListSpaces |
---|
Wyświetla listę pokoi, do których należy rozmówca. Czaty grupowe i czaty nie zostaną wyświetlone, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w sekcji Tworzenie listy pokoi. Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. Wyświetla listę pokoi widocznych dla rozmówcy lub uwierzytelnionego użytkownika. Czaty grupowe i czaty nie zostaną wyświetlone, dopóki nie zostanie wysłana pierwsza wiadomość. Aby wyświetlić wszystkie nazwane pokoje według organizacji Google Workspace, użyj metody
|
SearchSpaces |
---|
use_admin_access na true .
|
SetUpSpace |
---|
Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik nawiązujący połączenie jest automatycznie dodawany do pokoju i nie powinien być określony jako członek w prośbie. Przykład znajdziesz w sekcji Konfigurowanie pokoju z początkowymi użytkownikami. Aby określić osoby, które mają zostać dodane, dodaj członkostwa za pomocą odpowiednich właściwości Aby określić grupy dyskusyjne Google, które chcesz dodać, dodaj członków za pomocą odpowiednich właściwości W przypadku nazwanego pokoju lub czatu grupowego: jeśli rozmówca zablokuje połączenie, jest zablokowany przez niektórych użytkowników lub nie ma uprawnień do dodawania niektórych osób, wtedy tacy użytkownicy nie zostaną dodani do utworzonego pokoju. Aby utworzyć wiadomość bezpośrednią (DM) między użytkownikiem wywołującym a innym użytkownikiem, określ dokładnie 1 członkostwo reprezentujące użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie nie zostanie wysłane, a wiadomość prywatna nie zostanie utworzona. Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw opcję Jeśli istnieje już czat pomiędzy 2 użytkownikami, nawet jeśli jeden z nich zablokuje drugiego w momencie wysyłania żądania, to istniejący czat zostanie zwrócony. Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie Wymaga uwierzytelniania użytkownika.
|
UpdateMembership |
---|
Aktualizuje subskrypcję. Przykład znajdziesz w artykule Aktualizowanie użytkowników pokoju w pokoju. Wymaga uwierzytelniania użytkownika.
|
UpdateMessage |
---|
Aktualizuje wiadomość. Metody Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników. Gdy używasz uwierzytelniania aplikacji, żądania mogą aktualizować tylko wiadomości utworzone przez wywołującą aplikację Google Chat.
|
UpdateSpace |
---|
Aktualizuje pokój. Przykład znajdziesz w artykule Aktualizowanie pokoju. Jeśli podczas aktualizowania pola Wymaga uwierzytelniania użytkownika.
|
UpdateSpaceReadState |
---|
Aktualizuje stan odczytu użytkownika w pokoju, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w sekcji Aktualizowanie stanu odczytu pokoju użytkownika. Wymaga uwierzytelniania użytkownika.
|
AccessoryWidget
Co najmniej jeden interaktywny widżet wyświetlany u dołu wiadomości. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.
Pola | |
---|---|
Pole sumy action . Typ działania. action może mieć tylko jedną z tych wartości: |
|
button_list |
Lista przycisków. |
ActionResponse
Parametry, których aplikacja do obsługi czatu może używać do konfigurowania sposobu publikowania odpowiedzi.
Pola | |
---|---|
type |
Tylko dane wejściowe. Typ odpowiedzi aplikacji Google Chat. |
url |
Tylko dane wejściowe. Adres URL, który użytkownicy mogą uwierzytelniać lub konfigurować. (Tylko w przypadku |
dialog_action |
Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji powiązane z oknem. Wymagany jest dokument |
updated_widget |
Tylko dane wejściowe. Odpowiedź zaktualizowanego widżetu. |
ResponseType
Typ odpowiedzi aplikacji Google Chat.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Typ domyślny obsługiwany jako NEW_MESSAGE . |
NEW_MESSAGE |
Opublikuj jako nową wiadomość w temacie. |
UPDATE_MESSAGE |
Zaktualizuj wiadomość w aplikacji Google Chat. Jest to dozwolone tylko w zdarzeniu CARD_CLICKED , w którym typ nadawcy wiadomości to BOT . |
UPDATE_USER_MESSAGE_CARDS |
Zaktualizuj karty w wiadomości do 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 widżetu. |
SelectionItems
Lista wyników autouzupełniania widżetów.
Pola | |
---|---|
items[] |
Tablica obiektów SelectionItem. |
UpdatedWidget
Odpowiedź zaktualizowanego widżetu. Służy do udostępniania opcji autouzupełniania widżetu.
Pola | |
---|---|
widget |
Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał żądanie aktualizacji. |
Pole sumy 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 |
Lista wyników autouzupełniania widżetów |
ActionStatus
Reprezentuje stan żądania wywołania lub przesłania okna.
Pola | |
---|---|
status_code |
Kod stanu. |
user_facing_message |
Wiadomość wysyłana do użytkowników z informacją o stanie prośby. Jeśli zasada jest nieskonfigurowana, wysyłana jest ogólna wiadomość na podstawie |
Adnotacja
Tylko dane wyjściowe. Adnotacje powiązane z główną treścią wiadomości. Aby dowiedzieć się, jak dodać podstawowe formatowanie do SMS-a, przeczytaj artykuł Formatowanie SMS-ów.
Przykład treści wiadomości w postaci 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 |
Typ tej adnotacji. |
length |
Długość podłańcucha w treści wiadomości zwykłego tekstu, której odpowiada ta adnotacja. |
start_index |
Indeks początkowy (w postaci 0, włącznie) w treści wiadomości tekstowej, której odpowiada ta adnotacja. |
Pole sumy metadata . Dodatkowe metadane adnotacji. metadata może mieć tylko jedną z tych wartości: |
|
user_mention |
Metadane wzmianki użytkownika. |
slash_command |
Metadane polecenia po ukośniku. |
rich_link_metadata |
Metadane linku z elementami rozszerzonymi. |
AnnotationType
Typ adnotacji.
Wartości w polu enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Wartość domyślna typu wyliczeniowego. Nie używaj. |
USER_MENTION |
Ktoś dodał wzmiankę o użytkowniku. |
SLASH_COMMAND |
Wywoływane jest polecenie po ukośniku. |
RICH_LINK |
Szczegółowa adnotacja z linkiem. |
AttachedGif
Obraz GIF określony za pomocą adresu URL.
Pola | |
---|---|
uri |
Tylko dane wyjściowe. Adres URL, pod którym znajduje się obraz GIF. |
Załącznik
załącznik w Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu załącznika, w formacie |
content_name |
Tylko dane wyjściowe. Pierwotna nazwa pliku treści, a nie pełna ścieżka. |
content_type |
Tylko dane wyjściowe. Typ treści (typ MIME) pliku. |
thumbnail_uri |
Tylko dane wyjściowe. Adres URL miniatury, który należy użyć, aby wyświetlić podgląd załącznika dla użytkownika. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania zawartości załączników. |
download_uri |
Tylko dane wyjściowe. Adres URL pobierania, który umożliwia 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. |
Pole sumy data_ref . Odwołanie do danych do załącznika. data_ref może mieć tylko jedną z tych wartości: |
|
attachment_data_ref |
Odwołanie do danych załącznika. To pole jest używane przez interfejs Media API do pobierania danych załącznika. |
drive_data_ref |
Tylko dane wyjściowe. Odwołanie do załącznika z Dysku Google. To pole jest używane w interfejsie Google Drive API. |
Źródło
Źródło załącznika.
Wartości w polu enum | |
---|---|
SOURCE_UNSPECIFIED |
Zarezerwowane. |
DRIVE_FILE |
Plik jest plikiem na Dysku Google. |
UPLOADED_CONTENT |
Plik zostanie przesłany do Google Chat. |
AttachmentDataRef
Odwołanie do danych załącznika.
Pola | |
---|---|
resource_name |
Nazwa zasobu danych załączników. To pole jest używane przez interfejs Media API do pobierania danych załącznika. |
attachment_upload_token |
Nieprzezroczysty token zawierający odwołanie do przesłanego załącznika. Traktowane przez klientów jako nieprzejrzysty ciąg znaków i używane do tworzenia lub aktualizowania wiadomości z Google Chat z załącznikami. |
CardWithId
Karta w wiadomości w Google Chat.
Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli Twoja aplikacja Google Chat uwierzytelnia się jako użytkownik, wiadomość nie może zawierać kart.
Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora kart.
Otwórz kreatora kartPola | |
---|---|
card_id |
Wymagany, jeśli wiadomość zawiera kilka kart. Unikalny identyfikator karty w wiadomości. |
card |
Kartę Maksymalny rozmiar to 32 KB. |
ChatSpaceLinkData
Dane dotyczące linków do pokoi czatu.
Pola | |
---|---|
space |
Pokój powiązanego zasobu pokoju czatu. Format: |
thread |
Wątek zasobu połączonego pokoju czatu. Format: |
message |
Wiadomość z zasobu połączonego pokoju czatu. Format: |
CompleteImportSpaceRequest
Komunikat z prośbą o ukończenie procesu importowania pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju trybu importu. Format: |
CompleteImportSpaceResponse
Komunikat z odpowiedzią na zakończenie procesu importowania pokoju.
Pola | |
---|---|
space |
Obszar trybu importu. |
ContextualAddOnMarkup
Ten typ nie zawiera pól.
Znaczniki dla programistów służące do określania zawartości dodatku kontekstowego.
Karta
Karta to element interfejsu, który może zawierać widżety interfejsu takie jak tekst czy obrazy.
Pola | |
---|---|
header |
Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz. |
sections[] |
Sekcje są rozdzielone linią. |
card_actions[] |
Działania na tej karcie. |
name |
Nazwa karty. |
CardAction
Działanie związane z kartą to działanie powiązane z kartą. W przypadku karty faktury typowe działanie to: usunięcie faktury, wysłanie jej e-mailem lub otwarcie faktury w przeglądarce.
Nie są obsługiwane przez aplikacje Google Chat.
Pola | |
---|---|
action_label |
Etykieta, która była wyświetlana w menu czynności. |
on_click |
Działanie „onclick” dla tego działania. |
CardHeader
Pola | |
---|---|
title |
Należy podać tytuł. Nagłówek ma stałą wysokość: jeśli określono zarówno tytuł, jak i podtytuł, każdy z nich zajmuje po jednym wierszu. Jeśli określono tylko tytuł, tekst zajmuje oba wiersze. |
subtitle |
Podtytuł nagłówka karty. |
image_style |
Typ obrazu (np. kwadratowe lub okrągłe obramowanie). |
image_url |
Adres URL obrazu w nagłówku karty. |
ImageStyle
Wartości w polu enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Kwadratowe obramowanie. |
AVATAR |
Obramowanie okrągłe. |
Sekcja
Sekcja zawiera zbiór widżetów, które są renderowane (w pionie) w określonej kolejności. Na wszystkich platformach karty mają wąską stałą szerokość, więc obecnie nie trzeba stosować właściwości układu (np. kreacji zmiennoprzecinkowych).
Pola | |
---|---|
header |
Nagłówek sekcji. Tekst sformatowany 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[] |
Sekcja musi zawierać co najmniej jeden widżet. |
CreateMembershipRequest
Poproś o wiadomość dotyczącą utworzenia członkostwa.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, do którego chcesz dodać członkostwo. Format: spacje/{spacja} |
membership |
Wymagane. Relacja członkostwa do utworzenia. Pole |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Przy użyciu dostępu administracyjnego nie można tworzyć subskrypcji w aplikacjach ani tworzyć subskrypcji dla użytkowników spoza organizacji Google Workspace administratora. |
CreateMessageRequest
Tworzy wiadomość.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzona wiadomość. Format: |
message |
Wymagane. Treść wiadomości. |
thread_key |
Opcjonalnie: Wycofano: użyj atrybutu |
request_id |
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. |
message_reply_option |
Opcjonalnie: Określa, czy wiadomość rozpoczyna wątek, czy odpowiada w nim. Obsługiwane tylko w przypadku nazwanych pokoi. |
message_id |
Opcjonalnie: Niestandardowy identyfikator wiadomości. Pozwala aplikacjom Google Chat na pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności zapisywania identyfikatora przypisanego przez system w nazwie zasobu wiadomości (reprezentowanej w polu Wartość w tym polu musi spełniać te wymagania:
Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom. |
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. Użycie tej opcji powoduje zignorowanie wszystkich uwzględnionych elementów thread ID i . |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub . Jeśli to się nie uda, zostanie otwarta nowy wątek. |
REPLY_MESSAGE_OR_FAIL |
Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub . Jeśli użyjesz nowego pola thread_key , zostanie utworzony nowy wątek. Jeśli nie uda się utworzyć wiadomości, zamiast tego zostanie zwrócony błąd NOT_FOUND . |
CreateReactionRequest
Tworzy reakcję na wiadomość.
Pola | |
---|---|
parent |
Wymagane. Wiadomość, w której tworzona jest reakcja. Format: |
reaction |
Wymagane. Reakcja do utworzenia. |
CreateSpaceRequest
prośba o utworzenie pokoju bez użytkowników;
Pola | |
---|---|
space |
Wymagane. Pola Jeśli pojawi się komunikat o błędzie Jeśli uczestniczysz w Programie testowania aktualizacji dla programistów, możesz używać Pokój |
request_id |
Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócony pokój utworzony z tym identyfikatorem, zamiast tworzyć nowy pokój. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat z innym uwierzytelnionym użytkownikiem zwraca błąd. |
CustomEmoji
Reprezentuje niestandardowy emotikon.
Pola | |
---|---|
uid |
Tylko dane wyjściowe. Unikalny klucz zasobu niestandardowych emotikonów. |
DeleteMembershipRequest
Prośba o usunięcie członkostwa w pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu subskrypcji do usunięcia. Aplikacje do obsługi czatu mogą usuwać użytkowników lub własnych subskrypcji. Aplikacje do obsługi czatu nie mogą usuwać innych aplikacji subskrypcji. W przypadku usuwania członkostwa człowieka wymagany jest zakres Podczas usuwania członkostwa w aplikacji wymagany jest zakres Format: |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Usuwanie członkostwa w aplikacjach w pokoju nie jest możliwe w przypadku dostępu administracyjnego. |
DeleteMessageRequest
Prośba o usunięcie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli masz ustawiony dla wiadomości niestandardowy identyfikator, możesz dla |
force |
W przypadku funkcji Ma zastosowanie tylko podczas uwierzytelniania jako użytkownik. nie ma wpływu w przypadku uwierzytelniania jako aplikacja Google Chat. |
DeleteReactionRequest
Usuwa reakcję na wiadomość.
Pola | |
---|---|
name |
Wymagane. Nazwa reakcji do usunięcia. Format: |
DeleteSpaceRequest
Prośba o usunięcie pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju do usunięcia. Format: |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga |
DeletionMetadata
Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu funkcji delete_time
.
Pola | |
---|---|
deletion_type |
Wskazuje, kto usunął wiadomość. |
DeletionType
kto i w jaki sposób usunął wiadomość,
Wartości w polu enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Ta wartość nie jest używana. |
CREATOR |
Użytkownik usunął własną wiadomość. |
SPACE_OWNER |
Właściciel pokoju usunął wiadomość. |
ADMIN |
Administrator Google Workspace usunął wiadomość. |
APP_MESSAGE_EXPIRY |
Aplikacja do obsługi czatu usunęła własną wiadomość po wygaśnięciu. |
CREATOR_VIA_APP |
Aplikacja do obsługi czatu usunęła wiadomość w imieniu użytkownika. |
SPACE_OWNER_VIA_APP |
Aplikacja do obsługi czatu usunęła wiadomość w imieniu właściciela pokoju. |
Dialog
Zawijaj wokół treści karty w oknie.
Pola | |
---|---|
body |
Tylko dane wejściowe. Treść okna, renderowana w formacie modalnym. Aplikacje Google Chat nie obsługują tych kart: |
DialogAction
Zawiera okno i kod stanu żądania.
Pola | |
---|---|
action_status |
Tylko dane wejściowe. Stan żądania wywołania lub przesłania okna. W razie potrzeby wyświetla stan i komunikat dla użytkowników. np. w przypadku błędu lub powodzenia. |
Pole sumy action . Działanie do wykonania. action może mieć tylko jedną z tych wartości: |
|
dialog |
Tylko dane wejściowe. Okno dialogowe żądania. |
DriveDataRef
Odwołanie do danych przyłącza dysku.
Pola | |
---|---|
drive_file_id |
Identyfikator pliku na Dysku. Do użytku z interfejsem Drive API. |
DriveLinkData
Dane dotyczące linków do Dysku Google.
Pola | |
---|---|
drive_data_ref |
DriveDataRef odwołujący się do pliku na Dysku Google. |
mime_type |
Typ MIME połączonego zasobu Dysku Google. |
Emotikony
Emotikon używany jako reakcja na wiadomość.
Pola | |
---|---|
Pole sumy content . Zawartość emotikona. content może mieć tylko jedną z tych wartości: |
|
unicode |
Podstawowy emotikon reprezentowany przez ciąg Unicode. |
custom_emoji |
Tylko dane wyjściowe. Własny emotikon |
EmojiReactionSummary
Liczba osób, które zareagowały na wiadomość przy użyciu określonego emotikona.
Pola | |
---|---|
emoji |
Emotikony powiązane z reakcjami. |
reaction_count |
Łączna liczba reakcji przy użyciu powiązanego emotikona. |
FindDirectMessageRequest
Prośba o pobranie pokoju na czacie na podstawie zasobu użytkownika.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu użytkownika, z którym chcesz znaleźć czat. Format: |
GetAttachmentRequest
Prośba o pobranie załącznika.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu załącznika, w formacie |
GetMembershipRequest
Poproś o dołączenie do pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu subskrypcji do pobrania. Aby uzyskać własną subskrypcję aplikacji przez uwierzytelnianie użytkownika, możesz opcjonalnie użyć Format: Po uwierzytelnionym jako użytkownik możesz używać adresu e-mail użytkownika jako aliasu dla |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga zakresów OAuth 2.0 Wspieranie aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administracyjnego. |
GetMessageRequest
Prośba o odebranie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli masz ustawiony dla wiadomości niestandardowy identyfikator, możesz dla |
GetSpaceEventRequest
Prośba o wiadomość dotyczącą otrzymania wydarzenia w pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wydarzenia w pokoju. Format: |
GetSpaceReadStateRequest
Komunikat żądania do interfejsu API GetSpaceReadState.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu stanu odczytu pokoju do pobrania. Obsługuje tylko pobieranie stanu odczytu w przypadku dzwoniącego użytkownika. Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:
Format: użytkownicy/{użytkownik}/spaces/{spacja}/spaceReadState |
GetSpaceRequest
prośba o zwrócenie 1 pokoju,
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju w formacie Format: |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga zakresów OAuth 2.0 |
GetThreadReadStateRequest
Komunikat żądania do interfejsu API GetThreadReadStateRequest.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu stanu odczytu wątku do pobrania. Obsługuje tylko pobieranie stanu odczytu w przypadku dzwoniącego użytkownika. Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:
Format: users/{użytkownik}/pokoje/{spacja}/wątki/{wątek}/threadReadState |
Grupa
Grupa dyskusyjna Google w Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu Grupy dyskusyjnej Google. Reprezentuje grupę w Cloud Identity Groups API. Format: grupy/{grupa} |
HistoryState
Stan historii wiadomości i pokoi. Określa, jak długo wiadomości i wątki rozmów są przechowywane po utworzeniu.
Wartości w polu enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Wartość domyślna. Nie używać. |
HISTORY_OFF |
Historia wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny. |
HISTORY_ON |
Historia włączona. Okres przechowywania wiadomości i wątków określają reguły przechowywania w Vault obowiązujące w organizacji. |
ListMembershipsRequest
Prośba o wiadomość dotyczącą członkostwa w wizytówce.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, do którego ma zostać pobrana lista użytkowników. Format: spacje/{spacja} |
page_size |
Opcjonalnie: Maksymalna liczba subskrypcji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 członkó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 |
page_token |
Opcjonalnie: Token strony otrzymany z poprzedniego wywołania listy członkostwa. Podaj ten parametr, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie: Filtr zapytania. Wspieranie możesz filtrować według roli ( Aby filtrować według roli, ustaw Aby filtrować według typu, ustaw Aby filtrować dane według roli i typu, użyj operatora Gdy zasada Prawidłowe są na przykład te zapytania:
Te zapytania są nieprawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
show_groups |
Opcjonalnie: Gdy |
show_invited |
Opcjonalnie: Gdy Obecnie wymaga uwierzytelniania użytkownika. |
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga zakresu OAuth 2.0 Wspieranie aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administracyjnego. |
ListMembershipsResponse
Odpowiedź na listę osób w pokoju.
Pola | |
---|---|
memberships[] |
Lista nieuporządkowana. Lista użytkowników na żądanej (lub pierwszej) stronie. |
next_page_token |
Token, który możesz wysłać jako |
ListMessagesRequest
Wyświetla listę wiadomości w określonym pokoju, którego członkiem jest użytkownik.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, z którego wiadomości mają być wyświetlane. Format: |
page_size |
Maksymalna liczba zwróconych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość. Jeśli nie określisz tej wartości, zwróci się 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 |
page_token |
Opcjonalne, jeśli wznawiam działanie od poprzedniego zapytania. Token strony otrzymany z poprzedniego wywołania listy wiadomości. Podaj ten parametr, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Filtr zapytania. Wiadomości możesz filtrować według daty ( Aby filtrować wiadomości według daty ich utworzenia, wpisz Aby filtrować według wątku, podaj element Aby filtrować wyniki zarówno według wątku, jak i daty, użyj w zapytaniu operatora Prawidłowe są na przykład te zapytania:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
order_by |
Opcjonalne, jeśli wznawiam działanie od poprzedniego zapytania. Określ kolejność wyświetlania wiadomości. Określ wartość do zamówienia według operacji porządkowania. Prawidłowe wartości operacji sortowania:
Domyślna kolejność to |
show_deleted |
Określa, czy uwzględniać usunięte wiadomości. Usunięte wiadomości zawierają informacje o czasie usunięcia i metadane dotyczące jego usunięcia, ale treść wiadomości jest niedostępna. |
ListMessagesResponse
Komunikat z odpowiedzią na listę wiadomości.
Pola | |
---|---|
messages[] |
Lista wiadomości. |
next_page_token |
Aby pobrać następną stronę wyników, możesz wysłać token jako |
ListReactionsRequest
Wyświetla listę reakcji na wiadomość.
Pola | |
---|---|
parent |
Wymagane. Wiadomość, na którą zareagowali użytkownicy. Format: |
page_size |
Opcjonalnie: Maksymalna liczba zwróconych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie zostanie podana, wartością domyślną jest 25. Maksymalna wartość to 200. wartości powyżej 200 są zmieniane na 200. |
page_token |
Opcjonalnie: (W przypadku wznawiania poprzedniego zapytania). Token strony otrzymany z poprzedniego wywołania listy reakcji. Podaj go, aby pobrać kolejną stronę. Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem podanym dla tokena strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie: Filtr zapytania. Możesz filtrować reakcje według emotikonów ( Aby filtrować reakcje według wielu emotikonów lub użytkowników, złącz podobne pola za pomocą operatora Aby filtrować reakcje według emotikona i użytkownika, użyj operatora Jeśli w zapytaniu używane są zarówno Prawidłowe są na przykład te zapytania:
Te zapytania są nieprawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
ListReactionsResponse
Odpowiedź na prośbę o wyświetlenie listy reakcji.
Pola | |
---|---|
reactions[] |
Lista reakcji na żądanej (lub pierwszej) stronie. |
next_page_token |
Token kontynuacji, który pozwala pobrać następną stronę wyników. Pole jest puste na ostatniej stronie wyników. |
ListSpaceEventsRequest
Wiadomość z prośbą o wyświetlenie listy zdarzeń w pokoju.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju Google Chat, w którym wystąpiły zdarzenia. Format: |
page_size |
Opcjonalnie: Maksymalna liczba zwróconych zdarzeń dla pokoju. Usługa może zwrócić mniej niż ta wartość. Wartości ujemne zwracają błąd |
page_token |
Token strony otrzymany z poprzedniego wywołania zdarzeń w pokoju listy. Podaj go, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry służące do wyświetlania listy zdarzeń pokoju muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Wymagane. Filtr zapytania. Musisz określić co najmniej 1 typ zdarzenia ( Możesz też filtrować dane według czasu rozpoczęcia (
Aby określić godzinę rozpoczęcia lub zakończenia, użyj operatora równa się Prawidłowe są na przykład te zapytania:
Te zapytania są nieprawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
ListSpaceEventsResponse
Komunikat z odpowiedzią na listę zdarzeń w pokoju.
Pola | |
---|---|
space_events[] |
Wyniki są zwracane w kolejności chronologicznej (od najstarszych zdarzeń). |
next_page_token |
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 |
Opcjonalnie: Maksymalna liczba spacji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji. 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 |
page_token |
Opcjonalnie: Token strony otrzymany z poprzedniego wywołania listy pokoi. Podaj ten parametr, aby pobrać kolejną stronę. Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem podanym dla tokena strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie: Filtr zapytania. Możesz filtrować pokoje według typu pokoju ( Aby filtrować według typu pokoju, musisz podać prawidłową wartość wyliczeniową, np. Prawidłowe są na przykład te zapytania:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
ListSpacesResponse
Odpowiedź na żądanie dotyczące pokoi z listą.
Pola | |
---|---|
spaces[] |
Lista pokoi na żądanej (lub pierwszej) stronie. |
next_page_token |
Aby pobrać następną stronę wyników, możesz wysłać token jako |
MatchedUrl
Pasujący adres URL w wiadomości Google Chat. Aplikacje do obsługi czatu mogą wyświetlać podgląd pasujących adresów URL. Więcej informacji znajdziesz w sekcji Podgląd linków.
Pola | |
---|---|
url |
Tylko dane wyjściowe. Dopasowany adres URL. |
Członkostwo
Reprezentuje relację członkostwa w Google Chat, na przykład to, czy użytkownik lub aplikacja do obsługi czatu został zaproszony do pokoju, jego część lub osoba w nim nie ma.
Pola | |
---|---|
name |
Nazwa zasobu subskrypcji przypisana przez serwer. Format: |
state |
Tylko dane wyjściowe. Stan subskrypcji. |
role |
Opcjonalnie: Rola użytkownika w pokoju czatu, która określa dozwolone działania w pokoju. Tego pola można używać tylko jako danych wejściowych w usłudze |
create_time |
Opcjonalnie: Stała. Czas utworzenia subskrypcji, na przykład kiedy użytkownik dołączył do pokoju lub został zaproszony do pokoju. To pole jest używane tylko do wprowadzania danych wyjściowych, chyba że jest używane do importowania wcześniejszych danych o członkostwie w pokojach w trybie importowania. |
delete_time |
Opcjonalnie: Stała. daty usunięcia subskrypcji, na przykład daty opuszczenia pokoju przez użytkownika lub jego usunięcia z pokoju. To pole jest używane tylko do wprowadzania danych wyjściowych, chyba że jest używane do importowania wcześniejszych danych o członkostwie w pokojach w trybie importowania. |
Pole sumy memberType . Członek powiązany z tą subskrypcją. W przyszłości mogą być obsługiwane inne typy członków. memberType może mieć tylko jedną z tych wartości: |
|
member |
Użytkownik lub aplikacja Google Chat, której dotyczy subskrypcja. Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pola |
group_member |
Grupa dyskusyjna Google, do której należy członkostwo. |
MembershipRole
Reprezentuje dozwolone działania użytkownika w pokoju czatu. W przyszłości możemy dodać więcej wartości enum.
Wartości w polu enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Wartość domyślna. W przypadku users : ta osoba nie jest członkiem pokoju, ale można ją zaprosić. W przypadku użytkowników Google Groups zawsze mają przypisaną tę rolę (w przyszłości mogą zostać użyte inne wartości wyliczeniowe). |
ROLE_MEMBER |
Użytkownik pokoju. Użytkownik ma podstawowe uprawnienia, takie jak wysyłanie wiadomości do pokoju. W rozmowach 1:1 i rozmowach grupowych bez nazwy wszyscy mają tę rolę. |
ROLE_MANAGER |
menedżer pokoju. Użytkownik ma wszystkie podstawowe uprawnienia oraz uprawnienia administracyjne, które umożliwiają mu zarządzanie pokojem, w tym dodawanie i usuwanie użytkowników. Funkcja obsługiwana tylko w tym kraju: SpaceType.SPACE . |
MembershipState
Określa relację użytkownika z pokojem. W przyszłości mogą być obsługiwane inne stany 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 otrzymał zaproszenie 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 niego. |
MembershipBatchCreatedEventData
Ładunek zdarzeń dla wielu nowych użytkowników.
Typ zdarzenia: google.workspace.chat.membership.v1.batchCreated
Pola | |
---|---|
memberships[] |
Listę nowych subskrypcji. |
MembershipBatchDeletedEventData
Ładunek zdarzeń dla wielu usuniętych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchDeleted
Pola | |
---|---|
memberships[] |
Lista usuniętych subskrypcji. |
MembershipBatchUpdatedEventData
Ładunek zdarzeń dla wielu zaktualizowanych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchUpdated
Pola | |
---|---|
memberships[] |
Listę zaktualizowanych subskrypcji. |
MembershipCreatedEventData
Ładunek zdarzenia dla nowej subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.created
.
Pola | |
---|---|
membership |
Nowa subskrypcja. |
MembershipDeletedEventData
Ładunek zdarzenia dla usuniętej subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.deleted
Pola | |
---|---|
membership |
Usunięta subskrypcja. Wypełnij tylko pola |
MembershipUpdatedEventData
Ładunek zdarzenia związanego ze zaktualizowanym członkostwem.
Typ zdarzenia: google.workspace.chat.membership.v1.updated
Pola | |
---|---|
membership |
Zaktualizowana subskrypcja. |
Wiadomość
Wiadomość w pokoju Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu wiadomości. Format: Gdzie Jeśli podczas tworzenia wiadomości ustawisz identyfikator niestandardowy, możesz go użyć do określenia komunikatu w żądaniu. W tym celu zastąp |
sender |
Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pola |
create_time |
Opcjonalnie: Stała. w przypadku pokoi utworzonych w Google Chat – data utworzenia wiadomości; To pole dotyczy tylko danych wyjściowych, chyba że jest używane w pokojach w trybie importowania. W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową, w której wiadomość została utworzona w źródle, aby zachować pierwotny czas utworzenia. |
last_update_time |
Tylko dane wyjściowe. Czas ostatniej modyfikacji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie była edytowana, to pole jest puste. |
delete_time |
Tylko dane wyjściowe. Godzina usunięcia wiadomości z Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole będzie puste. |
text |
Zwykły tekst wiadomości. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wygenerowanie elementu podglądu. Możesz też dodać@wzmiankę o użytkowniku Google Chat lub każdej osobie w pokoju. Aby dowiedzieć się więcej o tworzeniu SMS-ów, zobacz Wysyłanie wiadomości. |
formatted_text |
Tylko dane wyjściowe. Zawiera wiadomość
Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu w wiadomości. |
cards[] |
Wycofano: użyj atrybutu Szczegółowe, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowany tekst, przyciski i klikalne obrazy. Zazwyczaj są one wyświetlane pod zwykłym tekstem wiadomości. Pliki |
cards_v2[] |
Tablica kart. Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli Twoja aplikacja Google Chat uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart. Aby dowiedzieć się, jak utworzyć wiadomość z kartami, przeczytaj sekcję Wysyłanie wiadomości. Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora kart. Otwórz kreator kart |
annotations[] |
Tylko dane wyjściowe. Adnotacje powiązane z elementem |
thread |
Wątek, do którego należy wiadomość. Przykładowe użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego. |
space |
Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe pojawią się w pokoju |
fallback_text |
Zwykły tekst opisu kart wiadomości używany, gdy nie można wyświetlić odpowiednich kart – na przykład do powiadomień na urządzeniu mobilnym. |
action_response |
Tylko dane wejściowe. Parametry, których aplikacja do obsługi czatu może używać do konfigurowania sposobu publikowania odpowiedzi. |
argument_text |
Tylko dane wyjściowe. Zwykły tekst wiadomości z usuniętymi wszystkimi wzmiankami w aplikacji Google Chat. |
slash_command |
Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (jeśli dotyczy). |
attachment[] |
Załącznik przesłany przez użytkownika. |
matched_url |
Tylko dane wyjściowe. Adres URL w domenie |
thread_reply |
Tylko dane wyjściowe. Gdy Jeśli pokój nie obsługuje odpowiedzi w wątkach, w tym polu jest zawsze |
client_assigned_message_id |
Opcjonalnie: Niestandardowy identyfikator wiadomości. Za pomocą tego pola możesz zidentyfikować wiadomość albo pobrać, usunąć lub zaktualizować wiadomość. Aby ustawić identyfikator niestandardowy, określ pole |
emoji_reaction_summaries[] |
Tylko dane wyjściowe. Lista podsumowań emotikonów w wiadomości. |
private_message_viewer |
Stała. Dane wejściowe do utworzenia wiadomości. W przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Po ustawieniu tego ustawienia wiadomość jest prywatna i widoczna tylko dla określonego użytkownika oraz aplikacji Google Chat. Aby uwzględnić to pole w swoim żądaniu, musisz wywołać interfejs Chat API za pomocą uwierzytelniania aplikacji i pominąć te informacje: Więcej informacji znajdziesz w artykule Wysyłanie wiadomości prywatnej. |
deletion_metadata |
Tylko dane wyjściowe. Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu funkcji |
quoted_message_metadata |
Tylko dane wyjściowe. Informacje o wiadomości cytowanej przez użytkownika Google Chat w pokoju. Użytkownicy Google Chat mogą zacytować wiadomość, aby na nią odpowiedzieć. |
attached_gifs[] |
Tylko dane wyjściowe. GIF-y dołączone do wiadomości. |
accessory_widgets[] |
Co najmniej jeden interaktywny widżet wyświetlany u dołu wiadomości. Widżety akcesorium możesz dodawać do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nieobsługiwane w przypadku wiadomości zawierających okna dialogowe. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości. Utworzenie wiadomości z widżetami akcesoriów wymaga uwierzytelniania aplikacji. |
MessageBatchCreatedEventData
Ładunek zdarzenia dla wielu nowych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchCreated
Pola | |
---|---|
messages[] |
Listę nowych wiadomości. |
MessageBatchDeletedEventData
Ładunek zdarzenia dla wielu usuniętych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchDeleted
Pola | |
---|---|
messages[] |
Lista usuniętych wiadomości. |
MessageBatchUpdatedEventData
Ładunek zdarzenia dla wielu zaktualizowanych komunikatów.
Typ zdarzenia: google.workspace.chat.message.v1.batchUpdated
Pola | |
---|---|
messages[] |
Lista zaktualizowanych wiadomości. |
MessageCreatedEventData
Ładunek zdarzenia dla nowej wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.created
Pola | |
---|---|
message |
Nowa wiadomość. |
MessageDeletedEventData
Ładunek zdarzenia dla usuniętej wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.deleted
Pola | |
---|---|
message |
Usunięta wiadomość. Wypełnione są tylko pola |
MessageUpdatedEventData
Ładunek zdarzenia dotyczący zaktualizowanej wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.updated
Pola | |
---|---|
message |
Zaktualizowana wiadomość. |
QuotedMessageMetadata
Informacje o cytowanej wiadomości.
Pola | |
---|---|
name |
Tylko dane wyjściowe. Nazwa zasobu cytowanej wiadomości. Format: |
last_update_time |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy cytowana wiadomość została utworzona lub kiedy została ostatnio zaktualizowana. |
Reakcja
Reakcja na wiadomość.
Pola | |
---|---|
name |
Nazwa zasobu reakcji. Format: |
user |
Tylko dane wyjściowe. Użytkownik, który utworzył reakcję. |
emoji |
Emotikon użyty w reakcji. |
ReactionBatchCreatedEventData
Ładunek zdarzenia na potrzeby wielu nowych reakcji.
Typ zdarzenia: google.workspace.chat.reaction.v1.batchCreated
Pola | |
---|---|
reactions[] |
Lista nowych reakcji. |
ReactionBatchDeletedEventData
Ładunek zdarzenia dla wielu usuniętych reakcji.
Typ zdarzenia: google.workspace.chat.reaction.v1.batchDeleted
Pola | |
---|---|
reactions[] |
Lista usuniętych reakcji. |
ReactionCreatedEventData
Ładunek zdarzenia dla nowej reakcji.
Typ zdarzenia: google.workspace.chat.reaction.v1.created
Pola | |
---|---|
reaction |
Nowa reakcja. |
ReactionDeletedEventData
Ładunek zdarzenia dla usuniętej reakcji.
Typ: google.workspace.chat.reaction.v1.deleted
Pola | |
---|---|
reaction |
Usunięta reakcja. |
RichLinkMetadata
Precyzyjny link do zasobu.
Pola | |
---|---|
uri |
Identyfikator URI tego linku. |
rich_link_type |
Typ linku z elementami rozszerzonymi. |
Pole sumy data . Dane dla połączonego zasobu. data może mieć tylko jedną z tych wartości: |
|
drive_link_data |
Dane dla linku do Dysku. |
chat_space_link_data |
Dane dotyczące linku do pokoju czatu. |
RichLinkType
Rodzaj linku z elementami rozszerzonymi. W przyszłości możemy dodać więcej typów.
Wartości w polu enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
DRIVE_FILE |
Szczegółowy typ linku do Dysku Google. |
CHAT_SPACE |
Szczegółowy typ linku do pokoju czatu. Na przykład element inteligentny dotyczący pokoju. |
SearchSpacesRequest
Prośba o wyszukanie listy pokoi na podstawie zapytania.
Pola | |
---|---|
use_admin_access |
Jeśli zasada jest Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga zakresu OAuth 2.0 Ta metoda obsługuje obecnie tylko dostęp administracyjny, więc w tym polu akceptowana jest tylko wartość |
page_size |
Maksymalna liczba spacji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. |
page_token |
Token otrzymany z poprzedniego wywołania metody searchSpaces. Podaj ten parametr, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
query |
Wymagane. zapytanie; Możesz wyszukiwać przy użyciu tych parametrów:
Pole Funkcja
Pole W różnych polach obsługiwane są tylko operatory Wśród tego samego pola Prawidłowe są te przykładowe zapytania:
|
order_by |
Opcjonalnie: Sposób porządkowania listy pokoi. Obsługiwane atrybuty, według których należy sortować:
Prawidłowe wartości operacji porządkowania to:
Obsługiwana składnia to:
|
SearchSpacesResponse
Odpowiedź z listą pokoi odpowiadających żądaniu wyszukiwania pokoi.
Pola | |
---|---|
spaces[] |
Strona pokoi, których dotyczy prośba. |
next_page_token |
Token, za pomocą którego można pobrać następną stronę. Jeśli to pole jest puste, nie ma kolejnych stron. |
total_size |
Łączna liczba pokoi pasujących do zapytania na wszystkich stronach. Jeśli wynik obejmuje więcej niż 10 000 pokoi, jest to wartość szacunkowa. |
SetUpSpaceRequest
Poproś o utworzenie pokoju i dodanie do niego określonych użytkowników.
Pola | |
---|---|
space |
Wymagane. Pole Aby utworzyć pokój, ustaw opcję Aby utworzyć czat grupowy, ustaw Aby utworzyć rozmowę 1:1 między ludźmi, ustaw Aby utworzyć rozmowę 1:1 między osobą a dzwoniącym aplikacją Google Chat, ustaw opcję Jeśli pokój |
request_id |
Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócony pokój utworzony z tym identyfikatorem, zamiast tworzyć nowy pokój. Podanie istniejącego identyfikatora żądania z tej samej aplikacji Google Chat z innym uwierzytelnionym użytkownikiem zwraca błąd. |
memberships[] |
Opcjonalnie: użytkowników lub grupy Google Chat, których chcesz zaprosić do pokoju; Pomiń użytkownika wywołującego, ponieważ zostanie on dodany automatycznie. Zestaw pozwala obecnie na maksymalnie 20 członków (oprócz wywołującego). W przypadku członkostwa człowieka pole W przypadku członkostwa w grupie dyskusyjnej Google pole Opcjonalne przy ustawianiu Wymagany w przypadku ustawienia zasady Wymagane, gdy To pole musi być puste podczas tworzenia rozmowy 1:1 między osobą a dzwoniącym aplikacją Google Chat (gdy |
SlashCommand
Polecenie po ukośniku w Google Chat.
Pola | |
---|---|
command_id |
Identyfikator wywołanego polecenia po ukośniku. |
SlashCommandMetadata
Metadane adnotacji w poleceniach po ukośniku (/).
Pola | |
---|---|
bot |
Aplikacja do obsługi czatu, której polecenie zostało wywołane. |
type |
Typ polecenia po ukośniku. |
command_name |
Nazwa wywołanego polecenia po ukośniku. |
command_id |
Identyfikator wywołanego polecenia po ukośniku. |
triggers_dialog |
Wskazuje, czy polecenie po ukośniku jest przeznaczone do okna. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
ADD |
Dodaj aplikację Google Chat do pokoju. |
INVOKE |
Wywołaj polecenie po ukośniku w spacji. |
Spacja
Pokój w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1:1 między użytkownikiem a aplikacją Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu pokoju. Format: Gdzie |
type |
Tylko dane wyjściowe. Wycofano: użyj atrybutu |
space_type |
Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. Dane wyjściowe tylko do innych zastosowań. |
single_user_bot_dm |
Opcjonalnie: Określa, czy pokój jest czatem między aplikacją Google Chat a jednym człowiekiem. |
threaded |
Tylko dane wyjściowe. Wycofano: użyj atrybutu |
display_name |
Wyświetlana nazwa pokoju. Wymagane podczas tworzenia pokoju z ustawieniem W przypadku czatów to pole może być puste. Może mieć do 128 znaków. |
external_user_allowed |
Stała. Określa, czy ten pokój pozwala na dołączenie dowolnego użytkownika Google Chat. Wprowadź podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:
W przypadku dotychczasowych pokoi to pole zawiera tylko dane wyjściowe. |
space_threading_state |
Tylko dane wyjściowe. Stan wątku w pokoju czatu. |
space_details |
Informacje o pokoju, w tym opis i reguły. |
space_history_state |
Stan historii wiadomości dla wiadomości i wątków w tym pokoju. |
import_mode |
Opcjonalnie: Określa, czy ten pokój został utworzony w usłudze |
create_time |
Opcjonalnie: Stała. W przypadku pokoi utworzonych w Google Chat jest to czas utworzenia pokoju. To pole dotyczy tylko danych wyjściowych, chyba że jest używane w pokojach w trybie importowania. W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową, w której pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia pokoju. Wartość podawana w danych wyjściowych tylko wtedy, gdy |
last_active_time |
Tylko dane wyjściowe. Sygnatura czasowa ostatniej wiadomości w pokoju. |
admin_installed |
Tylko dane wyjściowe. w przypadku pokoi czatu z aplikacją Google Chat – informacja o tym, czy pokój został utworzony przez administratora Google Workspace; Administratorzy mogą zainstalować i skonfigurować czat w aplikacji Google Chat w imieniu użytkowników w swojej organizacji. Aby instalacja była obsługiwana przez administratora, aplikacja Google Chat musi obsługiwać czat. |
membership_count |
Tylko dane wyjściowe. Liczba osób, które dołączyły, pogrupowane według typu wspierającego. Wartość wypełniana, gdy |
access_settings |
Opcjonalnie: Określa ustawienie dostępu do pokoju. Wartość jest podawana tylko wtedy, gdy |
space_uri |
Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju. |
Pole sumy space_permission_settings . Reprezentuje ustawienia uprawnień pokoju. Wartość jest podawana tylko wtedy, gdy space_type ma wartość SPACE . space_permission_settings może mieć tylko jedną z tych wartości: |
|
predefined_permission_settings |
Opcjonalnie: Tylko dane wejściowe. Ustawienia uprawnień pokoju. Dane wejściowe do utworzenia pokoju. Jeśli to pole nie jest skonfigurowane, tworzony jest pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu |
permission_settings |
Opcjonalnie: Dokładne ustawienia uprawnień, które można skonfigurować w celu aktualizowania pokoju. Pole na aktualizowanie pokoju. W przeciwnym razie tylko dane wyjściowe. Aby utworzyć pokój, użyj |
AccessSettings
Reprezentuje ustawienie dostępu do pokoju.
Pola | |
---|---|
access_state |
Tylko dane wyjściowe. Wskazuje stan dostępu do pokoju. |
audience |
Opcjonalnie: Nazwa zasobu grupy odbiorców, która może wykryć pokój, dołączyć do pokoju i wyświetlić podgląd wiadomości w pokoju. Jeśli zasada jest nieskonfigurowana, dostęp do pokoju mają tylko użytkownicy lub Grupy dyskusyjne Google, którzy zostali indywidualnie zaproszeni lub dodani do pokoju. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego dla grupy odbiorców. Format: Aby użyć domyślnej grupy odbiorców w organizacji Google Workspace, ustaw wartość |
AccessState
Reprezentuje stan dostępu do pokoju.
Wartości w polu enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Stan dostępu jest nieznany lub nieobsługiwany przez ten interfejs API. |
PRIVATE |
Tylko użytkownicy i Grupy dyskusyjne Google, którzy zostali dodani lub zaproszeni przez innych użytkowników albo administratorów Google Workspace, mogą odkryć pokój i uzyskać do niego dostęp. |
DISCOVERABLE |
Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub Grupy dyskusyjne Google, którzy zostali indywidualnie dodani do pokoju lub zostali do niego zaproszeni, też mogą odkrywać pokój i uzyskiwać do niego dostęp. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako wykrywalnego dla określonych użytkowników. |
MembershipCount
Pola | |
---|---|
joined_direct_human_user_count |
Liczba użytkowników, którzy bezpośrednio dołączyli do pokoju, bez uwzględniania użytkowników, którzy zostali członkami grupy. |
joined_group_count |
Liczba wszystkich grup, które bezpośrednio dołączyły do pokoju. |
PermissionSetting
Reprezentuje ustawienie uprawnień pokoju.
Pola | |
---|---|
managers_allowed |
Określa, czy menedżerowie pokoju mają to uprawnienie. |
members_allowed |
Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie. |
PermissionSettings
Ustawienia uprawnień do nazwanego pokoju. Aby skonfigurować ustawienia uprawnień podczas tworzenia pokoju, podaj w prośbie pole PredefinedPermissionSettings
.
Pola | |
---|---|
manage_members_and_groups |
Ustawienie zarządzania użytkownikami i grupami w pokoju. |
modify_space_details |
Ustawienie do aktualizowania nazwy, awatara, opisu i wytycznych pokoju. |
toggle_history |
Ustawienie do włączania i wyłączania historii pokoju. |
use_at_mention_all |
Ustawienie używania @all w pokoju. |
manage_apps |
Ustawienie zarządzania aplikacjami w pokoju. |
manage_webhooks |
Ustawienie zarządzania webhookami w pokoju. |
post_messages |
Tylko dane wyjściowe. Ustawienie publikowania wiadomości w pokoju. |
reply_messages |
Ustawienie odpowiadania na wiadomości w pokoju. |
PredefinedPermissionSettings
Ustawienia uprawnień pokoju, które możesz określić podczas tworzenia nazwanego pokoju. W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień do nazwanych pokoi znajdziesz w artykule Więcej informacji o pokojach.
Wartości w polu enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Nie określono. Nie używaj. |
COLLABORATION_SPACE |
Ustawienie, dzięki któremu pokój stanie się przestrzenią współpracy, w której wszyscy użytkownicy mogą publikować wiadomości. |
ANNOUNCEMENT_SPACE |
Ustawienie, aby ten pokój stał się miejscem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości. |
SpaceDetails
Informacje o pokoju, w tym opis i reguły.
Pola | |
---|---|
description |
Opcjonalnie: Opis pokoju. Na przykład opisz temat rozmowy, przeznaczenie lub uczestników pokoju. Może mieć do 150 znaków. |
guidelines |
Opcjonalnie: Zasady, oczekiwania i etykieta Może mieć do 5000 znaków. |
SpaceThreadingState
Określa typ stanu wątku w pokoju czatu.
Wartości w polu enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Zarezerwowane. |
THREADED_MESSAGES |
Pokoje z nazwami obsługujące wątki wiadomości. Gdy użytkownicy odpowiedzą na wiadomość, będą mogli odpowiedzieć w wątku, co zachowa zgodność z kontekstem oryginalnej wiadomości. |
GROUPED_MESSAGES |
Nazwane pokoje, w których rozmowa jest uporządkowana według tematów. Tematy i odpowiedzi na nie są grupowane. |
UNTHREADED_MESSAGES |
Czaty z dwiema osobami i rozmowy grupowe z udziałem co najmniej 3 osób. |
SpaceType
Typ pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. Dane wyjściowe tylko do innych zastosowań.
Wartości w polu enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Zarezerwowane. |
SPACE |
Miejsce, w którym użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować. Element SPACE może obejmować aplikacje Google Chat. |
GROUP_CHAT |
rozmów grupowych z co najmniej 3 osobami, Element GROUP_CHAT może obejmować aplikacje Google Chat. |
DIRECT_MESSAGE |
1:1 wiadomości między 2 osobami lub człowiekiem i aplikacją Google Chat. |
Typ
Wycofano: użyj atrybutu SpaceType
.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Zarezerwowane. |
ROOM |
rozmowy między co najmniej 2 osobami, |
DM |
Czat 1:1 między człowiekiem a aplikacją do obsługi czatu, gdzie wszystkie wiadomości są płaskie. Pamiętaj, że nie dotyczy to czatów między 2 osobami. |
SpaceBatchUpdatedEventData
Ładunek zdarzenia do wielu aktualizacji pokoju.
Typ zdarzenia: google.workspace.chat.space.v1.batchUpdated
Pola | |
---|---|
spaces[] |
Lista zaktualizowanych pokoi. |
SpaceEvent
Zdarzenie reprezentujące zmianę lub aktywność w pokoju Google Chat. Więcej informacji znajdziesz w artykule Praca z wydarzeniami w Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu zdarzenia dla pokoju. Format: |
event_time |
Czas wystąpienia zdarzenia. |
event_type |
Typ wydarzenia dotyczącego miejsca. Każdy typ zdarzenia ma wersję zbiorczą, która reprezentuje wiele wystąpień danego typu zdarzenia, które wystąpiły w krótkim czasie. W przypadku żądań Obsługiwane typy zdarzeń w przypadku wiadomości:
Obsługiwane typy zdarzeń w przypadku wspierania:
Obsługiwane typy zdarzeń w przypadku reakcji:
Obsługiwane typy zdarzeń dotyczących pokoju:
|
Pole sumy
|
|
message_created_event_data |
Ładunek zdarzenia dla nowej wiadomości. Typ zdarzenia: |
message_updated_event_data |
Ładunek zdarzenia związanego ze zaktualizowanym komunikatem. Typ zdarzenia: |
message_deleted_event_data |
Ładunek zdarzenia dla usuniętej wiadomości. Typ zdarzenia: |
message_batch_created_event_data |
Ładunek zdarzenia dla wielu nowych wiadomości. Typ zdarzenia: |
message_batch_updated_event_data |
Ładunek zdarzenia dla wielu zaktualizowanych komunikatów. Typ zdarzenia: |
message_batch_deleted_event_data |
Ładunek zdarzenia dla wielu usuniętych wiadomości. Typ zdarzenia: |
space_updated_event_data |
Ładunek zdarzenia dotyczącego aktualizacji pokoju. Typ zdarzenia: |
space_batch_updated_event_data |
Ładunek zdarzenia do wielu aktualizacji pokoju. Typ zdarzenia: |
membership_created_event_data |
Ładunek zdarzenia dla nowej subskrypcji. Typ zdarzenia: |
membership_updated_event_data |
Ładunek zdarzenia związanego ze zaktualizowanym członkostwem. Typ zdarzenia: |
membership_deleted_event_data |
Ładunek zdarzenia dla usuniętej subskrypcji. Typ zdarzenia: |
membership_batch_created_event_data |
Ładunek zdarzeń dla wielu nowych użytkowników. Typ zdarzenia: |
membership_batch_updated_event_data |
Ładunek zdarzeń dla wielu zaktualizowanych subskrypcji. Typ zdarzenia: |
membership_batch_deleted_event_data |
Ładunek zdarzeń dla wielu usuniętych subskrypcji. Typ zdarzenia: |
reaction_created_event_data |
Ładunek zdarzenia dla nowej reakcji. Typ zdarzenia: |
reaction_deleted_event_data |
Ładunek zdarzenia dla usuniętej reakcji. Typ zdarzenia: |
reaction_batch_created_event_data |
Ładunek zdarzenia na potrzeby wielu nowych reakcji. Typ zdarzenia: |
reaction_batch_deleted_event_data |
Ładunek zdarzenia dla wielu usuniętych reakcji. Typ zdarzenia: |
SpaceReadState
Stan odczytu użytkownika w pokoju używany do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
Pola | |
---|---|
name |
Nazwa zasobu stanu odczytu pokoju. Format: |
last_read_time |
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 oznaczającej ostatnią przeczytaną wiadomość w pokoju. |
SpaceUpdatedEventData
Ładunek zdarzenia dotyczący zaktualizowanego miejsca.
Typ zdarzenia: google.workspace.chat.space.v1.updated
Pola | |
---|---|
space |
Zaktualizowany pokój. |
Wątek
Wątek w pokoju Google Chat. Przykładowe użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
Jeśli podczas tworzenia wiadomości określisz wątek, w polu messageReplyOption
możesz określić, co się stanie, jeśli nie znajdziesz pasującego wątku.
Pola | |
---|---|
name |
Nazwa zasobu wątku. Przykład: |
thread_key |
Opcjonalnie: Dane wejściowe do tworzenia lub aktualizowania wątku. W przeciwnym razie tylko dane wyjściowe. Identyfikator wątku. Maksymalna długość tekstu to 4000 znaków. Jest to unikalny identyfikator aplikacji Google Chat, która go ustawia. Jeśli na przykład wiele aplikacji Google Chat utworzy wiadomość przy użyciu tego samego klucza wątku, zostaną one opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez osobę lub inną aplikację Google Chat, zamiast tego użyj pola wątku |
ThreadReadState
Stan przeczytania wątku przez użytkownika używany do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
Pola | |
---|---|
name |
Nazwa zasobu stanu odczytu wątku. Format: |
last_read_time |
Czas zaktualizowania stanu odczytu wątku użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku. |
UpdateMembershipRequest
Prośba o wiadomość dotyczącą aktualizacji subskrypcji.
Pola | |
---|---|
membership |
Wymagane. Subskrypcja do zaktualizowania. Zaktualizowane zostaną tylko pola określone przez |
update_mask |
Wymagane. Ścieżki pól do zaktualizowania. Oddziel wartości przecinkami lub użyj Obecnie obsługiwane ścieżki pól:
|
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga |
UpdateMessageRequest
Prośba o zaktualizowanie wiadomości.
Pola | |
---|---|
message |
Wymagane. Komunikat z polami został zaktualizowany. |
update_mask |
Wymagane. Ścieżki pól do zaktualizowania. Oddziel wartości przecinkami lub użyj Obecnie obsługiwane ścieżki pól:
|
allow_missing |
Opcjonalnie: Jeśli |
UpdateSpaceReadStateRequest
Komunikat żądania dotyczącego interfejsu UpdateSpaceReadState API.
Pola | |
---|---|
space_read_state |
Wymagane. Stan odczytu pokoju i pola do zaktualizowania. Obsługuje tylko aktualizowanie stanu odczytu użytkownika wywołującego. Aby odwołać się do użytkownika dzwoniącego, ustaw jedną z tych opcji:
Format: użytkownicy/{użytkownik}/spaces/{spacja}/spaceReadState |
update_mask |
Wymagane. Ścieżki pól do zaktualizowania. Obecnie obsługiwane ścieżki pól:
Gdy Aby oznaczyć pokój jako przeczytany, ustaw |
UpdateSpaceRequest
prośba o zaktualizowanie jednego pokoju;
Pola | |
---|---|
space |
Wymagane. Pokój z polami do zaktualizowania. Pole |
update_mask |
Wymagane. Zaktualizowane ścieżki pól, jeśli jest ich kilka, rozdziel je przecinkami. Możesz zaktualizować te pola pokoju:
|
use_admin_access |
true , metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Niektóre wartości |
Użytkownik
Użytkownik w Google Chat. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe zasobu User
pojawią się jako dane wyjściowe żądania, a w wartościach name
i type
użytkownika pojawią się tylko te dane.
Pola | |
---|---|
name |
Nazwa zasobu dla: Format: W przypadku usługi
|
display_name |
Tylko dane wyjściowe. Wyświetlana nazwa użytkownika. |
domain_id |
Unikalny identyfikator domeny Google Workspace użytkownika. |
type |
Typ użytkownika. |
is_anonymous |
Tylko dane wyjściowe. Gdy |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. NIE UŻYWAĆ. |
HUMAN |
Człowiek. |
BOT |
Użytkownik aplikacji Google Chat. |
UserMentionMetadata
Metadane adnotacji w przypadku wzmianek użytkowników (@).
Pola | |
---|---|
user |
Wspomniał użytkownik. |
type |
Rodzaj wzmianki użytkownika. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
ADD |
Dodaj użytkownika do pokoju. |
MENTION |
Dodaj wzmiankę w pokoju. |
WidgetMarkup
Widżet to element interfejsu, który prezentuje tekst i obrazy.
Pola | |
---|---|
buttons[] |
Lista przycisków. Przyciski mają też wartość |
Pole sumy data . Element 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 |
Wyświetla akapit tekstu w tym widżecie. |
image |
Wyświetlaj obraz w tym widżecie. |
key_value |
Wyświetla element pary klucz-wartość w tym widżecie. |
Przycisk
Przycisk. Może to być przycisk tekstowy lub graficzny.
Pola | |
---|---|
Pole sumy
|
|
text_button |
Przycisk z tekstem i działaniem |
image_button |
Przycisk z obrazem i działaniem |
FormAction
Działanie związane z formularzem opisuje zachowanie po przesłaniu formularza. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.
Pola | |
---|---|
action_method_name |
Nazwa metody służy do określenia, która część formularza spowodowała jego przesłanie. Te informacje są odczytywane w aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Tej samej nazwy metody możesz użyć w przypadku kilku elementów, które wywołują typowe zachowanie. |
parameters[] |
Lista parametrów działań. |
ActionParameter
Lista parametrów ciągu tekstowego, które mają być dostarczone po wywołaniu metody działania. Weźmy na przykład 3 przyciski drzemki: Odłóż teraz, Odłóż jeden dzień i Odłóż w przyszłym tygodniu. Możesz użyć funkcji action method = snooze()
, która przekazuje typ drzemki i czas drzemki na liście parametrów ciągu.
Pola | |
---|---|
key |
Nazwa parametru skryptu działania. |
value |
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 za pomocą adresu URL i może mieć działanie onclick
.
Pola | |
---|---|
image_url |
Adres URL obrazu. |
on_click |
Działanie |
aspect_ratio |
Format obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości obrazu podczas oczekiwania na jego wczytanie. Nie zastępuje on wbudowanego formatu obrazu. Jeśli zasada jest nieskonfigurowana, serwer wypełnia ją, pobierając obraz z wyprzedzeniem. |
ImageButton
Przycisk obrazu z działaniem onclick
.
Pola | |
---|---|
on_click |
Działanie |
name |
Nazwa tego elementu ( |
Pole sumy icons . Ikonę można określić za pomocą właściwości enum Icon lub adresu URL. icons może mieć tylko jedną z tych wartości: |
|
icon |
Ikona określona przez |
icon_url |
Ikona określona przez adres URL. |
KeyValue
Element interfejsu zawiera klucz (etykietę) i wartość (treść). Ten element może też zawierać niektóre działania, np. przycisk onclick
.
Pola | |
---|---|
top_label |
Tekst etykiety u góry. 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. |
content |
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 |
Czy treść powinna być wielowierszowa. |
bottom_label |
Tekst dolnej etykiety. 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. |
on_click |
Działanie |
Pole sumy icons . Musisz zdefiniować co najmniej 1 z ikon: top_label i bottom_label . icons może mieć tylko jedną z tych wartości: |
|
icon |
Wartość wyliczeniowa, którą zastępuje Chat API odpowiednim obrazem ikony. |
icon_url |
Ikona określona przez adres URL. |
Pole sumy control . Widżet sterujący. Możesz ustawić button lub switch_widget , ale nie oba jednocześnie. control może mieć tylko jedną z tych wartości: |
|
button |
Przycisk, który można kliknąć, aby wywołać działanie. |
OnClick
działanie onclick
(np. otwarcie linku);
Pola | |
---|---|
Pole sumy
|
|
action |
Działanie związane z formularzem jest wywoływane przez to działanie |
open_link |
To działanie |
OpenLink
Link otwierający nowe okno.
Pola | |
---|---|
url |
Adres URL do otwarcia. |
TextButton
Przycisk z tekstem i działaniem onclick
.
Pola | |
---|---|
text |
Tekst na przycisku. |
on_click |
Działanie |
TextParagraph
Akapit tekstu. 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.
Pola | |
---|---|
text |
|