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

Recebe um WidgetConfig.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Nome completo do recurso WidgetConfig. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

Parâmetros de consulta

Parâmetros
acceptCache

boolean

Opcional. Se é aceitável carregar a configuração do widget do cache. Se definido como "true", as mudanças recentes nas configurações do widget podem levar alguns minutos para aparecer na visualização do usuário final. Recomendamos definir como "true" para widgets desenvolvidos, já que isso melhora o desempenho deles. Defina como "false" para ver as mudanças refletidas na produção imediatamente, se o widget estiver em desenvolvimento.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Opcional. Opções para GetWidgetConfigRequest.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de WidgetConfig.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.widgetConfigs.get

Para mais informações, consulte a documentação do IAM.