1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsUserEvents

ProjectsLocationsUserEvents

class ProjectsLocationsUserEvents extends Resource (View source)

The "userEvents" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $userEvents = $discoveryengineService->projects_locations_userEvents;

Methods

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)

GoogleCloudDiscoveryengineV1UserEvent
write(string $parent, GoogleCloudDiscoveryengineV1UserEvent $postBody, array $optParams = [])

Writes a single user event. (userEvents.write)

Details

at line 56
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)

Parameters

string $parent

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{ data_store}.
array $optParams

Optional parameters.

Return Value

GoogleApiHttpBody

Exceptions

Exception

at line 80
GoogleCloudDiscoveryengineV1UserEvent write(string $parent, GoogleCloudDiscoveryengineV1UserEvent $postBody, array $optParams = [])

Writes a single user event. (userEvents.write)

Parameters

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}.
GoogleCloudDiscoveryengineV1UserEvent $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1UserEvent

Exceptions

Exception