Method: projects.locations.dataStores.widgetConfigs.get

Obtienes una WidgetConfig.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre completo del recurso WidgetConfig. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

Parámetros de consulta

Parámetros
acceptCache

boolean

Es opcional. Indica si se puede cargar la configuración del widget desde la caché. Si se establece en verdadero, los cambios recientes en las configuraciones del widget pueden tardar unos minutos en reflejarse en la vista del usuario final. Se recomienda establecerlo en verdadero para los widgets desarrollados de forma madura, ya que mejora el rendimiento del widget. Establécelo en falso para ver los cambios reflejados en la producción de inmediato, si tu widget está en desarrollo.

getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Es opcional. Opciones para GetWidgetConfigRequest.

languageCode

string

Es opcional. Etiqueta de idioma BCP-47 (p.ej., "en", "fr-CA"). Se usa para localizar cadenas legibles por humanos en la respuesta, como el selector de modelos displayName / description en WidgetConfig.UiSettings.ModelConfigInfo. Si está vacío o no configurado, se revierte al idioma predeterminado (inglés).

modelInfoView

enum (ModelInfoView)

Es opcional. Selecciona qué vista de WidgetConfig.UiSettings.ModelConfigInfo calcula el backend. La página "Administración de funciones" (screen/4Vn9gQKbN8tb7gm) de la consola de Cloud establece MODEL_INFO_VIEW_ADMIN para recibir el conjunto de modelos expuesto por el administrador con ResolvedModel.admin_view propagado; si no se establece o se establece MODEL_INFO_VIEW_WEB, se muestra el selector del usuario final. La superficie móvil se detecta desde el encabezado X-Goog-Gemini-Enterprise-Mobile (consulta ModelInfoView).

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de WidgetConfig.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.widgetConfigs.get

Para obtener más información, consulta la documentación de IAM.