Method: projects.locations.collections.dataStores.widgetConfigs.patch

Atualize um WidgetConfig.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
widgetConfig.name

string

Imutável. O nome completo do recurso da configuração do widget. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Indica os campos no WidgetConfig fornecido a atualizar. Seguem-se os únicos campos suportados:

Se não estiver definido, todos os campos suportados são atualizados.

Esta é uma lista separada por vírgulas de nomes totalmente qualificados de campos. Exemplo: "user.displayName,photo".

Corpo do pedido

O corpo do pedido contém uma instância de WidgetConfig.

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.update

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