com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.UserEvents

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.UserEvents

Enclosing class:

DiscoveryEngine.Projects.Locations

public class DiscoveryEngine.Projects.Locations.UserEvents
extends Object

The "userEvents" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.UserEvents.Collect
class	DiscoveryEngine.Projects.Locations.UserEvents.Write

Constructor Summary

Constructors

Constructor and Description
UserEvents()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.UserEvents.Collect	collect(String parent) Writes a single user event from the browser.
DiscoveryEngine.Projects.Locations.UserEvents.Write	write(String parent, GoogleCloudDiscoveryengineV1UserEvent content) Writes a single user event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserEvents

public UserEvents()

Method Detail

collect

public DiscoveryEngine.Projects.Locations.UserEvents.Collect collect(String parent)
                                                              throws IOException

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. Create a request for the method "userEvents.collect". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` .

Returns:

the request

Throws:

IOException

write

public DiscoveryEngine.Projects.Locations.UserEvents.Write write(String parent,
                                                                 GoogleCloudDiscoveryengineV1UserEvent content)
                                                          throws IOException

Writes a single user event. Create a request for the method "userEvents.write". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStore s/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.

content - the GoogleCloudDiscoveryengineV1UserEvent

Returns:

the request

Throws:

IOException