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 do wiadomości. Na przykład: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Jeśli podczas tworzenia wiadomości ustawisz identyfikator niestandardowy, możesz go użyć, aby określić treść żądania. 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ści.

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ą wartości name i type użytkownika.

createTime

string (Timestamp format)

Opcjonalnie. Stałe. w przypadku pokoi utworzonych w Google Chat jest to data utworzenia wiadomości; To pole podaje tylko dane wyjściowe, chyba że jest używane w trybie importowania.

W przypadku pokoi w trybie importowania ustaw w tym polu historyczną sygnaturę czasową utworzenia wiadomości w źródle, aby zachować pierwotny czas utworzenia.

lastUpdateTime

string (Timestamp format)

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

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

text

string

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.

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

formattedText

string

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

  • Składnia znaczników: pogrubienie, kursywa, przekreślenie, o stałej szerokości, blok o stałej szerokości i lista punktowana.

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

  • Niestandardowe hiperlinki w formacie <{url}|{rendered_text}>, gdzie pierwszy ciąg to adres URL, a drugi jest renderowanym tekstem, np. <http://example.com|custom text>.

  • Niestandardowe emotikony w formacie :{emoji_name}:, na przykład :smile:. Nie dotyczy to emotikonów w standardzie Unicode, na przykład U+1F600 w przypadku emotikona uśmiechniętej buźki.

Więcej informacji znajdziesz w sekcji Wyświetlanie formatowania tekstu wysłanego w wiadomości

cards[]
(deprecated)

object (Card)

Wycofane: użyj zasady cardsV2.

Bogate, sformatowane i interaktywne karty, które możesz wykorzystać do wyświetlania elementów interfejsu, takich jak: sformatowane teksty, przyciski i klikalne obrazy. Zazwyczaj karty są wyświetlane pod zwykłym tekstem wiadomości. cards i cardsV2 mogą mieć maksymalny rozmiar 32 KB.

cardsV2[]

object (CardWithId)

Tablica kart.

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

Aby dowiedzieć się więcej o kartach i o tym, jak je tworzyć, przeczytaj artykuł Projektowanie dynamicznych, interaktywnych i spójnych interfejsów użytkownika za pomocą kart.

Projektuj karty i wyświetl ich podgląd w kreatorze kart.

Otwórz Kreator kart

annotations[]

object (Annotation)

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

thread

object (Thread)

Wątek, do którego należy wiadomość. Informacje o używaniu rozwiązania znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na nie.

space

object (Space)

Jeśli Twoja aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełnią pokój name.

fallbackText

string

Zwykły opis tekstowy kart wiadomości używany, gdy nie można wyświetlić rzeczywistych kart (np. w powiadomieniach na urządzeniu mobilnym).

actionResponse

object (ActionResponse)

Tylko wejście. Parametry, których aplikacja do obsługi czatu może używać do konfigurowania sposobu publikowania odpowiedzi.

argumentText

string

Tylko dane wyjściowe. Treść wiadomości zawierająca zwykły tekst z usuniętymi wszystkimi wzmiankami w aplikacji Google Chat.

slashCommand

object (SlashCommand)

Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (w odpowiednich przypadkach).

attachment[]

object (Attachment)

Załącznik przesłany przez użytkownika.

matchedUrl

object (MatchedUrl)

Tylko dane wyjściowe. Adres URL w polu spaces.messages.text zgodny ze wzorcem 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. Gdy false, wiadomość jest widoczna w rozmowie najwyższego poziomu w pokoju jako pierwsza wiadomość wątku lub wiadomość bez odpowiedzi w wątkach.

Jeśli w pokoju nie można odpowiadać w wątkach, to pole ma zawsze wartość false.

clientAssignedMessageId

string

Opcjonalnie. Niestandardowy identyfikator wiadomości. W tym polu możesz zidentyfikować wiadomość albo ją pobrać, usunąć lub zaktualizować. Aby ustawić identyfikator niestandardowy, podczas tworzenia wiadomości podaj pole messageId. Szczegółowe informacje znajdziesz w sekcji Nadawanie nazwy wiadomości.

