REST Resource: projects.chatAppConfig

リソース: ChatAppConfig

Google Workspace アドオンとして構築された Google Chat アプリの構成を表します。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
フィールド
name

string

必須。ID。Chat アプリの設定のリソース名。

形式: projects/{project}/chatAppConfig。ここで、{project} は Google Cloud プロジェクト番号です。
displayName

string

必須。Chat 用アプリの表示名。長さは 3 ～ 25 文字にする必要があります。
description

string

必須。Chat 用アプリの簡単な説明。1 ～ 40 文字で指定してください。
interactiveFeatureConfig

object (InteractiveFeatureConfig)

省略可。アプリのインタラクティブ機能の設定。これが指定されていない場合、アプリは非インタラクティブになります。つまり、Chat API を使用できますが、ユーザーはアプリを操作できません。
avatarUri

string

省略可。アプリのアバター画像の URL。正方形（アスペクト比 1:1）の PNG 画像をホストする HTTPS URL を指定してください。推奨最小サイズ: 256 × 256 ピクセル。指定しない場合は、デフォルトのアプリのアバターが使用されます。
state

enum (AppState)

省略可。アプリの状態。指定しない場合のデフォルトは ACTIVE です。
errorLoggingEnabled

boolean

省略可。Cloud Logging にエラーを記録するかどうか。指定しない場合のデフォルトは false です。
markupSyntax

enum (MarkupSyntax)

省略可。この Chat 用アプリが送受信するメッセージのデフォルトのマークアップ構文。指定しない場合のデフォルトは MARKUP_SYNTAX_MARKDOWN です。

AppState

Chat 用アプリの現在の状態。

列挙型
APP_STATE_UNSPECIFIED デフォルト値。指定なし。
ACTIVE Chat API 構成ページの LIVE にマッピングされます。アプリは有効です。公開設定されているユーザーがアプリを検索して使用できます。
DISABLED アプリは無効になり、誰にも見つからなくなります。また、誰もアプリと会話できなくなります。

InteractiveFeatureConfig

アプリのインタラクティブな機能の設定。

JSON 表現 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
フィールド
connectionConfig

object (ConnectionConfig)

必須。アプリが Google Chat からイベントを受信する方法。
appCommands[]

object (AppCommand)

省略可。アプリコマンドの構成。
urlPatterns[]

object (UrlPattern)

省略可。リンク プレビューの構成。
allowlistedTestingPrincipals[]

string

省略可。アプリを検索して使用できる、Google Workspace ドメイン内のユーザーとグループのメールアドレス。
supportsMultiuserSpaces

boolean

省略可。アプリを 1 対 1 の人間との DM、グループ チャット、スペースに追加できるかどうか。指定しない場合のデフォルトは false です。

ConnectionConfig

アプリがイベントを受信する方法。

JSON 表現 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
フィールド
接続のタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
httpEndpointConfig

object (HttpEndpointConfig)

HTTP エンドポイントの構成。
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Apps Script のデプロイ構成。
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Pub/Sub トピックの構成。
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Dialogflow の構成。
相互に排他的なフィールドの終了。

HttpEndpointConfig

HTTP エンドポイントの構成。

JSON 表現 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
フィールド
HTTP エンドポイント URL の構成。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
commonUrl

string

省略可。Google Chat がすべてのインタラクティブ イベントを送信する HTTPS URL。
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

省略可。Google Chat が各タイプのインタラクティブ イベントを送信する個別の HTTPS URL。
相互に排他的なフィールドの終了。

HttpPerEventEndpointConfig

特定のイベントタイプの HTTP エンドポイント構成。

JSON 表現 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
フィールド
appCommandEndpoint

string

必須。アプリコマンド イベントの HTTPS URL エンドポイント。
addedToSpaceEndpoint

string

必須。スペースへの追加イベントの HTTPS URL エンドポイント。
messageEndpoint

string

必須。メッセージ イベントの HTTPS URL エンドポイント。
removedFromSpaceEndpoint

string

必須。スペースから削除されたイベントの HTTPS URL エンドポイント。

AppsScriptEndpointConfig

Apps Script エンドポイントの構成。

JSON 表現 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
フィールド
deploymentId

string

必須。Apps Script のデプロイ ID。
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

省略可。各タイプのインタラクティブ イベントに対して Google Chat が呼び出す Apps Script 関数の名前。指定しない場合、Chat はイベントタイプごとにデフォルトの関数を呼び出します。

AppsScriptPerEventEndpointConfig

特定のイベントタイプに対する Apps Script エンドポイントの構成。

JSON 表現 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
フィールド
appCommandEndpoint

string

省略可。アプリコマンド イベントの関数名。指定しない場合は、デフォルトの onAppCommand 関数名が使用されます。
addedToSpaceEndpoint

string

省略可。スペースへの追加イベントの関数名。指定しない場合は、デフォルトの onAddedToSpace 関数名が使用されます。
messageEndpoint

string

省略可。メッセージ イベントの関数名。指定しない場合は、デフォルトの onMessage 関数名が使用されます。
removedFromSpaceEndpoint

