ProjectsLocationsCatalogsUserEvents
class ProjectsLocationsCatalogsUserEvents extends Resource (View source)
The "userEvents" collection of methods.
Typical usage is:
$retailService = new Google\Service\CloudRetail(...);
$userEvents = $retailService->projects_locations_catalogs_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 3rd party domain. This method is used only by the Retail 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.
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. (userEvents.rejoin)
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 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. (userEvents.collect)
GoogleLongrunningOperation
import(string $parent, GoogleCloudRetailV2ImportUserEventsRequest $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, GoogleCloudRetailV2PurgeUserEventsRequest $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)
GoogleLongrunningOperation
rejoin(string $parent, GoogleCloudRetailV2RejoinUserEventsRequest $postBody, array $optParams = [])
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. (userEvents.rejoin)
GoogleCloudRetailV2UserEvent
write(string $parent, GoogleCloudRetailV2UserEvent $postBody, array $optParams = [])
Writes a single user event. (userEvents.write)