REST Resource: projects.chatAppConfig

Ressource: ChatAppConfig

Stellt die Konfiguration einer Google Chat-App dar, die als Google Workspace-Add‑on erstellt wurde.

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

string

Erforderlich. ID. Ressourcenname der Chat-App-Konfiguration.

Format: projects/{project}/chatAppConfig, wobei {project} die Google Cloud-Projektnummer ist.
displayName

string

Erforderlich. Der Anzeigename der Chat-App. Die Länge sollte zwischen 3 und 25 Zeichen liegen.
description

string

Erforderlich. Eine kurze Beschreibung der Chat-App. Sie sollte zwischen 1 und 40 Zeichen lang sein.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Optional. Die Einstellungen für interaktive Funktionen der App. Wenn diese nicht angegeben sind, ist die App nicht interaktiv. Das bedeutet, dass sie die Chat API verwenden kann, Nutzer aber nicht mit der App interagieren können.
avatarUri

string

Optional. Die URL für das Avatarbild der Anwendung. Muss eine HTTPS-URL sein, die ein quadratisches PNG-Bild (Seitenverhältnis 1:1) hostet. Empfohlene Mindestgröße: 256 x 256 Pixel. Wenn nichts angegeben ist, wird ein Standard-App-Avatar verwendet.
state

enum (AppState)

Optional. Der Status der App. Wenn keine Angabe gemacht wird, ist der Standardwert ACTIVE.
errorLoggingEnabled

boolean

Optional. Gibt an, ob Fehler in Cloud Logging protokolliert werden sollen. Wenn keine Angabe gemacht wird, ist der Standardwert false.
markupSyntax

enum (MarkupSyntax)

Optional. Die Standard-Markup-Syntax für Nachrichten, die von dieser Chat-App gesendet oder gelesen werden. Wenn keine Angabe gemacht wird, ist der Standardwert MARKUP_SYNTAX_MARKDOWN.

AppState

Der aktuelle Status der Chat-App.

Enums
APP_STATE_UNSPECIFIED Standardwert. Nicht angegeben
ACTIVE Wird auf der Seite für die Chat API-Konfiguration zu LIVE zugeordnet. Die App ist aktiv und kann von Personen mit Sichtbarkeit gefunden und verwendet werden.
DISABLED Die App ist deaktiviert, kann nicht mehr gefunden werden und niemand kann mehr mit ihr interagieren.

InteractiveFeatureConfig

Einstellungen für die interaktiven Funktionen der App.

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

object (ConnectionConfig)

Erforderlich. Wie die App Ereignisse von Google Chat empfängt.
appCommands[]

object (AppCommand)

Optional. Konfiguration für App-Befehle.
urlPatterns[]

object (UrlPattern)

Optional. Konfiguration für Linkvorschauen.
allowlistedTestingPrincipals[]

string

Optional. Die E‑Mail-Adressen von Nutzern und Gruppen in Ihrer Google Workspace-Domain, die die App finden und verwenden können.
supportsMultiuserSpaces

boolean

Optional. Ob die App zu 1:1-DMs, Gruppenchats und Gruppenbereichen hinzugefügt werden kann. Wenn keine Angabe gemacht wird, ist der Standardwert false.

ConnectionConfig

Wie die App Ereignisse empfängt.

JSON-Darstellung 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Felder
Der Verbindungstyp. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
httpEndpointConfig

object (HttpEndpointConfig)

HTTP-Endpunktkonfiguration.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Apps Script-Bereitstellungskonfiguration.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Konfiguration von Pub/Sub-Themen.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Dialogflow-Konfiguration.
Ende der sich gegenseitig ausschließenden Felder.

HttpEndpointConfig

HTTP-Endpunktkonfiguration.

JSON-Darstellung 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Felder
Die URL-Konfiguration des HTTP-Endpunkts. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
commonUrl

string

