Method: projects.locations.collections.engines.getWorkspaceSettings

최종 사용자의 Workspace 설정을 가져옵니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 전체 엔진 리소스 이름입니다. 형식: 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 문서를 참조하세요.