REST Resource: spaces.messages

Zasób: wiadomość

wiadomości 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,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
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 identyfikator wiadomości przypisany przez system. 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 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 Nadawanie nazwy wiadomości.
sender

object (User)

Tylko dane wyjściowe. Użytkownik, który utworzył wiadomość. Jeśli aplikacja do Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pola user name i type zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązania z użytkownikiem wywołującym, np. rozmowę na czacie.
createTime

string (Timestamp format)

Opcjonalnie: Wartość niezmienna. W przypadku pokoi utworzonych w Google Chat – czas utworzenia wiadomości. To pole jest tylko do odczytu, chyba że jest używane w pokojach w trybie importowania.

W przypadku pokoi w trybie importu ustaw to pole na historyczną sygnaturę czasową, kiedy 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 była edytowana, to pole jest puste.
deleteTime

string (Timestamp format)

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

string

Opcjonalnie: Treść wiadomości w formacie zwykłego tekstu. Pierwszy link do obrazu, filmu lub strony internetowej generuje element podglądu. Możesz też @wzmiankować użytkownika Google Chat lub wszystkie osoby w pokoju.

Aby dowiedzieć się, jak tworzyć SMS-y, przeczytaj artykuł Wysyłanie wiadomości.
formattedText

string

Tylko dane wyjściowe. Zawiera wiadomość text ze znacznikami dodanymi w celu przekazania formatowania. To pole może nie obejmować wszystkich formatów widocznych w interfejsie, ale zawiera te elementy:

  • Składnia znaczników dla pogrubienia, kursywy, przekreślenia, czcionki o stałej szerokości znaków, bloku o stałej szerokości znaków, listy punktowanej i cytatu blokowego.

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

  • Niestandardowe hiperlinki w formacie <{url}|{rendered_text}>, gdzie pierwszy ciąg znaków to adres URL, a drugi to 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 oznaczający uśmiechniętą twarz.

  • Elementy listy punktowanej z gwiazdkami (*) – na przykład * item.

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

object (Card)

Wycofana: użyj zasady cardsV2.

Rozbudowane, sformatowane i interaktywne karty, których możesz używać do wyświetlania elementów interfejsu, takich jak sformatowane teksty, przyciski i obrazy, które można kliknąć. Karty są zwykle wyświetlane pod treścią wiadomości w formacie zwykłego tekstu. Maksymalny rozmiar pól cards i cardsV2 to 32 KB.
cardsV2[]

object (CardWithId)

Opcjonalnie: Tablica kart.

Aplikacje do obsługi czatu mogą tworzyć karty z uwierzytelnianiem aplikacji. W ramach programu wersji przedpremierowych dla programistów, jeśli Twoja aplikacja do Google Chat uwierzytelnia się jako użytkownik, może tworzyć wiadomości z kartami. Jeśli Twoja aplikacja do Google Chat nie jest częścią programu wersji przedpremierowych dla programistów, nie może tworzyć kart z uwierzytelnianiem użytkownika.

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

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

Otwieranie Kreatora kart
annotations[]

object (Annotation)

Tylko dane wyjściowe. Adnotacje mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub z elementami, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami startIndex i length równymi 0.
thread

object (Thread)

Wątek, do którego należy wiadomość. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i odpowiadanie na niego.
space

object (Space)

Tylko dane wyjściowe. Jeśli aplikacja do Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe zawierają tylko pokój name.
fallbackText

string

Opcjonalnie: Opis kart wiadomości w postaci zwykłego tekstu, używany, gdy nie można wyświetlić rzeczywistych kart, np. w powiadomieniach na urządzeniach mobilnych.
actionResponse

object (ActionResponse)

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

string

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

object (SlashCommand)

Tylko dane wyjściowe. Informacje o poleceniu po ukośniku (jeśli dotyczy).
attachment[]

object (Attachment)

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

object (MatchedUrl)

Tylko dane wyjściowe. Adres URL w polu text wiadomości na czacie, który pasuje do wzorca podglądu linku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków.
threadReply

boolean

Tylko dane wyjściowe. Gdy true, wiadomość jest odpowiedzią w wątku odpowiedzi. Gdy parametr ma wartość false, wiadomość jest widoczna w rozmowie na najwyższym poziomie pokoju jako pierwsza wiadomość w wątku lub wiadomość bez odpowiedzi w wątku.

