Google_Service_Analytics_ManagementCustomDimensions_Resource

The "customDimensions" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Analytics.php  
  1. class Google_Service_Analytics_ManagementCustomDimensions_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Get a custom dimension to which the user has access. (customDimensions.get) 
  5. * @param string $accountId Account ID for the custom dimension to retrieve. 
  6. * @param string $webPropertyId Web property ID for the custom dimension to 
  7. * retrieve. 
  8. * @param string $customDimensionId The ID of the custom dimension to retrieve. 
  9. * @param array $optParams Optional parameters. 
  10. * @return Google_Service_Analytics_CustomDimension 
  11. */ 
  12. public function get($accountId, $webPropertyId, $customDimensionId, $optParams = array()) 
  13. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId); 
  14. $params = array_merge($params, $optParams); 
  15. return $this->call('get', array($params), "Google_Service_Analytics_CustomDimension"); 
  16.  
  17. /** 
  18. * Create a new custom dimension. (customDimensions.insert) 
  19. * @param string $accountId Account ID for the custom dimension to create. 
  20. * @param string $webPropertyId Web property ID for the custom dimension to 
  21. * create. 
  22. * @param Google_CustomDimension $postBody 
  23. * @param array $optParams Optional parameters. 
  24. * @return Google_Service_Analytics_CustomDimension 
  25. */ 
  26. public function insert($accountId, $webPropertyId, Google_Service_Analytics_CustomDimension $postBody, $optParams = array()) 
  27. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody); 
  28. $params = array_merge($params, $optParams); 
  29. return $this->call('insert', array($params), "Google_Service_Analytics_CustomDimension"); 
  30.  
  31. /** 
  32. * Lists custom dimensions to which the user has access. 
  33. * (customDimensions.listManagementCustomDimensions) 
  34. * @param string $accountId Account ID for the custom dimensions to retrieve. 
  35. * @param string $webPropertyId Web property ID for the custom dimensions to 
  36. * retrieve. 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param int max-results The maximum number of custom dimensions to include 
  39. * in this response. 
  40. * @opt_param int start-index An index of the first entity to retrieve. Use this 
  41. * parameter as a pagination mechanism along with the max-results parameter. 
  42. * @return Google_Service_Analytics_CustomDimensions 
  43. */ 
  44. public function listManagementCustomDimensions($accountId, $webPropertyId, $optParams = array()) 
  45. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId); 
  46. $params = array_merge($params, $optParams); 
  47. return $this->call('list', array($params), "Google_Service_Analytics_CustomDimensions"); 
  48.  
  49. /** 
  50. * Updates an existing custom dimension. This method supports patch semantics. 
  51. * (customDimensions.patch) 
  52. * @param string $accountId Account ID for the custom dimension to update. 
  53. * @param string $webPropertyId Web property ID for the custom dimension to 
  54. * update. 
  55. * @param string $customDimensionId Custom dimension ID for the custom dimension 
  56. * to update. 
  57. * @param Google_CustomDimension $postBody 
  58. * @param array $optParams Optional parameters. 
  59. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  60. * warnings related to the custom dimension being linked to a custom data source 
  61. * / data set. 
  62. * @return Google_Service_Analytics_CustomDimension 
  63. */ 
  64. public function patch($accountId, $webPropertyId, $customDimensionId, Google_Service_Analytics_CustomDimension $postBody, $optParams = array()) 
  65. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId, 'postBody' => $postBody); 
  66. $params = array_merge($params, $optParams); 
  67. return $this->call('patch', array($params), "Google_Service_Analytics_CustomDimension"); 
  68.  
  69. /** 
  70. * Updates an existing custom dimension. (customDimensions.update) 
  71. * @param string $accountId Account ID for the custom dimension to update. 
  72. * @param string $webPropertyId Web property ID for the custom dimension to 
  73. * update. 
  74. * @param string $customDimensionId Custom dimension ID for the custom dimension 
  75. * to update. 
  76. * @param Google_CustomDimension $postBody 
  77. * @param array $optParams Optional parameters. 
  78. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  79. * warnings related to the custom dimension being linked to a custom data source 
  80. * / data set. 
  81. * @return Google_Service_Analytics_CustomDimension 
  82. */ 
  83. public function update($accountId, $webPropertyId, $customDimensionId, Google_Service_Analytics_CustomDimension $postBody, $optParams = array()) 
  84. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customDimensionId' => $customDimensionId, 'postBody' => $postBody); 
  85. $params = array_merge($params, $optParams); 
  86. return $this->call('update', array($params), "Google_Service_Analytics_CustomDimension");