com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest<GoogleApiHttpBody>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect
extends DiscoveryEngineRequest<GoogleApiHttpBody>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Collect(String parent) Writes a single user event from the browser.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Long	getEts() The event timestamp in milliseconds.
String	getParent() Required.
String	getUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
String	getUserEvent() Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setEts(Long ets) The event timestamp in milliseconds.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setParent(String parent) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setUri(String uri) The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect	setUserEvent(String userEvent) Required.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Collect

protected Collect(String parent)

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 the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DiscoveryEngine.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

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}`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleApiHttpBody>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleApiHttpBody>

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleApiHttpBody>

setAccessToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleApiHttpBody>

setAlt

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleApiHttpBody>

setCallback

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleApiHttpBody>

setFields

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleApiHttpBody>

setKey

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setKey(String key)

Description copied from class: DiscoveryEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DiscoveryEngineRequest<GoogleApiHttpBody>

setOauthToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleApiHttpBody>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleApiHttpBody>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryEngineRequest<GoogleApiHttpBody>

setUploadType

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleApiHttpBody>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleApiHttpBody>

getParent

public String getParent()

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}/dataStores/{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}`.

setParent

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setParent(String parent)

Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collection s/{collection}/dataStores/{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}`.

getEts

public Long getEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

setEts

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setEts(Long ets)

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

getUri

public String getUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

setUri

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setUri(String uri)

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

getUserEvent

public String getUserEvent()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

setUserEvent

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect setUserEvent(String userEvent)

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

set

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents.Collect set(String parameterName,
                                                                                        Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleApiHttpBody>