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

PropertiesCustomMetrics

class PropertiesCustomMetrics extends Resource (View source)

The "customMetrics" collection of methods.

Typical usage is:

 $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
 $customMetrics = $analyticsadminService->properties_customMetrics;

Methods

GoogleProtobufEmpty
archive(string $name, GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest $postBody, array $optParams = [])

Archives a CustomMetric on a property. (customMetrics.archive)

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

Creates a CustomMetric. (customMetrics.create)

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

Lookup for a single CustomMetric. (customMetrics.get)

GoogleAnalyticsAdminV1betaListCustomMetricsResponse
listPropertiesCustomMetrics(string $parent, array $optParams = [])

Lists CustomMetrics on a property.

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

Updates a CustomMetric on a property. (customMetrics.patch)

Details

at line 45
GoogleProtobufEmpty archive(string $name, GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest $postBody, array $optParams = [])

Archives a CustomMetric on a property. (customMetrics.archive)

Parameters

string $name

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678
GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 60
GoogleAnalyticsAdminV1betaCustomMetric create(string $parent, GoogleAnalyticsAdminV1betaCustomMetric $postBody, array $optParams = [])

Creates a CustomMetric. (customMetrics.create)

Parameters

string $parent

Required. Example format: properties/1234
GoogleAnalyticsAdminV1betaCustomMetric $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomMetric

Exceptions

Exception

at line 75
GoogleAnalyticsAdminV1betaCustomMetric get(string $name, array $optParams = [])

Lookup for a single CustomMetric. (customMetrics.get)

Parameters

string $name

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomMetric

Exceptions

Exception

at line 98
GoogleAnalyticsAdminV1betaListCustomMetricsResponse listPropertiesCustomMetrics(string $parent, array $optParams = [])

Lists CustomMetrics on a property.

(customMetrics.listPropertiesCustomMetrics)

Parameters

string $parent

Required. Example format: properties/1234
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaListCustomMetricsResponse

Exceptions

Exception

at line 118
GoogleAnalyticsAdminV1betaCustomMetric patch(string $name, GoogleAnalyticsAdminV1betaCustomMetric $postBody, array $optParams = [])

Updates a CustomMetric on a property. (customMetrics.patch)

Parameters

string $name

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
GoogleAnalyticsAdminV1betaCustomMetric $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomMetric

Exceptions

Exception