Indeks
ChatService
(interfejs)AccessoryWidget
(komunikat)ActionResponse
(komunikat)ActionResponse.ResponseType
(wyliczenie)ActionResponse.SelectionItems
(komunikat)ActionResponse.UpdatedWidget
(komunikat)ActionStatus
(komunikat)Annotation
(komunikat)AnnotationType
(wyliczenie)AppCommandMetadata
(komunikat)AppCommandMetadata.AppCommandType
(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)CustomEmojiMetadata
(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 programistom tworzenie aplikacji i integracji na platformie Google Chat.
CompleteImportSpace |
---|
Kończy proces importowania w przypadku określonego pokoju i udostępnia go użytkownikom. Wymaga uwierzytelniania użytkownika i przekazywania dostępu w całej domenie z zakresem autoryzacji:
Więcej informacji znajdziesz w artykule Autoryzowanie aplikacji Google Chat do importowania danych.
|
CreateCustomEmoji |
---|
Tworzy niestandardowy emotikon. Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów. Wymaga uwierzytelnienia użytkownika z użyciem zakresu autoryzacji:
|
CreateMembership |
---|
Tworzy członkostwo w aplikacji do połączeń Chat, użytkownika lub grupy Google. Tworzenie subskrypcji dla innych aplikacji do obsługi czatu nie jest obsługiwane. Jeśli podczas tworzenia członkostwa określony członek ma wyłączone automatyczne akceptowanie, zostanie zaproszony i musi zaakceptować zaproszenie do przestrzeni, zanim do niej dołączy. W przeciwnym razie utworzenie członkostwa spowoduje dodanie użytkownika bezpośrednio do wybranego pokoju. Obsługuje te typy uwierzytelniania:
Uwierzytelnianie aplikacji nie jest obsługiwane w tych przypadkach:
Przykłady użycia znajdziesz w tych artykułach:
|
CreateMessage |
---|
Tworzy wiadomość w pokoju Google Chat. Przykład znajdziesz w artykule Wysyłanie wiadomości. Obsługuje te typy uwierzytelniania:
Chat przypisuje nadawcę wiadomości w różny sposób w zależności od typu uwierzytelniania użytego w żądaniu. Ilustracja pokazująca, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawcę wiadomości. Treść wiadomości może zawierać tekst ( Ilustracja poniżej pokazuje, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje aplikację do obsługi czatu do wiadomości, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst ( Maksymalny rozmiar wiadomości, w tym jej zawartość, to 32 000 bajtów. W przypadku żądań webhooka odpowiedź nie zawiera pełnej wiadomości. Odpowiedź zawiera tylko pola
|
CreateReaction |
---|
Tworzy reakcję i dodaje ją do wiadomości. Przykład znajdziesz w artykule Dodawanie reakcji na wiadomość. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
CreateSpace |
---|
Tworzy pokój. Można go używać do tworzenia pokoju nazwanego lub czatu grupowego w Obsługuje te typy uwierzytelniania:
Podczas uwierzytelniania jako aplikacja w żądaniu musi być ustawione pole Podczas uwierzytelniania jako aplikacja aplikacja Google Chat jest dodawana jako członek pokoju. W przeciwieństwie do uwierzytelniania przez człowieka aplikacja Google Chat nie jest dodawana jako menedżer pokoju. Domyślnie aplikację Chat mogą usunąć z pokoju wszyscy jego użytkownicy. Aby zezwolić na usuwanie aplikacji z pokoju tylko menedżerom pokoju, ustaw Członkostwo w pokoju po jego utworzeniu zależy od tego, czy pokój został utworzony w
Jeśli podczas tworzenia pokoju pojawi się komunikat o błędzie
|
DeleteCustomEmoji |
---|
Usuwa niestandardowy emotikon. Domyślnie użytkownicy mogą usuwać tylko utworzone przez siebie niestandardowe emotikony. Menedżerowie emotikonów wyznaczeni przez administratora mogą usuwać dowolne niestandardowe emotikony w organizacji. Więcej informacji znajdziesz w artykule Więcej informacji o niestandardowych emotikonach w Google Chat. Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów. Wymaga uwierzytelnienia użytkownika z użyciem zakresu autoryzacji:
|
DeleteMembership |
---|
Usuwa subskrypcję. Przykład znajdziesz w artykule Usuwanie użytkownika lub aplikacji Google Chat z pokoju. Obsługuje te typy uwierzytelniania:
Uwierzytelnianie aplikacji nie jest obsługiwane w tych przypadkach:
Aby usunąć członkostwo menedżerów pokoju, osoba wysyłająca prośbę musi być menedżerem pokoju. Jeśli używasz uwierzytelniania aplikacji, twórcą pokoju musi być aplikacja Google Chat.
|
DeleteMessage |
---|
Usuwa wiadomość. Przykład znajdziesz w artykule Usuwanie wiadomości. Obsługuje te typy uwierzytelniania:
W przypadku uwierzytelniania aplikacji żądania mogą usuwać tylko wiadomości utworzone przez aplikację Chat, która wysyła żądanie.
|
DeleteReaction |
---|
Usuwa reakcję na wiadomość. Przykład znajdziesz w artykule Usuwanie reakcji. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
DeleteSpace |
---|
Usuwa nazwany pokój. Zawsze wykonuje kaskadowe usuwanie, co oznacza, że usuwane są również zasoby podrzędne pokoju, takie jak wiadomości opublikowane w pokoju i członkostwo w pokoju. Przykład znajdziesz w sekcji Usuwanie pokoju. Obsługuje te typy uwierzytelniania:
|
FindDirectMessage |
---|
Zwraca istniejącą wiadomość na czacie z określonym użytkownikiem. Jeśli nie znaleziono miejsca na czat, zwraca błąd W przypadku uwierzytelniania aplikacji zwraca przestrzeń czatu między określonym użytkownikiem a wywołującą aplikacją Google Chat. W przypadku uwierzytelniania użytkownika zwraca przestrzeń wiadomości na czacie między określonym użytkownikiem a uwierzytelnionym użytkownikiem. Obsługuje te typy uwierzytelniania:
|
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 do wiadomości. Wymaga uwierzytelnienia aplikacji z zakresem autoryzacji:
|
GetCustomEmoji |
---|
Zwraca szczegóły niestandardowego emotikonu. Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
GetMembership |
---|
Zwraca szczegóły subskrypcji. Przykład znajdziesz w artykule Pobieranie szczegółowych informacji o członkostwie użytkownika lub aplikacji Google Chat. Obsługuje te typy uwierzytelniania:
|
GetMessage |
---|
Zwraca szczegółowe informacje o wiadomości. Przykład znajdziesz w artykule Wyświetlanie szczegółowych informacji o wiadomości. Obsługuje te typy uwierzytelniania:
Uwaga: może zwrócić wiadomość od zablokowanego użytkownika lub z zablokowanego pokoju.
|
GetSpace |
---|
Zwraca szczegóły pokoju. Przykład znajdziesz w artykule Wyświetlanie szczegółów pokoju. Obsługuje te typy uwierzytelniania:
Uwierzytelnianie aplikacji ma te ograniczenia:
|
GetSpaceEvent |
---|
Zwraca zdarzenie z pokoju Google Chat. Ładunek zdarzenia zawiera najnowszą wersję zmienionego zasobu. Jeśli na przykład poprosisz o zdarzenie dotyczące nowej wiadomości, ale wiadomość zostanie później zaktualizowana, serwer zwróci zaktualizowany zasób Uwaga: w przypadku tego żądania pole Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji odpowiednim do odczytywania żądanych danych:
Aby otrzymać zdarzenie, uwierzytelniony użytkownik musi być członkiem pokoju. Przykład znajdziesz w artykule Uzyskiwanie szczegółowych informacji o wydarzeniu z pokoju w Google Chat.
|
GetSpaceNotificationSetting |
---|
Pobiera ustawienia powiadomień o pokoju. Przykład znajdziesz w sekcji Pobieranie ustawień powiadomień o przestrzeni rozmówcy. Wymaga uwierzytelnienia użytkownika z użyciem zakresu autoryzacji:
|
GetSpaceReadState |
---|
Zwraca szczegóły dotyczące stanu odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w artykule Pobieranie szczegółowych informacji o stanie odczytu przestrzeni użytkownika. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
GetThreadReadState |
---|
Zwraca szczegóły dotyczące stanu odczytu użytkownika w wątku, używane do identyfikowania przeczytanych i nieprzeczytanych wiadomości. Przykład znajdziesz w artykule Uzyskiwanie szczegółowych informacji o stanie wątku użytkownika. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
ListCustomEmojis |
---|
Wyświetla listę niestandardowych emotikonów widocznych dla uwierzytelnionego użytkownika. Niestandardowe emoji są dostępne tylko na kontach Google Workspace, a administrator musi włączyć je w organizacji. Więcej informacji znajdziesz w artykułach Więcej informacji o niestandardowych emotikonach w Google Chat i Zarządzanie uprawnieniami do niestandardowych emotikonów. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
ListMemberships |
---|
Wyświetla listę użytkowników pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Wymienianie członkostw z uwierzytelnianiem aplikacji obejmuje członkostwa w pokojach, do których aplikacja Google Chat ma dostęp, ale wyklucza członkostwa w aplikacji Google Chat, w tym własne. Wymienianie członkostw z uwierzytelnianiem użytkownika zawiera członkostwa w przestrzeniach, do których ma dostęp uwierzytelniony użytkownik. Obsługuje te typy uwierzytelniania:
|
ListMessages |
---|
Wyświetla listę wiadomości w pokoju, którego użytkownikiem jest osoba wywołująca, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Jeśli wyświetlisz listę wiadomości z pokoju, w którym nie ma wiadomości, odpowiedź będzie pustym obiektem. Jeśli używasz interfejsu REST/HTTP, odpowiedź zawiera pusty obiekt JSON, Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
ListReactions |
---|
Zawiera listę reakcji na wiadomość. Przykład znajdziesz w artykule Wyświetlanie reakcji na wiadomość. Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
ListSpaceEvents |
---|
Wyświetla listę wydarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. Jeśli na przykład wymienisz wydarzenia dotyczące nowych członków przestrzeni, serwer zwróci Wymaga uwierzytelnienia użytkownika z zakresem autoryzacji odpowiednim do odczytywania żądanych danych:
Aby wyświetlać listę wydarzeń, uwierzytelniony użytkownik musi być członkiem przestrzeni. Przykład znajdziesz w artykule Wyświetlanie listy wydarzeń z pokoju w Google Chat.
|
ListSpaces |
---|
Wyświetla pokoje, których element wywołujący jest członkiem. Czaty grupowe i czaty nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w artykule Wyświetlanie listy pokoi. Obsługuje te typy uwierzytelniania:
Aby wyświetlić listę wszystkich nazwanych pokoi według organizacji Google Workspace, użyj metody
|
SearchSpaces |
---|
Zwraca listę przestrzeni w organizacji Google Workspace na podstawie wyszukiwania administratora. Wymaga uwierzytelnienia użytkownika z uprawnieniami administratora i jednego z tych zakresów autoryzacji:
W prośbie ustaw wartość
|
SetUpSpace |
---|
Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik, który inicjuje połączenie, jest automatycznie dodawany do pokoju i nie powinien być określony jako członek w żądaniu. Przykład znajdziesz w artykule Konfigurowanie pokoju z początkowymi członkami. Aby określić osoby, które chcesz dodać, dodaj członkostwo z odpowiednim Aby określić grupy dyskusyjne Google do dodania, dodaj członkostwo z odpowiednim W przypadku pokoju z nazwą lub czatu grupowego, jeśli dzwoniący zablokuje niektórych członków lub zostanie przez nich zablokowany albo nie ma uprawnień do dodania niektórych członków, ci członkowie nie zostaną dodani do utworzonego pokoju. Aby utworzyć czat między użytkownikiem dzwoniącym a innym użytkownikiem, określ dokładnie 1 członkostwo, które będzie reprezentować tego użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie się nie powiedzie, a wiadomość nie zostanie utworzona. Aby utworzyć wiadomość bezpośrednią między użytkownikiem dzwoniącym a aplikacją dzwoniącą, ustaw wartość Jeśli między 2 użytkownikami istnieje już wiadomość na czacie, zostanie ona zwrócona, nawet jeśli w momencie wysłania żądania jeden z użytkowników zablokuje drugiego. Przestrzenie z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie Wymaga uwierzytelnienia użytkownika z jednym z tych zakresów autoryzacji:
|
UpdateMembership |
---|
Aktualizuje subskrypcję. Przykład znajdziesz w artykule Aktualizowanie członkostwa użytkownika w pokoju. Obsługuje te typy uwierzytelniania:
|
UpdateMessage |
---|
Aktualizuje wiadomość. Metody Obsługuje te typy uwierzytelniania:
W przypadku 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 przestrzeni. Jeśli aktualizujesz pole Obsługuje te typy uwierzytelniania:
Uwierzytelnianie aplikacji ma te ograniczenia:
|
UpdateSpaceNotificationSetting |
---|
Aktualizuje ustawienie powiadomień o pokoju. Przykład znajdziesz w artykule Aktualizowanie ustawień powiadomień o przestrzeni rozmówcy. Wymaga uwierzytelnienia użytkownika z użyciem zakresu autoryzacji:
|
UpdateSpaceReadState |
---|
Aktualizuje stan odczytu użytkownika w pokoju, aby można było rozróżniać przeczytane i nieprzeczytane wiadomości. Przykład znajdziesz w artykule Aktualizowanie stanu odczytu pokoju użytkownika. Wymaga uwierzytelnienia użytkownika z użyciem zakresu autoryzacji:
|
AccessoryWidget
Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości.
Pola | |
---|---|
Pole unii action . Typ działania. action może mieć tylko jedną z tych wartości: |
|
button_list |
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, pod którym użytkownicy mogą się uwierzytelnić lub dokonać konfiguracji. (Dotyczy tylko typów odpowiedzi |
dialog_action |
Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z oknem. Musi mu towarzyszyć |
updated_widget |
Tylko dane wejściowe. Odpowiedź z informacjami o zaktualizowanym widżecie. |
ResponseType
Typ odpowiedzi aplikacji Google Chat.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Domyślny typ, który jest traktowany jako NEW_MESSAGE . |
NEW_MESSAGE |
Opublikuj jako nową wiadomość w temacie. |
UPDATE_MESSAGE |
Zaktualizuj wiadomość w aplikacji Chat. Jest to dozwolone tylko w przypadku zdarzenia CARD_CLICKED , w którym typ nadawcy wiadomości to BOT . |
UPDATE_USER_MESSAGE_CARDS |
Aktualizowanie kart w wiadomości użytkownika. Jest to dozwolone tylko w odpowiedzi na MESSAGE zdarzenie z pasującym adresem URL lub CARD_CLICKED zdarzenie, w którym typ nadawcy wiadomości to HUMAN . Tekst jest ignorowany. |
REQUEST_CONFIG |
Prywatnie poproś użytkownika o dodatkowe uwierzytelnianie lub konfigurację. |
DIALOG |
Wyświetla okno. |
UPDATE_WIDGET |
Zapytanie o opcje autouzupełniania tekstu widżetu. |
SelectionItems
Lista wyników autouzupełniania widżetu.
Pola | |
---|---|
items[] |
Tablica obiektów SelectionItem. |
UpdatedWidget
W przypadku widżetów selectionInput
zwraca sugestie autouzupełniania dla menu wielokrotnego wyboru.
Pola | |
---|---|
widget |
Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał żądanie aktualizacji. |
Pole unii updated_widget . Widżet został zaktualizowany w odpowiedzi na działanie użytkownika. updated_widget może mieć tylko jedną z tych wartości: |
|
suggestions |
Lista wyników autouzupełniania widżetu |
ActionStatus
Reprezentuje stan prośby o wywołanie lub przesłanie okna.
Pola | |
---|---|
status_code |
Kod stanu. |
user_facing_message |
Wiadomość, którą należy wysłać użytkownikom w sprawie stanu ich prośby. Jeśli nie jest ustawiony, wysyłana jest ogólna wiadomość na podstawie |
Adnotacja
Tylko dane wyjściowe. Adnotacje powiązane z treścią wiadomości w formacie zwykłego tekstu. Aby dodać podstawowe formatowanie do wiadomości tekstowej, przeczytaj artykuł Formatowanie wiadomości tekstowych.
Przykładowa treść wiadomości w formacie zwykłego tekstu:
Hello @FooBot how are you!"
Odpowiednie metadane adnotacji:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Pola | |
---|---|
type |
Typ tej adnotacji. |
length |
Długość podciągu w treści wiadomości w formie zwykłego tekstu, do którego odnosi się ta adnotacja. |
start_index |
Indeks początkowy (liczony od zera, włącznie) w treści wiadomości w formacie zwykłego tekstu, do którego odnosi się ta adnotacja. |
Pole unii metadata . Dodatkowe metadane dotyczące adnotacji. metadata może mieć tylko jedną z tych wartości: |
|
user_mention |
Metadane wzmianki o użytkowniku. |
slash_command |
Metadane polecenia po ukośniku. |
rich_link_metadata |
Metadane linku sformatowanego. |
custom_emoji_metadata |
Metadane niestandardowego emotikona. |
AnnotationType
Typ adnotacji.
Wartości w polu enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
USER_MENTION |
Użytkownik jest wymieniony. |
SLASH_COMMAND |
Wywoływane jest polecenie po ukośniku. |
RICH_LINK |
Adnotacja rozszerzonego linku. |
CUSTOM_EMOJI |
Adnotacja niestandardowego emotikona. |
AppCommandMetadata
Metadane dotyczące polecenia aplikacji Google Chat.
Pola | |
---|---|
app_command_id |
Identyfikator polecenia określony w konfiguracji interfejsu Chat API. |
app_command_type |
Typ polecenia aplikacji Google Chat. |
AppCommandType
Typ polecenia aplikacji Google Chat. Więcej informacji znajdziesz w artykule Rodzaje poleceń aplikacji na czacie.
Wartości w polu enum | |
---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Wartość domyślna. Nie określono. |
SLASH_COMMAND |
Polecenie po ukośniku. Użytkownik wysyła polecenie w wiadomości na czacie. |
QUICK_COMMAND |
szybkie polecenie, Użytkownik wybiera polecenie z menu Google Chat w obszarze odpowiedzi na wiadomość. |
AttachedGif
Obraz GIF określony przez adres URL.
Pola | |
---|---|
uri |
Tylko dane wyjściowe. Adres URL, pod którym znajduje się obraz GIF. |
Załącznik
załącznik w Google Chat,
Pola | |
---|---|
name |
Opcjonalnie. Nazwa zasobu załącznika w formacie |
content_name |
Tylko dane wyjściowe. Oryginalna 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óra powinna być używana do wyświetlania podglądu załącznika użytkownikowi. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania treści załączników. |
download_uri |
Tylko dane wyjściowe. Adres URL pobierania, który powinien umożliwiać użytkownikowi pobranie załącznika. Aplikacje do obsługi czatu nie powinny używać tego adresu URL do pobierania treści załączników. |
source |
Tylko dane wyjściowe. Źródło załącznika. |
Pole unii data_ref . Odwołanie do danych załącznika. data_ref może mieć tylko jedną z tych wartości: |
|
attachment_data_ref |
Opcjonalnie. Odwołanie do danych załącznika. To pole służy do tworzenia lub aktualizowania wiadomości z załącznikami albo do pobierania danych załączników za pomocą interfejsu Media API. |
drive_data_ref |
Tylko dane wyjściowe. Odwołanie do załącznika z Dysku Google. To pole jest używane w interfejsie Google Drive API. |
Źródło
Źródło załącznika.
Wartości w polu enum | |
---|---|
SOURCE_UNSPECIFIED |
Zarezerwowano. |
DRIVE_FILE |
Plik jest plikiem z Dysku Google. |
UPLOADED_CONTENT |
Plik zostanie przesłany do Google Chat. |
AttachmentDataRef
Odwołanie do danych załącznika.
Pola | |
---|---|
resource_name |
Opcjonalnie. Nazwa zasobu danych załącznika. To pole jest używane w interfejsie Media API do pobierania danych załącznika. |
attachment_upload_token |
Opcjonalnie. Nieprzezroczysty token zawierający odniesienie do przesłanego załącznika. Traktowany przez klientów jako nieprzezroczysty ciąg znaków i używany do tworzenia lub aktualizowania wiadomości na czacie z załącznikami. |
CardWithId
Karta w wiadomości Google Chat.
Tylko aplikacje do obsługi Google Chat mogą tworzyć karty. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, wiadomość nie może zawierać kart.
Projektuj i wyświetlaj podgląd kart za pomocą narzędzia do tworzenia kart.
Otwórz narzędzie do tworzenia kartPola | |
---|---|
card_id |
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 Google Chat. Format: |
thread |
Wątek połączonego zasobu pokoju Google Chat. Format: |
message |
Wiadomość z połączonego zasobu pokoju czatu. Format: |
CompleteImportSpaceRequest
Wiadomość z prośbą o dokończenie procesu importowania pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu pokoju w trybie importowania. Format: |
CompleteImportSpaceResponse
Wiadomość z odpowiedzią po zakończeniu procesu importowania pokoju.
Pola | |
---|---|
space |
Pokój w trybie importowania. |
ContextualAddOnMarkup
Ten typ nie ma pól.
Znaczniki, które deweloperzy mogą stosować, aby określać zawartość dodatku kontekstowego.
Karta
Karta to element interfejsu, który może zawierać widżety interfejsu, takie jak tekst i obrazy.
Pola | |
---|---|
header |
Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz. |
sections[] |
Sekcje są oddzielone linią. |
card_actions[] |
Czynności na tej karcie. |
name |
Nazwa karty. |
CardAction
Działanie karty to działanie powiązane z kartą. W przypadku karty faktury typowe działania to: usuń fakturę, wyślij fakturę e-mailem lub otwórz fakturę w przeglądarce.
Nieobsługiwane przez aplikacje Google Chat.
Pola | |
---|---|
action_label |
Etykieta, która była wyświetlana w elemencie menu czynności. |
on_click |
Działanie onclick dla tego elementu działania. |
CardHeader
Pola | |
---|---|
title |
Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli podasz zarówno tytuł, jak i podtytuł, każdy z nich zajmie jeden wiersz. Jeśli podasz tylko tytuł, zajmie on oba wiersze. |
subtitle |
Podtytuł nagłówka karty. |
image_style |
Typ obrazu (np. kwadratowa lub okrągła ramka). |
image_url |
Adres URL obrazu w nagłówku karty. |
ImageStyle
Wartości w polu enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Kwadratowe obramowanie. |
AVATAR |
Okrągłe obramowanie. |
Sekcja
Sekcja zawiera zbiór widżetów, które są renderowane (pionowo) w określonej kolejności. Na wszystkich platformach karty mają wąską, stałą szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).
Pola | |
---|---|
header |
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 emotikona.
Pola | |
---|---|
custom_emoji |
Wymagane. Niestandardowy emotikon do utworzenia. |
CreateMembershipRequest
Wiadomość z prośbą o utworzenie subskrypcji.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzone członkostwo. Format: spaces/{space} |
membership |
Wymagane. Relacja subskrypcji do utworzenia. Pole Gdy aplikacja do obsługi czatu tworzy relację członkostwa dla użytkownika, musi używać określonych zakresów autoryzacji i ustawiać określone wartości w przypadku niektórych pól:
Zapraszanie użytkowników spoza organizacji Workspace, do której należy pokój, wymaga uwierzytelnienia użytkownika. Gdy aplikacja Chat tworzy relację członkostwa dla siebie, musi uwierzytelnić się jako użytkownik i użyć zakresu |
use_admin_access |
Opcjonalnie. Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Tworzenie członkostwa w aplikacji lub tworzenie członkostwa dla użytkowników spoza organizacji Google Workspace administratora nie jest obsługiwane w przypadku dostępu administracyjnego. |
CreateMessageRequest
Tworzy wiadomość.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, w którym chcesz utworzyć wiadomość. Format: |
message |
Wymagane. Treść wiadomości. |
thread_key |
Opcjonalnie. Wycofana: zamiast niej używaj zasady |
request_id |
Opcjonalnie. Unikalny identyfikator żądania dla tej wiadomości. Określenie istniejącego identyfikatora żądania spowoduje zwrócenie wiadomości utworzonej za pomocą tego identyfikatora zamiast utworzenia nowej wiadomości. |
message_reply_option |
Opcjonalnie. Określa, czy wiadomość rozpoczyna wątek, czy jest odpowiedzią w wątku. Ta funkcja jest obsługiwana tylko w nazwanych pokojach. Podczas odpowiadania na interakcje użytkownika to pole jest ignorowane. W przypadku interakcji w wątku odpowiedź jest tworzona w tym samym wątku. W przeciwnym razie odpowiedź zostanie utworzona jako nowy wątek. |
message_id |
Opcjonalnie. Niestandardowy identyfikator wiadomości. Umożliwia aplikacjom Chat pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności przechowywania identyfikatora przypisanego przez system w nazwie zasobu wiadomości (reprezentowanego w polu Wartość tego pola musi spełniać te wymagania:
Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości. |
MessageReplyOption
Określa sposób odpowiadania na wiadomość. W przyszłości możemy dodać więcej stanów.
Wartości w polu enum | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Domyślny: Rozpoczyna nowy wątek. Użycie tej opcji powoduje zignorowanie wszystkich uwzględnionych elementów thread ID lub . |
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żyjesz nowego kodu thread_key , utworzysz nowy wątek. Jeśli utworzenie wiadomości się nie powiedzie, zamiast tego zwracany jest błąd NOT_FOUND . |
CreateReactionRequest
Tworzy reakcję na wiadomość.
Pola | |
---|---|
parent |
Wymagane. Wiadomość, w której utworzono reakcję. Format: |
reaction |
Wymagane. Reakcja do utworzenia. |
CreateSpaceRequest
Żądanie utworzenia nazwanego pokoju bez użytkowników.
Pola | |
---|---|
space |
Wymagane. Pola Jeśli pojawi się komunikat o błędzie Miejsce |
request_id |
Opcjonalnie. Unikalny identyfikator tego żądania. Zalecany jest losowy identyfikator UUID. Określenie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego za pomocą tego identyfikatora zamiast utworzenia nowego pokoju. Określenie identyfikatora istniejącej prośby z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem spowoduje zwrócenie błędu. |
CustomEmoji
Reprezentuje niestandardowy emotikon.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu niestandardowego emoji przypisana przez serwer. Format: |
uid |
Tylko dane wyjściowe. Unikalny klucz zasobu niestandardowego emotikona. |
emoji_name |
Opcjonalnie. Niezmienne. Nazwa niestandardowego emotikona podana przez użytkownika, która jest unikalna w organizacji. Wymagane podczas tworzenia niestandardowego emotikona, w innych przypadkach tylko dane wyjściowe. Nazwy emoji muszą zaczynać się i kończyć dwukropkiem, być zapisane małymi literami i mogą zawierać tylko znaki alfanumeryczne, łączniki i podkreślenia. Podkreślenia i łączniki powinny być używane do oddzielania słów i nie można ich wpisywać kolejno po sobie. Przykład: |
temporary_image_uri |
Tylko dane wyjściowe. Tymczasowy adres URL obrazu niestandardowego emoji, ważny przez co najmniej 10 minut. Pamiętaj, że ta wartość nie jest wypełniana w odpowiedzi podczas tworzenia niestandardowego emotikona. |
payload |
Opcjonalnie. Tylko dane wejściowe. Dane ładunku. Wymagane podczas tworzenia niestandardowego emotikona. |
CustomEmojiPayload
Dane ładunku niestandardowego emotikona.
Pola | |
---|---|
file_content |
Wymagane. Tylko dane wejściowe. Obraz użyty w niestandardowym emotikonie. Rozmiar ładunku musi być mniejszy niż 256 KB, a wymiary obrazu muszą być kwadratowe i mieścić się w zakresie od 64 do 500 pikseli. Ograniczenia mogą ulec zmianie. |
filename |
Wymagane. Tylko dane wejściowe. Nazwa pliku obrazu. Obsługiwane rozszerzenia plików: |
CustomEmojiMetadata
Metadane adnotacji dla niestandardowych emotikonów.
Pola | |
---|---|
custom_emoji |
Niestandardowy emotikon. |
DeleteCustomEmojiRequest
Prośba o usunięcie niestandardowego emotikona.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu niestandardowego emotikona do usunięcia. Format: Nazwy emoji możesz używać jako aliasu dla |
DeleteMembershipRequest
Prośba o usunięcie uczestnika z pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu uczestnictwa do usunięcia. Aplikacje do czatowania mogą usuwać członkostwo użytkowników lub własne. Aplikacje do obsługi czatu nie mogą usuwać członkostwa w innych aplikacjach. Usuwanie członkostwa użytkownika wymaga zakresu Usuwanie członkostwa w aplikacji wymaga zakresu Format: |
use_admin_access |
Opcjonalnie. Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Usuwanie członkostwa w aplikacji w pokoju nie jest obsługiwane w przypadku dostępu administracyjnego. |
DeleteMessageRequest
Prośba o usunięcie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli masz ustawiony niestandardowy identyfikator wiadomości, możesz użyć wartości z pola |
force |
Opcjonalnie. Gdy Dotyczy tylko uwierzytelniania jako użytkownik. Nie ma wpływu na uwierzytelnianie jako aplikacja do obsługi czatu. |
DeleteReactionRequest
Usuwa reakcję na wiadomość.
Pola | |
---|---|
name |
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 |
Opcjonalnie. Gdy 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ść jest usuwana, gdy ustawisz delete_time
.
Pola | |
---|---|
deletion_type |
Wskazuje, kto usunął wiadomość. |
DeletionType
kto i w jaki sposób usunął wiadomość; W przyszłości możemy dodać więcej wartości. Szczegółowe informacje o tym, kiedy można usunąć wiadomości, znajdziesz w artykule Edytowanie i usuwanie wiadomości w Google Chat.
Wartości w polu enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Ta wartość nie jest używana. |
CREATOR |
Użytkownik usunął własną wiadomość. |
SPACE_OWNER |
Menedżer pokoju usunął wiadomość. |
ADMIN |
Administrator Google Workspace usunął wiadomość. Administratorzy mogą usuwać dowolne wiadomości w pokoju, w tym wiadomości wysłane przez dowolnego członka pokoju lub aplikację Chat. |
APP_MESSAGE_EXPIRY |
Aplikacja Google Chat usunęła swoją wiadomość po wygaśnięciu. |
CREATOR_VIA_APP |
Aplikacja Google Chat usunęła wiadomość w imieniu twórcy (przy użyciu uwierzytelniania użytkownika). |
SPACE_OWNER_VIA_APP |
Aplikacja Google Chat usunęła wiadomość w imieniu menedżera pokoju (przy użyciu uwierzytelniania użytkownika). |
SPACE_MEMBER |
Wiadomość została usunięta przez osobę w pokoju. Użytkownicy mogą usuwać wiadomości wysłane przez aplikacje. |
Dialog
Kontener wokół treści karty w oknie.
Pola | |
---|---|
body |
Tylko dane wejściowe. Treść okna, która jest renderowana w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów karty: |
DialogAction
Zawiera okno dialogowe i kod stanu żądania.
Pola | |
---|---|
action_status |
Tylko dane wejściowe. Stan prośby o wywołanie lub przesłanie dialogu. W razie potrzeby wyświetla użytkownikom stan i komunikat. na przykład w przypadku błędu lub powodzenia. |
Pole unii action . Działanie do wykonania. action może mieć tylko jedną z tych wartości: |
|
dialog |
Tylko dane wejściowe. Okno dotyczące prośby. |
DriveDataRef
Odwołanie do danych załącznika z Dysku.
Pola | |
---|---|
drive_file_id |
Identyfikator pliku na Dysku. Używanie z interfejsem Drive API. |
DriveLinkData
Dane dotyczące linków do Dysku Google.
Pola | |
---|---|
drive_data_ref |
DriveDataRef, który odwołuje 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 unii content . Wymagane. Treść emotikona. content może mieć tylko jedną z tych wartości: |
|
unicode |
Opcjonalnie. Podstawowy emoji reprezentowany przez ciąg znaków Unicode. |
custom_emoji |
niestandardowy emotikon, |
EmojiReactionSummary
Liczba osób, które zareagowały na wiadomość za pomocą określonego emotikona.
Pola | |
---|---|
emoji |
Tylko dane wyjściowe. Emotikon powiązany z reakcjami. |
reaction_count |
Tylko dane wyjściowe. Łączna liczba reakcji z użyciem powiązanego emotikona. |
FindDirectMessageRequest
Prośba o uzyskanie dostępu do pokoju na czacie na podstawie zasobu użytkownika.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu użytkownika, z którym chcesz znaleźć wiadomości na czacie. Format: |
GetAttachmentRequest
Prośba o pobranie załącznika.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu załącznika w formacie |
GetCustomEmojiRequest
Żądanie zwrócenia pojedynczego niestandardowego emotikona.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu niestandardowego emoji. Format: Nazwy emoji możesz używać jako aliasu dla |
GetMembershipRequest
Wysyłanie prośby o dołączenie do pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu uczestnictwa do pobrania. Aby uzyskać własne członkostwo w aplikacji za pomocą uwierzytelniania użytkownika, możesz opcjonalnie użyć Format: Możesz użyć adresu e-mail użytkownika jako aliasu dla adresu |
use_admin_access |
Opcjonalnie. Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Uzyskiwanie członkostwa w aplikacjach w przestrzeni nie jest obsługiwane w przypadku korzystania z dostępu administratora. |
GetMessageRequest
Poproś o otrzymanie wiadomości.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu wiadomości. Format: Jeśli masz ustawiony niestandardowy identyfikator wiadomości, możesz użyć wartości z pola |
GetSpaceEventRequest
Wiadomość z prośbą o zdarzenie w pokoju.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu zdarzenia w pokoju. Format: |
GetSpaceNotificationSettingRequest
Wiadomość z prośbą o ustawienie powiadomień o miejscach. Obsługuje tylko pobieranie ustawień powiadomień dla użytkownika, który dzwoni.
Pola | |
---|---|
name |
Wymagane. Format: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Komunikat żądania interfejsu API GetSpaceReadState.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu stanu odczytu przestrzeni do pobrania. Obsługuje tylko pobieranie stanu odczytu dla użytkownika, który wywołuje funkcję. Aby odwołać się do użytkownika wywołującego, ustaw jedną z tych wartości:
Format: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Żądanie zwrócenia pojedynczego miejsca.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu przestrzeni w formacie Format: |
use_admin_access |
Opcjonalnie. Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga |
GetThreadReadStateRequest
Komunikat żądania interfejsu API GetThreadReadStateRequest.
Pola | |
---|---|
name |
Wymagane. Nazwa zasobu stanu odczytu wątku do pobrania. Obsługuje tylko pobieranie stanu odczytu dla użytkownika, który wywołuje funkcję. Aby odwołać się do użytkownika wywołującego, ustaw jedną z tych wartości:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Grupa
Grupy dyskusyjnej 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 włączona. Reguły przechowywania w Vault organizacji określają, jak długo wiadomości i wątki są przechowywane. |
ListCustomEmojisRequest
Żądanie zwrócenia listy niestandardowych emotikonów.
Pola | |
---|---|
page_size |
Opcjonalnie. Maksymalna liczba zwracanych niestandardowych emotikonów. Usługa może zwrócić mniej niestandardowych emoji niż ta wartość. Jeśli nie podasz żadnej opcji, domyślna wartość to 25. Wartość maksymalna to 200. Wartości powyżej 200 są zmieniane na 200. |
page_token |
Opcjonalnie. (Jeśli wznawiasz poprzednie zapytanie). Token strony otrzymany z poprzedniego wywołania listy niestandardowych emotikonów. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie. filtr zapytania, Obsługuje filtrowanie według twórcy. Aby filtrować według twórcy, musisz podać prawidłową wartość. Obecnie do filtrowania niestandardowych emotikonów pod kątem tego, czy zostały utworzone przez użytkownika dzwoniącego, czy nie, akceptowane są tylko wartości Na przykład to zapytanie zwraca niestandardowe emotikony utworzone przez osobę wywołującą:
Nieprawidłowe zapytania są odrzucane z błędem |
ListCustomEmojisResponse
Odpowiedź z listą niestandardowych emotikonów.
Pola | |
---|---|
custom_emojis[] |
Lista nieuporządkowana. Lista niestandardowych emotikonów. |
next_page_token |
Token, który możesz wysłać jako |
ListMembershipsRequest
Wiadomość z prośbą o dodanie wspierania.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, dla którego chcesz pobrać listę osób. Format: spaces/{space} |
page_size |
Opcjonalnie. Maksymalna liczba zwracanych wspierań. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 subskrypcji. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. Wartości ujemne zwracają błąd |
page_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wspierających. Podaj ten parametr, aby pobrać następną stronę. Podczas stronicowania wszystkie inne podane parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
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 Jeśli parametr Na przykład te zapytania są prawidłowe:
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 uwierzytelnienia użytkownika. |
use_admin_access |
Opcjonalnie. Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane w przypadku korzystania z dostępu administracyjnego. |
ListMembershipsResponse
Odpowiedź na listę osób w pokoju.
Pola | |
---|---|
memberships[] |
Lista nieuporządkowana. Lista członkostw na żądanej (lub pierwszej) stronie. |
next_page_token |
Token, który możesz wysłać jako |
ListMessagesRequest
Wyświetla wiadomości w określonym pokoju, do którego należy użytkownik.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju, z którego chcesz wyświetlić listę wiadomości. Format: |
page_size |
Opcjonalnie. Maksymalna liczba zwracanych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 25 wyników. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. Wartości ujemne zwracają błąd |
page_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wiadomości. Podaj ten parametr, aby pobrać następną stronę. Podczas stronicowania wszystkie inne podane parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie. filtr zapytania, Wiadomości możesz filtrować według daty ( Aby filtrować wiadomości według daty ich utworzenia, podaj Aby filtrować według wątku, podaj wartość Aby filtrować według wątku i daty, użyj w zapytaniu operatora Na przykład te zapytania są prawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
order_by |
Opcjonalnie. Określa kolejność wyświetlania listy wiadomości. Określ wartość, według której ma być przeprowadzona operacja porządkowania. Prawidłowe wartości operacji zamawiania są następujące:
Domyślna kolejność to |
show_deleted |
Opcjonalnie. Czy uwzględniać usunięte wiadomości. Usunięte wiadomości zawierają czas usunięcia i metadane dotyczące usunięcia, ale treść wiadomości jest niedostępna. |
ListMessagesResponse
Wiadomość odpowiedzi dotycząca wyświetlania wiadomości.
Pola | |
---|---|
messages[] |
Lista wiadomości. |
next_page_token |
Aby pobrać następną stronę wyników, możesz wysłać token jako |
ListReactionsRequest
Zawiera listę reakcji na wiadomość.
Pola | |
---|---|
parent |
Wymagane. Wiadomość, na którą zareagowali użytkownicy. Format: |
page_size |
Opcjonalnie. Maksymalna liczba zwracanych reakcji. Usługa może zwrócić mniej reakcji niż ta wartość. Jeśli nie podasz żadnej opcji, domyślna wartość to 25. Wartość maksymalna to 200. Wartości powyżej 200 są zmieniane na 200. |
page_token |
Opcjonalnie. (Jeśli wznawiasz poprzednie zapytanie). Token strony otrzymany z poprzedniego wywołania listy reakcji. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie. filtr zapytania, Możesz filtrować reakcje według emotikonu ( Aby filtrować reakcje według wielu emotikonów lub użytkowników, połącz podobne pola za pomocą operatora Aby filtrować reakcje według emotikonu i użytkownika, użyj operatora Jeśli zapytanie zawiera zarówno symbol Na przykład te zapytania są prawidłowe:
Te zapytania są nieprawidłowe:
Nieprawidłowe zapytania są odrzucane z błędem |
ListReactionsResponse
Odpowiedź na żądanie listy reakcji.
Pola | |
---|---|
reactions[] |
Lista reakcji na żądanej (lub pierwszej) stronie. |
next_page_token |
Token kontynuacji do pobrania następnej strony wyników. W przypadku ostatniej strony wyników jest puste. |
ListSpaceEventsRequest
Wiadomość z prośbą o wyświetlanie wydarzeń dotyczących przestrzeni reklamowej.
Pola | |
---|---|
parent |
Wymagane. Nazwa zasobu pokoju Google Chat, w którym wystąpiły zdarzenia. Format: |
page_size |
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_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wydarzeń w przestrzeni. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wszystkie inne parametry przekazane do zdarzeń przestrzeni listy muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Wymagane. filtr zapytania, Musisz określić co najmniej 1 typ zdarzenia ( Opcjonalnie możesz też filtrować dane według czasu rozpoczęcia (
Aby określić godzinę rozpoczęcia lub zakończenia, użyj operatora równości Na przykład te zapytania są prawidłowe:
Te zapytania są nieprawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
ListSpaceEventsResponse
Wiadomość z odpowiedzią dotyczącą wyświetlania wydarzeń w przestrzeni.
Pola | |
---|---|
space_events[] |
Wyniki są zwracane w kolejności chronologicznej (najpierw najstarsze zdarzenie). Uwaga: pole |
next_page_token |
Token kontynuacji używany do pobierania większej liczby zdarzeń. Jeśli pominiesz to pole, nie będzie kolejnych stron. |
ListSpacesRequest
Prośba o wyświetlenie listy pokoi, w których użytkownik jest członkiem.
Pola | |
---|---|
page_size |
Opcjonalnie. Maksymalna liczba zwracanych przestrzeni. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 miejsc. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. Wartości ujemne zwracają błąd |
page_token |
Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy pokoi. Podaj ten parametr, aby pobrać następną stronę. Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników. |
filter |
Opcjonalnie. filtr zapytania, Możesz filtrować pokoje według ich typu ( Aby filtrować według typu miejsca, musisz podać prawidłową wartość wyliczeniową, np. Na przykład te zapytania są prawidłowe:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
ListSpacesResponse
Odpowiedź na żądanie listy pokoi.
Pola | |
---|---|
spaces[] |
Lista pokoi na żądanej (lub pierwszej) stronie. Uwaga: pole |
next_page_token |
Aby pobrać następną stronę wyników, możesz wysłać token jako |
MatchedUrl
pasujący adres URL w wiadomości w Google Chat; Aplikacje do obsługi czatu mogą wyświetlać podgląd pasujących adresów URL. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków.
Pola | |
---|---|
url |
Tylko dane wyjściowe. Adres URL, który został dopasowany. |
Członkostwo
Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja Google Chat jest zaproszony do pokoju, należy do niego czy nie jest w nim obecny.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu uczestnictwa przypisana przez serwer. Format: |
state |
Tylko dane wyjściowe. Stan subskrypcji. |
role |
Opcjonalnie. Rola użytkownika w pokoju czatu, która określa, jakie działania może on wykonywać w pokoju. To pole może być używane jako dane wejściowe tylko w przypadku |
create_time |
Opcjonalnie. Niezmienne. Czas utworzenia członkostwa, np. gdy użytkownik dołączył do pokoju lub otrzymał zaproszenie do dołączenia do niego. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania. |
delete_time |
Opcjonalnie. Niezmienne. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania. |
Pole unii memberType . Uczestnik powiązany z tym członkostwem. W przyszłości możemy wprowadzić obsługę innych typów użytkowników. memberType może mieć tylko jedną z tych wartości: |
|
member |
Opcjonalnie. Użytkownik lub aplikacja Google Chat, do której należy członkostwo. Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user |
group_member |
Opcjonalnie. Grupa Google, do której należy członkostwo. Odczytywanie lub zmienianie członkostwa w grupach dyskusyjnych Google wymaga uwierzytelniania użytkownika. |
MembershipRole
Reprezentuje dozwolone działania użytkownika w pokoju czatu. W przyszłości możemy dodać więcej wartości typu wyliczeniowego.
Wartości w polu enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Wartość domyślna. W przypadku users : nie jest użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups : zawsze przypisana jest ta rola (w przyszłości mogą być używane inne wartości wyliczeniowe). |
ROLE_MEMBER |
osoba w pokoju, Użytkownik ma podstawowe uprawnienia, takie jak wysyłanie wiadomości na czacie. W rozmowach 1:1 i grupowych bez nazwy każda osoba ma tę rolę. |
ROLE_MANAGER |
menedżerem pokoju, Użytkownik ma wszystkie podstawowe uprawnienia oraz uprawnienia administracyjne, które pozwalają mu zarządzać pokojem, np. dodawać i usuwać użytkowników. Obsługiwane tylko w SpaceType.SPACE . |
MembershipState
Określa relację użytkownika z pokojem. W przyszłości możemy zacząć obsługiwać inne kraje członkowskie.
Wartości w polu enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Wartość domyślna. Nie używaj. |
JOINED |
Użytkownik zostanie dodany do pokoju i będzie mógł w nim uczestniczyć. |
INVITED |
Użytkownik został zaproszony do pokoju, ale nie dołączył do niego. |
NOT_A_MEMBER |
Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do niego. |
MembershipBatchCreatedEventData
Ładunek zdarzenia dla wielu nowych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchCreated
Pola | |
---|---|
memberships[] |
Lista nowych wspierających. |
MembershipBatchDeletedEventData
Ładunek zdarzenia dla wielu usuniętych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchDeleted
Pola | |
---|---|
memberships[] |
Lista usuniętych wspierań. |
MembershipBatchUpdatedEventData
Ładunek zdarzenia dla wielu zaktualizowanych subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.batchUpdated
Pola | |
---|---|
memberships[] |
Lista zaktualizowanych wspierań. |
MembershipCreatedEventData
Ładunek zdarzenia w przypadku nowej subskrypcji.
Typ zdarzenia: google.workspace.chat.membership.v1.created
.
Pola | |
---|---|
membership |
nowe członkostwo; |
MembershipDeletedEventData
Ładunek zdarzenia w przypadku usuniętego członkostwa.
Typ zdarzenia: google.workspace.chat.membership.v1.deleted
Pola | |
---|---|
membership |
Usunięte wspieranie. Wypełnione są tylko pola |
MembershipUpdatedEventData
Ładunek zdarzenia w przypadku 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 go użyć do określenia wiadomości w żądaniu, zastępując |
sender |
Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user |
create_time |
Opcjonalnie. Niezmienne. W przypadku pokoi utworzonych w Chat jest to czas utworzenia wiadomości. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane w pokojach w trybie importowania. W przypadku pokoi w trybie importowania ustaw to pole na historyczny znacznik czasu, w którym wiadomość została utworzona w źródle, aby zachować pierwotny czas utworzenia. |
last_update_time |
Tylko dane wyjściowe. Czas ostatniej edycji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie była edytowana, to pole jest puste. |
delete_time |
Tylko dane wyjściowe. Czas, w którym wiadomość została usunięta z Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole będzie puste. |
text |
Opcjonalnie. Treść wiadomości w formacie zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej generuje element podglądu. Możesz też @wzmiankować użytkownika Google Chat lub wszystkich użytkowników w pokoju. Więcej informacji o tworzeniu wiadomości tekstowych znajdziesz w artykule Wysyłanie wiadomości. |
formatted_text |
Tylko dane wyjściowe. Zawiera wiadomość
Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości. |
cards[] |
Wycofana: zamiast niej używaj zasady Karty sformatowane, interaktywne i zawierające elementy multimedialne, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowany tekst, przyciski i obrazy, które można kliknąć. Karty są zwykle wyświetlane pod treścią wiadomości w formacie zwykłego tekstu. |
cards_v2[] |
Opcjonalnie. Tablica kart. Tylko aplikacje do obsługi Google Chat mogą tworzyć karty. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart. Aby dowiedzieć się, jak utworzyć wiadomość zawierającą karty, przeczytaj artykuł Wysyłanie wiadomości. Projektuj i wyświetlaj podgląd kart za pomocą narzędzia do tworzenia kart. Otwórz narzędzie do tworzenia kart |
annotations[] |
Tylko dane wyjściowe. Adnotacje powiązane z |
thread |
Wątek, do którego należy wiadomość. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku lub odpowiadanie w wątku. |
space |
Tylko dane wyjściowe. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pole space |
fallback_text |
Opcjonalnie. Opis kart wiadomości w formie zwykłego tekstu, używany, gdy nie można wyświetlić rzeczywistych kart, np. w powiadomieniach na urządzeniach mobilnych. |
action_response |
Tylko dane wejściowe. Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi. |
argument_text |
Tylko dane wyjściowe. Treść wiadomości w formacie zwykłego tekstu, z której usunięto wszystkie wzmianki o aplikacji do obsługi czatu. |
slash_command |
Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (w stosownych przypadkach). |
attachment[] |
Opcjonalnie. Załącznik przesłany przez użytkownika. |
matched_url |
Tylko dane wyjściowe. Adres URL w |
thread_reply |
Tylko dane wyjściowe. Gdy pojawi się ikona Jeśli pokój nie obsługuje odpowiedzi w wątkach, to pole ma zawsze wartość |
client_assigned_message_id |
Opcjonalnie. Niestandardowy identyfikator wiadomości. Możesz użyć tego pola, aby zidentyfikować wiadomość lub ją pobrać, usunąć lub zaktualizować. Aby ustawić niestandardowy identyfikator, podczas tworzenia wiadomości określ pole |
emoji_reaction_summaries[] |
Tylko dane wyjściowe. Lista podsumowań reakcji emotikonami na wiadomość. |
private_message_viewer |
Opcjonalnie. Niezmienne. Dane wejściowe do tworzenia wiadomości, w przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Gdy to pole jest ustawione, wiadomość jest prywatna i widoczna tylko dla określonego użytkownika i aplikacji do obsługi czatu. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API za pomocą uwierzytelniania aplikacji i pominąć te elementy: Szczegółowe informacje znajdziesz w artykule Wysyłanie wiadomości prywatnej. |
deletion_metadata |
Tylko dane wyjściowe. Informacje o usuniętej wiadomości. Wiadomość jest usuwana, gdy ustawisz |
quoted_message_metadata |
Tylko dane wyjściowe. Informacje o wiadomości zacytowanej przez użytkownika Google Chat w pokoju. Użytkownicy Google Chat mogą cytować wiadomości, aby na nie odpowiadać. |
attached_gifs[] |
Tylko dane wyjściowe. Obrazy GIF załączone do wiadomości. |
accessory_widgets[] |
Opcjonalnie. Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Możesz dodawać widżety dodatkowe do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nie jest obsługiwana w przypadku wiadomości zawierających okna dialogowe. Więcej informacji znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu wiadomości. Tworzenie wiadomości z widgetami akcesoriów wymaga uwierzytelnienia aplikacji. |
MessageBatchCreatedEventData
Ładunek zdarzenia dla wielu nowych wiadomości.
Typ zdarzenia: google.workspace.chat.message.v1.batchCreated
Pola | |
---|---|
messages[] |
Lista 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 wiadomości.
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 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 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 utworzenia cytowanej wiadomości lub jej ostatniej aktualizacji. |
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 zdarzenia 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 zdarzenia dla nowej reakcji.
Typ zdarzenia: google.workspace.chat.reaction.v1.created
Pola | |
---|---|
reaction |
Nowa reakcja. |
ReactionDeletedEventData
Ładunek zdarzenia usuniętej reakcji.
Typ: google.workspace.chat.reaction.v1.deleted
Pola | |
---|---|
reaction |
Usunięta reakcja. |
RichLinkMetadata
Link do zasobu z elementami multimedialnymi.
Pola | |
---|---|
uri |
Identyfikator URI tego linku. |
rich_link_type |
Typ linku z elementami rozszerzonymi. |
Pole unii data . Dane połączonego zasobu. data może mieć tylko jedną z tych wartości: |
|
drive_link_data |
Dane linku do Dysku. |
chat_space_link_data |
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 wyliczenia. Nie używaj. |
DRIVE_FILE |
Typ linku do Dysku Google. |
CHAT_SPACE |
Typ linku sformatowanego w pokoju czatu. Może to być na przykład element inteligentny w przestrzeni. |
SearchSpacesRequest
Żądanie wyszukania listy pokoi na podstawie zapytania.
Pola | |
---|---|
use_admin_access |
Gdy Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokoju. Wymaga Ta metoda obsługuje obecnie tylko dostęp administracyjny, dlatego w tym polu akceptowana jest tylko wartość |
page_size |
Maksymalna liczba zwracanych przestrzeni. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 miejsc. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. |
page_token |
Token otrzymany z poprzedniego wywołania przestrzeni wyszukiwania. Podaj ten parametr, aby pobrać następną stronę. Podczas stronicowania wszystkie inne podane parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
query |
Wymagane. Zapytanie. Możesz wyszukiwać, korzystając z tych parametrów:
Pole W różnych polach obsługiwane są tylko operatory W ramach tego samego pola Poniższe przykłady zapytań są prawidłowe:
|
order_by |
Opcjonalnie. Sposób uporządkowania listy pokoi. Obsługiwane atrybuty, według których można sortować:
Prawidłowe wartości operacji sortowania to:
Obsługiwana składnia:
|
SearchSpacesResponse
Odpowiedź z listą pokoi odpowiadających żądaniu wyszukiwania pokoi.
Pola | |
---|---|
spaces[] |
Strona z żądanymi przestrzeniami. |
next_page_token |
Token, którego można użyć do pobrania następnej strony. Jeśli to pole jest puste, nie ma kolejnych stron. |
total_size |
Łączna liczba przestrzeni pasujących do zapytania na wszystkich stronach. Jeśli wynik przekracza 10 000 miejsc, ta wartość jest szacunkowa. |
SetUpSpaceRequest
Prośba o utworzenie pokoju i dodanie do niego określonych użytkowników.
Pola | |
---|---|
space |
Wymagane. Pole Aby utworzyć pokój, ustaw Aby utworzyć czat grupowy, ustaw Aby utworzyć rozmowę 1:1 między osobami, ustaw wartość Aby utworzyć rozmowę 1:1 między osobą a aplikacją Google Chat, która inicjuje połączenie, ustaw Jeśli pokój |
request_id |
Opcjonalnie. Unikalny identyfikator tego żądania. Zalecany jest losowy identyfikator UUID. Określenie identyfikatora istniejącej prośby spowoduje zwrócenie pokoju utworzonego za pomocą tego identyfikatora zamiast utworzenia nowego pokoju. Określenie identyfikatora istniejącej prośby z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem spowoduje zwrócenie błędu. |
memberships[] |
Opcjonalnie. Użytkownicy lub grupy Google Chat, których chcesz zaprosić do pokoju. Pomiń użytkownika, który dzwoni, ponieważ jest on dodawany automatycznie. Obecnie zestaw umożliwia maksymalnie 49 członkostw (oprócz osoby dzwoniącej). W przypadku członkostwa osoby fizycznej pole W przypadku członkostwa w grupie dyskusyjnej Google pole Opcjonalny, gdy atrybut Wymagane, gdy wartość parametru Wymagane, gdy ustawiasz wartość Musi być puste podczas tworzenia rozmowy 1:1 między osobą a aplikacją Google Chat (gdy ustawisz |
SlashCommand
Metadane dotyczące polecenia rozpoczynającego się ukośnikiem w Google Chat.
Pola | |
---|---|
command_id |
Identyfikator polecenia po ukośniku. |
SlashCommandMetadata
Metadane adnotacji do poleceń po ukośniku (/).
Pola | |
---|---|
bot |
Aplikacja Google Chat, 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 polecenia wywołanego polecenia po ukośniku. |
triggers_dialog |
Wskazuje, czy polecenie po ukośniku dotyczy okna. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
ADD |
Dodaj aplikację Google Chat do pokoju. |
INVOKE |
wywoływać polecenia po ukośniku w pokoju, |
Spacja
Pokoju w Google Chat. Pokoje to rozmowy między co najmniej 2 użytkownikami lub wiadomości 1:1 między użytkownikiem a aplikacją Google Chat.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu pokoju. Format: gdzie |
type |
Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady |
space_type |
Opcjonalnie. Rodzaj pokoju. Wymagane podczas tworzenia pokoju lub aktualizowania jego typu. W przypadku innych zastosowań tylko dane wyjściowe. |
single_user_bot_dm |
Opcjonalnie. Czy pokój to czat między aplikacją Chat a pojedynczym użytkownikiem. |
threaded |
Tylko dane wyjściowe. Wycofana: zamiast niej używaj zasady |
display_name |
Opcjonalnie. Wyświetlana nazwa pokoju. Wymagany podczas tworzenia pokoju z wartością W przypadku czatów to pole może być puste. Może mieć do 128 znaków. |
external_user_allowed |
Opcjonalnie. Niezmienne. Określa, czy w tym pokoju może być dowolny użytkownik Google Chat. Podawane podczas tworzenia pokoju w organizacji Google Workspace. Pomiń to pole podczas tworzenia pokoi w tych warunkach:
W przypadku istniejących pokoi to pole jest tylko danymi wyjściowymi. |
space_threading_state |
Tylko dane wyjściowe. Stan wątków w pokoju czatu. |
space_details |
Opcjonalnie. Szczegóły dotyczące pokoju, w tym opis i zasady. |
space_history_state |
Opcjonalnie. Stan historii wiadomości w przypadku wiadomości i wątków w tym pokoju. |
import_mode |
Opcjonalnie. Czy ta przestrzeń została utworzona w Tworzenie pokoju w |
create_time |
Opcjonalnie. Niezmienne. W przypadku pokoi utworzonych w Chat jest to czas utworzenia pokoju. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane w pokojach w trybie importowania. W przypadku pokoi w trybie importowania ustaw to pole na historyczną sygnaturę czasową, w której pokój został utworzony w źródle, aby zachować pierwotny czas utworzenia. Wypełniane w danych wyjściowych tylko wtedy, gdy wartość pola |
last_active_time |
Tylko dane wyjściowe. Sygnatura czasowa ostatniej wiadomości w pokoju. |
admin_installed |
Tylko dane wyjściowe. W przypadku pokoi na czacie z aplikacją Google Chat, czy pokój został utworzony przez administratora Google Workspace. Administratorzy mogą instalować i konfigurować czat z aplikacją do obsługi czatu w imieniu użytkowników w organizacji. Aby obsługiwać instalację przez administratora, aplikacja do obsługi czatu musi mieć funkcję czatu. |
membership_count |
Tylko dane wyjściowe. Liczba dołączonych subskrypcji pogrupowanych według typu członka. Wypełniane, gdy element |
access_settings |
Opcjonalnie. Określa ustawienie dostępu do pokoju. Wypełnione tylko wtedy, gdy pole |
space_uri |
Tylko dane wyjściowe. Identyfikator URI, za pomocą którego użytkownik może uzyskać dostęp do pokoju. |
import_mode_expire_time |
Tylko dane wyjściowe. Czas, po którym pokój zostanie automatycznie usunięty przez system, jeśli pozostanie w trybie importowania. Każdy pokój utworzony w trybie importowania musi opuścić ten tryb przed upływem tego czasu za pomocą To pole jest wypełniane tylko w przypadku pokoi utworzonych w trybie importowania. |
customer |
Opcjonalnie. Niezmienne. Identyfikator klienta domeny pokoju. Wymagane tylko podczas tworzenia pokoju z uwierzytelnianiem aplikacji i gdy W formacie W przypadku czatów to pole nie jest wypełniane. |
Pole unii space_permission_settings . Reprezentuje ustawienia uprawnień pokoju. Wypełnione tylko wtedy, gdy pole space_type ma wartość SPACE . space_permission_settings może mieć tylko jedną z tych wartości: |
|
predefined_permission_settings |
Opcjonalnie. Tylko dane wejściowe. Wstępnie zdefiniowane ustawienia uprawnień w pokoju, które można wprowadzić tylko podczas tworzenia pokoju. Jeśli to pole nie zostanie ustawione, zostanie utworzony pokój współpracy. Po utworzeniu pokoju ustawienia zostaną wypełnione w polu Ustawianie predefiniowanych ustawień uprawnień obsługuje:
|
permission_settings |
Opcjonalnie. Ustawienia uprawnień pokoju w przypadku istniejących pokoi. Dane wejściowe do aktualizowania dokładnych ustawień uprawnień dotyczących pokoju, w których istniejące ustawienia uprawnień są zastępowane. Wynik zawiera listę bieżących ustawień uprawnień. Odczytywanie i aktualizowanie ustawień uprawnień obsługuje:
|
AccessSettings
Określa ustawienie dostępu do pokoju.
Pola | |
---|---|
access_state |
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 niego dołączyć i wyświetlić podgląd wiadomości w nim. Jeśli to ustawienie nie jest skonfigurowane, dostęp do pokoju mają tylko użytkownicy lub grupy dyskusyjne Google, którzy zostali indywidualnie zaproszeni lub dodani do pokoju. Więcej informacji znajdziesz w artykule Udostępnianie pokoju grupie odbiorców. Format: Aby używać domyślnej grupy odbiorców w organizacji Google Workspace, ustaw wartość Odczytywanie grupy docelowej obsługuje:
To pole nie jest wypełniane, gdy używasz zakresu Ustawienie grupy docelowej wymaga uwierzytelnienia użytkownika. |
AccessState
Reprezentuje stan dostępu do pokoju.
Wartości w polu enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Stan dostępu jest nieznany lub nieobsługiwany w tym interfejsie API. |
PRIVATE |
Tylko użytkownicy lub grupy dyskusyjne Google, które zostały indywidualnie dodane lub zaproszone przez innych użytkowników lub administratorów Google Workspace, mogą znaleźć pokój i uzyskać do niego dostęp. |
DISCOVERABLE |
Menedżer pokoju przyznał grupie odbiorców dostęp do pokoju. Użytkownicy lub grupy dyskusyjne Google, którzy zostali indywidualnie dodani do pokoju lub zaproszeni do niego, również mogą go znaleźć i uzyskać do niego dostęp. Więcej informacji znajdziesz w artykule Udostępnianie pokoju konkretnym użytkownikom. Tworzenie pokoi możliwych do znalezienia wymaga uwierzytelniania użytkownika. |
MembershipCount
Reprezentuje liczbę członkostw w pokoju pogrupowanych w kategorie.
Pola | |
---|---|
joined_direct_human_user_count |
Tylko dane wyjściowe. Liczba użytkowników, którzy dołączyli do pokoju bezpośrednio, bez uwzględniania użytkowników, którzy dołączyli w ramach członkostwa w grupie. |
joined_group_count |
Tylko dane wyjściowe. Liczba wszystkich grup, które dołączyły bezpośrednio do pokoju. |
PermissionSetting
Reprezentuje ustawienie uprawnień pokoju.
Pola | |
---|---|
managers_allowed |
Opcjonalnie. Czy menedżerowie pokoju mają to uprawnienie. |
members_allowed |
Opcjonalnie. Czy członkowie grupy, którzy nie są menedżerami, mają to uprawnienie. |
PermissionSettings
Ustawienia uprawnień, które możesz określić podczas aktualizowania istniejącego pokoju z nazwą.
Aby ustawić uprawnienia podczas tworzenia pokoju, w żądaniu określ pole PredefinedPermissionSettings
.
Pola | |
---|---|
manage_members_and_groups |
Opcjonalnie. Ustawienie do zarządzania użytkownikami i grupami w pokoju. |
modify_space_details |
Opcjonalnie. Ustawienie umożliwiające aktualizowanie nazwy pokoju, awatara, opisu i wytycznych. |
toggle_history |
Opcjonalnie. Ustawienie włączania i wyłączania historii pokoju. |
use_at_mention_all |
Opcjonalnie. Ustawienie dotyczące używania polecenia @all w pokoju. |
manage_apps |
Opcjonalnie. Ustawienie zarządzania aplikacjami w pokoju. |
manage_webhooks |
Opcjonalnie. Ustawienie do zarządzania webhookami w pokoju. |
post_messages |
Tylko dane wyjściowe. Ustawienie publikowania wiadomości w pokoju. |
reply_messages |
Opcjonalnie. Ustawienie odpowiadania na wiadomości w pokoju. |
PredefinedPermissionSettings
Wstępnie zdefiniowane ustawienia uprawnień, które można określić tylko podczas tworzenia pokoju z nazwą. W przyszłości możemy dodać więcej ustawień. Szczegółowe informacje o ustawieniach uprawnień w przypadku nazwanych pokoi znajdziesz w artykule Więcej informacji o pokojach.
Wartości w polu enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Nie określono. Nie używaj. |
COLLABORATION_SPACE |
Ustawienie, które sprawia, że pokój staje się miejscem współpracy, w którym wszyscy użytkownicy mogą publikować wiadomości. |
ANNOUNCEMENT_SPACE |
Ustawienie, które sprawia, że pokój staje się pokojem z ogłoszeniami, w którym tylko menedżerowie pokoju mogą publikować wiadomości. |
SpaceDetails
Szczegóły dotyczące pokoju, w tym opis i zasady.
Pola | |
---|---|
description |
Opcjonalnie. Opis pokoju. Możesz na przykład opisać temat dyskusji w pokoju, jego funkcję lub uczestników. Może zawierać maksymalnie 150 znaków. |
guidelines |
Opcjonalnie. zasady, oczekiwania i etykieta obowiązujące w pokoju; Obsługuje do 5000 znaków. |
SpaceThreadingState
Określa typ stanu wątku w pokoju Google Chat.
Wartości w polu enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Zarezerwowano. |
THREADED_MESSAGES |
nazwane pokoje, które obsługują wątki wiadomości; Gdy użytkownicy odpowiadają na wiadomość, mogą to zrobić w wątku, dzięki czemu ich odpowiedź będzie powiązana z oryginalną wiadomością. |
GROUPED_MESSAGES |
Nazwane pokoje, w których rozmowy są uporządkowane według tematu. Tematy i odpowiedzi na nie są grupowane. |
UNTHREADED_MESSAGES |
czaty między 2 osobami i rozmowy grupowe z co najmniej 3 osobami; |
SpaceType
Rodzaj pokoju. Wymagane podczas tworzenia lub aktualizowania pokoju. W przypadku innych zastosowań tylko dane wyjściowe.
Wartości w polu enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Zarezerwowano. |
SPACE |
Miejsce, w którym użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować. SPACE może zawierać aplikacje Google Chat. |
GROUP_CHAT |
rozmowy grupowe z co najmniej 3 osobami; GROUP_CHAT może zawierać aplikacje Google Chat. |
DIRECT_MESSAGE |
Wiadomości 1:1 między 2 osobami lub między osobą a aplikacją w Google Chat. |
Typ
Wycofana: zamiast niej używaj zasady SpaceType
.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Zarezerwowano. |
ROOM |
Rozmowy między co najmniej 2 osobami. |
DM |
Czat indywidualny między osobą a aplikacją do obsługi czatu, w którym wszystkie wiadomości są płaskie. Pamiętaj, że nie obejmuje to wiadomości na czacie między dwoma osobami. |
SpaceBatchUpdatedEventData
Ładunek zdarzenia w przypadku wielu aktualizacji przestrzeni.
Typ zdarzenia: google.workspace.chat.space.v1.batchUpdated
Pola | |
---|---|
spaces[] |
Lista zaktualizowanych pokoi. |
SpaceEvent
Zdarzenie, które reprezentuje zmianę lub aktywność w pokoju Google Chat. Więcej informacji znajdziesz w artykule Praca ze zdarzeniami z Google Chat.
Pola | |
---|---|
name |
Nazwa zasobu zdarzenia w pokoju. Format: |
event_time |
Czas wystąpienia zdarzenia. |
event_type |
Typ zdarzenia dotyczącego pokoju. Każdy typ zdarzenia ma wersję zbiorczą, która reprezentuje wiele wystąpień danego typu zdarzenia w krótkim czasie. W przypadku żądań Obsługiwane typy zdarzeń w przypadku wiadomości:
Obsługiwane typy zdarzeń w przypadku subskrypcji:
Obsługiwane typy zdarzeń w przypadku reakcji:
Obsługiwane typy zdarzeń dotyczące przestrzeni:
|
Pole unii
|
|
message_created_event_data |
Ładunek zdarzenia dla nowej wiadomości. Typ zdarzenia: |
message_updated_event_data |
Ładunek zdarzenia zaktualizowanej wiadomości. Typ zdarzenia: |
message_deleted_event_data |
Ładunek zdarzenia 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 wiadomości. Typ zdarzenia: |
message_batch_deleted_event_data |
Ładunek zdarzenia dla wielu usuniętych wiadomości. Typ zdarzenia: |
space_updated_event_data |
Ładunek zdarzenia dotyczący aktualizacji pokoju. Typ zdarzenia: |
space_batch_updated_event_data |
Ładunek zdarzenia w przypadku wielu aktualizacji przestrzeni. Typ zdarzenia: |
membership_created_event_data |
Ładunek zdarzenia w przypadku nowej subskrypcji. Typ zdarzenia: |
membership_updated_event_data |
Ładunek zdarzenia w przypadku zaktualizowanej subskrypcji. Typ zdarzenia: |
membership_deleted_event_data |
Ładunek zdarzenia w przypadku usuniętego członkostwa. Typ zdarzenia: |
membership_batch_created_event_data |
Ładunek zdarzenia dla wielu nowych subskrypcji. Typ zdarzenia: |
membership_batch_updated_event_data |
Ładunek zdarzenia dla wielu zaktualizowanych subskrypcji. Typ zdarzenia: |
membership_batch_deleted_event_data |
Ładunek zdarzenia dla wielu usuniętych subskrypcji. Typ zdarzenia: |
reaction_created_event_data |
Ładunek zdarzenia dla nowej reakcji. Typ zdarzenia: |
reaction_deleted_event_data |
Ładunek zdarzenia usuniętej reakcji. Typ zdarzenia: |
reaction_batch_created_event_data |
Ładunek zdarzenia dla wielu nowych reakcji. Typ zdarzenia: |
reaction_batch_deleted_event_data |
Ładunek zdarzenia dla wielu usuniętych reakcji. Typ zdarzenia: |
SpaceNotificationSetting
Ustawienie powiadomień użytkownika w pokoju.
Pola | |
---|---|
name |
Identyfikator. Nazwa zasobu ustawienia powiadomień w pokoju. Format: |
notification_setting |
Ustawienie powiadomień. |
mute_setting |
Ustawienie wyciszania powiadomień z pokoju. |
MuteSetting
Typy ustawień wyciszania powiadomień z pokoju.
Wartości w polu enum | |
---|---|
MUTE_SETTING_UNSPECIFIED |
Zarezerwowano. |
UNMUTED |
Użytkownik będzie otrzymywać powiadomienia dotyczące przestrzeni na podstawie ustawień powiadomień. |
MUTED |
Użytkownik nie będzie otrzymywać żadnych powiadomień z pokoju, niezależnie od ustawień powiadomień. |
NotificationSetting
Typy ustawień powiadomień. W przyszłości możemy dodać obsługę innych typów.
Wartości w polu enum | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Zarezerwowano. |
ALL |
Powiadomienia są wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Wszystkie nowe wątki są automatycznie obserwowane, chyba że użytkownik ręcznie przestanie je obserwować. |
MAIN_CONVERSATIONS |
Powiadomienie jest wywoływane przez @wzmianki, obserwowane wątki i pierwszą wiadomość w nowych wątkach. Nie jest dostępna w przypadku czatów 1:1. |
FOR_YOU |
Powiadomienie jest wywoływane przez @wzmianki i obserwowane wątki. Nie jest dostępna w przypadku czatów 1:1. |
OFF |
Powiadomienia są wyłączone. |
SpaceReadState
Stan przeczytania użytkownika w pokoju, używany do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
Pola | |
---|---|
name |
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 w celu oznaczenia ostatniej przeczytanej pozycji w pokoju. |
SpaceUpdatedEventData
Ładunek zdarzenia w przypadku zaktualizowanego pokoju.
Typ zdarzenia: google.workspace.chat.space.v1.updated
Pola | |
---|---|
space |
zaktualizowany pokój. |
Wątek
wątku w pokoju Google Chat; Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku lub odpowiadanie w wątku.
Jeśli podczas tworzenia wiadomości określisz wątek, możesz ustawić pole messageReplyOption
, aby określić, co się stanie, jeśli nie zostanie znaleziony pasujący wątek.
Pola | |
---|---|
name |
Identyfikator. 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. Obsługuje do 4000 znaków. Ten identyfikator jest unikalny dla aplikacji do obsługi czatu, która go ustawia. Jeśli na przykład kilka aplikacji do obsługi czatu utworzy wiadomość przy użyciu tego samego klucza wątku, wiadomości zostaną opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez osobę lub inną aplikację Google Chat, zamiast tego określ pole |
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, w którym zaktualizowano stan wątku użytkownika. Zwykle odpowiada to sygnaturze czasowej ostatniej przeczytanej wiadomości w wątku. |
UpdateMembershipRequest
Prośba o aktualizację subskrypcji.
Pola | |
---|---|
membership |
Wymagane. Członkostwo do zaktualizowania. Aktualizowane są tylko pola określone przez |
update_mask |
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_admin_access |
Opcjonalnie. Gdy 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. Wiadomość ze zaktualizowanymi polami. |
update_mask |
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_missing |
Opcjonalnie. Jeśli |
UpdateSpaceNotificationSettingRequest
Prośba o zaktualizowanie ustawień powiadomień dotyczących pokoju. Obsługuje tylko aktualizowanie ustawień powiadomień dla użytkownika, który dzwoni.
Pola | |
---|---|
space_notification_setting |
Wymagane. Nazwa zasobu ustawień powiadomień dotyczących pokoju musi być podana w formacie |
update_mask |
Wymagane. Obsługiwane ścieżki pól:
|
UpdateSpaceReadStateRequest
Komunikat z prośbą o wywołanie interfejsu UpdateSpaceReadState API.
Pola | |
---|---|
space_read_state |
Wymagane. Stan odczytu pokoju i pola do zaktualizowania. Obsługuje tylko aktualizowanie stanu odczytu dla użytkownika, który wywołuje funkcję. Aby odwołać się do użytkownika wywołującego, ustaw jedną z tych wartości:
Format: users/{user}/spaces/{space}/spaceReadState |
update_mask |
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_mask |
Wymagane. Zaktualizowane ścieżki pól, rozdzielone przecinkami, jeśli jest ich kilka. W przypadku pokoju możesz zaktualizować te pola:
|
use_admin_access |
Opcjonalnie. Gdy 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 czatu uwierzytelnia się jako użytkownik, w przypadku zwrócenia jako dane wyjściowe żądania 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_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 |
Użytkownik. |
BOT |
użytkownik aplikacji do obsługi czatu, |
UserMentionMetadata
Metadane adnotacji dotyczące 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 wyliczenia. Nie używaj. |
ADD |
Dodaj użytkownika do pokoju. |
MENTION |
Wzmianka o użytkowniku w pokoju. |
WidgetMarkup
Widżet to element interfejsu, który wyświetla tekst i obrazy.
Pola | |
---|---|
buttons[] |
Lista przycisków. Pole Buttons jest też |
Pole unii data . WidgetMarkup może zawierać tylko jeden z tych elementów. Możesz użyć wielu pól WidgetMarkup , aby wyświetlić więcej produktów. data może mieć tylko jedną z tych wartości: |
|
text_paragraph |
Wyświetla akapit tekstu w tym widżecie. |
image |
Wyświetl obraz w tym widżecie. |
key_value |
Wyświetl w tym widżecie element z wartością kluczową. |
Przycisk
Przycisk. Może to być przycisk tekstowy lub graficzny.
Pola | |
---|---|
Pole unii
|
|
text_button |
Przycisk z tekstem i |
image_button |
Przycisk z obrazem i działaniem |
FormAction
Działanie formularza opisuje zachowanie po przesłaniu formularza. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.
Pola | |
---|---|
action_method_name |
Nazwa metody służy do identyfikowania części formularza, która spowodowała przesłanie formularza. Te informacje są przekazywane z powrotem do aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Możesz użyć tej samej nazwy metody w przypadku kilku elementów, które wywołują wspólne działanie. |
parameters[] |
Lista parametrów działania. |
ActionParameter
Lista parametrów tekstowych do podania podczas wywoływania metody działania. Na przykład możesz mieć 3 przyciski odkładania: odłóż teraz, odłóż o 1 dzień i odłóż o tydzień. Możesz użyć action method = snooze()
, przekazując typ i czas odroczenia na liście parametrów ciągu znaków.
Pola | |
---|---|
key |
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 przez adres URL, który może mieć działanie onclick
.
Pola | |
---|---|
image_url |
Adres URL obrazu. |
on_click |
Działanie |
aspect_ratio |
Współczynnik proporcji tego obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości obrazu podczas oczekiwania na jego załadowanie. Nie ma on zastępować wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go przez wstępne pobranie obrazu. |
ImageButton
Przycisk graficzny z działaniem onclick
.
Pola | |
---|---|
on_click |
Działanie |
name |
Nazwa tego |
Pole unii icons . Ikonę można określić za pomocą elementu Icon enum lub adresu URL. icons może mieć tylko jedną z tych wartości: |
|
icon |
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. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. |
content |
Tekst treści. Formatowanie tekstu jest obsługiwane i zawsze wymagane. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. |
content_multiline |
Określa, czy treść powinna być wielowierszowa. |
bottom_label |
Tekst etykiety u dołu. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. |
on_click |
Działanie |
Pole unii icons . Musisz zdefiniować co najmniej 1 z tych elementów: ikony, top_label i bottom_label . icons może mieć tylko jedną z tych wartości: |
|
icon |
Wartość wyliczeniowa, która jest zastępowana przez interfejs Chat API odpowiednim obrazem ikony. |
icon_url |
Ikona określona przez adres URL. |
Pole unii control . widżet sterujący, Możesz ustawić wartość button lub switch_widget , ale nie obie jednocześnie. control może mieć tylko jedną z tych wartości: |
|
button |
Przycisk, który można kliknąć, aby wywołać działanie. |
OnClick
działanie onclick
(np. otwarcie linku);
Pola | |
---|---|
Pole unii
|
|
action |
Jeśli określono działanie formularza, jest ono wywoływane przez to działanie |
open_link |
To działanie |
OpenLink
link, który otwiera nowe okno;
Pola | |
---|---|
url |
Adres URL do otwarcia. |
TextButton
Przycisk z tekstem i onclick
działaniem.
Pola | |
---|---|
text |
Tekst na przycisku. |
on_click |
|
TextParagraph
Akapit tekstu. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
Pola | |
---|---|
text |
|