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

PropertiesCustomDimensions

class PropertiesCustomDimensions extends Resource (View source)

The "customDimensions" collection of methods.

Typical usage is:

 $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
 $customDimensions = $analyticsadminService->properties_customDimensions;

Methods

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

Archives a CustomDimension on a property. (customDimensions.archive)

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

Creates a CustomDimension. (customDimensions.create)

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

Lookup for a single CustomDimension. (customDimensions.get)

GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
listPropertiesCustomDimensions(string $parent, array $optParams = [])

Lists CustomDimensions on a property.

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

Updates a CustomDimension on a property. (customDimensions.patch)

Details

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

Archives a CustomDimension on a property. (customDimensions.archive)

Parameters

string $name

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678
GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a CustomDimension. (customDimensions.create)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomDimension

Exceptions

Exception

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

Lookup for a single CustomDimension. (customDimensions.get)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomDimension

Exceptions

Exception

at line 98
GoogleAnalyticsAdminV1betaListCustomDimensionsResponse listPropertiesCustomDimensions(string $parent, array $optParams = [])

Lists CustomDimensions on a property.

(customDimensions.listPropertiesCustomDimensions)

Parameters

string $parent

Required. Example format: properties/1234
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaListCustomDimensionsResponse

Exceptions

Exception

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

Updates a CustomDimension on a property. (customDimensions.patch)

Parameters

string $name

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
GoogleAnalyticsAdminV1betaCustomDimension $postBody
array $optParams

Optional parameters.

Return Value

GoogleAnalyticsAdminV1betaCustomDimension

Exceptions

Exception