Jeśli pokój nie obsługuje odpowiedzi w wątkach, to pole ma zawsze wartość false.
silent

boolean

Tylko dane wyjściowe. Czy jest to cicha wiadomość. Ciche wiadomości to wiadomości, w przypadku których Google Chat blokuje powiadomienia push dla odbiorców.
clientAssignedMessageId

string

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

object (EmojiReactionSummary)

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

object (User)

Opcjonalnie: Wartość niezmienna. 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 i aplikacji Google Chat. Aby uwzględnić to pole w żądaniu, musisz wywołać interfejs Chat API przy użyciu uwierzytelniania aplikacji i pominąć te elementy:

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

Opcjonalnie: Informacje o wiadomości, którą cytuje inna wiadomość.

Podczas tworzenia wiadomości możesz cytować wiadomości w tym samym wątku lub zacytować wiadomość główną, aby utworzyć nową wiadomość główną. Nie możesz jednak cytować odpowiedzi na wiadomość z innego wątku.

Podczas aktualizowania wiadomości nie możesz dodać ani zastąpić pola quotedMessageMetadata, ale możesz je usunąć.

Przykłady użycia znajdziesz w artykule Cytowanie innej wiadomości.
attachedGifs[]

object (AttachedGif)

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

object (AccessoryWidget)

Opcjonalnie: Co najmniej 1 interaktywny widżet, który pojawia się u dołu wiadomości. Widżety dodatkowe możesz dodawać do wiadomości zawierających tekst, karty lub zarówno tekst, jak i karty. Nie są obsługiwane w przypadku wiadomości zawierających okna. Szczegółowe informacje znajdziesz w sekcji Dodawanie interaktywnych widżetów u dołu wiadomości.

Tworzenie wiadomości z widżetami dodatkowymi wymaga uwierzytelniania aplikacji.
elements

object (Elements)

Opcjonalnie: Elementy to dodatkowe komponenty udostępniane podczas tworzenia wiadomości, które mogą, ale nie muszą być powiązane z określonymi fragmentami tekstu wiadomości. Różnią się one od adnotacji, które są przeznaczone tylko do odczytu i zawierają dodatkowe informacje powiązane z fragmentami wiadomości lub całym tekstem wiadomości.

markupSyntax

enum (MarkupSyntax)

Opcjonalnie: Określa, jak serwer interpretuje zawartość pola text wiadomości.

CardWithId

karta w wiadomości na czacie w Google Chat.

Aplikacje do obsługi czatu mogą tworzyć karty z uwierzytelnianiem aplikacji. W ramach programu wersji przedpremierowych dla programistów, jeśli Twoja aplikacja do Google Chat uwierzytelnia się jako użytkownik, może tworzyć wiadomości z kartami. Jeśli Twoja aplikacja do Google Chat nie jest częścią programu wersji przedpremierowych dla programistów, nie może tworzyć kart z uwierzytelnianiem użytkownika.

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

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

Otwieranie Kreatora kart

Zapis JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  },
  "ownerUser": {
    object (User)
  }
}
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.
ownerUser

object (User)

Tylko dane wyjściowe. Aplikacja, do której należy karta.

Adnotacja

Adnotacje mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub z elementami, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami startIndex i length równymi 0. Aby dodać podstawowe formatowanie do SMS-a, zapoznaj się z artykułem Formatowanie SMS-ów.

Przykładowa treść wiadomości w formacie 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Pola
type

enum (AnnotationType)

Typ tej adnotacji.
length

integer

Długość podłańcucha w treści wiadomości w formacie zwykłego tekstu, której dotyczy ta adnotacja. Jeśli nie jest obecny, oznacza długość 0.
startIndex

integer

Indeks początkowy (liczony od 0, włącznie) w treści wiadomości w formacie zwykłego tekstu, której dotyczy ta adnotacja.
Dodatkowe metadane dotyczące adnotacji. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
userMention

object (UserMentionMetadata)

Metadane wzmianki o użytkowniku.
slashCommand

object (SlashCommandMetadata)

Metadane polecenia po ukośniku.
customEmojiMetadata

object (CustomEmojiMetadata)

Metadane niestandardowego emotikonu.
Koniec pól wykluczających się wzajemnie.

AnnotationType

Typ adnotacji.

