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

Nazwa zasobu wiadomości.

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

Gdzie {space} to identyfikator pokoju, w którym została opublikowana wiadomość, a {message} to identyfikator przypisany przez system tej wiadomości. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz identyfikator niestandardowy, możesz go użyć do określenia komunikatu w żądaniu. W tym celu zastąp {message} wartością z pola clientAssignedMessageId. Na przykład: spaces/AAAAAAAAAAA/messages/client-custom-name. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomościom.

sender

object (User)

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pola name i type użytkownika.

createTime

string (Timestamp format)

Opcjonalnie: Stały. w przypadku pokoi utworzonych w Google Chat – data 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 w tym polu historyczną sygnaturę czasową, w której 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

Zwykły tekst wiadomości. Pierwszy link do obrazu, filmu lub strony internetowej powoduje wygenerowanie elementu podglądu. Możesz też dodać@wzmiankę o użytkowniku Google Chat lub każdej osobie w pokoju.

Aby dowiedzieć się, jak tworzyć SMS-y, zobacz Wysyłanie SMS-ów.

formattedText

string

Tylko dane wyjściowe. Zawiera wiadomość text ze znacznikami dodanymi w celu komunikowania formatowania. To pole może nie zawierać całego formatowania widocznego w interfejsie, ale zawiera:

  • Składnia znaczników w przypadku pogrubienia, kursywy, przekreślenia, blokowej o stałej szerokości, bloku o stałej szerokości i listy punktowanej.

  • Wzmianki użytkownika 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}:, np. :smile:. Nie dotyczy to emotikonów Unicode, takich jak U+1F600 w przypadku emotikonu uśmiechniętej buźki.

Więcej informacji znajdziesz w artykule Wyświetlanie formatowania tekstu w wiadomości.

cards[]
(deprecated)

object (Card)

Wycofane: użyj atrybutu 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 są one wyświetlane pod zwykłym tekstem wiadomości. Pliki cards i cardsV2 mogą mieć maksymalny rozmiar 32 KB.

cardsV2[]

object (CardWithId)

Tablica kart.

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

Więcej informacji o kartach i sposobach ich tworzenia znajdziesz w artykule Wysyłanie wiadomości dotyczących kart.

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

Otwórz kreator kart

annotations[]

object (Annotation)

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

thread

object (Thread)

Wątek, do którego należy wiadomość. Przykładowe użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

space

object (Space)

Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe pojawią się w pokoju name.

fallbackText

string

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 do obsługi czatu 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 w aplikacji Google Chat.

slashCommand

object (SlashCommand)

Tylko dane wyjściowe. Informacje o poleceniach po ukośniku (jeśli dotyczy).

attachment[]

object (Attachment)

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. Gdy true, wiadomość jest odpowiedzią w wątku odpowiedzi. Gdy false, wiadomość jest widoczna w rozmowie na najwyższym poziomie pokoju jako pierwsza wiadomość w wątku lub wiadomość bez odpowiedzi w wątkach.

Jeśli pokój nie obsługuje odpowiedzi w wątkach, w tym polu jest zawsze false.

clientAssignedMessageId

string

Opcjonalnie: Niestandardowy identyfikator wiadomości. Za pomocą tego pola możesz zidentyfikować wiadomość albo pobrać, usunąć lub zaktualizować wiadomość. Aby ustawić identyfikator niestandardowy, określ pole messageId podczas tworzenia wiadomości. 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)

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ść. Po ustawieniu tego ustawienia wiadomość jest prywatna i widoczna tylko dla określonego użytkownika oraz aplikacji Google Chat. Podgląd linków ani załączników nie jest obsługiwany w przypadku wiadomości prywatnych.

Wiadomości prywatne mogą wysyłać tylko aplikacje do obsługi czatu. Jeśli Twoja aplikacja Google Chat uwierzytelnia się jako użytkownik przed wysłaniem wiadomości, wiadomość nie może być prywatna i musi pominąć to pole.

Więcej informacji znajdziesz w artykule Wysyłanie prywatnych wiadomości do użytkowników Google Chat.

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 cytowanej przez użytkownika Google Chat 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)

