ProjectsLocationsCollectionsDataStoresUserEvents
class ProjectsLocationsCollectionsDataStoresUserEvents extends Resource (View source)
The "userEvents" collection of methods.
Typical usage is:
$discoveryengineService = new Google\Service\DiscoveryEngine(...);
$userEvents = $discoveryengineService->projects_locations_collections_dataStores_userEvents;Methods
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. (userEvents.collect)
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.
Deletes permanently all user events specified by the filter provided.
Writes a single user event. (userEvents.write)
Details
GoogleApiHttpBody
collect(string $parent, array $optParams = [])
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. (userEvents.collect)
GoogleLongrunningOperation
import(string $parent, GoogleCloudDiscoveryengineV1ImportUserEventsRequest $postBody, array $optParams = [])
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. (userEvents.import)
GoogleLongrunningOperation
purge(string $parent, GoogleCloudDiscoveryengineV1PurgeUserEventsRequest $postBody, array $optParams = [])
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. (userEvents.purge)
GoogleCloudDiscoveryengineV1UserEvent
write(string $parent, GoogleCloudDiscoveryengineV1UserEvent $postBody, array $optParams = [])
Writes a single user event. (userEvents.write)