Wartości w polu enum
ANNOTATION_TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
USER_MENTION użytkownik zostanie wspomniany,
SLASH_COMMAND wywołanie polecenia po ukośniku,
CUSTOM_EMOJI Adnotacja niestandardowego emotikonu.

UserMentionMetadata

Metadane adnotacji dotyczące 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 Wzmianka o użytkowniku w pokoju.

SlashCommandMetadata

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

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

object (User)

Aplikacja do Google Chat, 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 dotyczy okna.

Typ

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

RichLinkMetadata

Szczegółowy link do zasobu. Linki wzbogacone mogą być powiązane z treścią wiadomości w formacie zwykłego tekstu lub reprezentować elementy, które prowadzą do zasobów Google Workspace, takich jak Dokumenty Google lub Arkusze Google, z wartościami startIndex i length równymi 0.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
Pola
uri

string

Identyfikator URI tego linku.
Dane połączonego zasobu. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
Koniec pól wykluczających się wzajemnie.

RichLinkType

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

Wartości w polu enum
DRIVE_FILE Typ linku z informacjami na Dysku Google.
CHAT_SPACE Typ precyzyjnego linku do pokoju czatu. Na przykład element inteligentny pokoju.
GMAIL_MESSAGE Typ linku do wiadomości w Gmailu. Konkretnie element Gmaila z opcji Udostępnij w Google Chat. Interfejs API obsługuje tylko odczytywanie wiadomości z linkami GMAIL_MESSAGE.
MEET_SPACE Typ linku do wiadomości w Meet z elementami rozszerzonymi. Może to być na przykład element Meet.
CALENDAR_EVENT Typ linku z podglądem wiadomości z Kalendarza. Na przykład element Kalendarza.

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 połączonego zasobu pokoju czatu.

Format: spaces/{space}
thread

string

Wątek połączonego zasobu pokoju czatu.

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

string

Wiadomość z połączonego zasobu pokoju czatu.

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

MeetSpaceLinkData

Dane dotyczące linków do pokoi w Meet.

Zapis JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
Pola
meetingCode

string

Kod spotkania połączonego pokoju w Meet.
type

enum (Type)

Wskazuje typ pokoju w Meet.
huddleStatus

enum (HuddleStatus)

Opcjonalnie: Tylko dane wyjściowe. Jeśli spotkanie w Meet jest szybką rozmową, wskazuje jej stan. W przeciwnym razie ta wartość nie jest ustawiona.

Typ

Typ pokoju w Meet.

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
MEETING Pokój w Meet to spotkanie.
HUDDLE Pokój Meet to pokój do szybkich spotkań.

HuddleStatus

Stan spotkania

Wartości w polu enum
HUDDLE_STATUS_UNSPECIFIED Wartość domyślna typu wyliczeniowego. Nie używaj.
STARTED Szybkie spotkanie się rozpoczęło.
ENDED Szybkie spotkanie zostało zakończone. W takim przypadku identyfikator URI i identyfikatory pokoju Meet nie będą już ważne.
MISSED Masz nieodebraną rozmowę Huddle. W takim przypadku identyfikator URI i identyfikatory pokoju Meet nie będą już ważne.

CalendarEventLinkData

Dane linków do wydarzeń w Kalendarzu.

Zapis JSON 
{
  "calendarId": string,
  "eventId": string
}
Pola
calendarId

string

Identyfikator kalendarza połączonego kalendarza.
eventId

string

Identyfikator wydarzenia powiązanego wydarzenia w Kalendarzu.

CustomEmojiMetadata

Metadane adnotacji niestandardowego emotikonu.

Zapis JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
Pola
customEmoji

object (CustomEmoji)

Niestandardowy emotikon.

Wątek

Wątek w pokoju Google Chat. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości i 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 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. Może zawierać maksymalnie 4000 znaków.

Ten identyfikator jest unikalny dla aplikacji Google Chat, która go ustawia. Jeśli na przykład kilka aplikacji Google Chat 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, określ pole wątku name.

ActionResponse

Parametry, których aplikacja do 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 do Google Chat.
url

string

Tylko dane wejściowe. URL, pod którym użytkownicy mogą się uwierzytelnić lub skonfigurować usługę. (Tylko w przypadku typów odpowiedzi REQUEST_CONFIG).
dialogAction

object (DialogAction)

Tylko dane wejściowe. Odpowiedź na zdarzenie interakcji związane z oknem. Musi mu towarzyszyć ResponseType.Dialog.
updatedWidget