Optional. Die HTTPS-URL, an die Google Chat alle interaktiven Ereignisse sendet.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Optional. Separate HTTPS-URLs, an die Google Chat die einzelnen Arten von interaktiven Ereignissen sendet.
Ende der sich gegenseitig ausschließenden Felder.

HttpPerEventEndpointConfig

HTTP-Endpunktkonfiguration für bestimmte Ereignistypen.

JSON-Darstellung 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Felder
appCommandEndpoint

string

Erforderlich. HTTPS-URL-Endpunkt für App-Befehlsereignisse.
addedToSpaceEndpoint

string

Erforderlich. HTTPS-URL-Endpunkt für Ereignisse, bei denen die App einem Gruppenbereich hinzugefügt wird.
messageEndpoint

string

Erforderlich. HTTPS-URL-Endpunkt für Nachrichtenereignisse.
removedFromSpaceEndpoint

string

Erforderlich. HTTPS-URL-Endpunkt für Ereignisse, bei denen die App aus einem Gruppenbereich entfernt wurde.

AppsScriptEndpointConfig

Konfiguration des Apps Script-Endpunkts.

JSON-Darstellung 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Felder
deploymentId

string

Erforderlich. Die Apps Script-Bereitstellungs-ID.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Optional. Die Namen der Apps Script-Funktionen, die Google Chat für jeden Typ von interaktivem Ereignis aufruft. Wenn nichts angegeben ist, ruft Google Chat die Standardfunktion für den jeweiligen Ereignistyp auf.

AppsScriptPerEventEndpointConfig

Apps Script-Endpunktkonfiguration für bestimmte Ereignistypen.

JSON-Darstellung 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Felder
appCommandEndpoint

string

Optional. Funktionsname für App-Befehlsereignisse. Wenn keine Angabe erfolgt, wird der Standardfunktionsname onAppCommand verwendet.
addedToSpaceEndpoint

string

Optional. Funktionsname für Ereignisse, die einem Gruppenbereich hinzugefügt wurden. Wenn keine Angabe erfolgt, wird der Standardfunktionsname onAddedToSpace verwendet.
messageEndpoint

string

Optional. Funktionsname für Nachrichtenereignisse. Wenn keine Angabe erfolgt, wird der Standardfunktionsname onMessage verwendet.
removedFromSpaceEndpoint

string

Optional. Funktionsname für Ereignisse, die aus dem Gruppenbereich entfernt wurden. Wenn keine Angabe erfolgt, wird der Standardfunktionsname onRemovedFromSpace verwendet.

CloudPubSubEndpointConfig

Pub/Sub-Endpunktkonfiguration.

JSON-Darstellung 
{
  "topic": string
}
Felder
topic

string

Erforderlich. Das Pub/Sub-Thema, in dem Google Chat alle interaktiven Ereignisse veröffentlicht. Das Thema muss sich im selben Google Cloud-Projekt wie die App befinden und Google Chat muss die Berechtigung haben, Nachrichten im Thema zu veröffentlichen. Weitere Informationen finden Sie unter Google Chat-App mit Pub/Sub erstellen.

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

DialogflowEndpointConfig

Konfiguration des Dialogflow-Endpunkts.

JSON-Darstellung 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Felder
dialogflowEdition

enum (DialogflowEdition)

Erforderlich. Die Dialogflow-Version.
agent

string

Optional. Der Name des Dialogflow CX-Agenten oder der Umgebung. Erforderlich für Dialogflow CX. Nicht für Dialogflow ES festlegen.

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

DialogflowEdition

Dialogflow-Versionstyp.

Enums
DIALOGFLOW_EDITION_UNSPECIFIED Standardwert. Nicht angegeben
ES Dialogflow ES-Version. Wenn Sie diese Version verwenden möchten, muss im selben Google Cloud-Projekt wie die App ein Dialogflow ES-Agent vorhanden sein. Google Chat sendet alle interaktiven Ereignisse an diesen Agenten.
CX Dialogflow CX-Version. Wenn Sie diese Version verwenden möchten, muss im selben Google Cloud-Projekt wie die App ein Dialogflow CX-Agent vorhanden sein und im Feld agent angegeben werden. Google Chat sendet alle interaktiven Ereignisse an diesen Agenten.

