Method: projects.chatAppConfig.get

プロジェクトの Chat 用アプリの構成を取得します。Google Workspace アドオンとして構築された Chat アプリのみがサポートされます。各 Google Cloud プロジェクトには、Chat 用アプリの構成が 1 つだけあります。

ユーザー認証情報と、プロジェクトに対する gsuiteaddons.chatAppConfigs.get および chat.bots.get IAM 権限による認証と認可が必要です。

HTTP リクエスト

GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/chatAppConfig}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。Chat アプリ構成のリソース名。

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

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gsuiteaddons.chatAppConfigs.get
  • chat.bots.get

クエリ パラメータ

パラメータ
view

enum (ChatAppConfigView)

省略可。返される ChatAppConfig のビュー。指定しない場合のデフォルトは BASIC です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には ChatAppConfig のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

詳しくは、承認ガイドをご覧ください。

ChatAppConfigView

ChatAppConfig リソースに入力するフィールドを指定するビュー。

列挙型
CHAT_APP_CONFIG_VIEW_UNSPECIFIED デフォルト値または未設定値。デフォルトは BASIC です。
BASIC アプリ構成に関する基本的なメタデータのみが入力され、インタラクティブ機能の構成は入力されません。これがデフォルト値です。
FULL インタラクティブ機能の構成を含むすべてのフィールドに入力します。