- Zasób: wiadomość
- Karta
- CardHeader
- StylStyle
- Sekcja
- WidgetMarkup
- TextParagraph
- Obrazy
- OnClick
- FormAction
- ActionParameter
- OpenLink
- Para klucz-wartość
- Ikona
- Przycisk
- TextButton
- ImageButton
- CardAction
- CardWithId
- Karta
- CardHeader
- Typ obrazu
- Sekcja
- Widżet
- TextParagraph
- Obrazy
- OnClick
- Działanie
- ActionParameter
- Wskaźnik wczytywania
- Interakcja
- OpenLink
- OpenAs
- OnClose
- DekorowanyTekst
- Ikona
- Przycisk
- Kolor
- SwitchControl
- ControlType
- ButtonList
- Dane wejściowe
- Typ
- Sugestie
- SuggestionItem
- Dane wejściowe Select
- Typ wyboru
- SelectionItem
- DateTimePicker
- DateTimePickerType
- Separator
- Siatka
- GridItem
- ImageKomponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- Typ obramowania
- GridItemLayout
- Kolumny
- Kolumna
- Poziom HorizontalSizeStyle
- Wyrównanie w poziomie
- Wyrównanie w pionie
- Widżety
- CardAction
- CardFixedfooter
- StylSezonu
- Adnotacja:
- Typ adnotacji
- UserMentionMetadata
- Typ
- SlashCommandMetadata
- Typ
- Wątek
- ActionResponse
- ResponseType
- DialogAction
- Okno
- ActionStatus
- Code
- SlashCommand
- matchedUrl
- EmojiReactionPodsumowanie
- DeletionMetadata
- Typ usuwania
- Metody
Zasób: wiadomość
Wiadomość w Google Chat.
Zapis JSON |
---|
{ "name": string, "sender": { object ( |
Pola | |
---|---|
name |
Nazwa zasobu w formacie Przykład: |
sender |
Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli Twoja aplikacja do obsługi czatu uwierzytelni się jako użytkownik, w danych wyjściowych pojawią się dane użytkownika |
createTime |
W przypadku pokoi utworzonych w Google Chat w momencie utworzenia wiadomości. To pole jest używane tylko w danych wyjściowych, chyba że jest używane w zaimportowanych pokojach. W przypadku zaimportowanych pokoi ustaw w tym polu sygnaturę czasową, z której wiadomość została utworzona w źródle, aby zachować pierwotny czas utworzenia. |
lastUpdateTime |
Tylko dane wyjściowe. Czas ostatniej modyfikacji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie była edytowana, to pole jest puste. |
deleteTime |
Tylko dane wyjściowe. Godzina usunięcia wiadomości w Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole jest puste. |
text |
Treść wiadomości. Pierwszy link do obrazu, filmu, strony internetowej lub innego elementu, który można wyświetlić na podglądzie, generuje element podglądu. |
cards[] |
Wycofane: użyj Bogate, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowane teksty, przyciski i klikalne obrazy. Karty są zwykle wyświetlane pod zwykłym tekstem wiadomości. |
cardsV2[] |
Bogate i interaktywne karty z elementami interfejsu i edytowalnymi widżetami, w tym:
Karty są zwykle wyświetlane pod tekstem wiadomości czatu, ale w niektórych sytuacjach mogą pojawiać się w innych miejscach, takich jak dialogi. Maksymalny rozmiar karty może wynosić 32 KB.
Obecnie obsługiwane widżety to:
|
annotations[] |
Tylko dane wyjściowe. Adnotacje powiązane z elementem |
thread |
Wątek, do którego należy wiadomość. Więcej informacji znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na niego. |
space |
Jeśli Twoja aplikacja do obsługi czatu uwierzytelni się jako użytkownik, w danych wyjściowych pojawi się spacja |
fallbackText |
Opis kart informacyjnych w formacie zwykłego tekstu, używany, gdy nie można wyświetlić kart, np. powiadomień na urządzenia mobilne. |
actionResponse |
Podaj tylko dane wejściowe. Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi. |
argumentText |
Tylko dane wyjściowe. Zwykła treść wiadomości ze wszystkimi wzmiankami w aplikacji do obsługi czatu. |
slashCommand |
Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (w odpowiednich przypadkach). |
attachment[] |
Załącznik przesłany przez użytkownika. |
matchedUrl |
Tylko dane wyjściowe. Adres URL w polu |
threadReply |
Tylko dane wyjściowe. Gdy pole Jeśli pokój nie obsługuje odpowiedzi w wątkach, to pole ma zawsze wartość |
clientAssignedMessageId |
Niestandardowa nazwa wiadomości w Google Chat podczas tworzenia. Musi zaczynać się od |
emojiReactionSummaries[] |
Tylko dane wyjściowe. Lista podsumowań emotikonów w wiadomości. |
deletionMetadata |
Tylko dane wyjściowe. Informacje o usuniętej wiadomości. Gdy ustawisz |
Identyfikator karty
Widżety do określania aplikacji czatu.
Zapis JSON |
---|
{
"cardId": string,
"card": {
object ( |
Pola | |
---|---|
cardId |
Wymagane w przypadku |
card |
Karty obsługują zdefiniowany układ, interaktywne elementy interfejsu, takie jak przyciski, oraz rich media, np. obrazy. Na tej karcie możesz prezentować szczegółowe informacje, zbierać informacje od użytkowników i prowadzić ich do kolejnego kroku. |
Adnotacja
Adnotacje powiązane z zwykłym tekstem wiadomości.
Przykładowa treść 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"
}
}]
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type |
Typ tej adnotacji. |
length |
Długość podłańcucha w treści zwykłego tekstu wiadomości, do której odnosi się ta adnotacja. |
startIndex |
Indeks początkowy (oparty na 0 i włącznie) w treści wiadomości tekstowej, której dotyczy ta adnotacja. |
Pole sumy metadata . Dodatkowe metadane dotyczące adnotacji. metadata może mieć tylko jedną z tych wartości: |
|
userMention |
Metadane wzmianki o użytkowniku |
slashCommand |
Metadane polecenia po ukośniku. |
Typ adnotacji
Typ adnotacji.
Wartości w polu enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
USER_MENTION |
Ktoś wspomniał o użytkowniku. |
SLASH_COMMAND |
Wywołane jest polecenie po ukośniku. |
Metadane wzmianki o użytkowniku
Metadane adnotacji wzmianek o użytkownikach (@).
Zapis JSON |
---|
{ "user": { object ( |
Pola | |
---|---|
user |
Wspomniał użytkownik. |
type |
Typ wzmianki użytkownika. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
ADD |
Dodaj użytkownika do pokoju. |
MENTION |
Wzmianka o użytkowniku w pokoju. |
Metadane polecenia po ukośniku
Metadane adnotacji do poleceń po ukośniku (/).
Zapis JSON |
---|
{ "bot": { object ( |
Pola | |
---|---|
bot |
Aplikacja Google Chat, której polecenie zostało wywołane. |
type |
Typ polecenia po ukośniku. |
commandName |
Nazwa wywołanego polecenia po ukośniku. |
commandId |
Identyfikator polecenia wywoływanego polecenia po ukośniku. |
triggersDialog |
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łaj polecenie po ukośniku w pokoju. |
Wątek
Wątek w Google Chat.
Zapis JSON |
---|
{ "name": string, "threadKey": string } |
Pola | |
---|---|
name |
Nazwa zasobu wątku. Przykład: |
threadKey |
Opcjonalnie. Identyfikator wątku nieprzezroczystego. Aby rozpocząć lub dodać wątek, utwórz wiadomość i wskaż W przypadku innych żądań jest to pole tylko wyjściowe. |
Działanie
Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type |
Podaj tylko dane wejściowe. Typ odpowiedzi aplikacji Google Chat. |
url |
Podaj tylko dane wejściowe. Adres URL do uwierzytelniania lub konfiguracji użytkowników. (Tylko dla |
dialogAction |
Podaj tylko dane wejściowe. Odpowiedź na zdarzenie związane z oknem. Musi towarzyszyć mu tekst |
Typ odpowiedzi
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 wydarzenia CARD_CLICKED , w którym typ nadawcy wiadomości to BOT . |
UPDATE_USER_MESSAGE_CARDS |
Zaktualizuj karty w wiadomości od użytkownika. Jest to dozwolone tylko jako odpowiedź na zdarzenie MESSAGE z dopasowanym adresem URL lub zdarzenie CARD_CLICKED , w którym typ nadawcy wiadomości to HUMAN . Tekst jest ignorowany. |
REQUEST_CONFIG |
Poproś użytkownika o dodatkowe uwierzytelnianie lub dodatkową konfigurację. |
DIALOG |
Wyświetla okno. |
Okno dialogowe
Zawiera okno i kod stanu żądania.
Zapis JSON |
---|
{ "actionStatus": { object ( |
Pola | |
---|---|
actionStatus |
Podaj tylko dane wejściowe. Stan żądania do wywołania lub przesłania okna. W razie potrzeby wyświetla stan i komunikat dla użytkowników. na przykład z powodu błędu lub powodzenia. |
Pole sumy
|
|
dialog |
Podaj tylko dane wejściowe. Okno żądania. |
Dialog
Kod otaczający treść karty w oknie.
Zapis JSON |
---|
{
"body": {
object ( |
Pola | |
---|---|
body |
Podaj tylko dane wejściowe. Treść okna renderowanego w oknie modalnym. Aplikacje Google Chat nie obsługują tych kart: |
Stan działania
Określa stan żądania, by wywołać lub przesłać okno.
Zapis JSON |
---|
{
"statusCode": enum ( |
Pola | |
---|---|
statusCode |
Kod stanu. |
userFacingMessage |
Komunikat informujący użytkowników o stanie ich prośby. Jeśli zasada jest nieskonfigurowana, wysyłana jest ogólna wiadomość na podstawie |
Kod
Kanoniczne kody błędów interfejsów API gRPC.
Czasami może obowiązywać wiele kodów błędów. Usługi powinny zwracać najbardziej szczegółowy kod błędu. Na przykład: OUT_OF_RANGE
zamiast FAILED_PRECONDITION
, jeśli oba kody są stosowane. Podobnie preferuj NOT_FOUND
lub ALREADY_EXISTS
zamiast FAILED_PRECONDITION
.
Wartości w polu enum | |
---|---|
OK |
To nie błąd; powodzenie zostało zwrócone. Mapowanie HTTP: 200 OK |
CANCELLED |
Operacja została anulowana przez operatora. Mapowanie HTTP: żądanie zamknięte przez klienta 499 |
UNKNOWN |
Nieznany błąd. Ten błąd może się np. pojawić, gdy wartość Mapowanie HTTP: wewnętrzny błąd serwera 500 |
INVALID_ARGUMENT |
Klient podał nieprawidłowy argument. Różni się to od Mapowanie HTTP: błąd 400 |
DEADLINE_EXCEEDED |
Termin upłynął przed wykonaniem operacji. W przypadku operacji, które zmieniają stan systemu, ten błąd może zostać zwrócony nawet wówczas, gdy operacja zakończyła się pomyślnie. Na przykład pomyślna odpowiedź serwera mogła być tak opóźniona, że termin upłynął. Mapowanie HTTP: przekroczenie limitu czasu bramy 504 |
NOT_FOUND |
Nie znaleziono żądanego elementu (np. pliku lub katalogu). Uwaga dla programistów serwerów: jeśli żądanie zostanie odrzucone dla całej klasy użytkowników, na przykład stopniowego wdrażania funkcji lub listy dokumentów nieudokumentowanych, można użyć Mapowanie HTTP: nie znaleziono 404 |
ALREADY_EXISTS |
Element, który klient próbował utworzyć (np. plik lub katalog), już istnieje. Mapowanie HTTP: konflikt 409 |
PERMISSION_DENIED |
Element wywołujący nie ma uprawnień do wykonania określonej operacji. Mapowanie HTTP: 403 Zabronione |
UNAUTHENTICATED |
Żądanie nie ma prawidłowych danych uwierzytelniających dla tej operacji. Mapowanie HTTP: błąd 401 |
RESOURCE_EXHAUSTED |
Jeden zasób został wyczerpany – być może limit na użytkownika lub cały system plików zabrakło miejsca. Mapowanie HTTP: 429 zbyt wiele żądań |
FAILED_PRECONDITION |
Operacja została odrzucona, ponieważ system nie znajduje się w stanie wymaganym do jej wykonania. Na przykład katalog do usunięcia nie jest pusty, operacja RMdir zostanie zastosowana do katalogu itp. Decydując się na usługę Mapowanie HTTP: błąd 400 |
ABORTED |
Operacja została przerwana, zwykle z powodu problemu równoczesności, np. w wyniku kontroli sekwencera lub przerwania transakcji. Powyższe wytyczne ułatwią Ci wybór pomiędzy Mapowanie HTTP: konflikt 409 |
OUT_OF_RANGE |
Podjęto próbę wykonania operacji poza prawidłowym zakresem. Przykładem może być przeszukiwanie na końcu pliku lub odczyt go. W przeciwieństwie do W pewnym stopniu pokrywają się między Mapowanie HTTP: błąd 400 |
UNIMPLEMENTED |
Operacja nie została zaimplementowana w usłudze lub nie jest obsługiwana. Mapowanie HTTP: błąd 501 nie został zaimplementowany |
INTERNAL |
Błędy wewnętrzne. Oznacza to, że pewne niezmienniki oczekiwane przez system bazowy zostały uszkodzone. Ten kod błędu jest zarezerwowany dla poważnych błędów. Mapowanie HTTP: wewnętrzny błąd serwera 500 |
UNAVAILABLE |
Usługa jest obecnie niedostępna. Jest to najczęściej stan przejściowy, który można rozwiązać, ponawiając próbę. Pamiętaj, że nie zawsze można ponawiać próby niezwiązane z identyfikacją. Powyższe wytyczne ułatwią Ci wybór pomiędzy Mapowanie HTTP: usługa 503 niedostępna |
DATA_LOSS |
Nieodwracalna utrata danych lub uszkodzenie. Mapowanie HTTP: wewnętrzny błąd serwera 500 |
Polecenie po ukośniku
polecenie po ukośniku w Google Chat,
Zapis JSON |
---|
{ "commandId": string } |
Pola | |
---|---|
commandId |
Identyfikator wywołanego polecenia po ukośniku. |
Dopasowany URL
Dopasowany adres URL w wiadomości na czacie. Aplikacje do obsługi czatu mogą mieć podgląd pasujących adresów URL. Więcej informacji znajdziesz w artykule Podgląd linków.
Zapis JSON |
---|
{ "url": string } |
Pola | |
---|---|
url |
Tylko dane wyjściowe. Dopasowany adres URL. |
Podsumowanie reakcji na emotikony
Liczba osób, które zareagowały na wiadomość z określonym emotikonem.
Zapis JSON |
---|
{
"emoji": {
object ( |
Pola | |
---|---|
emoji |
Emotikony powiązane z reakcjami. |
reactionCount |
Łączna liczba reakcji przy użyciu powiązanych emotikonów. |
Metadane usuwania
Informacje o usuniętej wiadomości. Gdy ustawisz deleteTime
, wiadomość zostanie usunięta.
Zapis JSON |
---|
{
"deletionType": enum ( |
Pola | |
---|---|
deletionType |
Wskazuje, kto usunął wiadomość. |
Typ usunięcia
kto usunął wiadomość i jak została ona usunięta,
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ść, gdy wygasła. |
CREATOR_VIA_APP |
Aplikacja Google Chat usunąła wiadomość w imieniu użytkownika. |
SPACE_OWNER_VIA_APP |
Aplikacja Google Chat usunął wiadomość w imieniu właściciela pokoju. |
Metody |
|
---|---|
|
Tworzy wiadomość. |
|
Usunięcie wiadomości. |
|
Zwraca szczegóły wiadomości. |
|
Wyświetla wiadomości w pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. |
|
Aktualizuje wiadomość. |
|
Aktualizuje wiadomość. |