Google_Service_Analytics_ManagementCustomDimensions_Resource Class Reference

The "customDimensions" collection of methods. More...

Inheritance diagram for Google_Service_Analytics_ManagementCustomDimensions_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($accountId, $webPropertyId, $customDimensionId, $optParams=array())
	Get a custom dimension to which the user has access.
	insert ($accountId, $webPropertyId, Google_Service_Analytics_CustomDimension $postBody, $optParams=array())
	Create a new custom dimension.
	listManagementCustomDimensions ($accountId, $webPropertyId, $optParams=array())
	Lists custom dimensions to which the user has access.
	patch ($accountId, $webPropertyId, $customDimensionId, Google_Service_Analytics_CustomDimension $postBody, $optParams=array())
	Updates an existing custom dimension.
	update ($accountId, $webPropertyId, $customDimensionId, Google_Service_Analytics_CustomDimension $postBody, $optParams=array())
	Updates an existing custom dimension.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "customDimensions" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $customDimensions = $analyticsService->customDimensions;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_Analytics_ManagementCustomDimensions_Resource::get	(		$accountId,
			$webPropertyId,
			$customDimensionId,
			$optParams = array() )

Get a custom dimension to which the user has access.

(customDimensions.get)

Parameters

string	$accountId	Account ID for the custom dimension to retrieve.
string	$webPropertyId	Web property ID for the custom dimension to retrieve.
string	$customDimensionId	The ID of the custom dimension to retrieve.
array	$optParams	Optional parameters.

Return values

Google_Service_Analytics_CustomDimension

insert()

Google_Service_Analytics_ManagementCustomDimensions_Resource::insert	(		$accountId,
			$webPropertyId,
		Google_Service_Analytics_CustomDimension	$postBody,
			$optParams = array() )

Create a new custom dimension.

(customDimensions.insert)

Parameters

string	$accountId	Account ID for the custom dimension to create.
string	$webPropertyId	Web property ID for the custom dimension to create.
Google_CustomDimension	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Analytics_CustomDimension

listManagementCustomDimensions()

Google_Service_Analytics_ManagementCustomDimensions_Resource::listManagementCustomDimensions	(		$accountId,
			$webPropertyId,
			$optParams = array() )

Lists custom dimensions to which the user has access.

(customDimensions.listManagementCustomDimensions)

Parameters

string	$accountId	Account ID for the custom dimensions to retrieve.
string	$webPropertyId	Web property ID for the custom dimensions to retrieve.
array	$optParams	Optional parameters.

@opt_param int max-results The maximum number of custom dimensions to include in this response. @opt_param int start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Return values

Google_Service_Analytics_CustomDimensions

patch()

Google_Service_Analytics_ManagementCustomDimensions_Resource::patch	(		$accountId,
			$webPropertyId,
			$customDimensionId,
		Google_Service_Analytics_CustomDimension	$postBody,
			$optParams = array() )

Updates an existing custom dimension.

This method supports patch semantics. (customDimensions.patch)

Parameters

string	$accountId	Account ID for the custom dimension to update.
string	$webPropertyId	Web property ID for the custom dimension to update.
string	$customDimensionId	Custom dimension ID for the custom dimension to update.
Google_CustomDimension	$postBody
array	$optParams	Optional parameters.

@opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

Return values

Google_Service_Analytics_CustomDimension

update()

Google_Service_Analytics_ManagementCustomDimensions_Resource::update	(		$accountId,
			$webPropertyId,
			$customDimensionId,
		Google_Service_Analytics_CustomDimension	$postBody,
			$optParams = array() )

Updates an existing custom dimension.

(customDimensions.update)

Parameters

string	$accountId	Account ID for the custom dimension to update.
string	$webPropertyId	Web property ID for the custom dimension to update.
string	$customDimensionId	Custom dimension ID for the custom dimension to update.
Google_CustomDimension	$postBody
array	$optParams	Optional parameters.

@opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

Return values

Google_Service_Analytics_CustomDimension

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Analytics.php