Method: projects.locations.dataStores.widgetConfigs.get

Obtém um WidgetConfig.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

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

Parâmetros de consulta

Parâmetros
acceptCache

boolean

Opcional. Determina se é aceitável carregar a configuração do widget a partir da cache. Se estiver definido como verdadeiro, as alterações recentes nas configurações dos widgets podem demorar alguns minutos a refletir-se na vista do utilizador final. Recomendamos que defina como verdadeiro para widgets desenvolvidos de forma madura, uma vez que melhora o desempenho dos widgets. Defina como falso para ver as alterações refletidas na produção imediatamente, se o widget estiver em desenvolvimento.

getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Opcional. Opções para GetWidgetConfigRequest.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de WidgetConfig.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.widgetConfigs.get

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