REST Resource: projects.chatAppConfig

Zasób: ChatAppConfig

Reprezentuje konfigurację aplikacji Google Chat utworzonej jako dodatek do Google Workspace.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Pola
name

string

Wymagane. Identyfikator. Nazwa zasobu konfiguracji aplikacji Google Chat.

Format: projects/{project}/chatAppConfig, gdzie {project} to numer projektu Google Cloud.
displayName

string

Wymagane. Wyświetlana nazwa aplikacji Google Chat. Powinna mieć od 3 do 25 znaków.
description

string

Wymagane. Krótki opis aplikacji do Google Chat. Powinien mieć od 1 do 40 znaków.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Opcjonalnie: Ustawienia funkcji interaktywnych aplikacji. Jeśli nie zostaną podane, aplikacja nie będzie interaktywna, co oznacza, że będzie mogła korzystać z interfejsu Chat API, ale użytkownicy nie będą mogli z nią wchodzić w interakcje.
avatarUri

string

Opcjonalnie: Adres URL awatara aplikacji. Musi to być adres URL HTTPS kwadratowego obrazu PNG o formacie obrazu 1:1. Minimalny zalecany rozmiar: 256 × 256 pikseli. Jeśli awatar aplikacji nie zostanie wskazany, użyty zostanie awatar domyślny.
state

enum (AppState)

Opcjonalnie: Stan aplikacji. Jeśli nie zostanie podany, domyślnie przyjmuje wartość ACTIVE.
errorLoggingEnabled

boolean

Opcjonalnie: Określa, czy błędy mają być logowane w Cloud Logging. Jeśli nie zostanie podany, domyślnie przyjmuje się false.
markupSyntax

enum (MarkupSyntax)

Opcjonalnie: Domyślna składnia znaczników wiadomości wysyłanych lub odczytywanych przez tę aplikację do Google Chat. Jeśli nie zostanie określona, domyślnie będzie to MARKUP_SYNTAX_MARKDOWN.

AppState

Bieżący stan aplikacji Google Chat.

Wartości w polu enum
APP_STATE_UNSPECIFIED Wartość domyślna. Nie określono.
ACTIVE Mapuje na LIVE na stronie konfiguracji interfejsu Chat API. Aplikacja jest aktywna, może być wyszukiwana i używana przez osoby, które mają do niej dostęp.
DISABLED Aplikacja jest wyłączona, nikt nie może jej znaleźć ani z nią rozmawiać.

InteractiveFeatureConfig

Ustawienia funkcji interaktywnych aplikacji.

Zapis JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Pola
connectionConfig

object (ConnectionConfig)

Wymagane. Jak aplikacja odbiera zdarzenia z Google Chat.
appCommands[]

object (AppCommand)

Opcjonalnie: Konfiguracja poleceń aplikacji.
urlPatterns[]

object (UrlPattern)

Opcjonalnie: Konfiguracja podglądu linków.
allowlistedTestingPrincipals[]

string

Opcjonalnie: Adresy e-mail użytkowników i grup w domenie Google Workspace, którzy mogą znaleźć aplikację i z niej korzystać.
supportsMultiuserSpaces

boolean

Opcjonalnie: Czy aplikację można dodawać do czatów 1:1, czatów grupowych i pokoi. Jeśli nie zostanie podany, domyślnie przyjmuje się false.

ConnectionConfig

Sposób, w jaki aplikacja odbiera zdarzenia.

Zapis JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Pola
Typ połączenia. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
httpEndpointConfig

object (HttpEndpointConfig)

Konfiguracja punktu końcowego HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Konfiguracja wdrożenia Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Konfiguracja tematu Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Konfiguracja Dialogflow.
Koniec pól wykluczających się wzajemnie.

HttpEndpointConfig

Konfiguracja punktu końcowego HTTP.

Zapis JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Pola
Konfiguracja adresu URL punktu końcowego HTTP. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
commonUrl

string

Opcjonalnie: Adres URL HTTPS, na który Google Chat wysyła wszystkie zdarzenia interaktywne.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Opcjonalnie: Oddzielne adresy URL HTTPS, na które Google Chat wysyła poszczególne typy zdarzeń interaktywnych.
Koniec pól wykluczających się wzajemnie.

HttpPerEventEndpointConfig

Konfiguracja punktu końcowego HTTP dla określonych typów zdarzeń.

Zapis JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Pola
appCommandEndpoint

string

Wymagane. Punkt końcowy adresu URL HTTPS dla zdarzeń poleceń aplikacji.
addedToSpaceEndpoint

string

Wymagane. Punkt końcowy adresu URL HTTPS dla zdarzeń dodania do pokoju.
messageEndpoint

string

Wymagane. Punkt końcowy adresu URL HTTPS dla zdarzeń wiadomości.
removedFromSpaceEndpoint

string

Wymagane. Punkt końcowy adresu URL HTTPS dla zdarzeń usunięcia z pokoju.

AppsScriptEndpointConfig

Konfiguracja punktu końcowego Apps Script.

Zapis JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Pola
deploymentId

string

Wymagane. Identyfikator wdrożenia Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Opcjonalnie: Nazwy funkcji Apps Script, które Google Chat wywołuje w przypadku każdego typu zdarzenia interaktywnego. Jeśli nie zostanie określona, Google Chat wywoła domyślną funkcję dla każdego typu zdarzenia.

AppsScriptPerEventEndpointConfig

Konfiguracja punktu końcowego Apps Script dla określonych typów zdarzeń.

Zapis JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Pola
appCommandEndpoint

string

Opcjonalnie: Nazwa funkcji zdarzeń poleceń aplikacji. Jeśli nie zostanie określona, użyta zostanie domyślna nazwa funkcji onAppCommand.
addedToSpaceEndpoint

