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 systemu. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz niestandardowy identyfikator, możesz użyć tego identyfikatora do określenia wiadomości 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 dotyczy tylko danych wyjściowych, chyba że 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.
lastUpdateTime

string (Timestamp format)

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

string (Timestamp format)

Tylko dane wyjściowe. Godzina usunięcia wiadomości z Google Chat. Jeśli wiadomość nigdy nie zostanie usunięta, to pole będzie puste.
text

string

Opcjonalnie: Treść wiadomości w postaci 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 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 ze znacznikami dodanymi w celu komunikowania formatowania. 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}>, w których pierwszy ciąg to adres URL, a drugi renderowany tekst – np. <http://example.com|custom text>.

  • niestandardowe emotikony w formacie :{emojiName}:, na przykład :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)

Wycofane: użyj w zastępstwie zasady cardsV2.

Szczegółowe, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowany tekst, przyciski i klikalne obrazy. Zazwyczaj karty wyświetlają się pod zwykłym tekstem wiadomości. Pliki cards i cardsV2 mogą mieć maksymalny rozmiar 32 KB.
cardsV2[]

object (CardWithId)

Opcjonalnie: Tablica kart.

Karty mogą tworzyć tylko aplikacje do obsługi czatu. Jeśli aplikacja Czat uwierzytelnia się jako użytkownik, wiadomości nie mogą zawierać kart.

Aby dowiedzieć się, jak utworzyć wiadomość z kartami, przeczytaj sekcję Wysyłanie wiadomości.

Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora 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 Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe pojawią się tylko w pokoju name.
fallbackText

string

Opcjonalnie: Zwykły tekst opisu kart wiadomości używany, gdy nie można wyświetlić odpowiednich kart – na przykład do powiadomień na urządzeniu mobilnym.
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. Zwykły tekst wiadomości z usuniętymi wszystkimi wzmiankami z aplikacji Google Chat.
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 domenie spaces.messages.text, który pasuje do wzorca podglądu linku. Więcej informacji znajdziesz w sekcji 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: 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 sekcji Nadawanie nazwy wiadomościom.
emojiReactionSummaries[]

object (EmojiReactionSummary)

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

object (User)

Opcjonalnie: Stały. Dane wejściowe do utworzenia 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:

Więcej informacji znajdziesz w artykule Wysyłanie wiadomości prywatnej.
deletionMetadata

object (DeletionMetadata)

Tylko dane wyjściowe. Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu funkcji 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. GIF-y dołączone do wiadomości.
accessoryWidgets[]

object (AccessoryWidget)

Opcjonalnie: Co najmniej 1 interaktywny widget, który pojawia się u dołu wiadomości. Widżety akcesorium możesz dodawać do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nieobsługiwane w przypadku wiadomości zawierających okna dialogowe. Szczegółowe informacje znajdziesz w artykule Dodawanie interaktywnych widżetów u dołu 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.

Projektuj karty i wyświetlaj ich podgląd za pomocą kreatora kart.

Otwórz kreatora kart

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

string

Wymagany, jeśli wiadomość zawiera kilka 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 adnotacji. metadata może mieć tylko jedną z tych wartości:
userMention

object (UserMentionMetadata)

Metadane wzmianki użytkownika.
slashCommand

object (SlashCommandMetadata)

Metadane polecenia po ukośniku.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna wyliczenia. Nie używaj.
USER_MENTION Ktoś dodał wzmiankę o użytkowniku.
SLASH_COMMAND Wywoływane jest polecenie po ukośniku.

UserMentionMetadata

Metadane adnotacji w przypadku wzmianek użytkowników (@).

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

object (User)

Wspominany użytkownik.
type

enum (Type)

Typ wzmianki o użytkowniku.

Typ

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

SlashCommandMetadata

Metadane adnotacji w poleceniach 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 okna.

Typ

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

RichLinkMetadata

Precyzyjny 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 sumy data. Dane połączonego zasobu. data może być tylko jednym z tych elementów:

RichLinkType

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

Wartości w polu enum
DRIVE_FILE Szczegółowy typ linku do Dysku Google.
CHAT_SPACE Typ linku rozszerzonego pokoju czatu. Na przykład element inteligentny dotyczący pokoju.

DriveLinkData

Dane dotyczące linków do 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 zasobu połączonego pokoju czatu.

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

string

Wiadomość z zasobu połączonego 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 w polu messageReplyOption określić, co się stanie, jeśli nie znajdziesz pasującego wątku.

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 osobę lub inną aplikację Google Chat, zamiast tego użyj pola 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 powiązane z oknem. 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 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 zdarzeniu CARD_CLICKED, w którym typ nadawcy wiadomości to BOT.
UPDATE_USER_MESSAGE_CARDS Zaktualizuj karty w wiadomości do użytkownika. Jest to dozwolone tylko w odpowiedzi na zdarzenie MESSAGE z pasującym adresem URL lub 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ś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 użytkownikom. np. w przypadku błędu lub powodzenia.
Pole sumy action. Działanie do wykonania. action może być tylko jednym z tych elementów:
dialog

