Method: projects.locations.dataStores.widgetConfigs.get

WidgetConfig을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/dataStores/*/widgetConfigs/*}

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

경로 매개변수

매개변수
name

string

필수 항목. 전체 WidgetConfig 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

쿼리 파라미터

파라미터
acceptCache

boolean

선택사항. 위젯 구성을 캐시에서 로드하는 것이 허용되는지 여부입니다. true로 설정하면 위젯 구성에 대한 최근 변경사항이 최종 사용자 뷰에 반영되는 데 몇 분 정도 걸릴 수 있습니다. 이미 안정적으로 개발된 위젯의 경우 성능이 향상되도록 true로 설정하는 것이 좋습니다. 위젯이 개발 중이면 변경사항이 프로덕션에 즉시 반영되도록 false로 설정합니다.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

선택사항. GetWidgetConfigRequest의 옵션입니다.
languageCode

string

선택사항입니다. BCP-47 언어 태그 (예: 'en', 'fr-CA')입니다. WidgetConfig.UiSettings.ModelConfigInfo의 모델 선택기 displayName / description와 같이 응답에서 사람이 읽을 수 있는 문자열을 현지화하는 데 사용됩니다. 비어 있거나 설정되지 않은 경우 기본 언어 (영어)로 대체됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 WidgetConfig의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview에서 확인하세요.

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.widgetConfigs.get

자세한 내용은 IAM 문서를 참조하세요.