string

Opcjonalnie: Nazwa funkcji dla zdarzeń dodania do pokoju. Jeśli nie zostanie określona, użyta zostanie domyślna nazwa funkcji onAddedToSpace.
messageEndpoint

string

Opcjonalnie: Nazwa funkcji zdarzeń związanych z wiadomościami. Jeśli nie zostanie określona, użyta zostanie domyślna nazwa funkcji onMessage.
removedFromSpaceEndpoint

string

Opcjonalnie: Nazwa funkcji dla zdarzeń usunięcia z pokoju. Jeśli nie zostanie określona, użyta zostanie domyślna nazwa funkcji onRemovedFromSpace.

CloudPubSubEndpointConfig

Konfiguracja punktu końcowego Pub/Sub.

Zapis JSON 
{
  "topic": string
}
Pola
topic

string

Wymagane. Temat Pub/Sub, w którym Google Chat publikuje wszystkie zdarzenia interaktywne. Temat musi być w tym samym projekcie w chmurze Google co aplikacja, a Google Chat musi mieć uprawnienia do publikowania wiadomości w tym temacie. Szczegółowe informacje znajdziesz w artykule Tworzenie aplikacji Google Chat za pomocą Pub/Sub.

Format: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Konfiguracja punktu końcowego Dialogflow.

Zapis JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Pola
dialogflowEdition

enum (DialogflowEdition)

Wymagane. Wersja Dialogflow.
agent

string

Opcjonalnie: Nazwa agenta lub środowiska Dialogflow CX. Wymagane w przypadku Dialogflow CX. Nie ustawiaj w przypadku Dialogflow ES.

Format: projects/{project}/locations/{location}/agents/{agent} lub projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Typ wersji Dialogflow.

Wartości w polu enum
DIALOGFLOW_EDITION_UNSPECIFIED Wartość domyślna. Nie określono.
ES Wersja Dialogflow ES. Aby korzystać z tej wersji, agent Dialogflow ES musi znajdować się w tym samym projekcie w chmurze Google Cloud co aplikacja. Google Chat wysyła wszystkie zdarzenia interaktywne do tego agenta.
CX Wersja Dialogflow CX. Aby korzystać z tej wersji, agent Dialogflow CX musi znajdować się w tym samym projekcie w chmurze Google co aplikacja i być określony w polu agent. Google Chat wysyła wszystkie zdarzenia interaktywne do tego agenta.

AppCommand

Konfiguracja polecenia aplikacji.

Zapis JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Pola
commandType

enum (CommandType)

Wymagane. Typ tego polecenia.
commandId

integer

Wymagane. Identyfikator polecenia (1–1000). Musi być unikalny w aplikacji.
command

string

Opcjonalnie: Nazwa polecenia. Wymagane w przypadku polecenia SLASH_COMMAND, nie ustawiaj dla innych typów poleceń. Musi zaczynać się od „/”, np. „/polecenie”.
displayName

string

Opcjonalnie: Przyjazna dla użytkownika wyświetlana nazwa polecenia. Wymagane w przypadku MESSAGE_ACTION i QUICK_COMMAND, nie ustawiaj dla SLASH_COMMAND.
description

string

Wymagane. Krótki opis polecenia.
dialogEnabled

boolean

Opcjonalnie: Określa, czy to polecenie powinno wywołać okno. Jeśli nie zostanie podany, domyślnie przyjmuje się false.
loadingNotificationMessage

string

Opcjonalnie: Powiadomienie, które zostanie wysłane do użytkownika, gdy aktywuje on działanie związane z wiadomością. Obsługiwane tylko w przypadku poleceń MESSAGE_ACTION.

CommandType

Typ polecenia aplikacji.

Wartości w polu enum
COMMAND_TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
SLASH_COMMAND Polecenie wywoływane przez wpisanie „/”, a po nim nazwy polecenia. Może akceptować dodatkowe argumenty w tekście wiadomości.
QUICK_COMMAND Szybkie polecenie wywołane z menu kontekstowego tworzenia wiadomości. Szybkie polecenia nie akceptują dodatkowych argumentów.
MESSAGE_ACTION Polecenie wywołane z menu kontekstowego wiadomości.

UrlPattern

Konfiguracja podglądu linku.

Zapis JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Pola
hostPattern

string

Wymagane. Domena do dopasowania. Dopasuj konkretną subdomenę, np. „subdomena.example.com”, lub całą domenę, dodając gwiazdkę (*) jako początkowy symbol wieloznaczny. Na przykład „*.example.com” pasuje do „https://subdomain.example.com” i „https://any.number.of.subdomains.example.com”.
pathPrefix

string

Opcjonalnie: Prefiks ścieżki dołączany do wzorca hosta. Brak wartości oznacza dopasowanie do wszystkich adresów URL we wzorcu hosta. Na przykład w przypadku wzorca hosta „subdomain.example.com” podaj „path/”, aby dopasować adresy URL stron z dopasowaniem zaczynające się od „https://subdomain.example.com/path/”.

MarkupSyntax

Składnia znaczników używana do formatowania tekstu wiadomości w tej aplikacji do Google Chat.

Wartości w polu enum
MARKUP_SYNTAX_UNSPECIFIED Wartość domyślna. Nie określono. Istniejące aplikacje Google Chat utworzone przed wprowadzeniem markup_syntax mają tę wartość i używają MARKUP_SYNTAX_CHAT, dopóki nie zostaną wyraźnie zaktualizowane.
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

get

 Pobiera konfigurację aplikacji do obsługi czatu w projekcie.

patch

 Aktualizuje konfigurację aplikacji do Google Chat w projekcie.