object (Dialog)

Tylko dane wejściowe. Okno dialogowe żądania.

Dialog

Zawijaj wokół treści karty w oknie.

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

object (Card)

Tylko dane wejściowe. Treść okna, renderowana w formacie modalnym. Aplikacje Google Chat nie obsługują tych elementów kart: DateTimePicker, OnChangeAction.

ActionStatus

Reprezentuje stan żądania wywołania lub przesłania okna.

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

enum (Code)

Kod stanu.
userFacingMessage

string

Treść wiadomości, która ma być wysłana do użytkowników w związku ze stanem ich prośby. Jeśli zasada jest nieskonfigurowana, wysyłana jest ogólna wiadomość na podstawie statusCode.

Kod

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

Czasami może pojawić się kilka kodów błędów. Usługi powinny zwracać najbardziej szczegółowy kod błędu, który ma zastosowanie. 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

To nie błąd; kod zwrócony po powodzeniu.

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 być zwracany, 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 mogą również zostać przekonwertowane przez błędy zgłoszone przez interfejsy API, które nie zwracają wystarczającej ilości informacji o błędzie.

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

Klient podał nieprawidłowy argument. Uwaga: to nie to samo co FAILED_PRECONDITION. INVALID_ARGUMENT oznacza 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 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: przekroczenie limitu czasu bramy (504)
NOT_FOUND

Nie znaleziono żądanej encji (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ą klient próbował utworzyć (np. plik lub katalog), już istnieje.

Mapowanie HTTP: konflikt 409
PERMISSION_DENIED

Wywołujący nie ma uprawnień do wykonania określonej operacji. Parametru PERMISSION_DENIED nie można używać w przypadku odrzuceń spowodowanych wyczerpaniem się zasobów (w przypadku takich błędów użyj zasady RESOURCE_EXHAUSTED). Jeśli nie można zidentyfikować wywołującego, nie można używać metody PERMISSION_DENIED (w przypadku takich błędów użyj metody UNAUTHENTICATED). Ten kod błędu nie oznacza, że żądanie jest prawidłowe, ten podmiot istnieje lub spełnia inne warunki wstępne.

Mapowanie HTTP: kod 403 (Zabroniony)
UNAUTHENTICATED

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

Mapowanie HTTP: błąd 401 (Brak autoryzacji)
RESOURCE_EXHAUSTED

Część zasobów została wyczerpana, na przykład limit na użytkownika lub w całym systemie plików brakuje 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, 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 ABORTED, jeśli klient powinien spróbować ponownie na wyższym poziomie. Na przykład gdy określony przez klienta parametr test i ustawiony nie powiedzie się, wskazując, że klient powinien ponownie uruchomić sekwencję odczytu, modyfikacji i zapisu. (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 użycie parametru „rmdir” zakończy się niepowodzeniem, ponieważ katalog nie jest pusty, powinien zostać zwrócony element FAILED_PRECONDITION, ponieważ klient nie powinien ponawiać 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

Podjęto próbę wykonania operacji poza prawidłowym zakresem. Może to być np. przewinięcie do końca pliku lub odczyt.

W przeciwieństwie do zasady INVALID_ARGUMENT ten błąd oznacza problem, który można rozwiązać, jeśli zmieni się stan systemu. Na przykład 32-bitowy system plików wygeneruje żądanie INVALID_ARGUMENT, jeśli zostanie wyświetlone żądanie odczytu z przesunięciem spoza zakresu [0,2^32-1]. Jeśli jednak poprosi o odczyt z przesunięcia względem bieżącego rozmiaru pliku, wygeneruje wartość OUT_OF_RANGE.

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.

Zapoznaj się z powyższymi wskazówkami, aby wybrać tę opcję: FAILED_PRECONDITION, ABORTED lub UNAVAILABLE.

Mapowanie HTTP: 503 Usługa niedostępna
DATA_LOSS

Nieodwracalna utrata danych lub ich uszkodzenie.

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

UpdatedWidget

Odpowiedź zaktualizowanego widżetu. Służy do udostępniania opcji autouzupełniania w widżetach.

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 sumy updated_widget. Widżet jest aktualizowany 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 widżetów

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 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. Dopasowany adres URL.

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 do obsługi czatu 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, pod którym znajduje się obraz GIF.

AccessoryWidget

Co najmniej jeden interaktywny widżet wyświetlany 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 listę wiadomości w pokoju, do którego należy dzwoniący, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi.

patch

 aktualizuje wiadomość.

update

 aktualizuje wiadomość.