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

WidgetConfig を取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
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 のドキュメントをご覧ください。