com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.UserEvents

java.lang.Object

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

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores

public class DiscoveryEngine.Projects.Locations.DataStores.UserEvents
extends Object

The "userEvents" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
UserEvents()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.DataStores.UserEvents.Collect	collect(String parent) Writes a single user event from the browser.
DiscoveryEngine.Projects.Locations.DataStores.UserEvents.DiscoveryEngineImport	discoveryengineImport(String parent, GoogleCloudDiscoveryengineV1ImportUserEventsRequest content) Bulk import of user events.
DiscoveryEngine.Projects.Locations.DataStores.UserEvents.Purge	purge(String parent, GoogleCloudDiscoveryengineV1PurgeUserEventsRequest content) Deletes permanently all user events specified by the filter provided.
DiscoveryEngine.Projects.Locations.DataStores.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.DataStores.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 resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStore s/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.

Returns:

the request

Throws:

IOException

discoveryengineImport

public DiscoveryEngine.Projects.Locations.DataStores.UserEvents.DiscoveryEngineImport discoveryengineImport(String parent,
                                                                                                            GoogleCloudDiscoveryengineV1ImportUserEventsRequest content)
                                                                                                     throws IOException

Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. Create a request for the method "userEvents.import". 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. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`

content - the GoogleCloudDiscoveryengineV1ImportUserEventsRequest

Returns:

the request

Throws:

IOException

purge

public DiscoveryEngine.Projects.Locations.DataStores.UserEvents.Purge purge(String parent,
                                                                            GoogleCloudDiscoveryengineV1PurgeUserEventsRequest content)
                                                                     throws IOException

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. Create a request for the method "userEvents.purge". 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 resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.

content - the GoogleCloudDiscoveryengineV1PurgeUserEventsRequest

Returns:

the request

Throws:

IOException

write

public DiscoveryEngine.Projects.Locations.DataStores.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