emojiReactionSummaries[]

object (EmojiReactionSummary)

Tylko dane wyjściowe. Lista podsumowań reakcji emotikonem na wiadomość.

privateMessageViewer

object (User)

Stałe. Pole do utworzenia wiadomości. W przeciwnym razie tylko dane wyjściowe. Użytkownik, który może wyświetlić wiadomość. Gdy skonfigurujesz wiadomość, będzie ona prywatna i widoczna tylko dla określonego użytkownika oraz w aplikacji Google Chat. W wiadomościach prywatnych nie można wyświetlać podglądu linków ani załączników.

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

Szczegółowe informacje znajdziesz w artykule Wysyłanie wiadomości prywatnych 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 opcji 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. Obrazy GIF dołączone do wiadomości.

accessoryWidgets[]

object (AccessoryWidget)

Co najmniej jeden interaktywny widżet wyświetlany u dołu wiadomości. Do wiadomości zawierających tekst, karty lub tekst i karty możesz dodawać widżety akcesoriów. Nieobsługiwane w przypadku wiadomości zawierających okna.

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

Poniższy przykład przedstawia aplikację Google Chat, która wykorzystuje w wiadomości tekstowej widżety akcesoriów (przyciski kciuka w górę i kciuka w dół):

Przykładowy komunikat o widżetach akcesoriów

Oto kod JSON dla tej przykładowej wiadomości:

{
  "text": "Rate your experience with this Chat app.",
  "accessoryWidgets": [
    {
      "buttonList": {
        "buttons": [
          {
            "icon": {
              "materialIcon": {
                "name": "thumb_up"
              }
            },
            "color": {
              "red": 0,
              "blue": 255,
              "green": 0
            },
            "onClick": {
              "action": {
                "function": "doUpvote",
              }
            }
          },
          {
            "icon": {
              "materialIcon": {
                "name": "thumb_down"
              }
            },
            "color": {
              "red": 0,
              "blue": 255,
              "green": 0
            },
            "onClick": {
              "action": {
                "function": "doDownvote",
              }
            }
          }
        ]
      }
    }
  ]
}

CardWithId

kartę w wiadomości w Google Chat,

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

Projektuj karty i wyświetl ich podgląd w kreatorze kart.

