REST Resource: spaces.messages

Zasób: wiadomość

Wiadomość w pokoju Google Chat.

Zapis JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
Pola
name

string

Identyfikator. Nazwa zasobu wiadomości.

Format: spaces/{space}/messages/{message}

Gdzie {space} to identyfikator pokoju, w którym opublikowano wiadomość, a {message} to przypisany do niej identyfikator nadany przez system. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz niestandardowy identyfikator, możesz użyć tego identyfikatora, aby określić wiadomość w żądaniu, zastępując {message} wartością z pola clientAssignedMessageId. Na przykład: spaces/AAAAAAAAAAA/messages/client-custom-name. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.
sender

object (User)

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user name i type.
createTime

string (Timestamp format)

Opcjonalnie: Niezmienna. W przypadku pokoi utworzonych w Google Chat – czas utworzenia wiadomości. To pole jest tylko wyjściowe, z wyjątkiem sytuacji, gdy jest używane w pomieszczeniach w trybie importowania.

W przypadku pokoi w trybie importowania ustaw to pole na historyczny znacznik czasu, w którym wiadomość została utworzona w źródle, aby zachować pierwotny czas utworzenia.
lastUpdateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej edycji wiadomości przez użytkownika. Jeśli wiadomość nigdy nie została edytowana, to pole jest puste.
deleteTime

string (Timestamp format)

Tylko dane wyjściowe. Czas usunięcia wiadomości z Google Chat. Jeśli wiadomość nigdy nie została usunięta, to pole jest puste.
text

string

Opcjonalnie: Treść wiadomości w postaci zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wyświetlenie elementu z podglądem. Możesz też wzmiankować użytkownika Google Chat lub wszystkich użytkowników pokoju.

Więcej informacji o tworzeniu wiadomości tekstowych znajdziesz w artykule Wysyłanie wiadomości.
formattedText

string

