Method: projects.locations.dataStores.widgetConfigs.patch

Atualiza um WidgetConfig.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação 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}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Indica quais campos do WidgetConfig fornecido serão atualizados. Estes são os únicos campos compatíveis:

Se não for definido, todos os campos com suporte serão atualizados.

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

Corpo da solicitação

O corpo da solicitação contém uma instância de WidgetConfig.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá 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.update

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