object (UpdatedWidget)

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

ResponseType

Typ odpowiedzi aplikacji do Google Chat.

Wartości w polu enum
TYPE_UNSPECIFIED Domyślny typ, który jest obsługiwany jako NEW_MESSAGE.
NEW_MESSAGE Opublikuj jako nową wiadomość w temacie.
UPDATE_MESSAGE Zaktualizuj wiadomość aplikacji do 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 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 w widżecie.

DialogAction

Zawiera okno i kod stanu żądania.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
Pola
actionStatus

object (ActionStatus)

Tylko dane wejściowe. Stan żądania wywołania lub przesłania okna. W razie potrzeby wyświetla użytkownikom stan i komunikat. na przykład w przypadku błędu lub powodzenia.
Działanie do wykonania. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
dialog

object (Dialog)

Tylko dane wejściowe. Dialog dla żądania.
Koniec pól wykluczających się wzajemnie.

Dialog

Opakowanie wokół treści karty w oknie.

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

object (Card)

Tylko dane wejściowe. Treść okna, która jest renderowana w oknie modalnym. Aplikacje Google Chat nie obsługują tych elementów karty: 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ść, którą chcesz wysłać użytkownikom, aby poinformować ich o stanie ich prośby. Jeśli nie zostanie ustawiona, wysyłana jest ogólna wiadomość na podstawie statusCode.

Kod

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

Czasami może wystąpić kilka kodów błędów. Usługi powinny zwracać najbardziej szczegółowy kod błędu, który ma zastosowanie. Jeśli na przykład oba kody mają zastosowanie, wybierz OUT_OF_RANGE zamiast FAILED_PRECONDITION. Podobnie preferuj NOT_FOUND lub ALREADY_EXISTS zamiast FAILED_PRECONDITION.

Wartości w polu enum
OK

To nie jest błąd. Jest zwracany w przypadku powodzenia.

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 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. Błędy zgłaszane przez interfejsy API, które nie zwracają wystarczającej ilości informacji o błędzie, mogą zostać przekonwertowane na ten błąd.

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, które są problematyczne niezależnie od stanu systemu (np. nieprawidłowa nazwa pliku).

Mapowanie HTTP: 400 Nieprawidłowe żądanie
DEADLINE_EXCEEDED

Termin upłynął, zanim operacja została ukończona. 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 odpowiedź z serwera mogła zostać opóźniona na tyle, że upłynął termin.

Mapowanie HTTP: 504 Przekroczono limit czasu bramy
NOT_FOUND

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

Uwaga dla deweloperów serwerów: jeśli żądanie zostanie odrzucone dla całej klasy użytkowników, np. w przypadku stopniowego wdrażania funkcji lub nieudokumentowanej listy dozwolonych, można użyć NOT_FOUND. Jeśli żądanie zostanie odrzucone w przypadku niektórych użytkowników w ramach klasy użytkowników, np. 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: 409 Conflict
PERMISSION_DENIED

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

Mapowanie HTTP: 403 Dostęp zabroniony
UNAUTHENTICATED

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

Mapowanie HTTP: 401 Unauthorized
RESOURCE_EXHAUSTED

Zasoby zostały wyczerpane. Może to być limit na użytkownika lub brak miejsca w całym systemie plików.

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 elementu, który nie jest katalogiem, itp.

Osoby wdrażające usługi mogą skorzystać z poniższych wskazówek, aby wybrać między FAILED_PRECONDITION, ABORTED i UNAVAILABLE: (a) Użyj UNAVAILABLE, jeśli klient może ponowić tylko nieudane wywołanie. (b) Użyj ABORTED, jeśli klient powinien spróbować ponownie na wyższym poziomie. Na przykład gdy określona przez klienta operacja test-and-set nie powiedzie się, co oznacza, że klient powinien ponownie uruchomić sekwencję odczytu, modyfikacji i zapisu. (c) Użyj FAILED_PRECONDITION, jeśli klient nie powinien ponawiać próby, dopóki stan systemu nie zostanie bezpośrednio poprawiony. Jeśli na przykład polecenie „rmdir” nie powiedzie się, ponieważ katalog nie jest pusty, należy zwrócić błąd FAILED_PRECONDITION, ponieważ klient nie powinien ponawiać próby, dopóki pliki nie 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.

