- Zasób: wiadomość
- Karta
- CardHeader
- ImageStyle
- Sekcja
- WidgetMarkup
- TextParagraph
- Obraz
- OnClick
- FormAction
- ActionParameter
- OpenLink
- Wartość klucza
- Ikona
- Przycisk
- TextButton
- ImageButton
- CardAction
- CardWithId
- Karta
- CardHeader
- Typ obrazu
- Sekcja
- Widżet
- TextParagraph
- Obraz
- OnClick
- Działanie
- ActionParameter
- LoadIndicator (wskaźnik wczytywania)
- Interakcja
- OpenLink
- OpenAs
- OnClose
- decorationedText
- Ikona
- Przycisk
- Kolor
- SwitchControl
- Typ elementu sterującego
- ButtonList (Lista przycisków)
- TextInput
- Typ
- Sugestie
- SuggestionItem
- Pole wyboru
- SelectionType (Typ wyboru)
- SelectionItem
- PlatformDataSource
- CommonDataSource.
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource.
- DateTimePicker
- DateTimePickerType
- Rozgraniczenie
- Siatka
- GridItem
- ImageKomponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType,
- Układ GridItemLayout
- Kolumny
- Kolumna
- HorizontalSizeStyle
- Wyrównanie w poziomie
- Wyrównanie w pionie
- Widżety
- Rozgraniczenie
- CardAction
- CardFixedFooter
- Styl wyświetlania
- Adnotacja
- Typ adnotacji
- UserUsageMetadata
- Typ
- SlashCommandMetadata
- Typ
- Wątek
- ActionResponse
- ResponseType (Typ odpowiedzi)
- DialogAction
- Okno
- ActionStatus
- Code
- SlashCommand
- MatchedUrl:
- EmojiReactionSummary
- DeletionMetadata
- Typ usunięcia
- quodMessageMetadata
- AttachedGif (tylko w języku angielskim)
- Metody
Zasób: wiadomość
wiadomość w pokoju Google Chat;
Zapis JSON |
---|
{ "name": string, "sender": { object ( |
Pola | |
---|---|
name |
Nazwa zasobu w formularzu Przykład: |
sender |
Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja do obsługi czatu uwierzytelni się jako użytkownik, w danych wyjściowych zostaną wypełnione dane użytkownika |
createTime |
W przypadku pokoi utworzonych w Google Chat data utworzenia wiadomości. To pole wyświetla się tylko w danych wyjściowych, chyba że jest używane w importowanych pokojach. W przypadku zaimportowanych pokoi ustaw w tym polu historyczną sygnaturę czasową, w której źródłowa wiadomość została utworzona, aby zachować pierwotny czas utworzenia. |
lastUpdateTime |
Tylko dane wyjściowe. Czas ostatniego edytowania 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 z Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole jest puste. |
text |
Treść wiadomości w postaci zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wygenerowanie elementu podglądu. Możesz też dodać@wzmiankę o użytkowniku Google Chat lub o wszystkich osobach w pokoju. Więcej informacji o tworzeniu SMS-ów znajdziesz w artykule Tworzenie SMS-ów. |
formattedText |
Tylko dane wyjściowe. Zawiera wiadomość
Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości. |
cards[] |
Wycofane: użyj atrybutu Bogate, sformatowane i interaktywne karty, które pozwalają wyświetlać elementy interfejsu takie jak sformatowane teksty, przyciski i klikalne obrazy. Karty są zwykle wyświetlane pod zwykłym tekstem wiadomości. Maksymalny rozmiar plików |
cardsV2[] |
Tablica kart. Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart. Więcej informacji o kartach i sposobach ich tworzenia znajdziesz w artykule Projektowanie dynamicznych, interaktywnych i spójnych interfejsów użytkownika za pomocą kart. |
annotations[] |
Tylko dane wyjściowe. Adnotacje powiązane z elementem |
thread |
Wątek, do którego należy wiadomość. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na nie. |
space |
Jeśli aplikacja do obsługi czatu uwierzytelni się jako użytkownik, dane wyjściowe wypełnią pokój |
fallbackText |
Opis kart z wiadomością w formie zwykłego tekstu, używany, gdy nie można wyświetlić rzeczywistych kart – na przykład w powiadomieniach na urządzeniach mobilnych. |
actionResponse |
Tylko dane wejściowe. Parametry, których aplikacja do obsługi czatu może używać do konfigurowania sposobu publikowania odpowiedzi. |
argumentText |
Tylko dane wyjściowe. Treść wiadomości ze zwykłym tekstem ze wszystkimi wzmiankami z aplikacji Google Chat została wycięta. |
slashCommand |
Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (w stosownych przypadkach). |
attachment[] |
Załącznik przesłany przez użytkownika. |
matchedUrl |
Tylko dane wyjściowe. Adres URL w komponencie |
threadReply |
Tylko dane wyjściowe. Gdy Jeśli pokój nie obsługuje odpowiedzi w wątkach, to pole ma zawsze wartość |
clientAssignedMessageId |
Niestandardowa nazwa wiadomości w Google Chat przypisana podczas tworzenia. Musi zaczynać się od |
emojiReactionSummaries[] |
Tylko dane wyjściowe. Lista emotikonów reakcji na wiadomość. |
deletionMetadata |
Tylko dane wyjściowe. Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu |
quotedMessageMetadata |
Tylko dane wyjściowe. Informacje o wiadomości cytowanej przez użytkownika Google Chat w pokoju. Użytkownicy Google Chat mogą cytować wiadomość, aby na nią odpowiedzieć. |
attachedGifs[] |
Tylko dane wyjściowe. Obrazy GIF dołączone do wiadomości. |
KartaZ identyfikatorem
Karta w wiadomości w Google Chat.
Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, wiadomość nie może zawierać kart.
Zapis JSON |
---|
{
"cardId": string,
"card": {
object ( |
Pola | |
---|---|
cardId |
Wymagane, jeśli wiadomość zawiera kilka kart. Unikalny identyfikator karty w wiadomości. |
card |
Kartę Maksymalny rozmiar to 32 KB. |
Adnotacja
Tylko dane wyjściowe. Adnotacje powiązane ze zwykłym tekstem wiadomości. Aby dodać podstawowe formatowanie do wiadomości tekstowej, zobacz Formatowanie SMS-ów.
Przykładowy tekst wiadomości:
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 wiadomości tekstowej, której dotyczy ta adnotacja. |
startIndex |
Indeks początkowy (oparty na 0, włącznie) w treści zwykłego tekstu wiadomości, której dotyczy ta adnotacja. |
Pole Unii metadata . Dodatkowe metadane dotyczące adnotacji. metadata może mieć tylko jedną z tych wartości: |
|
userMention |
Metadane dotyczące wzmianek użytkownika. |
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 |
Wzmianka o użytkowniku. |
SLASH_COMMAND |
Wywołano polecenie po ukośniku. |
Metadane wzmianki użytkownika
Metadane adnotacji dotyczące wzmianek użytkowników (@).
Zapis JSON |
---|
{ "user": { object ( |
Pola | |
---|---|
user |
Wspomniał użytkownik. |
type |
Rodzaj wzmianki użytkownika. |
Typ
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Wartość domyślna wyliczenia. Nie używaj. |
ADD |
Dodaj użytkownika do pokoju. |
MENTION |
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 do obsługi czatu, 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 po ukośniku. |
triggersDialog |
Wskazuje, czy polecenie po ukośniku dotyczy okna dialogowego. |
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 pokoju Google Chat. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na nie.
Jeśli podczas tworzenia wiadomości określisz wątek, możesz skonfigurować pole messageReplyOption
, aby określić, co się stanie, jeśli nie zostanie znaleziony żaden wątek.
Zapis JSON |
---|
{ "name": string, "threadKey": string } |
Pola | |
---|---|
name |
Tylko dane wyjściowe. Nazwa zasobu wątku. Przykład: |
threadKey |
Opcjonalnie. Pole do tworzenia lub aktualizowania wątku. W przeciwnym razie tylko dane wyjściowe. Identyfikator wątku. Obsługuje do 4000 znaków. Jest on unikalny dla aplikacji Google Chat, która go ustawia. Jeśli na przykład wiele aplikacji do obsługi czatu utworzy wiadomość z tym samym kluczem wątku, zostaną one opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez osobę lub inną aplikację do obsługi czatu, zamiast tego określ pole |
ActionResponse
Parametry, których aplikacja do obsługi czatu może używać do konfigurowania sposobu publikowania odpowiedzi.
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type |
Tylko dane wejściowe. Typ odpowiedzi aplikacji do obsługi czatu. |
url |
Tylko dane wejściowe. Adres URL do uwierzytelniania lub skonfigurowania przez użytkowników. (Tylko w przypadku |
dialogAction |
Tylko dane wejściowe. Odpowiedź na zdarzenie związane z oknem dialogowym. Do pliku musi towarzyszyć plik |
Typ odpowiedzi
Typ odpowiedzi aplikacji do obsługi czatu.
Wartości w polu enum | |
---|---|
TYPE_UNSPECIFIED |
Typ domyślny obsługiwany jako NEW_MESSAGE . |
NEW_MESSAGE |
Opublikuj jako nową wiadomość w temacie. |
UPDATE_MESSAGE |
Zaktualizuj wiadomość w aplikacji Google Chat. Jest to dozwolone tylko w przypadku zdarzenia CARD_CLICKED , gdy 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 pasującym adresem URL lub na zdarzenie CARD_CLICKED , w którym typ nadawcy wiadomości to HUMAN . Tekst jest ignorowany. |
REQUEST_CONFIG |
Prywatnie poproś użytkownika o dodatkowe uwierzytelnienie lub konfigurację. |
DIALOG |
Wyświetli okno. |
DialogAction
Zawiera okno dialogowe i kod stanu żądania.
Zapis JSON |
---|
{ "actionStatus": { object ( |
Pola | |
---|---|
actionStatus |
Tylko dane wejściowe. Stan żądania wywołania lub przesłania okna. W razie potrzeby wyświetla stan i wiadomość dla użytkowników. np. w przypadku błędu lub powodzenia. |
Pole Unii
|
|
dialog |
Tylko dane wejściowe. Okno żądania. |
Dialog
Otok wokół treści karty okna.
Zapis JSON |
---|
{
"body": {
object ( |
Pola | |
---|---|
body |
Tylko dane wejściowe. Treść okna wyświetlana w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: |
Stan działania
Reprezentuje stan żądania wywołania lub przesłania okna.
Zapis JSON |
---|
{
"statusCode": enum ( |
Pola | |
---|---|
statusCode |
Kod stanu. |
userFacingMessage |
Wiadomość informująca użytkowników o stanie prośby. Jeśli zasada jest nieskonfigurowana, wysyłany jest ogólny komunikat na podstawie parametru |
Kod
Kanoniczne kody błędów interfejsów API gRPC.
Może się zdarzyć, że pojawi się kilka kodów błędów. Usługi powinny zwracać najbardziej konkretny kod błędu, który występuje. np. OUT_OF_RANGE
zamiast FAILED_PRECONDITION
, jeśli mają zastosowanie oba kody. Podobnie wolisz NOT_FOUND
lub ALREADY_EXISTS
zamiast FAILED_PRECONDITION
.
Wartości w polu enum | |
---|---|
OK |
To nie jest błąd; zwrócona w przypadku powodzenia. Mapowanie HTTP: 200 OK |
CANCELLED |
Operacja została anulowana, zwykle przez element wywołujący. Mapowanie HTTP: żądanie zamknięte klienta 499 |
UNKNOWN |
Nieznany błąd. Ten błąd może na przykład zostać zwrócony, gdy wartość Mapowanie HTTP: wewnętrzny błąd serwera 500 |
INVALID_ARGUMENT |
Klient podał nieprawidłowy argument. Zwróć uwagę, że to co innego niż Mapowanie HTTP: 400 Nieprawidłowe żądanie |
DEADLINE_EXCEEDED |
Termin minął przed zakończeniem operacji. W przypadku operacji, które zmieniają stan systemu, ten błąd może zostać zwrócony nawet wtedy, 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: błąd 504 gateway Gateway Timeout (Przekroczenie limitu czasu bramy) |
NOT_FOUND |
Nie znaleziono żądanej encji (np. pliku lub katalogu). Uwaga dla deweloperów serwerów: jeśli żądanie zostanie odrzucone dla całej klasy użytkowników, na przykład stopniowe wdrażanie funkcji lub nieudokumentowana lista dozwolonych, można użyć Mapowanie HTTP: 404 – nie znaleziono |
ALREADY_EXISTS |
Encja, którą 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. Typu Mapowanie HTTP: 403 Forbidden |
UNAUTHENTICATED |
Żądanie nie ma prawidłowych danych uwierzytelniających dla tej operacji. Mapowanie HTTP: 401 Brak autoryzacji |
RESOURCE_EXHAUSTED |
Niektóre zasoby zostały wyczerpane – na przykład limit na użytkownika lub w całym systemie 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 jest stosowana do katalogu niebędącego katalogiem itd. Podmioty implementujące usługi mogą wybierać między Mapowanie HTTP: 400 Nieprawidłowe żądanie |
ABORTED |
Operacja została przerwana, zwykle z powodu problemu równoczesności, takiego jak błąd sprawdzania sekwencera lub przerwanie transakcji. Wskazówki powyżej pomogą Ci wybrać ustawienie: Mapowanie HTTP: konflikt 409 |
OUT_OF_RANGE |
Próba wykonania operacji przekroczyła prawidłowy zakres. Na przykład wyszukiwanie lub odczytywanie minionego końca pliku. W przeciwieństwie do zasady Zakres dat Mapowanie HTTP: 400 Nieprawidłowe żądanie |
UNIMPLEMENTED |
Operacja nie jest wdrożona lub nie jest obsługiwana/włączona w tej usłudze. Mapowanie HTTP: błąd 501 nie zaimplementowano |
INTERNAL |
Błędy wewnętrzne. Oznacza to, że niektóre 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. Najprawdopodobniej jest to stan przejściowy, który można skorygować, ponownie próbując wykonać ponawianie. Pamiętaj, że nie zawsze można bezpiecznie ponawiać nieidempotentne operacje. Wskazówki powyżej pomogą Ci wybrać ustawienie: Mapowanie HTTP: 503 – usługa niedostępna |
DATA_LOSS |
Nieodwracalna utrata lub uszkodzenie danych. 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 adres URL
dopasowany adres URL w wiadomości w Google Chat. Aplikacje do obsługi czatu mogą wyświetlać podgląd dopasowanych 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 emotikonem
Liczba osób, które zareagowały na wiadomość przy użyciu określonego emotikona.
Zapis JSON |
---|
{
"emoji": {
object ( |
Pola | |
---|---|
emoji |
Emotikony związane z reakcjami. |
reactionCount |
Łączna liczba reakcji używających powiązanych emotikonów. |
DeletionMetadata
Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu deleteTime
.
Zapis JSON |
---|
{
"deletionType": enum ( |
Pola | |
---|---|
deletionType |
Wskazuje, kto usunął wiadomość. |
Typ usunięcia
kto usunął wiadomość i w jaki sposób została 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 do obsługi czatu usunęła własną wiadomość po jej wygaśnięciu. |
CREATOR_VIA_APP |
Aplikacja do obsługi czatu usunęła wiadomość w imieniu użytkownika. |
SPACE_OWNER_VIA_APP |
Aplikacja do obsługi czatu usunęła wiadomość w imieniu właściciela pokoju. |
cudzone metadane wiadomości
Informacje o cytowanej wiadomości.
Zapis JSON |
---|
{ "name": string, "lastUpdateTime": string } |
Pola | |
---|---|
name |
Tylko dane wyjściowe. Nazwa zasobu cytowanej wiadomości. Format: |
lastUpdateTime |
Tylko dane wyjściowe. Sygnatura czasowa utworzenia cytowanej wiadomości lub jej ostatniej aktualizacji. |
Załączony GIF
Obraz GIF określony przez adres URL.
Zapis JSON |
---|
{ "uri": string } |
Pola | |
---|---|
uri |
Tylko dane wyjściowe. Adres URL hostującego obraz GIF. |
Metody |
|
---|---|
|
Tworzy wiadomość w pokoju Google Chat. |
|
Usuwa wiadomość. |
|
Zwraca szczegóły wiadomości. |
|
Wyświetla listę 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ść. |