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

PropertiesKeyEvents

class PropertiesKeyEvents extends Resource (View source)

The "keyEvents" collection of methods.

Typical usage is:

 $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
 $keyEvents = $analyticsadminService->properties_keyEvents;

Methods

GoogleAnalyticsAdminV1betaKeyEvent
create(string $parent, GoogleAnalyticsAdminV1betaKeyEvent $postBody, array $optParams = [])

Creates a Key Event. (keyEvents.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes a Key Event. (keyEvents.delete)

GoogleAnalyticsAdminV1betaKeyEvent
get(string $name, array $optParams = [])

Retrieve a single Key Event. (keyEvents.get)

GoogleAnalyticsAdminV1betaListKeyEventsResponse
listPropertiesKeyEvents(string $parent, array $optParams = [])

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. (keyEvents.listPropertiesKeyEvents)

GoogleAnalyticsAdminV1betaKeyEvent
patch(string $name, GoogleAnalyticsAdminV1betaKeyEvent $postBody, array $optParams = [])

Updates a Key Event. (keyEvents.patch)

Details

at line 44
GoogleAnalyticsAdminV1betaKeyEvent create(string $parent, GoogleAnalyticsAdminV1betaKeyEvent $postBody, array $optParams = [])

Creates a Key Event. (keyEvents.create)

Parameters

string $parent

Required. The resource name of the parent property where this Key Event will be created. Format: properties/123
GoogleAnalyticsAdminV1betaKeyEvent $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaKeyEvent

Exceptions

Exception

at line 60
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a Key Event. (keyEvents.delete)

Parameters

string $name

Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 76
GoogleAnalyticsAdminV1betaKeyEvent get(string $name, array $optParams = [])

Retrieve a single Key Event. (keyEvents.get)

Parameters

string $name

Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaKeyEvent

Exceptions

Exception

at line 100
GoogleAnalyticsAdminV1betaListKeyEventsResponse listPropertiesKeyEvents(string $parent, array $optParams = [])

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. (keyEvents.listPropertiesKeyEvents)

Parameters

string $parent

Required. The resource name of the parent property. Example: 'properties/123'
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaListKeyEventsResponse

Exceptions

Exception

at line 121
GoogleAnalyticsAdminV1betaKeyEvent patch(string $name, GoogleAnalyticsAdminV1betaKeyEvent $postBody, array $optParams = [])

Updates a Key Event. (keyEvents.patch)

Parameters

string $name

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
GoogleAnalyticsAdminV1betaKeyEvent $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaKeyEvent

Exceptions

Exception