string

省略可。スペースから削除されたイベントの関数名。指定しない場合は、デフォルトの onRemovedFromSpace 関数名が使用されます。

CloudPubSubEndpointConfig

Pub/Sub エンドポイントの構成。

JSON 表現 
{
  "topic": string
}
フィールド
topic

string

必須。Google Chat がすべてのインタラクティブ イベントをパブリッシュする Pub/Sub トピック。トピックはアプリと同じ Google Cloud プロジェクトに存在する必要があり、Chat にはトピックにメッセージを公開する権限が必要です。詳しくは、Pub/Sub を使用して Google Chat アプリを構築するをご覧ください。

形式: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Dialogflow エンドポイントの構成。

JSON 表現 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
フィールド
dialogflowEdition

enum (DialogflowEdition)

必須。Dialogflow のエディション。
agent

string

省略可。Dialogflow CX エージェントまたは環境の名前。Dialogflow CX に必要です。Dialogflow ES には設定しないでください。

形式: projects/{project}/locations/{location}/agents/{agent} または projects/{project}/locations/{location}/agents/{agent}/environments/{environment}

DialogflowEdition

Dialogflow のエディション タイプ。

列挙型
DIALOGFLOW_EDITION_UNSPECIFIED デフォルト値。指定なし。
ES Dialogflow ES エディション。このエディションを使用するには、アプリと同じ Google Cloud プロジェクトに Dialogflow ES エージェントが存在する必要があります。Google Chat は、すべてのインタラクティブ イベントをそのエージェントに送信します。
CX Dialogflow CX エディション。このエディションを使用するには、Dialogflow CX エージェントがアプリと同じ Google Cloud プロジェクトに存在し、agent フィールドで指定されている必要があります。Google Chat は、すべてのインタラクティブ イベントをそのエージェントに送信します。

AppCommand

アプリコマンドの構成。

JSON 表現 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
フィールド
commandType

enum (CommandType)

必須。このコマンドのタイプ。
commandId

integer

必須。コマンドの ID（1 ～ 1,000）。アプリ内で一意である必要があります。
command

string

省略可。コマンドの名前。SLASH_COMMAND の場合は必須です。他のコマンドタイプには設定しないでください。「/」で始める必要があります（例: 「/command」）。
displayName

string

省略可。コマンドのユーザー フレンドリーな表示名。MESSAGE_ACTION と QUICK_COMMAND の場合は必須です。SLASH_COMMAND の場合は設定しないでください。
description

string

必須。コマンドの簡単な説明。
dialogEnabled

boolean

省略可。このコマンドでダイアログをトリガーするかどうか。指定しない場合のデフォルトは false です。
loadingNotificationMessage

string

省略可。ユーザーがメッセージ操作をトリガーしたときにユーザーに送信される通知。MESSAGE_ACTION コマンドでのみサポートされます。

CommandType

アプリコマンドのタイプ。

列挙型
COMMAND_TYPE_UNSPECIFIED デフォルト値。指定なし。
SLASH_COMMAND 「/」の後にコマンド名を入力して呼び出すコマンド。メッセージ テキストに追加の引数を受け入れることができます。
QUICK_COMMAND メッセージ作成のコンテキスト メニューから呼び出されるクイック コマンド。クイック コマンドは追加の引数を受け入れません。
MESSAGE_ACTION メッセージのコンテキスト メニューから呼び出されるコマンド。

UrlPattern

リンク プレビューの構成。

JSON 表現 
{
  "hostPattern": string,
  "pathPrefix": string
}
フィールド
hostPattern

string

必須。照合するドメイン。「subdomain.example.com」などの特定のサブドメイン、または先頭にワイルドカード文字としてアスタリスク（*）を付けてドメイン全体を一致させます。たとえば、「*.example.com」は「https://subdomain.example.com」と「https://any.number.of.subdomains.example.com」に一致します。
pathPrefix

string

省略可。ホストパターンに追加されるパスの接頭辞。空白のままにすると、ホストパターンのすべての URL にマッチングします。たとえば、ホストパターン「subdomain.example.com」と組み合わせて「path/」を指定すると、「https://subdomain.example.com/path/」で始まる一致するページ URL にマッチングします。

MarkupSyntax

この Chat 用アプリのメッセージ テキストの書式設定に使用されるマークアップ構文。

列挙型
MARKUP_SYNTAX_UNSPECIFIED デフォルト値。指定なし。markup_syntax が導入される前に作成された既存の Chat アプリにはこの値があり、明示的に更新されるまで MARKUP_SYNTAX_CHAT を使用します。
MARKUP_SYNTAX_CHAT Google Chat のマークアップ構文を使用します。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。
MARKUP_SYNTAX_MARKDOWN Markdown 構文を使用します。この構文は CommonMark 仕様に基づいており、追加の拡張機能が用意されています。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。

メソッド

get

 プロジェクトの Chat 用アプリの構成を取得します。

patch

 プロジェクトの Chat 用アプリの構成を更新します。