Otwórz Kreator 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 ze zwykłym tekstem wiadomości. Aby dowiedzieć się, jak dodać podstawowe formatowanie do SMS-a, przeczytaj artykuł 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 (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // 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 jako zwykły tekst, której odpowiada dana adnotacja.

startIndex

integer

Indeks początkowy (w oparciu o 0, włącznie) w treści zwykłego tekstu wiadomości, której dotyczy ta adnotacja.

Pole sumy metadata. Dodatkowe metadane dotyczące adnotacji. metadata może być tylko jedną z tych wartości:
userMention

object (UserMentionMetadata)

Metadane wzmianek 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 Wzmianka o użytkowniku.
SLASH_COMMAND Wywoływane jest polecenie po ukośniku.

UserMentionMetadata

Metadane adnotacji do wzmianek użytkownika (@).

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

object (User)

Wspomniany użytkownik.

type

enum (Type)

Rodzaj wzmianek 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ę o użytkowniku w pokoju.

SlashCommandMetadata

Metadane adnotacji do poleceń 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 polecenia wywołanego po ukośniku.

triggersDialog

boolean

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. Informacje o używaniu rozwiązania 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, gdy nie znajdzie pasującego wątku.

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

string

Tylko dane wyjściowe. Nazwa zasobu wątku.

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

threadKey

string

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

Ten identyfikator jest unikalny dla aplikacji Google Chat, która go ustawia. Jeśli na przykład wiele aplikacji do obsługi czatu utworzy wiadomość z użyciem tego samego klucza 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 wpisz pole name wątku.

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 wejście. Typ odpowiedzi aplikacji do obsługi czatu.

url

string

Tylko wejście. Adres URL do uwierzytelniania lub skonfigurowania przez użytkowników. (Tylko w przypadku REQUEST_CONFIG typów odpowiedzi).

dialogAction

object (DialogAction)

Tylko wejście. Odpowiedź na zdarzenie interakcji związane z oknem dialogowym. Muszą dołączyć ResponseType.Dialog.

updatedWidget

object (UpdatedWidget)

Tylko wejście. Odpowiedź zaktualizowanego widżetu.

ResponseType

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 dopasowanym 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świetla okno dialogowe.
UPDATE_WIDGET Zapytanie dotyczące opcji autouzupełniania tekstu widżetu.

DialogAction

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

Pole sumy action.

action może być tylko jedną z tych wartości:

dialog

object (Dialog)

Tylko wejście. Okno żądania.

Dialog

Otoka wokół treści karty w oknie.

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

object (Card)

Tylko wejście. Treść okna wyświetlana w formie modalnej. Aplikacje Google Chat nie obsługują tych elementów kart: DateTimePicker i 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ść wysłana do użytkowników o stanie ich prośby. Jeśli nie jest skonfigurowana, wysyłana jest ogólna wiadomość na podstawie statusCode.

Kod

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

Czasami może pojawić się kilka kodów błędów. Usługi powinny zwracać najbardziej odpowiedni kod błędu. Na przykład preferuj OUT_OF_RANGE, a nie 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ócony w przypadku powodzenia.

Mapowanie HTTP: 200 OK

CANCELLED

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

Mapowanie HTTP: żądanie zamknięte przez klienta 499

UNKNOWN

Nieznany błąd. Ten błąd może na przykład zostać zwrócony, gdy wartość Status otrzymana z innej przestrzeni adresowej należy do przestrzeni błędów, która nie jest znana w tej przestrzeni adresowej. Na ten błąd mogą również wystąpić błędy zgłaszane 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. Pamiętaj, że różni się to od FAILED_PRECONDITION. INVALID_ARGUMENT wskazuje argumenty powodujące problemy niezależnie od stanu systemu (np. niewłaściwą nazwę pliku).

Mapowanie HTTP: 400 Nieprawidłowe żądanie

DEADLINE_EXCEEDED

Upłynął termin 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: 504 gateway Timeout (Przekroczenie limitu czasu bramy)

NOT_FOUND

Nie znaleziono żądanej encji (np. pliku lub katalogu).

Uwaga dla programistów serwerów: jeśli żądanie zostanie odrzucone dla całej klasy użytkowników, na przykład stopniowe wdrażanie funkcji lub dodanie nieudokumentowanej listy dozwolonych, można użyć NOT_FOUND. Jeśli żądanie zostanie odrzucone w przypadku niektórych użytkowników z danej klasy (na przykład kontroli dostępu na podstawie kont użytkowników), należy użyć PERMISSION_DENIED.

Mapowanie HTTP: błąd 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 PERMISSION_DENIED nie można używać w przypadku odrzuceń spowodowanych wyczerpaniem się zasobów (w przypadku tych błędów zamiast tego użyj RESOURCE_EXHAUSTED). Nie należy używać metody PERMISSION_DENIED, jeśli nie można zidentyfikować elementu wywołującego (w przypadku tych błędów użyj elementu UNAUTHENTICATED). Ten kod błędu nie sugeruje, że żądanie jest prawidłowe, żądana jednostka istnieje lub spełnia inne warunki wstępne.

Mapowanie HTTP: 403 Forbidden

UNAUTHENTICATED

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

Mapowanie HTTP: 401 Brak autoryzacji

RESOURCE_EXHAUSTED

Skończyło się miejsce na niektóre zasoby – na przykład limit na użytkownika lub w całym systemie plików nie ma już 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 elementów niebędących katalogiem itd.

Podmioty implementujące usługi mogą korzystać z tych wskazówek przy wyborze między FAILED_PRECONDITION, ABORTED i UNAVAILABLE: (a) Użyj metody UNAVAILABLE, jeśli klient może ponowić próbę wywołania tylko nieudanego wywołania. (b) Użyj ABORTED, jeśli klient powinien spróbować ponownie na wyższym poziomie. Jeśli na przykład określony przez klienta test i zestaw nie powiedzie się, oznacza to, że klient powinien ponownie uruchomić sekwencję odczytu, modyfikacji i zapisu. (c) Użyj metody FAILED_PRECONDITION, jeśli klient nie powinien ponawiać próby do czasu, gdy stan systemu nie zostanie bezpośrednio poprawiony. Jeśli na przykład nie uda się użyć parametru „rmdir”, ponieważ katalog nie jest pusty, należy zwrócić wartość 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, zwykle z powodu problemu równoczesności, takiego jak błąd sprawdzania sekwencera lub przerwanie transakcji.

Powyżej znajdziesz wskazówki, jak wybrać ustawienie: FAILED_PRECONDITION, ABORTED i UNAVAILABLE.

Mapowanie HTTP: konflikt 409

OUT_OF_RANGE

Podjęto próbę wykonania operacji poza prawidłowym zakresem. Na przykład podczas wyszukiwania lub czytania po zakończeniu pliku.

W przeciwieństwie do zasady INVALID_ARGUMENT ten błąd oznacza problem, który może zostać rozwiązany po zmianie stanu systemu. Na przykład 32-bitowy system plików wygeneruje ciąg INVALID_ARGUMENT, jeśli zostanie wyświetlony z prośbą o odczytanie z przesunięciem spoza zakresu [0,2^32-1], ale w przypadku prośby o odczyt odsuniętego poza bieżący rozmiar pliku wygeneruje wartość OUT_OF_RANGE.

Zakres dat FAILED_PRECONDITION i OUT_OF_RANGE jest spory. W przypadku danego błędu zalecamy użycie właściwości OUT_OF_RANGE (bardziej szczegółowego błędu), aby rozmówca, który powtarza iterację w pokoju, mógł łatwo znaleźć błąd OUT_OF_RANGE, który pozwoliłby wykryć, kiedy zostało wykonane.

Mapowanie HTTP: 400 Nieprawidłowe żądanie

UNIMPLEMENTED

Operacja nie jest zaimplementowana lub nie jest obsługiwana/włączona w tej usłudze.

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

UNAVAILABLE

Usługa jest obecnie niedostępna. Jest to najprawdopodobniej stan przejściowy, który można rozwiązać, próbując ponownie wykonać operację z użyciem ponowienia. Pamiętaj, że nie zawsze można bezpiecznie ponawiać próby nieidempotentne.

Powyżej znajdziesz wskazówki, jak wybrać ustawienie: FAILED_PRECONDITION, ABORTED i UNAVAILABLE.

Mapowanie HTTP: 503 Service Available (Usługa niedostępna)

DATA_LOSS

Nieodwracalna utrata lub uszkodzenie danych.

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

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 widżetem, który wywołał żądanie aktualizacji.

Pole sumy updated_widget.

updated_widget może być tylko jedną z tych wartości:

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 URL w wiadomości w Google Chat. W aplikacjach do obsługi czatu można wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w sekcji Podgląd linków.

Zapis JSON
{
  "url": string
}
Pola
url

string

Tylko dane wyjściowe. Pasujący 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 z użyciem powiązanego emotikona.

DeletionMetadata

Informacje o usuniętej wiadomości. Wiadomość zostanie usunięta po ustawieniu opcji 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 jej wygaśnięciu.
CREATOR_VIA_APP Aplikacja do obsługi czatu 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 utworzenia cytowanej wiadomości lub jej ostatniej aktualizacji.

AttachedGif

Obraz GIF określony przez adres URL.

Zapis JSON
{
  "uri": string
}
Pola
uri

string

Tylko dane wyjściowe. Adres URL, pod którym jest przechowywany obraz GIF.

AccessoryWidget

Widżet bez obramowania dołączony u dołu wiadomości w aplikacji.

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.

action może być tylko jedną z tych wartości:

buttonList

object (ButtonList)

Lista przycisków wyświetlanych pod wiadomością.

Metody

create

Tworzy wiadomość w pokoju w Google Chat.

delete

Usuwa wiadomość.

get

Zwraca szczegóły 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ść.