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

Obtienes una WidgetConfig.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
name

string

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

Parámetros de consulta

Parámetros
acceptCache

boolean

Opcional. Indica si se acepta cargar la configuración del widget desde la caché. Si se establece como verdadero, los cambios recientes en la configuración de los widgets pueden tardar unos minutos en reflejarse en la vista del usuario final. Se recomienda establecer este valor como verdadero para los widgets desarrollados de forma madura, ya que mejora el rendimiento del widget. Establece el valor en falso para ver los cambios reflejados en la producción de inmediato, si tu widget está en desarrollo.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Opcional. Opciones para GetWidgetConfigRequest.

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.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.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.