Tylko dane wyjściowe. Zawiera wiadomość text z dodanymi znacznikami, które wskazują formatowanie. To pole może nie uwzględniać całego formatowania widocznego w interfejsie użytkownika, ale obejmuje:

  • Składnia znaczników do pogrubienia, kursywy, przekreślenia, czcionki monospace, bloku czcionki monospace i listy punktowanej.

  • Wzmianki użytkowników w formacie <users/{user}>.

  • niestandardowe hiperlinki w formacie <{url}|{rendered_text}>, gdzie pierwszy ciąg to adres URL, a drugi – renderowany tekst (np. <http://example.com|custom text>);

  • niestandardowe emotikony w formacie :{emojiName}:, np. :smile:; Nie dotyczy to emotikonów Unicode, takich jak U+1F600, które oznaczają uśmiechniętą buźkę.

Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu wysłanego w wiadomości.
cards[]
(deprecated)

object (Card)

Wycofana: użyj w jej miejsce zasady cardsV2.

bogate, sformatowane i interaktywne karty, które możesz wykorzystać do wyświetlania elementów UI, takich jak sformatowany tekst, przyciski i klikalne obrazy; Karty są zwykle wyświetlane pod zwykłym tekstem treści wiadomości. cards i cardsV2 mogą mieć maksymalny rozmiar 32 KB.
cardsV2[]

object (CardWithId)

Opcjonalnie: Tablica kart.

Tylko aplikacje Google Chat mogą tworzyć karty. Jeśli aplikacja Czat uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart.

Aby dowiedzieć się, jak utworzyć wiadomość zawierającą karty, przeczytaj artykuł Wysyłanie wiadomości.

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Otwórz kreatora kart
annotations[]

object (Annotation)

Tylko dane wyjściowe. Adnotacje powiązane z text w tej wiadomości.
thread

object (Thread)

Wątek, do którego należy wiadomość. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.
space

object (Space)

Tylko dane wyjściowe. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pole pokoju name.
fallbackText

string

Opcjonalnie: Tekstowy opis kart wiadomości, używany, gdy nie można wyświetlić samych kart (np. w przypadku powiadomień mobilnych).
actionResponse

object (ActionResponse)

Tylko dane wejściowe. Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.
argumentText

string

Tylko dane wyjściowe. Treść wiadomości w postaci zwykłego tekstu bez wzmianek o aplikacji do obsługi czatu.
slashCommand

object (SlashCommand)

Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (w stosownych przypadkach).
attachment[]

object (Attachment)

Opcjonalnie: Załącznik przesłany przez użytkownika.
matchedUrl

object (MatchedUrl)

Tylko dane wyjściowe. Adres URL w spaces.messages.text, który pasuje do wzorca podglądu linku. Więcej informacji znajdziesz w artykule Podgląd linków.
threadReply

boolean

Tylko dane wyjściowe. Jeśli true, wiadomość jest odpowiedzią w wątku odpowiedzi. Jeśli false, wiadomość jest widoczna w rozmowie na najwyższym poziomie pokoju jako pierwsza wiadomość wątku lub wiadomość bez wątków.

Jeśli pokój nie obsługuje odpowiadania w wątkach, to pole jest zawsze false.
clientAssignedMessageId

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Możesz użyć pola, aby zidentyfikować wiadomość lub ją pobrać, usunąć lub zaktualizować. Aby ustawić niestandardowy identyfikator, podczas tworzenia wiadomości użyj pola messageId. Szczegółowe informacje znajdziesz w artykule Nazywanie wiadomości.
emojiReactionSummaries[]

object (EmojiReactionSummary)

Tylko dane wyjściowe. Lista podsumowań reakcji emotikonów w wiadomości.
privateMessageViewer

object (User)

Opcjonalnie: Niezmienna. Dane wejściowe do tworzenia wiadomości, w przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Gdy to pole jest ustawione, wiadomość jest prywatna i widoczna tylko dla określonego użytkownika oraz aplikacji do obsługi czatu. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API za pomocą uwierzytelniania aplikacji i pominąć te elementy:

Szczegółowe informacje znajdziesz w artykule Wysyłanie wiadomości prywatnych.
deletionMetadata

object (DeletionMetadata)

Tylko dane wyjściowe. informacje o usuniętej wiadomości; Wiadomość jest usuwana, gdy ustawiona jest wartość deleteTime.
quotedMessageMetadata

object (QuotedMessageMetadata)

Tylko dane wyjściowe. Informacje o wiadomości, którą użytkownik Google Chat zacytował w pokoju. Użytkownicy Google Chat mogą zacytować wiadomość, aby na nią odpowiedzieć.
attachedGifs[]

object (AttachedGif)

Tylko dane wyjściowe. obrazy GIF załączone do wiadomości.
accessoryWidgets[]

object (AccessoryWidget)

Opcjonalnie: Co najmniej 1 interaktywny widget, który pojawia się u dołu wiadomości. Do wiadomości, które zawierają tekst, karty lub tekst i karty, możesz dodawać widżety dodatkowe. Nieobsługiwane w przypadku wiadomości zawierających dialogi. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów na dole wiadomości.

Tworzenie wiadomości z widżetami akcesoriów wymaga uwierzytelniania aplikacji.

CardWithId

Karta w wiadomości Google Chat.

Tylko aplikacje Google Chat mogą tworzyć karty. Jeśli aplikacja Google Chat uwierzytelnia użytkownika, wiadomość nie może zawierać kart.

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Otwórz kreatora kart

Zapis JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
Pola
cardId

string

Wymagane, jeśli wiadomość zawiera wiele kart. Unikalny identyfikator karty w wiadomości.
card

object (Card)

Kartę Maksymalny rozmiar to 32 KB.

Adnotacja

Tylko dane wyjściowe. adnotacje powiązane z treścią wiadomości w postaci zwykłego tekstu; Aby dodać podstawowe formatowanie do wiadomości tekstowej, zapoznaj się z artykułem Formatowanie wiadomości tekstowych.

Przykład treści wiadomości w postaci zwykłego tekstu:

Hello @FooBot how are you!"

Odpowiednie metadane adnotacji:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Zapis JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  }
  // End of list of possible types for union field metadata.
}
Pola
type

enum (AnnotationType)

Typ adnotacji.
length

integer

Długość podciągu w treści wiadomości w postaci zwykłego tekstu, do której odnosi się ta adnotacja.
startIndex

integer

Indeks początkowy (od 0 włącznie) w zwykłym tekście treści wiadomości, do której odnosi się ta adnotacja.
Pole unii metadata. dodatkowe metadane dotyczące adnotacji; metadata może być tylko jednym z tych elementów:
userMention

