Viewing file:  ManagementCustomDimensions.php (5.63 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Analytics\Resource;
use Google\Service\Analytics\CustomDimension;
use Google\Service\Analytics\CustomDimensions;
/**
* The "customDimensions" collection of methods.
* Typical usage is:
* <code>
* $analyticsService = new Google\Service\Analytics(...);
* $customDimensions = $analyticsService->management_customDimensions;
* </code>
*/
class ManagementCustomDimensions extends \Google\Service\Resource
{
/**
* Get a custom dimension to which the user has access. (customDimensions.get)
*
* @param string $accountId Account ID for the custom dimension to retrieve.
* @param string $webPropertyId Web property ID for the custom dimension to
* retrieve.
* @param string $customDimensionId The ID of the custom dimension to retrieve.
* @param array $optParams Optional parameters.
* @return CustomDimension
*/
public function get($accountId, $webPropertyId, $customDimensionId, $optParams = [])
{
$params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], CustomDimension::class);
}
/**
* Create a new custom dimension. (customDimensions.insert)
*
* @param string $accountId Account ID for the custom dimension to create.
* @param string $webPropertyId Web property ID for the custom dimension to
* create.
* @param CustomDimension $postBody
* @param array $optParams Optional parameters.
* @return CustomDimension
*/
public function insert($accountId, $webPropertyId, CustomDimension $postBody, $optParams = [])
{
$params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], CustomDimension::class);
}
/**
* Lists custom dimensions to which the user has access.
* (customDimensions.listManagementCustomDimensions)
*
* @param string $accountId Account ID for the custom dimensions to retrieve.
* @param string $webPropertyId Web property ID for the custom dimensions to
* retrieve.
* @param 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 CustomDimensions
*/
public function listManagementCustomDimensions($accountId, $webPropertyId, $optParams = [])
{
$params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], CustomDimensions::class);
}
/**
* Updates an existing custom dimension. This method supports patch semantics.
* (customDimensions.patch)
*
* @param string $accountId Account ID for the custom dimension to update.
* @param string $webPropertyId Web property ID for the custom dimension to
* update.
* @param string $customDimensionId Custom dimension ID for the custom dimension
* to update.
* @param CustomDimension $postBody
* @param 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 CustomDimension
*/
public function patch($accountId, $webPropertyId, $customDimensionId, CustomDimension $postBody, $optParams = [])
{
$params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], CustomDimension::class);
}
/**
* Updates an existing custom dimension. (customDimensions.update)
*
* @param string $accountId Account ID for the custom dimension to update.
* @param string $webPropertyId Web property ID for the custom dimension to
* update.
* @param string $customDimensionId Custom dimension ID for the custom dimension
* to update.
* @param CustomDimension $postBody
* @param 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 CustomDimension
*/
public function update($accountId, $webPropertyId, $customDimensionId, CustomDimension $postBody, $optParams = [])
{
$params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], CustomDimension::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ManagementCustomDimensions::class, 'Google_Service_Analytics_Resource_ManagementCustomDimensions');
|