Method: projects.locations.collections.engines.getWorkspaceSettings

エンドユーザーの Workspace 設定を取得します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:getWorkspaceSettings

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

パスパラメータ

パラメータ
name

string

必須。完全な Engine リソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

リクエストの本文

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

レスポンスの本文

エンドユーザーの Workspace 設定。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "workspaceAccessEnabled": boolean
}
フィールド
workspaceAccessEnabled

boolean

エンドユーザーのワークスペース アクセスが有効になっているかどうか。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.engines.get

詳細については、IAM のドキュメントをご覧ください。