object (UserMentionMetadata)

Metadane wzmianki o użytkowniku.
slashCommand

object (SlashCommandMetadata)

Metadane polecenia po ukośniku.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
USER_MENTION Wzmianka o użytkowniku.
SLASH_COMMAND Wywołano polecenie po ukośniku.

UserMentionMetadata

Metadane adnotacji dla wzmianek o użytkownikach (@).

Zapis JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Pola
user

object (User)

Wspomniany użytkownik.
type

enum (Type)

Typ wzmianki o użytkowniku.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
ADD Dodaj użytkownika do pokoju.
MENTION Wspomnienie użytkownika w pokoju.

SlashCommandMetadata

Metadane adnotacji poleceń po ukośniku (/).

Zapis JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Pola
bot

object (User)

Aplikacja Google Chat, której dotyczy wywołane polecenie.
type

enum (Type)

Typ polecenia po ukośniku.
commandName

string

Nazwa wywołanego polecenia po ukośniku.
commandId

string (int64 format)

Identyfikator wywołanego polecenia po ukośniku.
triggersDialog

boolean

Wskazuje, czy polecenie po ukośniku jest przeznaczone do dialogu.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
ADD Dodaj aplikację Google Chat do pokoju.
INVOKE wywołać polecenie po ukośniku w pokoju,

RichLinkMetadata

Link do zasobu.

Zapis JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  }
  // End of list of possible types for union field data.
}
Pola
uri

string

Identyfikator URI tego linku.
Pole unii data. Dane połączonego zasobu. data może być tylko jednym z tych elementów:

RichLinkType

Typ linku z elementami rozszerzonymi. W przyszłości możemy dodać więcej typów.

Wartości w polu enum
DRIVE_FILE Typ linku na Dysku Google.
CHAT_SPACE Typ linku rozszerzonego pokoju czatu. Może to być na przykład element inteligentny pokoju.

DriveLinkData

dane dotyczące linków na Dysku Google.

Zapis JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
Pola
driveDataRef

object (DriveDataRef)

DriveDataRef, który odwołuje się do pliku na Dysku Google.
mimeType

string

Typ MIME połączonego zasobu na Dysku Google.

ChatSpaceLinkData

dane dotyczące linków do pokoi czatu;

Zapis JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
Pola
space

string

Pokój powiązanego zasobu pokoju czatu.

Format: spaces/{space}
thread

string

Wątek powiązanego zasobu pokoju czatu.

Format: spaces/{space}/threads/{thread}
message

string

Wiadomość z powiązanego zasobu pokoju czatu.

Format: spaces/{space}/messages/{message}

Wątek

Wątek w pokoju Google Chat. Przykładowe zastosowanie znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

Jeśli podczas tworzenia wiadomości określisz wątek, możesz ustawić pole messageReplyOption, aby określić, co się stanie, jeśli nie zostanie znaleziony żaden pasujący wątek.

Zapis JSON 
{
  "name": string,
  "threadKey": string
}
Pola
name

string

Identyfikator. Nazwa zasobu wątku.

Przykład: spaces/{space}/threads/{thread}
threadKey

string

Opcjonalnie: Dane wejściowe do tworzenia lub aktualizowania wątku. W przeciwnym razie tylko dane wyjściowe. Identyfikator wątku. Obsługuje maksymalnie 4000 znaków.

Ten identyfikator jest unikalny dla aplikacji czatu, która go ustawia. Jeśli na przykład wiele aplikacji do czatu utworzy wiadomość przy użyciu tego samego klucza wątku, wiadomości zostaną opublikowane w różnych wątkach. Aby odpowiedzieć w wątku utworzonym przez inną osobę lub inną aplikację Google Chat, podaj pole wątku name.

ActionResponse

Parametry, których aplikacja Google Chat może używać do konfigurowania sposobu publikowania odpowiedzi.

Zapis JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Pola
type

enum (ResponseType)

Tylko dane wejściowe. Typ odpowiedzi aplikacji Google Chat.
url

string

Tylko dane wejściowe. Adres URL, którego użytkownicy używają do uwierzytelniania lub konfigurowania. (Dotyczy tylko typów odpowiedzi REQUEST_CONFIG).
dialogAction