AppCommand

Konfiguration für einen App-Befehl.

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

enum (CommandType)

Erforderlich. Der Typ dieses Befehls.
commandId

integer

Erforderlich. Die ID des Befehls (1–1.000). Die ID muss innerhalb der App eindeutig sein.
command

string

Optional. Der Name des Befehls. Erforderlich für SLASH_COMMAND, nicht für andere Befehlstypen festlegen. Muss mit einem „/“ beginnen, z.B. „/command“.
displayName

string

Optional. Der nutzerfreundliche Anzeigename des Befehls. Erforderlich für MESSAGE_ACTION und QUICK_COMMAND, nicht für SLASH_COMMAND festlegen.
description

string

Erforderlich. Eine kurze Beschreibung des Befehls.
dialogEnabled

boolean

Optional. Gibt an, ob dieser Befehl ein Dialogfeld auslösen soll. Wenn keine Angabe gemacht wird, ist der Standardwert false.
loadingNotificationMessage

string

Optional. Eine Benachrichtigung, die an den Nutzer gesendet wird, wenn er die Nachrichtenaktion auslöst. Wird nur für MESSAGE_ACTION-Befehle unterstützt.

CommandType

Der Typ des App-Befehls.

Enums
COMMAND_TYPE_UNSPECIFIED Standardwert. Nicht angegeben
SLASH_COMMAND Ein Befehl, der durch Eingabe von „/“ gefolgt vom Befehlsnamen aufgerufen wird. Es kann zusätzliche Argumente im Nachrichtentext akzeptieren.
QUICK_COMMAND Ein Schnellbefehl, der über das Kontextmenü zum Verfassen von Nachrichten aufgerufen wird. Schnellbefehle akzeptieren keine zusätzlichen Argumente.
MESSAGE_ACTION Ein Befehl, der über ein Nachrichtenkontextmenü aufgerufen wird.

UrlPattern

Konfiguration für eine Linkvorschau.

JSON-Darstellung 
{
  "hostPattern": string,
  "pathPrefix": string
}
Felder
hostPattern

string

Erforderlich. Die Domain, die als passend zugeordnet werden soll. Sie können eine bestimmte Subdomain wie „subdomain.beispiel.de“ oder eine ganze Domain abgleichen, indem Sie ein Sternchen (*) als vorangestelltes Platzhalterzeichen einfügen. Beispiel: „*.beispiel.de“ stimmt mit „https://subdomain.beispiel.de“ und „https://beliebige.anzahl.von.subdomains.beispiel.de“ überein.
pathPrefix

string

Optional. Pfadpräfix, das an das Hostmuster angehängt wird. Wenn das Feld leer ist, werden alle URLs im Hostmuster abgeglichen. Wenn Sie beispielsweise das Hostmuster „subdomain.beispiel.de“ verwenden, geben Sie „pfad/“ an, um Seiten-URLs abzugleichen, die mit „https://subdomain.beispiel.de/pfad/“ beginnen.

MarkupSyntax

Die Markup-Syntax, die zum Formatieren von Nachrichtentext für diese Chat-App verwendet wird.

Enums
MARKUP_SYNTAX_UNSPECIFIED Standardwert. Nicht angegeben Vor der Einführung von markup_syntax erstellte Chat-Apps haben diesen Wert und verwenden MARKUP_SYNTAX_CHAT, bis sie explizit aktualisiert werden.
MARKUP_SYNTAX_CHAT Verwendet die Markup-Syntax von Google Chat. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Verwendet Markdown-Syntax. Diese Syntax basiert auf der CommonMark-Spezifikation mit zusätzlichen Erweiterungen. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts.

Methoden

get

 Ruft die Chat-App-Konfiguration eines Projekts ab.

patch

 Aktualisiert die Chat-App-Konfiguration eines Projekts.