Method: projects.locations.dataStores.userEvents.write

Escribe un solo evento del usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal. Si la acción de escribir evento de usuario se aplica a nivel de DataStore, el formato es projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. Si la acción de escribir un evento de usuario se aplica en el nivel Location, por ejemplo, el evento con Document en varios DataStore, el formato es projects/{project}/locations/{location}.

Parámetros de consulta

Parámetros
writeAsync

boolean

Si se establece en verdadero, el evento del usuario se escribe de forma asíncrona después de la validación, y la API responde sin esperar la escritura.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de UserEvent.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de UserEvent.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.userEvents.create

Para obtener más información, consulta la documentación de IAM.