object (DialogAction)

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z dialogiem. Musi być dołączony ResponseType.Dialog.
updatedWidget

object (UpdatedWidget)

Tylko dane wejściowe. Odpowiedź zaktualizowanego widżetu.

ResponseType

Typ odpowiedzi aplikacji Google Chat.

Wartości w polu enum
TYPE_UNSPECIFIED Domyślny typ obsługiwany jako NEW_MESSAGE.
NEW_MESSAGE Opublikuj jako nową wiadomość w temacie.
UPDATE_MESSAGE Zaktualizuj wiadomość w aplikacji Google Chat. Jest to dozwolone tylko w przypadku zdarzenia CARD_CLICKED, w którym typ nadawcy wiadomości to BOT.
UPDATE_USER_MESSAGE_CARDS Zaktualizuj karty w wiadomości użytkownika. Jest to dozwolone tylko w odpowiedzi na zdarzenie MESSAGE z dopasowanym adresem URL lub zdarzenie CARD_CLICKED, w którym typem nadawcy wiadomości jest HUMAN. Tekst jest ignorowany.
REQUEST_CONFIG Poprosić użytkownika o dodatkowe uwierzytelnianie lub konfigurację.
DIALOG Wyświetla okno.
UPDATE_WIDGET Zapytanie dotyczące opcji autouzupełniania tekstu widżetu.

DialogAction

Zawiera dialog i kod stanu żądania.

Zapis JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
Pola
actionStatus

object (ActionStatus)

Tylko dane wejściowe. Stan prośby o wywołanie lub przesłanie dialogu. W razie potrzeby wyświetla stan i komunikat dla użytkowników. Na przykład w przypadku błędu lub sukcesu.
Pole unii action. Działanie do wykonania. action może być tylko jednym z tych elementów:
dialog

object (Dialog)

Tylko dane wejściowe. Dialog dotyczący prośby.

Dialog

Opakowanie na karcie w dialogu.

Zapis JSON 
{
  "body": {
    object (Card)
  }
}
Pola
body

object (Card)

Tylko dane wejściowe. Treść dialogu, który jest renderowany w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: DateTimePicker, OnChangeAction.

ActionStatus

Reprezentuje stan prośby o wywołanie lub przesłanie dialogu.

Zapis JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
Pola
statusCode

enum (Code)

Kod stanu.
userFacingMessage

string

Wiadomość, która ma być wysyłana do użytkowników o stanie ich prośby. Jeśli nie jest ustawiony, wysyłana jest ogólna wiadomość na podstawie statusCode.

Kod

Kanoniczne kody błędów interfejsów gRPC API.

Czasami może być więcej kodów błędów. Usługi powinny zwracać najbardziej szczegółowy kod błędu. Jeśli oba kody są odpowiednie, preferuj kod OUT_OF_RANGE zamiast FAILED_PRECONDITION. Podobnie preferuj NOT_FOUND lub ALREADY_EXISTS zamiast FAILED_PRECONDITION.

Wartości w polu enum
OK

Nie jest błędem; zwracany po zakończeniu operacji.

Mapowanie HTTP: 200 OK
CANCELLED

Operacja została anulowana, zwykle przez element wywołujący.

Mapowanie HTTP: 499 Klient zamknął żądanie
UNKNOWN

Nieznany błąd. Ten błąd może zostać zwrócony, gdy wartość Status otrzymana z innej przestrzeni adresów należy do przestrzeni błędów, która nie jest znana w tej przestrzeni adresów. Ten błąd może też oznaczać błędy zgłoszone przez interfejsy API, które nie zwracają wystarczającej ilości informacji o błędach.

Mapowanie HTTP: 500 Wewnętrzny błąd serwera
INVALID_ARGUMENT

Klient podał nieprawidłowy argument. Uwaga: to nie to samo co FAILED_PRECONDITION. INVALID_ARGUMENT wskazuje argumenty, które są problematyczne niezależnie od stanu systemu (np. źle sformatowana nazwa pliku).

Mapowanie HTTP: 400 Nieprawidłowe żądanie
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 deweloperów serwerów: jeśli prośba zostanie odrzucona dla całej klasy użytkowników, np. w przypadku stopniowego wdrażania funkcji lub nieudokumentowanej listy dozwolonych, można użyć NOT_FOUND. Jeśli prośba zostanie odrzucona w przypadku niektórych użytkowników w danej klasie użytkowników, np. w przypadku kontroli dostępu opartej na użytkownikach, należy użyć PERMISSION_DENIED.

