Google_Service_Analytics_ManagementCustomMetrics_Resource

The "customMetrics" collection of methods.

Defined (2)

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

/includes/api-libs/Google/Service/Analytics.php  
  1. class Google_Service_Analytics_ManagementCustomMetrics_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Get a custom metric to which the user has access. (customMetrics.get) 
  5. * @param string $accountId Account ID for the custom metric to retrieve. 
  6. * @param string $webPropertyId Web property ID for the custom metric to 
  7. * retrieve. 
  8. * @param string $customMetricId The ID of the custom metric to retrieve. 
  9. * @param array $optParams Optional parameters. 
  10. * @return Google_Service_Analytics_CustomMetric 
  11. */ 
  12. public function get($accountId, $webPropertyId, $customMetricId, $optParams = array()) 
  13. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId); 
  14. $params = array_merge($params, $optParams); 
  15. return $this->call('get', array($params), "Google_Service_Analytics_CustomMetric"); 
  16.  
  17. /** 
  18. * Create a new custom metric. (customMetrics.insert) 
  19. * @param string $accountId Account ID for the custom metric to create. 
  20. * @param string $webPropertyId Web property ID for the custom dimension to 
  21. * create. 
  22. * @param Google_CustomMetric $postBody 
  23. * @param array $optParams Optional parameters. 
  24. * @return Google_Service_Analytics_CustomMetric 
  25. */ 
  26. public function insert($accountId, $webPropertyId, Google_Service_Analytics_CustomMetric $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_CustomMetric"); 
  30.  
  31. /** 
  32. * Lists custom metrics to which the user has access. 
  33. * (customMetrics.listManagementCustomMetrics) 
  34. * @param string $accountId Account ID for the custom metrics to retrieve. 
  35. * @param string $webPropertyId Web property ID for the custom metrics to 
  36. * retrieve. 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param int max-results The maximum number of custom metrics to include in 
  39. * 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_CustomMetrics 
  43. */ 
  44. public function listManagementCustomMetrics($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_CustomMetrics"); 
  48.  
  49. /** 
  50. * Updates an existing custom metric. This method supports patch semantics. 
  51. * (customMetrics.patch) 
  52. * @param string $accountId Account ID for the custom metric to update. 
  53. * @param string $webPropertyId Web property ID for the custom metric to update. 
  54. * @param string $customMetricId Custom metric ID for the custom metric to 
  55. * update. 
  56. * @param Google_CustomMetric $postBody 
  57. * @param array $optParams Optional parameters. 
  58. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  59. * warnings related to the custom metric being linked to a custom data source / 
  60. * data set. 
  61. * @return Google_Service_Analytics_CustomMetric 
  62. */ 
  63. public function patch($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams = array()) 
  64. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId, 'postBody' => $postBody); 
  65. $params = array_merge($params, $optParams); 
  66. return $this->call('patch', array($params), "Google_Service_Analytics_CustomMetric"); 
  67.  
  68. /** 
  69. * Updates an existing custom metric. (customMetrics.update) 
  70. * @param string $accountId Account ID for the custom metric to update. 
  71. * @param string $webPropertyId Web property ID for the custom metric to update. 
  72. * @param string $customMetricId Custom metric ID for the custom metric to 
  73. * update. 
  74. * @param Google_CustomMetric $postBody 
  75. * @param array $optParams Optional parameters. 
  76. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  77. * warnings related to the custom metric being linked to a custom data source / 
  78. * data set. 
  79. * @return Google_Service_Analytics_CustomMetric 
  80. */ 
  81. public function update($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams = array()) 
  82. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId, 'postBody' => $postBody); 
  83. $params = array_merge($params, $optParams); 
  84. return $this->call('update', array($params), "Google_Service_Analytics_CustomMetric"); 
  1. class Google_Service_Analytics_ManagementCustomMetrics_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Get a custom metric to which the user has access. (customMetrics.get) 
  5. * @param string $accountId Account ID for the custom metric to retrieve. 
  6. * @param string $webPropertyId Web property ID for the custom metric to 
  7. * retrieve. 
  8. * @param string $customMetricId The ID of the custom metric to retrieve. 
  9. * @param array $optParams Optional parameters. 
  10. * @return Google_Service_Analytics_CustomMetric 
  11. */ 
  12. public function get($accountId, $webPropertyId, $customMetricId, $optParams = array()) 
  13. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId); 
  14. $params = array_merge($params, $optParams); 
  15. return $this->call('get', array($params), "Google_Service_Analytics_CustomMetric"); 
  16.  
  17. /** 
  18. * Create a new custom metric. (customMetrics.insert) 
  19. * @param string $accountId Account ID for the custom metric to create. 
  20. * @param string $webPropertyId Web property ID for the custom dimension to 
  21. * create. 
  22. * @param Google_CustomMetric $postBody 
  23. * @param array $optParams Optional parameters. 
  24. * @return Google_Service_Analytics_CustomMetric 
  25. */ 
  26. public function insert($accountId, $webPropertyId, Google_Service_Analytics_CustomMetric $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_CustomMetric"); 
  30.  
  31. /** 
  32. * Lists custom metrics to which the user has access. 
  33. * (customMetrics.listManagementCustomMetrics) 
  34. * @param string $accountId Account ID for the custom metrics to retrieve. 
  35. * @param string $webPropertyId Web property ID for the custom metrics to 
  36. * retrieve. 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param int max-results The maximum number of custom metrics to include in 
  39. * 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_CustomMetrics 
  43. */ 
  44. public function listManagementCustomMetrics($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_CustomMetrics"); 
  48.  
  49. /** 
  50. * Updates an existing custom metric. This method supports patch semantics. 
  51. * (customMetrics.patch) 
  52. * @param string $accountId Account ID for the custom metric to update. 
  53. * @param string $webPropertyId Web property ID for the custom metric to update. 
  54. * @param string $customMetricId Custom metric ID for the custom metric to 
  55. * update. 
  56. * @param Google_CustomMetric $postBody 
  57. * @param array $optParams Optional parameters. 
  58. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  59. * warnings related to the custom metric being linked to a custom data source / 
  60. * data set. 
  61. * @return Google_Service_Analytics_CustomMetric 
  62. */ 
  63. public function patch($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams = array()) 
  64. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId, 'postBody' => $postBody); 
  65. $params = array_merge($params, $optParams); 
  66. return $this->call('patch', array($params), "Google_Service_Analytics_CustomMetric"); 
  67.  
  68. /** 
  69. * Updates an existing custom metric. (customMetrics.update) 
  70. * @param string $accountId Account ID for the custom metric to update. 
  71. * @param string $webPropertyId Web property ID for the custom metric to update. 
  72. * @param string $customMetricId Custom metric ID for the custom metric to 
  73. * update. 
  74. * @param Google_CustomMetric $postBody 
  75. * @param array $optParams Optional parameters. 
  76. * @opt_param bool ignoreCustomDataSourceLinks Force the update and ignore any 
  77. * warnings related to the custom metric being linked to a custom data source / 
  78. * data set. 
  79. * @return Google_Service_Analytics_CustomMetric 
  80. */ 
  81. public function update($accountId, $webPropertyId, $customMetricId, Google_Service_Analytics_CustomMetric $postBody, $optParams = array()) 
  82. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'customMetricId' => $customMetricId, 'postBody' => $postBody); 
  83. $params = array_merge($params, $optParams); 
  84. return $this->call('update', array($params), "Google_Service_Analytics_CustomMetric");