Method: projects.locations.collections.engines.widgetConfigs.get

WidgetConfig을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/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의 옵션입니다.

요청 본문

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

응답 본문

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

승인 범위

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

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

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

  • discoveryengine.widgetConfigs.get

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