Mapowanie HTTP: 404 Nie znaleziono
ALREADY_EXISTS

Encja, którą próbował utworzyć klient (np. plik lub katalog), już istnieje.

Mapowanie HTTP: konflikt 409
PERMISSION_DENIED

Element wywołujący nie ma uprawnień do wykonania określonej operacji. Wartości PERMISSION_DENIED nie można używać w przypadku odrzuceń spowodowanych wyczerpaniem zasobu (w przypadku tych błędów należy użyć wartości RESOURCE_EXHAUSTED). Nie można używać wartości PERMISSION_DENIED, jeśli nie można zidentyfikować dzwoniącego (w przypadku tych błędów należy użyć wartości UNAUTHENTICATED). Ten kod błędu nie oznacza, że żądanie jest prawidłowe, że żądany element istnieje lub że spełnia inne warunki wstępne.

Mapowanie HTTP: 403 Zabronione
UNAUTHENTICATED

Żądanie nie ma prawidłowych danych uwierzytelniających dla tej operacji.

Mapowanie HTTP: 401 Nieautoryzowany
RESOURCE_EXHAUSTED

Pewien zasób został wyczerpany, np. limit dla użytkownika lub miejsce na pliki na całym systemie.

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, który ma zostać usunięty, nie jest pusty, operacja rmdir jest stosowana do niekatalogu itp.

Implementatorzy usługi mogą skorzystać z tych wskazówek, aby wybrać FAILED_PRECONDITION, ABORTED lub UNAVAILABLE: (a) Użyj UNAVAILABLE, jeśli klient może ponownie wykonać tylko nieudane wywołanie. (b) Użyj wartości ABORTED, jeśli klient powinien podjąć kolejną próbę na wyższym poziomie. Na przykład, gdy test i ustawienie określone przez klienta się nie powiedzie, co oznacza, że klient powinien ponownie uruchomić sekwencję odczyt-modyfikacja-zapis. (c) Użyj FAILED_PRECONDITION, jeśli klient nie powinien próbować ponownie, dopóki stan systemu nie zostanie bezpośrednio poprawiony. Jeśli na przykład polecenie „rmdir” zakończy się niepowodzeniem, ponieważ katalog nie jest pusty, powinna zostać zwrócona wartość FAILED_PRECONDITION, ponieważ klient nie powinien powtarzać próby, chyba że pliki zostaną usunięte z katalogu.

Mapowanie HTTP: 400 Nieprawidłowe żądanie
ABORTED

Operacja została przerwana, najczęściej z powodu problemu równoczesności, np. w przypadku nieudanej kontroli sekwencera lub przerwanej transakcji.

Aby zdecydować, czy użyć FAILED_PRECONDITION, ABORTED czy UNAVAILABLE, zapoznaj się z wytycznymi powyżej.

Mapowanie HTTP: konflikt 409
OUT_OF_RANGE

Operacja została przeprowadzona poza prawidłowym zakresem. Przykład: przeskakiwanie do początku lub koniec pliku.

W przeciwieństwie do błędu INVALID_ARGUMENT ten błąd wskazuje problem, który można rozwiązać, zmieniając stan systemu. Na przykład 32-bitowy system plików zwróci wartość INVALID_ARGUMENT, jeśli poprosisz o odczyt z odstępem, który nie mieści się w zakresie [0,2^32-1], ale zwróci wartość OUT_OF_RANGE, jeśli poprosisz o odczyt z odstępem poza bieżący rozmiar pliku.

Wartości FAILED_PRECONDITION i OUT_OF_RANGE są dość podobne. Zalecamy użycie błędu OUT_OF_RANGE (bardziej szczegółowego), jeśli to możliwe, aby osoby wywołujące, które przechodzą przez przestrzeń, mogły łatwo znaleźć błąd OUT_OF_RANGE, aby wykryć, kiedy skończyć.

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: 501 Nie zaimplementowano
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: 500 Wewnętrzny błąd serwera
UNAVAILABLE

