Method: projects.locations.dataStores.widgetConfigs.get

Ruft eine WidgetConfig ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Vollständiger Ressourcenname für WidgetConfig. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

Suchparameter

Parameter
acceptCache

boolean

Optional. Gibt an, ob die Widget-Konfiguration aus dem Cache geladen werden darf. Wenn diese Option auf „true“ gesetzt ist, kann es einige Minuten dauern, bis sich Änderungen an Widget-Konfigurationen in der Ansicht des Endnutzers widerspiegeln. Für ausgereifte Widgets wird empfohlen, diesen Wert auf „true“ zu setzen, da dies die Leistung des Widgets verbessert. Wenn Sie den Wert auf „false“ setzen, werden Änderungen sofort in der Produktionsumgebung übernommen, sofern sich Ihr Widget in der Entwicklung befindet.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Optional. Optionen für GetWidgetConfigRequest.
languageCode

string

Optional. BCP-47-Sprachtag (z.B. „en“, „fr-CA“). Wird verwendet, um für Menschen lesbare Strings in der Antwort zu lokalisieren, z. B. die Modellauswahl displayName / description auf WidgetConfig.UiSettings.ModelConfigInfo. Wenn das Feld leer ist oder nicht festgelegt wurde, wird die Standardsprache (Englisch) verwendet.
modelInfoView

enum (ModelInfoView)

Optional. Gibt an, welche Ansicht von WidgetConfig.UiSettings.ModelConfigInfo im Backend berechnet wird. MODEL_INFO_VIEW_ADMIN wird vom Cloud Console-Administrator auf der Seite „Funktionsverwaltung“ (screen/4Vn9gQKbN8tb7gm) festgelegt, um das vom Administrator angezeigte Modellset mit ResolvedModel.admin_view zu empfangen. Wenn MODEL_INFO_VIEW_ADMIN nicht festgelegt ist oder MODEL_INFO_VIEW_WEB zurückgegeben wird, wird die Endnutzerauswahl angezeigt. Die mobile Oberfläche wird stattdessen aus dem X-Goog-Gemini-Enterprise-Mobile-Header erkannt (siehe ModelInfoView).

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von WidgetConfig.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.widgetConfigs.get

Weitere Informationen finden Sie in der IAM-Dokumentation.