Wskazówki powyżej pomogą Ci zdecydować, czy wybrać FAILED_PRECONDITION, ABORTED czy UNAVAILABLE.

Mapowanie HTTP: 409 Conflict
OUT_OF_RANGE

Próba wykonania operacji poza prawidłowym zakresem. Na przykład próba odczytu poza końcem pliku.

W przeciwieństwie do INVALID_ARGUMENT ten błąd wskazuje na problem, który może zostać rozwiązany, jeśli zmieni się stan systemu. Na przykład 32-bitowy system plików wygeneruje błąd INVALID_ARGUMENT, jeśli zostanie poproszony o odczyt z przesunięcia, które nie mieści się w zakresie [0,2^32-1], ale wygeneruje błąd OUT_OF_RANGE, jeśli zostanie poproszony o odczyt z przesunięcia przekraczającego bieżący rozmiar pliku.

Między FAILED_PRECONDITION a OUT_OF_RANGE jest sporo podobieństw. Zalecamy używanie błędu OUT_OF_RANGE (bardziej szczegółowego), gdy ma on zastosowanie, aby rozmówcy, którzy przechodzą przez pokój, mogli łatwo wyszukać błąd OUT_OF_RANGE i wykryć, kiedy skończą.

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 zostały naruszone. 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 skorygować, ponawiając próbę z wycofaniem. Pamiętaj, że ponawianie operacji nieidempotentnych nie zawsze jest bezpieczne.

Wskazówki powyżej pomogą Ci zdecydować, czy wybrać FAILED_PRECONDITION, ABORTED czy UNAVAILABLE.

Mapowanie HTTP: 503 Usługa niedostępna
DATA_LOSS

Utrata lub uszkodzenie danych, których nie można odzyskać.

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

UpdatedWidget

W przypadku widżetów selectionInput zwraca sugestie autouzupełniania dla menu wielokrotnego wyboru.

Zapis JSON 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
Pola
widget

string

Identyfikator zaktualizowanego widżetu. Identyfikator musi być zgodny z identyfikatorem widżetu, który wywołał prośbę o aktualizację.
Widżet został zaktualizowany w odpowiedzi na działanie użytkownika. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
suggestions

object (SelectionItems)

Lista wyników autouzupełniania widżetu
Koniec pól wykluczających się wzajemnie.

SelectionItems

Lista wyników autouzupełniania widżetu.

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

object (SelectionItem)

Tablica obiektów SelectionItem.

SlashCommand

Metadane dotyczące polecenia po ukośniku w Google Chat.

Zapis JSON 
{
  "commandId": string
}
Pola
commandId

string (int64 format)

Identyfikator polecenia po ukośniku.

MatchedUrl

Dopasowany adres URL w wiadomości na czacie. Aplikacje do Google Chat mogą wyświetlać podgląd dopasowanych adresów URL. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu 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 emotikonu.

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 usunął wiadomość i w jaki sposób; W przyszłości możemy dodać więcej wartości. Szczegółowe informacje o tym, kiedy można usuwać wiadomości, znajdziesz w artykule Edytowanie i usuwanie wiadomości w Google Chat.

Wartości w polu enum
DELETION_TYPE_UNSPECIFIED Ta wartość nie jest używana.
CREATOR Użytkownik usunął własną wiadomość.
SPACE_OWNER Wiadomość została usunięta przez właściciela lub menedżera.
ADMIN Administrator Google Workspace usunął wiadomość. Administratorzy mogą usuwać dowolne wiadomości w pokoju, w tym wiadomości wysłane przez dowolnego członka pokoju lub aplikację do Google Chat.
APP_MESSAGE_EXPIRY Aplikacja do Google Chat usunęła własną wiadomość, gdy wygasła.
CREATOR_VIA_APP Aplikacja do Google Chat usunęła wiadomość w imieniu twórcy (przy użyciu uwierzytelniania użytkownika).
SPACE_OWNER_VIA_APP Aplikacja do Google Chat usunęła wiadomość w imieniu menedżera pokoju (przy użyciu uwierzytelniania użytkownika).
SPACE_MEMBER Wiadomość została usunięta przez użytkownika pokoju. Użytkownicy mogą usuwać wiadomości wysyłane przez aplikacje.

QuotedMessageMetadata

Informacje o wiadomości, którą cytuje inna wiadomość.

Podczas aktualizowania wiadomości nie możesz dodać ani zastąpić pola quotedMessageMetadata, ale możesz je usunąć.