Co najmniej jeden interaktywny widżet wyświetlany 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.

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

CardWithId

Karta w wiadomości w Google Chat.

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

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

Otwórz kreator 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 główną treścią wiadomości. Aby dowiedzieć się, jak dodać podstawowe formatowanie do SMS-a, przeczytaj artykuł Formatowanie SMS-ów.

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ść podłańcucha w treści wiadomości zwykłego tekstu, której odpowiada ta adnotacja.

startIndex

integer

Indeks początkowy (w postaci 0, włącznie) w treści wiadomości tekstowej, której odpowiada ta adnotacja.

Pole sumy 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)

Wspomniał użytkownik.

type

enum (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 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 do obsługi czatu, której polecenie zostało wywołane.

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 wyliczenia. Nie używaj.
ADD Dodaj aplikację Google Chat do pokoju.
INVOKE Wywołaj polecenie po ukośniku w spacji.

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 dla połączonego zasobu. data może mieć tylko jedną z tych wartości:

RichLinkType

Rodzaj linku z elementami rozszerzonymi. 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 Szczegółowy typ linku do 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 odwołujący się do pliku na Dysku Google.

mimeType

string

Typ MIME połączonego zasobu 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 użycie: Rozpoczynanie wątku wiadomości lub odpowiadanie na niego.

Jeśli podczas tworzenia wiadomości określisz wątek, w polu messageReplyOption możesz określić, co się stanie, jeśli nie znajdziesz pasującego wątku.

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

string

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. Maksymalna długość tekstu to 4000 znaków.

Jest to unikalny identyfikator aplikacji Google Chat, która go ustawia. Jeśli na przykład wiele aplikacji Google Chat utworzy wiadomość przy użyciu tego samego klucza wątku, zostaną one 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 do obsługi czatu 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óry użytkownicy mogą uwierzytelniać lub konfigurować. (Tylko w przypadku REQUEST_CONFIG typów odpowiedzi).

dialogAction

object (DialogAction)

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji powiązane z oknem. Wymagany jest dokument 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 o opcje autouzupełniania tekstu widżetu.

DialogAction

Zawiera okno 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 żądania wywołania lub przesłania okna. W razie potrzeby wyświetla stan i komunikat dla użytkowników. np. w przypadku błędu lub powodzenia.

Pole sumy action. Działanie do wykonania. action może mieć tylko jedną z tych wartości:
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 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

Wiadomość wysyłana do użytkowników z informacją o stanie prośby. Jeśli zasada jest nieskonfigurowana, wysyłana jest ogólna wiadomość na podstawie statusCode.

Kod

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

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. Na przykład w przypadku obu kodów preferuj OUT_OF_RANGE, a nie FAILED_PRECONDITION. Podobnie wolą opcję NOT_FOUND lub ALREADY_EXISTS zamiast FAILED_PRECONDITION.

Wartości w polu enum
OK

To nie jest błąd. zwracanych w przypadku sukcesu.

Mapowanie HTTP: 200 OK

CANCELLED

Operacja została anulowana, zwykle przez osobę wywołującą.

Mapowanie HTTP: żądanie zamknięcia klienta 499

UNKNOWN

Nieznany błąd. Ten błąd może być zwracany na przykład wtedy, gdy wartość Status otrzymana z innej przestrzeni adresowej należy do przestrzeni błędów, która nie jest znana w tej przestrzeni adresowej. 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. Pamiętaj, że różni się to od FAILED_PRECONDITION. INVALID_ARGUMENT wskazuje argumenty, które powodują problemy niezależnie od stanu systemu (np. nieprawidłowo sformatowana nazwa pliku).

Mapowanie HTTP: nieprawidłowe żądanie 400

DEADLINE_EXCEEDED

Termin minął przed ukoń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: przekroczenie limitu czasu bramy 504

NOT_FOUND

Nie udało się znaleźć żądanej jednostki (np. pliku lub katalogu).

Uwaga dla programistów serwerów: jeśli żądanie zostanie odrzucone w przypadku całej klasy użytkowników (np. stopniowe wdrażanie funkcji lub nieudokumentowana lista dozwolonych), może zostać użyta NOT_FOUND. W przypadku odrzucenia prośby w przypadku niektórych użytkowników w klasie użytkowników (na przykład przy użyciu kontroli dostępu opartej na użytkownikach) trzeba użyć funkcji PERMISSION_DENIED.

Mapowanie HTTP: Nie znaleziono błędu 404

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 do usunięcia nie jest pusty, operacja rmdir została zastosowana do elementu innego niż katalog itd.

Implementatory usług mogą wybierać między FAILED_PRECONDITION, ABORTED a UNAVAILABLE na podstawie tych wytycznych: (a) Użyj właściwości UNAVAILABLE, jeśli klient może ponowić próbę tylko nieudanego wywołania. (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 reguły FAILED_PRECONDITION, jeśli klient nie powinien ponawiać próby, dopóki stan systemu nie zostanie bezpośrednio poprawiony. Na przykład, jeśli wartość „rmdir” kończy się niepowodzeniem, ponieważ katalog nie jest pusty, dlatego powinien zostać zwrócony kod FAILED_PRECONDITION, ponieważ klient nie powinien ponawiać próby, chyba że pliki zostaną usunięte z katalogu.

Mapowanie HTTP: nieprawidłowe żądanie 400

ABORTED

Operacja została przerwana, zwykle z powodu problemu równoczesności, takiego jak błąd kontroli sekwencera lub przerwanie transakcji.

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

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.

Zakres dat FAILED_PRECONDITION i OUT_OF_RANGE w dużym stopniu się pokrywa. W razie potrzeby zalecamy użycie OUT_OF_RANGE (bardziej szczegółowego błędu), aby osoby dzwoniące wykonujące iteracje w pokoju mogły łatwo wyszukać błąd OUT_OF_RANGE, który pozwoli wykryć, że zadanie zostało wykonane.

Mapowanie HTTP: nieprawidłowe żądanie 400

UNIMPLEMENTED

Ta operacja nie została wdrożona albo nie jest obsługiwana lub włączona w tej usłudze.

Mapowanie HTTP: kod 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: wewnętrzny błąd serwera 500

UNAVAILABLE

Usługa jest obecnie niedostępna. Najprawdopodobniej jest to stan przejściowy, który można rozwiązać, ponawiając próbę z ponownym wystąpieniem. Pamiętaj, że ponawianie operacji nieidempotentnych nie zawsze jest bezpieczne.

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

Mapowanie HTTP: Usługa niedostępna 503

DATA_LOSS

Nieodwracalna utrata lub uszkodzenie danych.

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

UpdatedWidget

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

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ł żądanie aktualizacji.

Pole sumy updated_widget. Widżet jest aktualizowany w odpowiedzi na działanie użytkownika. updated_widget może mieć tylko jedną z tych wartości:
suggestions

object (SelectionItems)

Lista wyników autouzupełniania widżetów

SelectionItems

Lista wyników autouzupełniania widżetów.

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 obsługi czatu mogą wyświetlać podgląd pasujących adresów URL. Więcej informacji znajdziesz w sekcji 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ść przy użyciu określonego emotikona.

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

object (Emoji)

Emotikony powiązane z reakcjami.

reactionCount

integer

Łączna liczba reakcji przy użyciu powiązanego emotikona.

DeletionMetadata

Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu funkcji deleteTime.

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

enum (DeletionType)

Wskazuje, kto usunął wiadomość.

DeletionType

kto i w jaki sposób usunął wiadomość,

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 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.

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 cytowana wiadomość została utworzona lub kiedy została ostatnio zaktualizowana.

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 u dołu 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 sumy action. Typ działania. action może mieć tylko jedną z tych wartości:
buttonList

object (ButtonList)

Lista przycisków.

Metody

create

Tworzy wiadomość w pokoju Google Chat.

delete

Usuwa wiadomość.

get

Zwraca informacje o wiadomości.

list

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.

patch

Aktualizuje wiadomość.

update

Aktualizuje wiadomość.