* $discoveryengineService = new Google\Service\DiscoveryEngine(...); * $userEvents = $discoveryengineService->projects_locations_dataStores_userEvents; * */ class ProjectsLocationsDataStoresUserEvents extends \Google\Service\Resource { /** * 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) * * @param string $parent Required. The parent DataStore resource name, such as ` * projects/{project}/locations/{location}/collections/{collection}/dataStores/{ * data_store}`. * @param array $optParams Optional parameters. * * @opt_param string ets The event timestamp in milliseconds. This prevents * browser caching of otherwise identical get requests. The name is abbreviated * to reduce the payload bytes. * @opt_param 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. * @opt_param string userEvent Required. URL encoded UserEvent proto with a * length limit of 2,000,000 characters. * @return GoogleApiHttpBody * @throws \Google\Service\Exception */ public function collect($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('collect', [$params], GoogleApiHttpBody::class); } /** * 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) * * @param string $parent Required. Parent DataStore resource name, of the form ` * projects/{project}/locations/{location}/collections/{collection}/dataStores/{ * data_store}` * @param GoogleCloudDiscoveryengineV1ImportUserEventsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function import($parent, GoogleCloudDiscoveryengineV1ImportUserEventsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('import', [$params], GoogleLongrunningOperation::class); } /** * 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) * * @param string $parent Required. The resource name of the catalog under which * the events are created. The format is `projects/{project}/locations/global/co * llections/{collection}/dataStores/{dataStore}`. * @param GoogleCloudDiscoveryengineV1PurgeUserEventsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function purge($parent, GoogleCloudDiscoveryengineV1PurgeUserEventsRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('purge', [$params], GoogleLongrunningOperation::class); } /** * Writes a single user event. (userEvents.write) * * @param string $parent Required. The parent resource name. If the write user * event action is applied in DataStore level, the format is: `projects/{project * }/locations/{location}/collections/{collection}/dataStores/{data_store}`. If * the write user event action is applied in Location level, for example, the * event with Document across multiple DataStore, the format is: * `projects/{project}/locations/{location}`. * @param GoogleCloudDiscoveryengineV1UserEvent $postBody * @param array $optParams Optional parameters. * * @opt_param bool writeAsync If set to true, the user event is written * asynchronously after validation, and the API responds without waiting for the * write. * @return GoogleCloudDiscoveryengineV1UserEvent * @throws \Google\Service\Exception */ public function write($parent, GoogleCloudDiscoveryengineV1UserEvent $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('write', [$params], GoogleCloudDiscoveryengineV1UserEvent::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsDataStoresUserEvents::class, 'Google_Service_DiscoveryEngine_Resource_ProjectsLocationsDataStoresUserEvents');