Usługa jest obecnie niedostępna. Jest to najczęściej stan przejściowy, który można rozwiązać, ponawiając próbę z większym odstępem. Pamiętaj, że ponowne próby wykonywania operacji nie idempotentnych nie zawsze są bezpieczne.

Aby zdecydować, czy użyć FAILED_PRECONDITION, ABORTED czy UNAVAILABLE, zapoznaj się z wytycznymi powyżej.

Mapowanie HTTP: 503 Usługa niedostępna
DATA_LOSS

Nieodwracalna utrata danych lub ich uszkodzenie.

Mapowanie HTTP: 500 Wewnętrzny błąd serwera

UpdatedWidget

W przypadku widżetów selectionInput zwraca sugestie autouzupełniania dla menu z wieloma opcjami.

Zapis JSON 
{
  "widget": string,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
Pola
widget

string

Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał prośbę o aktualizację.
Pole unii updated_widget. widżet został zaktualizowany w odpowiedzi na działanie użytkownika; updated_widget może być tylko jednym z tych elementów:
suggestions

object (SelectionItems)

Lista wyników autouzupełniania w widżetach

SelectionItems

Lista wyników autouzupełniania widżetu.

Zapis JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
Pola
items[]

object (SelectionItem)

Tablica obiektów SelectionItem.

SlashCommand

Polecenie po ukośniku w Google Chat.

Zapis JSON 
{
  "commandId": string
}
Pola
commandId

string (int64 format)

Identyfikator wywołanego polecenia po ukośniku.

MatchedUrl

pasujący adres URL w wiadomości w Google Chat. Aplikacje do czatu mogą wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w artykule Podgląd linków.

Zapis JSON 
{
  "url": string
}
Pola
url

string

Tylko dane wyjściowe. Adres URL, który został dopasowany.

EmojiReactionSummary

Liczba osób, które zareagowały na wiadomość za pomocą określonego emotikona.

Zapis JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Pola
emoji

object (Emoji)

Tylko dane wyjściowe. emotikony powiązane z reakcjami.
reactionCount

integer

Tylko dane wyjściowe. Łączna liczba reakcji z użyciem powiązanego emotikona.

DeletionMetadata

informacje o usuniętej wiadomości; Wiadomość jest usuwana, gdy ustawiona jest wartość deleteTime.

Zapis JSON 
{
  "deletionType": enum (DeletionType)
}
Pola
deletionType

enum (DeletionType)

Wskazuje, kto usunął wiadomość.

DeletionType

Kto i w jaki sposób usunął wiadomość. W przyszłości możemy dodać więcej wartości.

Wartości w polu enum
DELETION_TYPE_UNSPECIFIED Ta wartość nie jest używana.
CREATOR Użytkownik usunął własną wiadomość.
SPACE_OWNER właściciel pokoju usunął wiadomość.
ADMIN Administrator Google Workspace usunął wiadomość.
APP_MESSAGE_EXPIRY Aplikacja Google Chat usunęła własną wiadomość po wygaśnięciu.
CREATOR_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu użytkownika.
SPACE_OWNER_VIA_APP Aplikacja Google Chat usunęła wiadomość w imieniu właściciela pokoju.

QuotedMessageMetadata

Informacje o cytowanej wiadomości.

Zapis JSON 
{
  "name": string,
  "lastUpdateTime": string
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu cytowanej wiadomości.

Format: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy cytowany komunikat został utworzony lub zaktualizowany.

AttachedGif

Obraz GIF określony za pomocą adresu URL.

Zapis JSON 
{
  "uri": string
}
Pola
uri

string

Tylko dane wyjściowe. Adres URL hostujący obraz GIF.

AccessoryWidget

Co najmniej 1 interaktywny widget, który pojawia się u dołu wiadomości. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów na dole wiadomości.

Zapis JSON 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
Pola
Pole unii action. Typ działania. action może być tylko jednym z tych elementów:
buttonList

object (ButtonList)

Lista przycisków.

Metody

create

 Tworzy wiadomość w pokoju Google Chat.

delete

 Usuwa wiadomość.

get

 Zwraca szczegóły wiadomości.

list

 Wyświetla wiadomości w pokoju, którego użytkownik jest członkiem, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi.

patch

 aktualizuje wiadomość.

update

 aktualizuje wiadomość.