Method: projects.locations.dataStores.widgetConfigs.get

Recebe um WidgetConfig.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/dataStores/*/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. Indica se é aceitável carregar a configuração do widget do cache. Se definido como verdadeiro, 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 verdadeiro para widgets desenvolvidos, porque isso melhora a performance. Defina como falso para que as mudanças sejam refletidas na produção imediatamente, se o widget estiver em desenvolvimento.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

Opcional. Opções para GetWidgetConfigRequest.
languageCode

string

Opcional. Tag de idioma BCP-47 (por exemplo, "en", "fr-CA"). Usado para localizar strings legíveis por humanos na resposta, como o seletor de modelo displayName / description em WidgetConfig.UiSettings.ModelConfigInfo. Se estiver vazio ou não definido, o idioma padrão será usado (inglês).
modelInfoView

enum (ModelInfoView)

Opcional. Seleciona qual visualização de WidgetConfig.UiSettings.ModelConfigInfo o back-end calcula. MODEL_INFO_VIEW_ADMIN é definido pela página "Gerenciamento de recursos" do administrador do Console do Cloud (tela/4Vn9gQKbN8tb7gm) para receber o conjunto de modelos exibido pelo administrador com ResolvedModel.admin_view preenchido. Se não estiver definido ou MODEL_INFO_VIEW_WEB, o seletor do usuário final será retornado. A superfície móvel é detectada no cabeçalho X-Goog-Gemini-Enterprise-Mobile (consulte ModelInfoView).

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