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)CreateCustomEmojiRequest
(komunikat)CreateMembershipRequest
(komunikat)CreateMessageRequest
(komunikat)CreateMessageRequest.MessageReplyOption
(wyliczenie)CreateReactionRequest
(komunikat)CreateSpaceRequest
(komunikat)CustomEmoji
(komunikat)CustomEmoji.CustomEmojiPayload
(komunikat)DeleteCustomEmojiRequest
(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)GetCustomEmojiRequest
(komunikat)GetMembershipRequest
(komunikat)GetMessageRequest
(komunikat)GetSpaceEventRequest
(komunikat)GetSpaceNotificationSettingRequest
(komunikat)GetSpaceReadStateRequest
(komunikat)GetSpaceRequest
(komunikat)GetThreadReadStateRequest
(komunikat)Group
(komunikat)HistoryState
(wyliczenie)ListCustomEmojisRequest
(komunikat)ListCustomEmojisResponse
(komunikat)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)SpaceNotificationSetting
(komunikat)SpaceNotificationSetting.MuteSetting
(wyliczenie)SpaceNotificationSetting.NotificationSetting
(wyliczenie)SpaceReadState
(komunikat)SpaceUpdatedEventData
(komunikat)Thread
(komunikat)ThreadReadState
(komunikat)UpdateMembershipRequest
(komunikat)UpdateMessageRequest
(komunikat)UpdateSpaceNotificationSettingRequest
(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 i integracji na platformie Google Chat.
CompleteImportSpace |
---|
Zakończy proces importowania w przypadku wybranego pokoju i sprawi, że będzie on widoczny dla użytkowników. Wymaga uwierzytelniania aplikacji i przekazywania dostępu w całej domenie. Więcej informacji znajdziesz w artykule Autoryzowanie aplikacji Google Chat do importowania danych.
|
CreateCustomEmoji |
---|
Wymaga uwierzytelniania użytkownika.
|
CreateMembership |
---|
Tworzy członkostwo dla aplikacji do połączeń w Google Chat, użytkownika lub grupy Google. Tworzenie wspierania w innych aplikacjach do obsługi czatu nie jest obsługiwane. Jeśli podczas tworzenia członkostwa określonego użytkownika nie jest włączona zasada automatycznego akceptowania, to po otrzymaniu zaproszenia musi on zaakceptować zaproszenie do pokoju, zanim do niego dołączy. W przeciwnym razie utworzenie członkostwa spowoduje dodanie użytkownika bezpośrednio do określonego pokoju. Obsługuje te typy uwierzytelniania:
Przykładowe zastosowania:
|
CreateMessage |
---|
Tworzy wiadomość w pokoju Google Chat. Przykład znajdziesz w artykule Wysyłanie wiadomości. Metoda Poniższy obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelniania aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawcę wiadomości. Treść wiadomości może zawierać tekst ( Na ilustracji poniżej widać, jak Google Chat przypisuje wiadomość, gdy korzystasz z uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje do niej aplikację Google Chat, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst ( Maksymalny rozmiar wiadomości, w tym jej zawartości, wynosi 32 tys. bajtów.
|
CreateReaction |
---|
Tworzy reakcję i dodaje ją do wiadomości. Obsługiwane są tylko emotikony w standardzie Unicode. Zobacz na przykład dodawanie reakcji do wiadomości. Wymaga uwierzytelniania użytkownika.
|
CreateSpace |
---|
Tworzy pokój. Można go użyć do utworzenia pokoju o nazwie lub czatu grupowego w Obsługuje te typy uwierzytelniania:
Podczas uwierzytelniania jako aplikacja musisz ustawić w żądaniu pole Uprawnienia do pokoju w momencie jego utworzenia zależą od tego, czy pokój został utworzony w
Jeśli podczas tworzenia pokoju pojawi się komunikat o błędzie
|
DeleteCustomEmoji |
---|
Wymaga uwierzytelniania użytkownika.
|
DeleteMembership |
---|
Usuwa subskrypcję. Przykład: usuwanie użytkownika lub aplikacji Google Chat z pokoju. Obsługuje te typy uwierzytelniania:
|
DeleteMessage |
---|
Usuwa wiadomość. Przykład znajdziesz w sekcji Usuwanie wiadomości. Obsługuje te typy uwierzytelniania: Gdy używasz uwierzytelniania aplikacji, żądania mogą usuwać tylko wiadomości utworzone przez aplikację Google Chat.
|
DeleteReaction |
---|
Usuwa reakcję na wiadomość. Obsługiwane są tylko emotikony w standardzie Unicode. Przykład znajdziesz w artykule Usuwanie reakcji. Wymaga uwierzytelniania użytkownika.
|
DeleteSpace |
---|
usuwa pokój nazwany; Zawsze wykonuje kasowanie kaskadowe, co oznacza, że zasoby podrzędne pokoju, takie jak wiadomości opublikowane w pokoju i członkostwa w pokoju, są również usuwane. Przykład znajdziesz w artykule Usuwanie pokoju. Obsługuje te typy uwierzytelniania:
|
FindDirectMessage |
---|
Zwraca istniejące bezpośrednie wiadomości z określonym użytkownikiem. Jeśli nie zostanie znaleziony żaden obszar wiadomości bezpośrednich, zwrócony zostanie błąd W przypadku uwierzytelniania aplikacji zwraca się pokój czatu między określonym użytkownikiem a wywołującą aplikacją Google Chat. W przypadku uwierzytelniania użytkownika zwraca przestrzeń wiadomości bezpośrednich między określonym użytkownikiem a uwierzytelnionym użytkownikiem. // Obsługuje te typy uwierzytelniania:
|
GetAttachment |
---|
Pobiera metadane załącznika wiadomości. Dane załącznika są pobierane za pomocą interfejsu media API. Przykład znajdziesz w artykule Pobieranie metadanych załącznika wiadomości. Wymaga uwierzytelniania aplikacji.
|
GetCustomEmoji |
---|
Wymaga uwierzytelniania użytkownika.
|
GetMembership |
---|
Zwraca szczegóły subskrypcji. Przykładem jest uzyskiwanie informacji o subskrypcji użytkownika lub aplikacji Google Chat. Obsługuje te typy uwierzytelniania:
|
GetMessage |
---|
Zwraca szczegóły wiadomości. Przykład znajdziesz w sekcji Uzyskiwanie szczegółowych informacji o wiadomości. Obsługuje te typy uwierzytelniania: Uwaga: może zwrócić wiadomość od zablokowanego użytkownika lub z zablokowanego pokoju.
|
GetSpace |
---|
Zwraca szczegóły pokoju. Przykładem jest pobieranie informacji o pokoju. Obsługuje te typy uwierzytelniania:
|
GetSpaceEvent |
---|
Zwraca zdarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zasobu, który uległ zmianie. Jeśli na przykład poprosisz o wydarzenie dotyczące nowej wiadomości, która została później zaktualizowana, serwer zwróci zaktualizowany zasób Uwaga: w przypadku tego żądania pole Wymaga uwierzytelniania użytkownika. Aby można było uzyskać zdarzenie, uwierzytelniony użytkownik musi być użytkownikiem pokoju. Przykładem jest uzyskiwanie szczegółowych informacji o zdarzeniu z pokoju Google Chat.
|
GetSpaceNotificationSetting |
---|
Wymaga uwierzytelniania użytkownika.
|
GetSpaceReadState |
---|
Zwraca informacje o stanie odczytania wiadomości w pokoju, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład: Uzyskiwanie informacji o stanie odczytu pokoju przez 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. Przykład: Uzyskiwanie informacji o stanie odczytu wątku przez użytkownika. Wymaga uwierzytelniania użytkownika.
|
ListCustomEmojis |
---|
Wymaga uwierzytelniania użytkownika.
|
ListMemberships |
---|
Wyświetla listę użytkowników pokoju. Przykład: Lista użytkowników i aplikacji Google Chat w pokoju. Wyświetlanie członkostwa z autoryzacją aplikacji wyświetla członkostwo w pokojach, do których ma dostęp aplikacja Google Chat, ale wyklucza członkostwo w Google Chat, w tym własne. Wyświetlanie członkostwa z uwierzytelnieniem użytkownika wyświetla członkostwo w przestrzeniach, do których uwierzytelniony użytkownik ma dostęp. Obsługuje te typy uwierzytelniania:
|
ListMessages |
---|
Wyświetla wiadomości w pokoju, którego użytkownik jest członkiem, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Jeśli wyświetlasz listę wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. W przypadku interfejsu REST/HTTP odpowiedź zawiera pusty obiekt JSON, Wymaga uwierzytelniania użytkownika.
|
ListReactions |
---|
Lista reakcji na wiadomość. Przykład znajdziesz w artykule Wyświetlanie reakcji na wiadomość. Wymaga uwierzytelniania użytkownika.
|
ListSpaceEvents |
---|
Lista zdarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. Jeśli na przykład wyświetlasz listę zdarzeń dotyczących nowych członków pokoju, serwer zwraca zasoby Wymaga uwierzytelniania użytkownika. Aby wyświetlić listę wydarzeń, uwierzytelniony użytkownik musi być członkiem pokoju. Przykład: Wyświetlanie listy zdarzeń z pokoju Google Chat.
|
ListSpaces |
---|
Lista pokoi, których użytkownik jest członkiem. Czaty grupowe i czaty bezpośrednie nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykładem jest lista pokoi. Obsługuje te typy uwierzytelniania: Aby wyświetlić listę wszystkich nazwanych pokoi w organizacji Google Workspace, użyj metody
|
SearchSpaces |
---|
Zwraca listę pokoi w organizacji Google Workspace na podstawie wyszukiwania administratora. Wymaga uwierzytelniania użytkownika z uprawnieniami administratora. W prośbie ustaw wartość
|
SetUpSpace |
---|
Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik dzwoniący jest automatycznie dodawany do pokoju i nie musi być wymieniony jako użytkownik w żądaniu. Przykład znajdziesz w artykule Konfigurowanie pokoju z początkowymi członkami. Aby określić osoby, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu Aby określić grupy dyskusyjne Google, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu W przypadku pokoju o nazwie lub czatu grupowego, jeśli osoba dzwoniąca zablokuje niektórych członków lub zostanie przez nich zablokowana albo nie będzie mieć uprawnień do dodawania niektórych osób, te osoby nie zostaną dodane 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ć wiadomość DM między użytkownikiem a aplikacją, ustaw Jeśli między dwoma użytkownikami istnieje już czat, nawet jeśli jeden z nich zablokuje drugiego w momencie wysłania żądania, zwrócony zostanie istniejący czat. Spacje 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: Aktualizowanie członkostwa użytkownika w pokoju. Obsługuje te typy uwierzytelniania:
|
UpdateMessage |
---|
aktualizuje wiadomość. Metody Obsługuje te typy uwierzytelniania: 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 Obsługuje te typy uwierzytelniania:
|
UpdateSpaceNotificationSetting |
---|
Wymaga uwierzytelniania użytkownika.
|
UpdateSpaceReadState |
---|
Aktualizuje stan odczytania wiadomości w pokoju, aby można było odróżnić przeczytane od nieprzeczytanych. Przykładem jest aktualizowanie stanu odczytu pokoju przez użytkownika. Wymaga uwierzytelniania użytkownika.
|
AccessoryWidget
Co najmniej 1 interaktywny widget, który pojawia się u dołu wiadomości. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów na dole wiadomości.
Pola | |
---|---|
Pole unii action . Typ działania. action może być tylko jednym z tych elementów: |
|
button_ |
Lista przycisków. |
ActionResponse
Parametry, których aplikacja Google Chat 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órego użytkownicy używają do uwierzytelniania lub konfigurowania. (Dotyczy tylko typów odpowiedzi |
dialog_ |
Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z dialogiem. Musi być dołączony |
updated_ |
Tylko dane wejściowe. Odpowiedź zaktualizowanego widżetu. |
ResponseType
Typ odpowiedzi aplikacji Google Chat.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Domyślny typ 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 przypadku zdarzenia CARD_CLICKED , w którym typ nadawcy wiadomości to BOT . |
UPDATE_USER_MESSAGE_CARDS |
Zaktualizuj karty w wiadomości użytkownika. Jest to dozwolone tylko w odpowiedzi na zdarzenie MESSAGE z dopasowanym adresem URL lub zdarzenie CARD_CLICKED , w którym typem nadawcy wiadomości jest HUMAN . Tekst jest ignorowany. |
REQUEST_CONFIG |
Poprosić użytkownika o dodatkowe uwierzytelnianie lub konfigurację. |
DIALOG |
Wyświetla okno. |
UPDATE_WIDGET |
Zapytanie dotyczące opcji autouzupełniania tekstu widżetu. |
SelectionItems
Lista wyników autouzupełniania widżetu.
Pola | |
---|---|
items[] |
Tablica obiektów SelectionItem. |
UpdatedWidget
Odpowiedź zaktualizowanego widżetu. Służy do udostępniania opcji autouzupełniania w widżetach.
Pola | |
---|---|
widget |
Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał prośbę o aktualizację. |
Pole unii updated_widget . widżet został zaktualizowany w odpowiedzi na działanie użytkownika; updated_widget może być tylko jednym z tych elementów: |
|
suggestions |
Lista wyników autouzupełniania w widżetach |
ActionStatus
Reprezentuje stan prośby o wywołanie lub przesłanie dialogu.
Pola | |
---|---|
status_ |
Kod stanu. |
user_ |
Wiadomość, która ma być wysyłana do użytkowników o stanie ich prośby. Jeśli nie jest ustawiony, wysyłana jest ogólna wiadomość na podstawie |
Adnotacja
Tylko dane wyjściowe. adnotacje powiązane z treścią wiadomości w postaci zwykłego tekstu; Aby dodać podstawowe formatowanie do wiadomości tekstowej, zapoznaj się z artykułem Formatowanie wiadomości tekstowych.
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 adnotacji. |
length |
Długość podciągu w treści wiadomości w postaci zwykłego tekstu, do której odnosi się ta adnotacja. |
start_ |
Indeks początkowy (od 0 włącznie) w zwykłym tekście treści wiadomości, do której odnosi się ta adnotacja. |
Pole unii metadata . dodatkowe metadane dotyczące adnotacji; metadata może być tylko jednym z tych elementów: |
|
user_ |
Metadane wzmianki o użytkowniku. |
slash_ |
Metadane polecenia po ukośniku. |
rich_ |
Metadane linku rozszerzonego. |
AnnotationType
Typ adnotacji.
Wartości w polu enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Wartość domyślna typu wyliczeniowego. Nie używaj. |
USER_MENTION |
Wzmianka o użytkowniku. |
SLASH_COMMAND |
Wywołano polecenie po ukośniku. |
RICH_LINK |
Adnotacja linku rozszerzonego. |
AttachedGif
Obraz GIF określony za pomocą adresu URL.
Pola | |
---|---|
uri |
Tylko dane wyjściowe. Adres URL hostujący obraz GIF. |
Załącznik
Załącznik w Google Chat.
Pola | |
---|---|
name |
Opcjonalnie: Nazwa zasobu załącznika w formacie |
content_ |
Tylko dane wyjściowe. Oryginalna nazwa pliku treści, a nie pełna ścieżka. |
content_ |
Tylko dane wyjściowe. Typ treści (typ MIME) pliku. |
thumbnail_ |
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. |
download_ |
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. |
Pole unii data_ref . Odwołania do załącznika. data_ref może być tylko jednym z tych elementów: |
|
attachment_ |
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. |
drive_ |
Tylko dane wyjściowe. Odniesienie do załącznika z Dysku Google. To pole jest używane w interfejsie Dysk Google API. |
Źródło
Źródło załącznika.
Wartości w polu enum | |
---|---|
SOURCE_UNSPECIFIED |
Zarezerwowane. |
DRIVE_FILE |
Plik jest plikiem z Dysku Google. |
UPLOADED_CONTENT |
Plik jest przesyłany do Google Chat. |
AttachmentDataRef
Odwołanie do danych załącznika.
Pola | |
---|---|
resource_ |
Opcjonalnie: Nazwa zasobu danych załącznika. To pole jest używane w ramach interfejsu Media API do pobierania danych załączonych. |
attachment_ |
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. |
CardWithId
Karta w wiadomości Google Chat.
Tylko aplikacje Google Chat mogą tworzyć karty. Jeśli aplikacja Google Chat uwierzytelnia użytkownika, wiadomość nie może zawierać kart.
Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.
Otwórz kreatora kartPola | |
---|---|
card_ |
Wymagane, jeśli wiadomość zawiera wiele 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 powiązanego zasobu pokoju czatu. Format: |
message |
Wiadomość z powiązanego zasobu pokoju czatu. Format: |
CompleteImportSpaceRequest
Prośba o dokończenie procesu importowania pokoju
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju w trybie importowania. Format: |
CompleteImportSpaceResponse
Odpowiedź na wiadomość o zakończeniu procesu importowania pokoju.
Pola | |
---|---|
space |
Pokój w trybie importowania. |
ContextualAddOnMarkup
Ten typ nie ma pól.
znaczniki dla deweloperów, które umożliwiają określenie zawartości kontekstowego dodatku;
Karta
Karta to element interfejsu, który może zawierać widżety interfejsu, takie jak tekst i obrazy.
Pola | |
---|---|
header |
Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz. |
sections[] |
Sekcje są rozdzielane linią. |
card_ |
Czynności związane z tą kartą. |
name |
Nazwa karty. |
CardAction
Działanie na karcie to działanie powiązane z kartą. W przypadku karty faktury typowe działania to: usunięcie faktury, wysłanie faktury e-mailem lub otwarcie faktury w przeglądarce.
Nieobsługiwane przez aplikacje Google Chat.
Pola | |
---|---|
action_ |
Etykieta wyświetlana w menu czynności. |
on_ |
Działanie onclick dla tego elementu działania. |
CardHeader
Pola | |
---|---|
title |
Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli określony jest tytuł i podtytuł, każdy z nich zajmuje jeden wiersz. Jeśli podany jest tylko tytuł, zajmuje on obie linie. |
subtitle |
Podtytuł nagłówka karty. |
image_ |
Typ obrazu (np. kwadratowe lub okrągłe obramowanie). |
image_ |
Adres URL obrazu w nagłówku karty. |
ImageStyle
Wartości w polu enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Kwadratowe obramowanie. |
AVATAR |
Okrągłe obramowanie. |
Sekcja
Sekcja zawiera zbiór widżetów, które są renderowane (pionowo) w kolejności, w jakiej zostały określone. Na wszystkich platformach karty mają wąską stałą szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).
Pola | |
---|---|
header |
Nagłówek sekcji. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. |
widgets[] |
Sekcja musi zawierać co najmniej 1 widżet. |
CreateCustomEmojiRequest
prośba o utworzenie niestandardowego emotikonu;
Pola | |
---|---|
custom_ |
Wymagane. Niestandardowy emotikon do utworzenia. |
CreateMembershipRequest
wiadomość z prośbą o utworzenie subskrypcji.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, dla którego chcesz utworzyć członkostwo. Format: spaces/{space} |
membership |
Wymagane. Relacja członkostwa do utworzenia. Pole 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:
Zapraszanie użytkowników spoza organizacji Workspace, która jest właścicielem pokoju, wymaga uwierzytelniania użytkowników. Gdy aplikacja do czatu tworzy dla siebie relację członkostwa, musi uwierzytelnić się jako użytkownik i użyć zakresu |
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga Tworzenie subskrypcji aplikacji lub subskrypcji dla użytkowników spoza organizacji Google Workspace administratora nie jest obsługiwane przy użyciu dostępu administratora. |
CreateMessageRequest
Tworzy wiadomość.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, w którym chcesz utworzyć wiadomość. Format: |
message |
Wymagane. Treść wiadomości. |
thread_key |
Opcjonalnie: Wycofana: użyj w jej miejsce zasady |
request_ |
Opcjonalnie: Unikalny identyfikator żądania dla tej wiadomości. Jeśli określisz istniejący identyfikator żądania, zwróci on wiadomość utworzoną z tym identyfikatorem, zamiast tworzyć nową wiadomość. |
message_ |
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. |
message_ |
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 Wartość w tym polu musi spełniać te wymagania:
Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości. |
MessageReplyOption
Określa sposób odpowiedzi 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. Ta opcja ignoruje wszystkie elementy thread ID lub , które są uwzględnione. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub . Jeśli się nie uda, wiadomość rozpocznie nowy wątek. |
REPLY_MESSAGE_OR_FAIL |
Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub . Jeśli użyto nowego thread_key , tworzony jest nowy wątek. Jeśli tworzenie wiadomości zakończy się niepowodzeniem, zamiast tego zwrócony zostanie błąd NOT_FOUND . |
CreateReactionRequest
tworzy reakcję na wiadomość.
Pola | |
---|---|
parent |
Wymagane. Wiadomość, w której utworzono reakcję. Format: |
reaction |
Wymagane. Reakcja do utworzenia. |
CreateSpaceRequest
prośba o utworzenie pokoju o nazwie bez użytkowników;
Pola | |
---|---|
space |
Wymagane. Pola Jeśli pojawi się komunikat o błędzie Przecinek |
request_ |
Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora prośby z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd. |
CustomEmoji
Reprezentuje niestandardowy emotikon.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu niestandardowego emotikonu przypisanego przez serwer. Format: |
uid |
Tylko dane wyjściowe. Unikalny klucz zasobu niestandardowego emotikonu. |
emoji_ |
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: |
temporary_ |
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. |
payload |
Opcjonalnie: Tylko dane wejściowe. Dane ładunku. Wymagana podczas tworzenia niestandardowego emotikonu. |
CustomEmojiPayload
Dane ładunku niestandardowego emotikonu.
Pola | |
---|---|
file_ |
Wymagane. Tylko dane wejściowe. Obraz użyty do emotikonu niestandardowego. Dane ładunku nie mogą przekraczać 256 KB, a rozmiar obrazu musi mieścić się w zakresie od 64 do 500 pikseli. Ograniczenia mogą ulec zmianie. |
filename |
Wymagane. Tylko dane wejściowe. Nazwa pliku obrazu. Obsługiwane rozszerzenia plików: |
DeleteCustomEmojiRequest
prośba o usunięcie niestandardowego emotikonu;
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu niestandardowego emotikona, który chcesz usunąć. Format: Możesz użyć nazwy emotikonu jako aliasu elementu |
DeleteMembershipRequest
prośba o usunięcie użytkownika z pokoju;
Pola | |
---|---|
name |
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 Usuwanie członkostwa w aplikacji wymaga zakresu Format: |
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga Usuwanie członkostwa w aplikacji w pokoju nie jest obsługiwane przy użyciu dostępu administracyjnego. |
DeleteMessageRequest
Prośba o usunięcie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu |
force |
Opcjonalnie: Gdy Dotyczy tylko uwierzytelniania jako użytkownik. Nie ma wpływu na uwierzytelnianie jako aplikacja Google Chat. |
DeleteReactionRequest
Usuwa reakcję na wiadomość.
Pola | |
---|---|
name |
Wymagane. Nazwa reakcji, którą chcesz usunąć. Format: |
DeleteSpaceRequest
Prośba o usunięcie pokoju
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju, który chcesz usunąć. Format: |
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga |
DeletionMetadata
informacje o usuniętej wiadomości; Wiadomość jest usuwana, gdy ustawiona jest wartość delete_time
.
Pola | |
---|---|
deletion_ |
Wskazuje, kto usunął wiadomość. |
DeletionType
Kto i w jaki sposób usunął wiadomość. W przyszłości możemy dodać więcej wartości.
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 Google Chat usunęła własną wiadomość po wygaśnięciu. |
CREATOR_VIA_APP |
Aplikacja Google Chat usunęła wiadomość w imieniu użytkownika. |
SPACE_OWNER_VIA_APP |
Aplikacja Google Chat usunęła wiadomość w imieniu właściciela pokoju. |
Dialog
Opakowanie na karcie w dialogu.
Pola | |
---|---|
body |
Tylko dane wejściowe. Treść dialogu, który jest renderowany w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: |
DialogAction
Zawiera dialog i kod stanu żądania.
Pola | |
---|---|
action_ |
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. |
Pole unii action . Działanie do wykonania. action może być tylko jednym z tych elementów: |
|
dialog |
Tylko dane wejściowe. Dialog dotyczący prośby. |
DriveDataRef
Odwołuje się do danych załącznika na dysku.
Pola | |
---|---|
drive_ |
Identyfikator pliku na Dysku. Używaj go z interfejsem Drive API. |
DriveLinkData
dane dotyczące linków na Dysku Google.
Pola | |
---|---|
drive_ |
DriveDataRef, który odwołuje się do pliku na Dysku Google. |
mime_ |
Typ MIME połączonego zasobu na Dysku Google. |
Emotikony
Emotikon używany jako reakcja na wiadomość.
Pola | |
---|---|
Pole unii content . Wymagane. treść emotikonu; content może być tylko jednym z tych elementów: |
|
unicode |
Opcjonalnie: Podstawowy emotikon reprezentowany przez ciąg znaków Unicode. |
custom_ |
Tylko dane wyjściowe. niestandardowy emotikon; |
EmojiReactionSummary
Liczba osób, które zareagowały na wiadomość za pomocą określonego emotikona.
Pola | |
---|---|
emoji |
Tylko dane wyjściowe. emotikony powiązane z reakcjami. |
reaction_ |
Tylko dane wyjściowe. Łączna liczba reakcji z użyciem powiązanego emotikona. |
FindDirectMessageRequest
Prośba o przestrzeń na czacie na podstawie zasobu użytkownika.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu użytkownika, z którym chcesz znaleźć wiadomość na czacie. Format: |
GetAttachmentRequest
Prośba o załącznik.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu załącznika w formacie |
GetCustomEmojiRequest
żądanie zwrócenia jednego niestandardowego emotikonu;
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu niestandardowego emotikonu. Format: Możesz użyć nazwy emotikonu jako aliasu elementu |
GetMembershipRequest
wysłać prośbę o członkostwo w pokoju;
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu subskrypcji do pobrania. Aby uzyskać członkostwo w aplikacji za pomocą uwierzytelnienia użytkownika, możesz opcjonalnie użyć Format: Możesz użyć adresu e-mail użytkownika jako aliasu |
use_ |
Opcjonalnie: Jeśli 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 Uzyskiwanie członkostwa w aplikacji w przestrzeni nie jest obsługiwane podczas korzystania z dostępu administratora. |
GetMessageRequest
Poproś o otrzymanie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli dla wiadomości ustawiono niestandardowy identyfikator, w polu |
GetSpaceEventRequest
wiadomość z prośbą o zdarzenie pokoju
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu zdarzenia dotyczącego pokoju. Format: |
GetSpaceNotificationSettingRequest
wiadomość z prośbą o ustawienie powiadomień o miejscu Obsługuje tylko pobieranie ustawień powiadomień dla dzwoniącego użytkownika.
Pola | |
---|---|
name |
Wymagane. Format: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Komunikat żądania interfejsu GetSpaceReadState API.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu z czytaniem stanu pokoju do pobrania. Obsługuje tylko odczytywanie wiadomości przez dzwoniącego użytkownika. Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:
Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni |
GetSpaceRequest
Żądanie zwrócenia pojedynej spacji.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju w formacie Format: |
use_ |
Opcjonalnie: Jeśli 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 |
GetThreadReadStateRequest
Treść żądania interfejsu GetThreadReadStateRequest API.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu stanu odczytu wątku do pobrania. Obsługuje tylko odczytywanie wiadomości przez dzwoniącego użytkownika. Aby odwoływać się do dzwoniącego użytkownika, użyj jednej z tych opcji:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Grupa
Grupa dyskusyjna Google w Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu grupy Google. Reprezentuje grupę w Cloud Identity Groups API. Format: groups/{group} |
HistoryState
stan historii wiadomości i pokoi. Określa, jak długo wiadomości i wątki rozmów są przechowywane po utworzeniu.
Wartości w polu enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Wartość domyślna. Nie używać. |
HISTORY_OFF |
Historia wyłączona. Wiadomości i wątki są przechowywane przez 24 godziny. |
HISTORY_ON |
Historia jest włączona. Reguły przechowywania Vault organizacji określają, jak długo wiadomości i wątki są przechowywane. |
ListCustomEmojisRequest
Żądanie zwrócenia listy niestandardowych emotikonów.
Pola | |
---|---|
page_ |
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ścią domyślną jest 25. Maksymalna wartość to 200; wartości powyżej 200 są zmieniane na 200. |
page_ |
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. |
filter |
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 Na przykład to zapytanie zwraca niestandardowy emotikon utworzony przez wywołującego:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
ListCustomEmojisResponse
Odpowiedź na listę niestandardowych emotikonów.
Pola | |
---|---|
custom_ |
Lista nieuporządkowana. Lista niestandardowych emotikonów na żądanej (lub pierwszej) stronie. |
next_ |
Token, który możesz wysłać jako |
ListMembershipsRequest
Prośba o wyświetlenie wiadomości o wspieraniu.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, z którego chcesz pobrać listę członków. Format: spaces/{space} |
page_ |
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 |
page_ |
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. |
filter |
Opcjonalnie: Filtr zapytania. Możesz filtrować członkostwa według roli ( Aby filtrować według roli, ustaw wartość Aby filtrować według typu, ustaw wartość Aby filtrować według roli i typu, użyj operatora Gdy element Na przykład te zapytania są prawidłowe:
Te zapytania są nieprawidłowe:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
show_ |
Opcjonalnie: Gdy |
show_ |
Opcjonalnie: Jeśli Obecnie wymaga uwierzytelnienia użytkownika. |
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga zakresu Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane, gdy używasz dostępu administratora. |
ListMembershipsResponse
Odpowiedź na listę osób w pokoju
Pola | |
---|---|
memberships[] |
Lista nieuporządkowana. Lista członkostw na stronie, której dotyczy żądanie (lub pierwszej stronie). |
next_ |
Token, który możesz wysłać jako |
ListMessagesRequest
Wyświetla wiadomości w określonym pokoju, którego użytkownik jest członkiem.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, z którego mają być wyświetlane wiadomości. Format: |
page_ |
Opcjonalnie: Maksymalna liczba zwracanych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość. Jeśli nie zostanie podana wartość, 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_ |
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. |
filter |
Opcjonalnie: Filtr zapytania. Możesz filtrować wiadomości według daty ( Aby filtrować wiadomości według daty ich utworzenia, określ Aby filtrować według wątku, określ Aby filtrować według wątku i daty, użyj w zapytaniu operatora Na przykład te zapytania są prawidłowe:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
order_ |
Opcjonalnie: kolejność wyświetlania listy wiadomości; Określ wartość do posortowania za pomocą operacji sortowania. Prawidłowe wartości operacji sortowania:
Domyślne sortowanie to |
show_ |
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. |
ListMessagesResponse
Odpowiedź na wiadomość o wyświetleniu wiadomości.
Pola | |
---|---|
messages[] |
Lista wiadomości. |
next_ |
Aby pobrać kolejną stronę wyników, możesz wysłać token jako |
ListReactionsRequest
Lista reakcji na wiadomość.
Pola | |
---|---|
parent |
Wymagane. wiadomość, na którą użytkownicy zareagowali; Format: |
page_ |
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_ |
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. |
filter |
Opcjonalnie: Filtr zapytania. Reakcje możesz filtrować według emotikonów ( Aby filtrować reakcje dotyczące wielu emotikonów lub użytkowników, złącz podobne pola za pomocą operatora Aby filtrować reakcje według emotikonów i użytkowników, użyj operatora Jeśli w zapytaniu występują zarówno Na przykład te zapytania są prawidłowe:
Te zapytania są nieprawidłowe:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
ListReactionsResponse
Odpowiedź na żądanie wyświetlenia reakcji na liście.
Pola | |
---|---|
reactions[] |
Lista reakcji na żądanej (lub pierwszej) stronie. |
next_ |
token kontynuacji do pobrania następnej strony wyników. Na ostatniej stronie wyników jest puste. |
ListSpaceEventsRequest
Prośba o utworzenie listy zdarzeń w pokoju
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju Google Chat, w którym wystąpiły zdarzenia. Format: |
page_ |
Opcjonalnie: Maksymalna liczba zwracanych zdarzeń dotyczących przestrzeni. Usługa może zwrócić mniej niż ta wartość. Wartości ujemne zwracają błąd |
page_ |
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. |
filter |
Wymagane. Filtr zapytania. Musisz określić co najmniej 1 typ zdarzenia ( Opcjonalnie możesz też filtrować według czasu rozpoczęcia (
Aby określić czas rozpoczęcia lub zakończenia, użyj operatora równa się Na przykład te zapytania są prawidłowe:
Te zapytania są nieprawidłowe:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
ListSpaceEventsResponse
Odpowiedź na wyświetlanie zdarzeń w pokoju
Pola | |
---|---|
space_ |
Wyniki są zwracane w kolejności chronologicznej (najpierw najstarsze zdarzenie). Uwaga: pole |
next_ |
Token kontynuacji służący do pobierania kolejnych zdarzeń. Jeśli pominiesz to pole, nie będzie kolejnych stron. |
ListSpacesRequest
Prośba o wyświetlenie listy pokoi, do których należy dzwoniący.
Pola | |
---|---|
page_ |
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 |
page_ |
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. |
filter |
Opcjonalnie: Filtr zapytania. Możesz filtrować pokoje według typu pokoju ( Aby filtrować według typu pokoju, musisz podać prawidłową wartość z układu, np. Na przykład te zapytania są prawidłowe:
Serwer odrzuca nieprawidłowe zapytania, zwracając błąd |
ListSpacesResponse
Odpowiedź na żądanie listy pokoi.
Pola | |
---|---|
spaces[] |
Lista pokoi na stronie, której dotyczy żądanie (lub na pierwszej stronie). Uwaga: pole |
next_ |
Aby pobrać kolejną stronę wyników, możesz wysłać token jako |
MatchedUrl
pasujący adres URL w wiadomości w Google Chat. Aplikacje do czatu mogą wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w artykule Podgląd linków.
Pola | |
---|---|
url |
Tylko dane wyjściowe. Adres URL, który został dopasowany. |
Członkostwo
Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja Google Chat są zaproszeni do pokoju lub są w nim obecni albo go nie ma.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu członkostwa przypisana przez serwer. Format: |
state |
Tylko dane wyjściowe. Stan członkostwa. |
role |
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 |
create_ |
Opcjonalnie: Niezmienna. Czas utworzenia członkostwa, np. kiedy użytkownik dołączył do pokoju lub został zaproszony do niego. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania. |
delete_ |
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. |
Pole unii memberType . Użytkownik powiązany z tym członkostwem. W przyszłości możemy obsługiwać inne typy użytkowników. memberType może być tylko jednym z tych elementów: |
|
member |
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 |
group_ |
Opcjonalnie: Grupa Google, do której należy użytkownik. Odczytywanie lub modyfikowanie członkostwa w Grupach dyskusyjnych Google wymaga uwierzytelnienia użytkownika. |
MembershipRole
Reprezentuje dozwolone działania użytkownika w pokoju czatu. W przyszłości możemy dodać więcej wartości typu wyliczeniowego.
Wartości w polu enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Wartość domyślna. users : nie jest on użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups : zawsze przypisana jest im ta rola (w przyszłości mogą być używane inne wartości). |
ROLE_MEMBER |
Użytkownik jest członkiem 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ą zarządzanie pokojem, np. dodawanie i usuwanie użytkowników. Obsługiwane tylko w SpaceType.SPACE . |
MembershipState
Określa relację użytkownika z pokojem. W przyszłości możemy obsługiwać inne stany członkostwa.
Wartości w polu enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Wartość domyślna. Nie używaj. |
JOINED |
Użytkownik zostaje dodany do pokoju i może w nim uczestniczyć. |
INVITED |
Użytkownik został zaproszony do pokoju, ale nie dołączył do niego. |
NOT_A_MEMBER |
Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do pokoju. |
MembershipBatchCreatedEventData
Ładunek zdarzenia dotyczący wielu nowych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchCreated
Pola | |
---|---|
memberships[] |
Lista nowych wspierających. |
MembershipBatchDeletedEventData
Ładunek zdarzenia dla wielu usuniętych wspierań.
Typ zdarzenia: google.workspace.chat.membership.v1.batchDeleted
Pola | |
---|---|
memberships[] |
Lista usuniętych wspierań. |
MembershipBatchUpdatedEventData
Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchUpdated
Pola | |
---|---|
memberships[] |
lista zaktualizowanych wspierań; |
MembershipCreatedEventData
ładunek zdarzeń dla nowego wspierania kanału;
Typ zdarzenia: google.workspace.chat.membership.v1.created
.
Pola | |
---|---|
membership |
Nowe członkostwo. |
MembershipDeletedEventData
Ładunek zdarzenia dotyczący usuniętej subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.deleted
Pola | |
---|---|
membership |
Usunięta subskrypcja. Wypełnione są tylko pola |
MembershipUpdatedEventData
Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.updated
Pola | |
---|---|
membership |
Zaktualizowane członkostwo. |
Wiadomość
Wiadomość w pokoju Google Chat.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu wiadomości. Format: Gdzie Jeśli podczas tworzenia wiadomości ustawisz niestandardowy identyfikator, możesz użyć tego identyfikatora, aby określić wiadomość w żądaniu, zastępując |
sender |
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 |
create_ |
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. |
last_ |
Tylko dane wyjściowe. Czas ostatniej edycji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie została edytowana, to pole jest puste. |
delete_ |
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. |
text |
Opcjonalnie: Treść wiadomości w postaci zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wyświetlenie elementu z podglądem. 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. |
formatted_ |
Tylko dane wyjściowe. Zawiera wiadomość
Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości. |
cards[] |
Wycofana: użyj w jej miejsce zasady 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_ |
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. Otwórz kreatora kart |
annotations[] |
Tylko dane wyjściowe. Adnotacje powiązane z |
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 |
fallback_ |
Opcjonalnie: Tekstowy opis kart wiadomości, używany, gdy nie można wyświetlić samych kart (np. w przypadku powiadomień mobilnych). |
action_ |
Tylko dane wejściowe. Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi. |
argument_ |
Tylko dane wyjściowe. Treść wiadomości w postaci zwykłego tekstu bez wzmianek o aplikacji do obsługi czatu. |
slash_ |
Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (w stosownych przypadkach). |
attachment[] |
Opcjonalnie: Załącznik przesłany przez użytkownika. |
matched_ |
Tylko dane wyjściowe. Adres URL w |
thread_ |
Tylko dane wyjściowe. Jeśli Jeśli pokój nie obsługuje odpowiadania w wątkach, to pole jest zawsze |
client_ |
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 |
emoji_ |
Tylko dane wyjściowe. Lista podsumowań reakcji emotikonów w wiadomości. |
private_ |
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: Szczegółowe informacje znajdziesz w artykule Wysyłanie wiadomości prywatnych. |
deletion_ |
Tylko dane wyjściowe. informacje o usuniętej wiadomości; Wiadomość jest usuwana, gdy ustawiona jest wartość |
quoted_ |
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ć. |
attached_ |
Tylko dane wyjściowe. obrazy GIF załączone do wiadomości. |
accessory_ |
Opcjonalnie: Co najmniej 1 interaktywny widget, 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. |
MessageBatchCreatedEventData
Ładunek zdarzeń dla wielu nowych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchCreated
Pola | |
---|---|
messages[] |
lista nowych wiadomości; |
MessageBatchDeletedEventData
Payload zdarzenia dla wielu usuniętych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchDeleted
Pola | |
---|---|
messages[] |
lista usuniętych wiadomości; |
MessageBatchUpdatedEventData
Ładunek zdarzeń dla wielu zaktualizowanych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchUpdated
Pola | |
---|---|
messages[] |
Lista zaktualizowanych wiadomości. |
MessageCreatedEventData
ładunek zdarzeń dla nowej wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.created
Pola | |
---|---|
message |
Nowa wiadomość. |
MessageDeletedEventData
Ładunek zdarzenia dotyczący 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 dla 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_ |
Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy cytowany komunikat został utworzony lub zaktualizowany. |
Reakcja
reakcja na wiadomość.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu reakcji. Format: |
user |
Tylko dane wyjściowe. Użytkownik, który utworzył reakcję. |
emoji |
Wymagane. Emotikon użyty w reakcji. |
ReactionBatchCreatedEventData
Ładunek zdarzeń dla 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 zdarzeń dla nowej reakcji;
Typ zdarzenia: google.workspace.chat.reaction.v1.created
Pola | |
---|---|
reaction |
Nowa reakcja. |
ReactionDeletedEventData
Ładunek zdarzenia dotyczący usuniętej reakcji.
Typ: google.workspace.chat.reaction.v1.deleted
Pola | |
---|---|
reaction |
Usunięta reakcja. |
RichLinkMetadata
Link do zasobu.
Pola | |
---|---|
uri |
Identyfikator URI tego linku. |
rich_ |
Typ linku z elementami rozszerzonymi. |
Pole unii data . Dane połączonego zasobu. data może być tylko jednym z tych elementów: |
|
drive_ |
Dane linku do Dysku. |
chat_ |
Dane dotyczące linku do pokoju czatu. |
RichLinkType
Typ 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 typu wyliczeniowego. Nie używaj. |
DRIVE_FILE |
Typ linku na Dysku Google. |
CHAT_SPACE |
Typ linku rozszerzonego pokoju czatu. Może to być na przykład element inteligentny pokoju. |
SearchSpacesRequest
Prośba o wyszukanie listy pokoi na podstawie zapytania.
Pola | |
---|---|
use_ |
Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga zakresu Ta metoda obsługuje obecnie tylko dostęp administracyjny, dlatego w tym polu akceptowana jest tylko wartość |
page_ |
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. |
page_ |
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. |
query |
Wymagane. zapytanie; Możesz wyszukiwać za pomocą tych parametrów:
Funkcja
Wymagana jest wartość W różnych polach obsługiwane są tylko operatory W tym samym polu funkcja Prawidłowe są te przykładowe zapytania:
|
order_ |
Opcjonalnie: kolejność listy pokoi. Obsługiwane atrybuty, według których można sortować:
Prawidłowe wartości operacji sortowania:
Obsługiwane składnie:
|
SearchSpacesResponse
Odpowiedź z listą pokoi odpowiadających żądaniu wyszukiwania pokoi.
Pola | |
---|---|
spaces[] |
strona z żądanymi pokojami. |
next_ |
Token, którego można użyć do pobrania następnej strony. Jeśli to pole jest puste, nie będzie kolejnych stron. |
total_ |
Łączna liczba miejsc pasujących do zapytania na wszystkich stronach. Jeśli wynik przekracza 10 tys. miejsc, jest to wartość szacunkowa. |
SetUpSpaceRequest
Prośba o utworzenie pokoju i dodanie do niego określonych użytkowników.
Pola | |
---|---|
space |
Wymagane. Pole Aby utworzyć pokój, ustaw Aby utworzyć czat grupowy, ustaw wartość Aby utworzyć rozmowę 1:1 między ludźmi, ustaw Aby utworzyć rozmowę 1:1 między człowiekiem a aplikacją Google Chat, ustaw Jeśli pokój |
request_ |
Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora prośby z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd. |
memberships[] |
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 W przypadku członkostwa w Grupach dyskusyjnych Google pole Opcjonalny, gdy wartość Wymagane, gdy Jest on wymagany, jeśli ustawisz wartość Podczas tworzenia rozmowy 1:1 między człowiekiem a aplikacją Google Chat (gdy |
SlashCommand
Polecenie po ukośniku w Google Chat.
Pola | |
---|---|
command_ |
Identyfikator wywołanego polecenia po ukośniku. |
SlashCommandMetadata
Metadane adnotacji poleceń po ukośniku (/).
Pola | |
---|---|
bot |
Aplikacja Google Chat, której dotyczy wywołane polecenie. |
type |
Typ polecenia po ukośniku. |
command_ |
Nazwa wywołanego polecenia po ukośniku. |
command_ |
Identyfikator wywołanego polecenia po ukośniku. |
triggers_ |
Wskazuje, czy polecenie po ukośniku jest przeznaczone do dialogu. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna typu wyliczeniowego. Nie używaj. |
ADD |
Dodaj aplikację Google Chat do pokoju. |
INVOKE |
wywołać polecenie po ukośniku w pokoju, |
Spacja
Pokoju w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1 na 1 między użytkownikiem a aplikacją Google Chat.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu pokoju. Format: Gdzie |
type |
Tylko dane wyjściowe. Wycofana: użyj w jej miejsce zasady |
space_ |
Opcjonalnie: Typ pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania typu pokoju. Dane wyjściowe tylko do innych zastosowań. |
single_ |
Opcjonalnie: Czy pokój to czat między botem a jedną osobą. |
threaded |
Tylko dane wyjściowe. Wycofana: użyj w jej miejsce zasady |
display_ |
Opcjonalnie: Wyświetlana nazwa pokoju. Wymagana podczas tworzenia pokoju z W przypadku czatów to pole może być puste. Obsługuje do 128 znaków. |
external_ |
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:
W przypadku istniejących pokoi to pole jest tylko do odczytu. |
space_ |
Tylko dane wyjściowe. Stan wątku w pokoju czatu. |
space_ |
Opcjonalnie: Szczegóły dotyczące pokoju, w tym opis i zasady. |
space_ |
Opcjonalnie: stan historii wiadomości i wątków w tym pokoju; |
import_ |
Opcjonalnie: Czy ten pokój został utworzony w Tworzenie pokoju w |
create_ |
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ść |
last_ |
Tylko dane wyjściowe. Sygnatura czasowa ostatniej wiadomości w pokoju. |
admin_ |
Tylko dane wyjściowe. W przypadku czatu z wiadomościami bezpośrednimi w aplikacji Google Chat sprawdź, 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. |
membership_ |
Tylko dane wyjściowe. Liczba wspierających pogrupowanych według typu wspierającego. Wypełniane, gdy wartość właściwości |
access_ |
Opcjonalnie: Określa ustawienie dostępu pokoju. Wypełniane tylko wtedy, gdy wartość |
space_ |
Tylko dane wyjściowe. Identyfikator URI umożliwiający użytkownikowi dostęp do pokoju. |
import_ |
Tylko dane wyjściowe. Czas, w którym pokój zostanie automatycznie usunięty przez system, jeśli nadal będzie w trybie importowania. Każdy pokój utworzony w trybie importowania musi wyjść z tego trybu przed upływem tego czasu za pomocą To pole jest wypełnione tylko w przypadku pokoi utworzonych w trybie importowania. |
customer |
Opcjonalnie: Niezmienna. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i wartością W formacie W przypadku czatów to pole nie jest wypełniane. |
Pole unii Wymaga uwierzytelniania użytkownika. |
|
predefined_ |
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 |
permission_ |
Opcjonalnie: ustawienia uprawnień pokoju dla 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ń. |
AccessSettings
Reprezentuje ustawienie dostępu pokoju.
Pola | |
---|---|
access_ |
Tylko dane wyjściowe. Wskazuje stan dostępu do pokoju. |
audience |
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: Aby użyć domyślnej grupy odbiorców organizacji Google Workspace, ustaw wartość Czytanie informacji o grupie odbiorców umożliwia:
To pole nie jest wypełniane, gdy używasz zakresu Aby ustawić grupę odbiorców, musisz uwierzytelnić użytkownika. |
AccessState
Reprezentuje stan dostępu do pokoju.
Wartości w polu enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Stan dostępu jest nieznany lub nieobsługiwany w tym interfejsie API. |
PRIVATE |
Dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, którzy zostali dodani indywidualnie lub zaproszeni przez innych użytkowników albo administratorów Google Workspace. |
DISCOVERABLE |
menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, które zostały dodane indywidualnie lub zaproszone do pokoju, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników. Tworzenie pokoi możliwych do znalezienia wymaga uwierzytelniania użytkownika. |
MembershipCount
Reprezentuje liczbę członkostw w pokoju, pogrupowanych według kategorii.
Pola | |
---|---|
joined_ |
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. |
joined_ |
Tylko dane wyjściowe. Liczba wszystkich grup, które bezpośrednio dołączyły do pokoju. |
PermissionSetting
Reprezentuje ustawienie uprawnień pokoju.
Pola | |
---|---|
managers_ |
Opcjonalnie: czy menedżerowie pokoju mają to uprawnienie. |
members_ |
Opcjonalnie: Określa, czy użytkownicy, którzy nie są menedżerami, mają to uprawnienie. |
PermissionSettings
Ustawienia uprawnień, które możesz określić podczas aktualizowania istniejącego pokoju o nazwie.
Aby ustawić ustawienia uprawnień podczas tworzenia pokoju, w żądaniu podaj pole PredefinedPermissionSettings
.
Pola | |
---|---|
manage_ |
Opcjonalnie: Ustawienie dotyczące zarządzania użytkownikami i grupami w pokoju. |
modify_ |
Opcjonalnie: Ustawienie umożliwiające aktualizowanie nazwy pokoju, awatara, opisu i wytycznych. |
toggle_ |
Opcjonalnie: Ustawienie włączania i wyłączania historii pokoju. |
use_ |
Opcjonalnie: Ustawienie dotyczące używania polecenia @all w pokoju |
manage_ |
Opcjonalnie: Ustawienie zarządzania aplikacjami w pokoju. |
manage_ |
Opcjonalnie: Ustawienie zarządzania webhookami w pokoju. |
post_ |
Tylko dane wyjściowe. Ustawienie dotyczące publikowania wiadomości w pokoju. |
reply_ |
Opcjonalnie: Ustawienie odpowiadania na wiadomości w pokoju. |
PredefinedPermissionSettings
wstępnie zdefiniowane ustawienia uprawnień, które możesz określić tylko podczas tworzenia pokoju o nazwie; W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień w przypadku pokoi o nazwie znajdziesz w artykule Więcej informacji o pokojach.
Wartości w polu enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Nie określono. Nie używaj. |
COLLABORATION_SPACE |
Ustawienie, które powoduje, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości. |
ANNOUNCEMENT_SPACE |
Ustawienie, które powoduje, że pokój staje się pokojem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości. |
SpaceDetails
Szczegóły dotyczące pokoju, w tym opis i zasady.
Pola | |
---|---|
description |
Opcjonalnie: Opis pokoju. Możesz na przykład opisać temat dyskusji, cel lub uczestników pokoju. Obsługuje do 150 znaków. |
guidelines |
Opcjonalnie: zasady, oczekiwania i etykietę obowiązujące w pokoju; Obsługuje do 5000 znaków. |
SpaceThreadingState
Określa typ stanu wątku w pokoju Google Chat.
Wartości w polu enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Zarezerwowane. |
THREADED_MESSAGES |
Nazwane pokoje, które obsługują wątki wiadomości. Gdy użytkownicy odpowiadają na wiadomość, mogą to zrobić w wątku, dzięki czemu ich odpowiedź będzie miała kontekst oryginalnej wiadomości. |
GROUPED_MESSAGES |
Nazwane pokoje, w których rozmowy są uporządkowane według tematu. Tematy i odpowiedzi na nie są grupowane. |
UNTHREADED_MESSAGES |
czaty między 2 osobami oraz rozmowy grupowe z co najmniej 3 osobami. |
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 wysyłają wiadomości, udostępniają pliki i współpracują. SPACE może zawierać aplikacje Google Chat. |
GROUP_CHAT |
rozmowy grupowe z co najmniej 3 osobami; GROUP_CHAT może zawierać aplikacje Google Chat. |
DIRECT_MESSAGE |
wiadomości 1:1 między dwoma osobami lub między osobą a aplikacją Google Chat; |
Typ
Wycofana: użyj w jej miejsce zasady SpaceType
.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Zarezerwowane. |
ROOM |
rozmowy między co najmniej 2 osobami, |
DM |
Czat indywidualny między człowiekiem a aplikacją do obsługi czatu, w którym wszystkie wiadomości są równe. Pamiętaj, że nie dotyczy to wiadomości na czacie między dwoma osobami. |
SpaceBatchUpdatedEventData
Ładunek zdarzeń dla wielu aktualizacji pokoju.
Typ zdarzenia: google.workspace.chat.space.v1.batchUpdated
Pola | |
---|---|
spaces[] |
lista zaktualizowanych pokoi; |
SpaceEvent
Zdarzenie, które reprezentuje zmianę lub aktywność w pokoju Google Chat. Więcej informacji znajdziesz w artykule Praca z wydarzeniami z Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu zdarzenia dotyczącego pokoju. Format: |
event_ |
Czas wystąpienia zdarzenia. |
event_ |
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ń Obsługiwane typy zdarzeń messages:
Obsługiwane typy zdarzeń memberships:
Obsługiwane typy zdarzeń w przypadku reakcji:
Obsługiwane typy zdarzeń dotyczących pokoju:
|
Pole unii
|
|
message_ |
ładunek zdarzeń dla nowej wiadomości. Typ zdarzenia: |
message_ |
Ładunek zdarzenia dla zaktualizowanej wiadomości. Typ zdarzenia: |
message_ |
Ładunek zdarzenia dotyczący usuniętej wiadomości. Typ zdarzenia: |
message_ |
ładunek zdarzeń dla wielu nowych wiadomości. Typ zdarzenia: |
message_ |
Ładunek zdarzeń dla wielu zaktualizowanych wiadomości. Typ zdarzenia: |
message_ |
Payload zdarzenia dla wielu usuniętych wiadomości. Typ zdarzenia: |
space_ |
ładunek zdarzeń dla aktualizacji pokoju; Typ zdarzenia: |
space_ |
Ładunek zdarzeń dla wielu aktualizacji pokoju. Typ zdarzenia: |
membership_ |
ładunek zdarzeń dla nowego wspierania kanału; Typ zdarzenia: |
membership_ |
Ładunek zdarzenia dotyczący zaktualizowanej subskrypcji. Typ zdarzenia: |
membership_ |
Ładunek zdarzenia dotyczący usuniętej subskrypcji. Typ zdarzenia: |
membership_ |
Ładunek zdarzenia dotyczący wielu nowych subskrypcji. Typ zdarzenia: |
membership_ |
Ładunek zdarzenia dotyczący wielu zaktualizowanych subskrypcji. Typ zdarzenia: |
membership_ |
Ładunek zdarzenia dotyczący wielu usuniętych wspierań. Typ zdarzenia: |
reaction_ |
ładunek zdarzeń dla nowej reakcji; Typ zdarzenia: |
reaction_ |
Ładunek zdarzenia dotyczący usuniętej reakcji. Typ zdarzenia: |
reaction_ |
Ładunek zdarzeń dla wielu nowych reakcji. Typ zdarzenia: |
reaction_ |
Ładunek zdarzenia dla wielu usuniętych reakcji. Typ zdarzenia: |
SpaceNotificationSetting
Ustawienia powiadomień użytkownika w pokoju.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu ustawień powiadomień w pokoju. Format: |
notification_ |
Ustawienie powiadomień. |
mute_ |
Ustawienie wyciszenia powiadomień z pokoju. |
MuteSetting
Typy ustawień ignorowania powiadomień w pokoju.
Wartości w polu enum | |
---|---|
MUTE_SETTING_UNSPECIFIED |
Zarezerwowane. |
UNMUTED |
Użytkownik będzie otrzymywać powiadomienia dotyczące pokoju zgodnie z ustawieniami powiadomień. |
MUTED |
Użytkownik nie będzie otrzymywać żadnych powiadomień z pokoju, niezależnie od ustawień powiadomień. |
NotificationSetting
Typy ustawień powiadomień.
Wartości w polu enum | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Zarezerwowane. |
ALL |
Powiadomienia są wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Wszystkie nowe wątki są automatycznie obserwowane, chyba że użytkownik zrezygnuje z obserwowania. |
MAIN_CONVERSATIONS |
Powiadomienie jest wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Niedostępne w przypadku czatów 1:1. |
FOR_YOU |
Powiadomienie jest wywoływane przez @wzmianki i obserwowane wątki. Niedostępne w przypadku czatów 1:1. |
OFF |
Powiadomienie jest wyłączone. |
SpaceReadState
Stan odczytania wiadomości przez użytkownika w pokoju, służący do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
Pola | |
---|---|
name |
Nazwa zasobu z informacją o stanie odczytu pokoju. Format: |
last_ |
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. |
SpaceUpdatedEventData
Ładunek zdarzenia dla zaktualizowanego pokoju.
Typ zdarzenia: google.workspace.chat.space.v1.updated
Pola | |
---|---|
space |
zaktualizowany pokój. |
Wątek
Wątek w pokoju Google Chat. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
Jeśli podczas tworzenia wiadomości określisz wątek, możesz ustawić pole messageReplyOption
, aby określić, co się stanie, jeśli nie zostanie znaleziony żaden pasujący wątek.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu wątku. Przykład: |
thread_ |
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 |
ThreadReadState
Stan odczytania wiadomości przez użytkownika w wątku, służący do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
Pola | |
---|---|
name |
Nazwa zasobu stanu odczytu wątku. Format: |
last_ |
Czas zaktualizowania stanu przeczytania wątku przez użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku. |
UpdateMembershipRequest
wiadomość z prośbą o zaktualizowanie subskrypcji.
Pola | |
---|---|
membership |
Wymagane. Subskrypcja do zaktualizowania. Zaktualizowane są tylko pola określone przez |
update_ |
Wymagane. Ścieżki pól do zaktualizowania. Jeśli jest wiele wartości, rozdziel je przecinkami lub użyj Obecnie obsługiwane ścieżki pól:
|
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga |
UpdateMessageRequest
Prośba o zaktualizowanie wiadomości
Pola | |
---|---|
message |
Wymagane. Wiadomość z zaktualizowanymi polami. |
update_ |
Wymagane. Ścieżki pól do zaktualizowania. Jeśli jest wiele wartości, rozdziel je przecinkami lub użyj Obecnie obsługiwane ścieżki pól:
|
allow_ |
Opcjonalnie: Jeśli |
UpdateSpaceNotificationSettingRequest
Poproś o zaktualizowanie ustawień powiadomień o pokoju. Obsługuje tylko aktualizowanie ustawień powiadomień dla dzwoniącego użytkownika.
Pola | |
---|---|
space_ |
Wymagane. Nazwa zasobu w ustawieniach powiadomień w pokoju musi być podana w formacie |
update_ |
Wymagane. Obsługiwane ścieżki pól: – |
UpdateSpaceReadStateRequest
Komunikat żądania interfejsu UpdateSpaceReadState API.
Pola | |
---|---|
space_ |
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:
Format: użytkownicy/{użytkownik}/przestrzenie/{przestrzeń}/stan_odczytania_przestrzeni |
update_ |
Wymagane. Ścieżki pól do zaktualizowania. Obecnie obsługiwane ścieżki pól:
Jeśli Aby oznaczyć pokój jako przeczytany, ustaw wartość |
UpdateSpaceRequest
prośba o aktualizację pojedynczego pokoju;
Pola | |
---|---|
space |
Wymagane. Pokój z polami do zaktualizowania. Pole |
update_ |
Wymagane. zaktualizowane ścieżki pól, rozdzielone przecinkami (jeśli jest ich więcej). Możesz zaktualizować te pola pokoju:
|
use_ |
Opcjonalnie: Jeśli Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach. Wymaga Niektóre wartości |
Użytkownik
Użytkownik w Google Chat. Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, dane wyjściowe zasobu User
wypełniają tylko pola name
i type
użytkownika.
Pola | |
---|---|
name |
Nazwa zasobu w Google Chat Format: W przypadku
|
display_ |
Tylko dane wyjściowe. Wyświetlana nazwa użytkownika. |
domain_ |
Unikalny identyfikator domeny Google Workspace użytkownika. |
type |
Typ użytkownika. |
is_ |
Tylko dane wyjściowe. Gdy |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna typu wyliczeniowego. NIE UŻYWAJ. |
HUMAN |
Użytkownik |
BOT |
Użytkownik aplikacji Google Chat. |
UserMentionMetadata
Metadane adnotacji dla wzmianek o użytkownikach (@).
Pola | |
---|---|
user |
Wspomniany użytkownik. |
type |
Typ wzmianki o użytkowniku. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna typu wyliczeniowego. Nie używaj. |
ADD |
Dodaj użytkownika do pokoju. |
MENTION |
Wspomnienie użytkownika w pokoju. |
WidgetMarkup
Widżet to element interfejsu użytkownika, który zawiera tekst i obrazy.
Pola | |
---|---|
buttons[] |
Lista przycisków. Pola przycisków mają też wartość |
Pole unii data . WidgetMarkup może zawierać tylko jeden z tych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól WidgetMarkup . data może być tylko jednym z tych elementów: |
|
text_ |
Wyświetlanie akapitu tekstu w tym widżecie. |
image |
Wyświetlanie obrazu w tym widżecie. |
key_ |
Wyświetlanie w tym widżecie elementu klucz-wartość. |
Przycisk
Przycisk Może to być przycisk tekstowy lub przycisk z obrazem.
Pola | |
---|---|
Pole unii
|
|
text_ |
Przycisk z tekstem i czynnością |
image_ |
Przycisk z obrazem i czynnością |
FormAction
Działanie formularza określa, co się dzieje, gdy formularz zostanie przesłany. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.
Pola | |
---|---|
action_ |
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. |
parameters[] |
Lista parametrów działania. |
ActionParameter
Lista parametrów ciągu, które należy podać podczas wywołania metody działania. Weźmy na przykład 3 przyciski drzemki: drzemka teraz, drzemka za 1 dzień, drzemka w przyszłym tygodniu. Możesz użyć action method = snooze()
, przekazując typ i czas drzemki na liście parametrów ciągu znaków.
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, który może zawierać działanie onclick
.
Pola | |
---|---|
image_ |
Adres URL obrazu. |
on_ |
Działanie |
aspect_ |
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. |
ImageButton
Przycisk graficzny z działaniem onclick
.
Pola | |
---|---|
on_ |
Działanie |
name |
Nazwa tego |
Pole unii icons . Ikona może być określona za pomocą Icon enum lub adresu URL. icons może być tylko jednym z tych elementów: |
|
icon |
Ikona określona przez |
icon_ |
Ikona określona za pomocą adresu URL. |
KeyValue
Element interfejsu użytkownika zawiera klucz (etykieta) i wartość (treść). Element ten może też zawierać pewne działania, np. przycisk onclick
.
Pola | |
---|---|
top_ |
Tekst górnej etykiety. 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. |
content |
Tekst treści. Formatowany 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_ |
czy treść powinna być wielowierszowa; |
bottom_ |
Tekst dolnej etykiety. 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. |
on_ |
Działanie |
Pole unii icons . Musisz zdefiniować co najmniej jedną z ikon: top_label lub bottom_label . icons może być tylko jednym z tych elementów: |
|
icon |
Wartość typu enum, która jest zastępowana przez interfejs API Google Chat odpowiednią ikoną. |
icon_ |
Ikona określona za pomocą adresu URL. |
Pole unii control . Widżet sterujący. Możesz ustawić wartość button lub switch_widget , ale nie obie jednocześnie. control może być tylko jednym z tych elementów: |
|
button |
Przycisk, który można kliknąć, aby wywołać działanie. |
OnClick
działanie onclick
(np. otwarcie linku).
Pola | |
---|---|
Pole unii
|
|
action |
Jeśli jest określone, to działanie |
open_ |
To działanie |
OpenLink
Link, który otwiera nowe okno.
Pola | |
---|---|
url |
Adres URL do otwarcia. |
TextButton
Przycisk z tekstem i czynnością onclick
.
Pola | |
---|---|
text |
Tekst na przycisku. |
on_ |
Działanie |
TextParagraph
akapit tekstu, 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.
Pola | |
---|---|
text |
|