Method: projects.locations.userEvents.write

Grava um único evento do usuário.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}/userEvents:write

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai. Se a ação de gravação do evento do usuário for aplicada no nível DataStore, o formato será: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. Se a ação de gravação de evento do usuário for aplicada no nível Location, por exemplo, o evento com Document em vários DataStore, o formato será: projects/{project}/locations/{location}.

Parâmetros de consulta

Parâmetros
writeAsync

boolean

Se definido como "true", o evento do usuário será gravado de forma assíncrona após a validação, e a API vai responder sem esperar a gravação.

Corpo da solicitação

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

Corpo da resposta

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

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 parent:

  • discoveryengine.userEvents.create

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