user_events

Creates, updates, deletes, gets or lists a user_events resource.

Overview

Name	user_events
Type	Resource
Id	google.discoveryengine.user_events

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_user_events_write	exec	projectsId, locationsId, collectionsId, dataStoresId	writeAsync	Writes a single user event.
projects_locations_collections_data_stores_user_events_collect	exec	projectsId, locationsId, collectionsId, dataStoresId	userEvent, uri, ets	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.
projects_locations_collections_data_stores_user_events_purge	exec	projectsId, locationsId, collectionsId, dataStoresId		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.
projects_locations_collections_data_stores_user_events_import	exec	projectsId, locationsId, collectionsId, dataStoresId		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.
projects_locations_data_stores_user_events_write	exec	projectsId, locationsId, dataStoresId	writeAsync	Writes a single user event.
projects_locations_data_stores_user_events_collect	exec	projectsId, locationsId, dataStoresId	userEvent, uri, ets	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.
projects_locations_data_stores_user_events_purge	exec	projectsId, locationsId, dataStoresId		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.
projects_locations_data_stores_user_events_import	exec	projectsId, locationsId, dataStoresId		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.
projects_locations_user_events_write	exec	projectsId, locationsId	writeAsync	Writes a single user event.
projects_locations_user_events_collect	exec	projectsId, locationsId	userEvent, uri, ets	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.
projects_locations_user_events_import	exec	projectsId, locationsId		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
locationsId	string
projectsId	string
ets	string (int64)
uri	string
userEvent	string
writeAsync	boolean

Lifecycle Methods

projects_locations_collections_data_stores_user_events_write

Writes a single user event.

EXEC google.discoveryengine.user_events.projects_locations_collections_data_stores_user_events_write 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@writeAsync={{ writeAsync }} 
@@json=
'{
"eventType": "{{ eventType }}", 
"conversionType": "{{ conversionType }}", 
"userPseudoId": "{{ userPseudoId }}", 
"engine": "{{ engine }}", 
"dataStore": "{{ dataStore }}", 
"eventTime": "{{ eventTime }}", 
"userInfo": "{{ userInfo }}", 
"directUserRequest": {{ directUserRequest }}, 
"sessionId": "{{ sessionId }}", 
"pageInfo": "{{ pageInfo }}", 
"attributionToken": "{{ attributionToken }}", 
"filter": "{{ filter }}", 
"documents": "{{ documents }}", 
"panel": "{{ panel }}", 
"searchInfo": "{{ searchInfo }}", 
"completionInfo": "{{ completionInfo }}", 
"transactionInfo": "{{ transactionInfo }}", 
"tagIds": "{{ tagIds }}", 
"promotionIds": "{{ promotionIds }}", 
"attributes": "{{ attributes }}", 
"mediaInfo": "{{ mediaInfo }}", 
"panels": "{{ panels }}"
}';

projects_locations_collections_data_stores_user_events_collect

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.

EXEC google.discoveryengine.user_events.projects_locations_collections_data_stores_user_events_collect 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@userEvent='{{ userEvent }}', 
@uri='{{ uri }}', 
@ets='{{ ets }}';

projects_locations_collections_data_stores_user_events_purge

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.

EXEC google.discoveryengine.user_events.projects_locations_collections_data_stores_user_events_purge 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"force": {{ force }}
}';

projects_locations_collections_data_stores_user_events_import

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.

EXEC google.discoveryengine.user_events.projects_locations_collections_data_stores_user_events_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"inlineSource": "{{ inlineSource }}", 
"gcsSource": "{{ gcsSource }}", 
"bigquerySource": "{{ bigquerySource }}", 
"errorConfig": "{{ errorConfig }}"
}';

projects_locations_data_stores_user_events_write

Writes a single user event.

EXEC google.discoveryengine.user_events.projects_locations_data_stores_user_events_write 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@writeAsync={{ writeAsync }} 
@@json=
'{
"eventType": "{{ eventType }}", 
"conversionType": "{{ conversionType }}", 
"userPseudoId": "{{ userPseudoId }}", 
"engine": "{{ engine }}", 
"dataStore": "{{ dataStore }}", 
"eventTime": "{{ eventTime }}", 
"userInfo": "{{ userInfo }}", 
"directUserRequest": {{ directUserRequest }}, 
"sessionId": "{{ sessionId }}", 
"pageInfo": "{{ pageInfo }}", 
"attributionToken": "{{ attributionToken }}", 
"filter": "{{ filter }}", 
"documents": "{{ documents }}", 
"panel": "{{ panel }}", 
"searchInfo": "{{ searchInfo }}", 
"completionInfo": "{{ completionInfo }}", 
"transactionInfo": "{{ transactionInfo }}", 
"tagIds": "{{ tagIds }}", 
"promotionIds": "{{ promotionIds }}", 
"attributes": "{{ attributes }}", 
"mediaInfo": "{{ mediaInfo }}", 
"panels": "{{ panels }}"
}';

projects_locations_data_stores_user_events_collect

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.

EXEC google.discoveryengine.user_events.projects_locations_data_stores_user_events_collect 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@userEvent='{{ userEvent }}', 
@uri='{{ uri }}', 
@ets='{{ ets }}';

projects_locations_data_stores_user_events_purge

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.

EXEC google.discoveryengine.user_events.projects_locations_data_stores_user_events_purge 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"force": {{ force }}
}';

projects_locations_data_stores_user_events_import

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.

EXEC google.discoveryengine.user_events.projects_locations_data_stores_user_events_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"inlineSource": "{{ inlineSource }}", 
"gcsSource": "{{ gcsSource }}", 
"bigquerySource": "{{ bigquerySource }}", 
"errorConfig": "{{ errorConfig }}"
}';

projects_locations_user_events_write

Writes a single user event.

EXEC google.discoveryengine.user_events.projects_locations_user_events_write 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@writeAsync={{ writeAsync }} 
@@json=
'{
"eventType": "{{ eventType }}", 
"conversionType": "{{ conversionType }}", 
"userPseudoId": "{{ userPseudoId }}", 
"engine": "{{ engine }}", 
"dataStore": "{{ dataStore }}", 
"eventTime": "{{ eventTime }}", 
"userInfo": "{{ userInfo }}", 
"directUserRequest": {{ directUserRequest }}, 
"sessionId": "{{ sessionId }}", 
"pageInfo": "{{ pageInfo }}", 
"attributionToken": "{{ attributionToken }}", 
"filter": "{{ filter }}", 
"documents": "{{ documents }}", 
"panel": "{{ panel }}", 
"searchInfo": "{{ searchInfo }}", 
"completionInfo": "{{ completionInfo }}", 
"transactionInfo": "{{ transactionInfo }}", 
"tagIds": "{{ tagIds }}", 
"promotionIds": "{{ promotionIds }}", 
"attributes": "{{ attributes }}", 
"mediaInfo": "{{ mediaInfo }}", 
"panels": "{{ panels }}"
}';

projects_locations_user_events_collect

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.

EXEC google.discoveryengine.user_events.projects_locations_user_events_collect 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@userEvent='{{ userEvent }}', 
@uri='{{ uri }}', 
@ets='{{ ets }}';

projects_locations_user_events_import

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.

EXEC google.discoveryengine.user_events.projects_locations_user_events_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"inlineSource": "{{ inlineSource }}", 
"gcsSource": "{{ gcsSource }}", 
"bigquerySource": "{{ bigquerySource }}", 
"errorConfig": "{{ errorConfig }}"
}';