ProjectsLocationsCatalogsEventStoresUserEvents
class ProjectsLocationsCatalogsEventStoresUserEvents extends Resource (View source)
The "userEvents" collection of methods.
Typical usage is:
$recommendationengineService = new Google\Service\RecommendationsAI(...);
$userEvents = $recommendationengineService->projects_locations_catalogs_eventStores_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 Recommendations AI JavaScript pixel. 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.
Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. (userEvents.listProjectsLocationsCatalogsEventStoresUserEvents)
Deletes permanently all user events specified by the filter provided.
Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items. (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 Recommendations AI JavaScript pixel. Users should not call this method directly. (userEvents.collect)
GoogleLongrunningOperation
import(string $parent, GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest $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)
GoogleCloudRecommendationengineV1beta1ListUserEventsResponse
listProjectsLocationsCatalogsEventStoresUserEvents(string $parent, array $optParams = [])
Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. (userEvents.listProjectsLocationsCatalogsEventStoresUserEvents)
GoogleLongrunningOperation
purge(string $parent, GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest $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, GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest $postBody, array $optParams = [])
Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items. (userEvents.rejoin)
GoogleCloudRecommendationengineV1beta1UserEvent
write(string $parent, GoogleCloudRecommendationengineV1beta1UserEvent $postBody, array $optParams = [])
Writes a single user event. (userEvents.write)