Przykłady użycia znajdziesz w artykule Cytowanie innej wiadomości.

Zapis JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
Pola
name

string

Wymagane. Nazwa zasobu cytowanej wiadomości.

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

string (Timestamp format)

Wymagane. Sygnatura czasowa określająca, kiedy cytowana wiadomość została utworzona lub kiedy została ostatnio zaktualizowana.

Jeśli wiadomość została zmodyfikowana, użyj tego pola: lastUpdateTime. Jeśli wiadomość nigdy nie była edytowana, użyj createTime.

Jeśli wartość lastUpdateTime nie jest zgodna z najnowszą wersją cytowanej wiadomości, żądanie nie powiedzie się.
quoteType

enum (QuoteType)

Opcjonalnie: Określa typ cytatu. Jeśli nie jest ustawione, domyślnie przyjmuje wartość REPLY w ścieżce odczytu/zapisu wiadomości, aby zapewnić zgodność wsteczną.
quotedMessageSnapshot

object (QuotedMessageSnapshot)

Tylko dane wyjściowe. podgląd treści cytowanej wiadomości.
forwardedMetadata

object (ForwardedMetadata)

Tylko dane wyjściowe. Metadane dotyczące pokoju źródłowego cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.

QuoteType

Typ cytatu cytowanej wiadomości.

Wartości w polu enum
QUOTE_TYPE_UNSPECIFIED Zarezerwowane. Ta wartość nie jest używana.
REPLY

Gdy quoteType jest REPLY, możesz wykonać te czynności:

  • Jeśli odpowiadasz w wątku, możesz zacytować inną wiadomość z tego wątku.

  • Jeśli tworzysz wiadomość główną, możesz zacytować inną wiadomość główną w tym pokoju.
FORWARD

Gdy quoteType jest FORWARD, możesz zacytować:

  • Wiadomość z innego pokoju.

  • odpowiedź na wiadomość z innego wątku w tym samym pokoju,

QuotedMessageSnapshot

zawiera podsumowanie treści cytowanej wiadomości w momencie cytowania lub przekazywania dalej;

Zapis JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
Pola
sender

string

Tylko dane wyjściowe. Nazwa autora cytowanej wiadomości. Wypełniane w przypadku typów cytatów REPLY i FORWARD.
text

string

Tylko dane wyjściowe. Zrzut ekranu z treścią cytowanej wiadomości.
formattedText

string

Tylko dane wyjściowe. Zawiera cytowaną wiadomość text ze znacznikami dodanymi w celu obsługi formatowania,takiego jak hiperlinki, niestandardowe emotikony, znaczniki itp. Wypełniane tylko w przypadku typu cytatu FORWARD.
annotations[]

object (Annotation)

Tylko dane wyjściowe. Adnotacje przeanalizowane z treści cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.
attachments[]

object (Attachment)

Tylko dane wyjściowe. Załączniki, które były częścią cytowanej wiadomości. Są to kopie metadanych załącznika cytowanej wiadomości. Wartość podawana tylko w przypadku typu wyceny FORWARD.

ForwardedMetadata

Metadane dotyczące pokoju źródłowego, z którego przekazano wiadomość.

Zapis JSON 
{
  "space": string,
  "spaceDisplayName": string
}
Pola
space

string

Tylko dane wyjściowe. Nazwa zasobu pokoju źródłowego. Format: spaces/{space}
spaceDisplayName

string

Tylko dane wyjściowe. Wyświetlana nazwa źródłowego pokoju lub czatu prywatnego w momencie przekazywania. W przypadku SPACE jest to nazwa pokoju. W przypadku DIRECT_MESSAGE jest to nazwa drugiego uczestnika (np. „Użytkownik A”). W przypadku GROUP_CHAT jest to nazwa wygenerowana na podstawie imion uczestników, ograniczona do 5 osób, w tym twórcy (np. „Użytkownik A, Użytkownik B”).

AttachedGif

Obraz GIF określony przez adres URL.

Zapis JSON 
{
  "uri": string
}
Pola
uri

string

Tylko dane wyjściowe. Adres URL, pod którym znajduje się obraz GIF.

AccessoryWidget

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

Zapis JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
Pola
Typ działania. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
buttonList

object (ButtonList)

Lista przycisków.
Koniec pól wykluczających się wzajemnie.

Elementy

