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

Obtiene un WidgetConfig.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a 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}

Los parámetros de consulta

Parámetros
acceptCache

boolean

Opcional. Indica si se puede cargar la configuración del widget desde la caché. Si se define como true, los cambios recientes en las configuraciones de los widgets pueden tardar unos minutos en reflejarse en la vista del usuario final. Se recomienda definir el valor como true en los widgets desarrollados, ya que mejora el rendimiento de los widgets. Asigna el valor "false" para que los cambios se reflejen en producción inmediatamente si tu widget está en fase de desarrollo.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Opcional. Opciones de GetWidgetConfigRequest.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de WidgetConfig.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.widgetConfigs.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.