Elementy to dodatkowe komponenty, które mogą, ale nie muszą być powiązane z tekstem wiadomości podanym podczas jej tworzenia.

Zapis JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
Pola
citedSources[]

object (CitedSource)

Lista źródeł, które mają być wyświetlane pod wiadomością jako linki w stopce. Nie są one przywoływane w tekście. W przypadku odwołań w tekście użyj citations.
citations[]

object (Citation)

Lista cytatów w tekście, do których odwołuje się tekst wiadomości (za pomocą tagów <chat-citation>), które są renderowane jako interaktywne wizytówki.

CitedSource

Odniesienie do źródła informacji.

Zapis JSON 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
Pola
title

string

Wymagane. Tytuł CitedSource w postaci zwykłego tekstu. To pole nie obsługuje formatowania.
uri

string

Wymagane. Identyfikator URI wskazujący zasób, do którego odwołuje się ten element CitedSource.
snippet

object (Snippet)

Opcjonalnie: Fragment zawierający informacje bezpośrednio ze źródła.
footer

object (Footer)

Opcjonalnie: Dodatkowe informacje wyświetlane obok fragmentu w formie stopki.

Krótki opis

Obiekt fragmentu kodu reprezentujący fragment większego korpusu.

Zapis JSON 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
Pola
text

string

Opcjonalnie: Krótki fragment tekstu bezpośrednio z korpusu, który może być renderowany w Google Chat. Nie obsługuje formatu Markdown.
imagePreview

object (ElementsImage)

Opcjonalnie: Podgląd obrazu fragmentu podanego jako dane wejściowe podczas tworzenia cytatu.

ElementsImage

Obiekt zawierający różne sposoby reprezentowania obrazu. Obecnie obsługiwane reprezentacje: – obraz pobrany z identyfikatora URI. W przyszłości możemy dodać obsługę innych reprezentacji.

Zapis JSON 
{

  "imageUri": string
}
Pola
Wymagane. Jedna z obsługiwanych reprezentacji obrazu. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
imageUri

string

Wymagane. Publicznie dostępny identyfikator URI obrazu.
Koniec pól wykluczających się wzajemnie.

Stopka źródła używana do atrybucji.

Zapis JSON 
{
  "text": string
}
Pola
text

string

Opcjonalnie: Tekst do wyświetlenia w stopce.

Cytat

Cytaty to odwołania w tekście, które mogą dostarczać użytkownikom bardziej szczegółowych informacji. Odpowiednie cytaty w tekście powinny być obecne w tekście wiadomości w formacie znaczników <chat-citation data-id="{id}">{text}</chat-citation>. Cytaty są obsługiwane tylko wtedy, gdy parametr markupSyntax wiadomości jest ustawiony na MARKDOWN.

Cytaty bez odniesień w Elements.citations (te bez pasującego tagu <chat-citation> w tekście wiadomości) są ignorowane i nie powodują odrzucenia wiadomości.

Zapis JSON 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
Pola
id

string

Wymagane. Identyfikator zdefiniowany przez aplikację. Może zawierać tylko litery i cyfry ASCII oraz mieć mniej niż 63 znaki.
citedSources[]

object (CitedSource)

Opcjonalnie: Lista źródeł powiązanych z cytatem. Źródła są wyświetlane na karcie informacyjnej cytatu.

MarkupSyntax

Określa składnię znaczników używaną do formatowania tekstu wiadomości na czacie. Dotyczy pola text zasobu Message.

Wartości w polu enum
MARKUP_SYNTAX_UNSPECIFIED Reprezentuje nieokreśloną wartość.
MARKUP_SYNTAX_CHAT Używa składni znaczników Google Chat. Więcej informacji znajdziesz na stronie https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Używa składni języka Markdown. Ta składnia jest oparta na specyfikacji CommonMark z dodatkowymi rozszerzeniami. Więcej informacji znajdziesz na stronie https://developers.google.com/workspace/chat/format-messages#format-texts.

Metody

create

 Tworzy wiadomość w pokoju Google Chat.

delete

 Usuwa wiadomość.

get

 Zwraca szczegółowe informacje o wiadomości.

list

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

patch

 Aktualizuje wiadomość.

replaceCards

 Zastępuje karty zawarte w wiadomości.
Wyszukuje wiadomości w Google Chat, do których użytkownik dzwoniący ma dostęp.

update

 Aktualizuje wiadomość.