Google_Service_Analytics_ManagementGoals_Resource

The "goals" collection of methods.

Defined (1)

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

/lib/vendor/google/apiclient/src/Google/Service/Analytics.php  
  1. class Google_Service_Analytics_ManagementGoals_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Gets a goal to which the user has access. (goals.get) 
  5. * @param string $accountId 
  6. * Account ID to retrieve the goal for. 
  7. * @param string $webPropertyId 
  8. * Web property ID to retrieve the goal for. 
  9. * @param string $profileId 
  10. * View (Profile) ID to retrieve the goal for. 
  11. * @param string $goalId 
  12. * Goal ID to retrieve the goal for. 
  13. * @param array $optParams Optional parameters. 
  14. * @return Google_Service_Analytics_Goal 
  15. */ 
  16. public function get($accountId, $webPropertyId, $profileId, $goalId, $optParams = array()) 
  17. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'goalId' => $goalId); 
  18. $params = array_merge($params, $optParams); 
  19. return $this->call('get', array($params), "Google_Service_Analytics_Goal"); 
  20. /** 
  21. * Create a new goal. (goals.insert) 
  22. * @param string $accountId 
  23. * Account ID to create the goal for. 
  24. * @param string $webPropertyId 
  25. * Web property ID to create the goal for. 
  26. * @param string $profileId 
  27. * View (Profile) ID to create the goal for. 
  28. * @param Google_Goal $postBody 
  29. * @param array $optParams Optional parameters. 
  30. * @return Google_Service_Analytics_Goal 
  31. */ 
  32. public function insert($accountId, $webPropertyId, $profileId, Google_Service_Analytics_Goal $postBody, $optParams = array()) 
  33. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody); 
  34. $params = array_merge($params, $optParams); 
  35. return $this->call('insert', array($params), "Google_Service_Analytics_Goal"); 
  36. /** 
  37. * Lists goals to which the user has access. (goals.listManagementGoals) 
  38. * @param string $accountId 
  39. * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to 
  40. * all the accounts that user has access to. 
  41. * @param string $webPropertyId 
  42. * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which 
  43. * refers to all the web properties that user has access to. 
  44. * @param string $profileId 
  45. * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all',  
  46. * which refers to all the views (profiles) that user has access to. 
  47. * @param array $optParams Optional parameters. 
  48. * @opt_param int max-results 
  49. * The maximum number of goals to include in this response. 
  50. * @opt_param int start-index 
  51. * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with 
  52. * the max-results parameter. 
  53. * @return Google_Service_Analytics_Goals 
  54. */ 
  55. public function listManagementGoals($accountId, $webPropertyId, $profileId, $optParams = array()) 
  56. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId); 
  57. $params = array_merge($params, $optParams); 
  58. return $this->call('list', array($params), "Google_Service_Analytics_Goals"); 
  59. /** 
  60. * Updates an existing view (profile). This method supports patch semantics. 
  61. * (goals.patch) 
  62. * @param string $accountId 
  63. * Account ID to update the goal. 
  64. * @param string $webPropertyId 
  65. * Web property ID to update the goal. 
  66. * @param string $profileId 
  67. * View (Profile) ID to update the goal. 
  68. * @param string $goalId 
  69. * Index of the goal to be updated. 
  70. * @param Google_Goal $postBody 
  71. * @param array $optParams Optional parameters. 
  72. * @return Google_Service_Analytics_Goal 
  73. */ 
  74. public function patch($accountId, $webPropertyId, $profileId, $goalId, Google_Service_Analytics_Goal $postBody, $optParams = array()) 
  75. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'goalId' => $goalId, 'postBody' => $postBody); 
  76. $params = array_merge($params, $optParams); 
  77. return $this->call('patch', array($params), "Google_Service_Analytics_Goal"); 
  78. /** 
  79. * Updates an existing view (profile). (goals.update) 
  80. * @param string $accountId 
  81. * Account ID to update the goal. 
  82. * @param string $webPropertyId 
  83. * Web property ID to update the goal. 
  84. * @param string $profileId 
  85. * View (Profile) ID to update the goal. 
  86. * @param string $goalId 
  87. * Index of the goal to be updated. 
  88. * @param Google_Goal $postBody 
  89. * @param array $optParams Optional parameters. 
  90. * @return Google_Service_Analytics_Goal 
  91. */ 
  92. public function update($accountId, $webPropertyId, $profileId, $goalId, Google_Service_Analytics_Goal $postBody, $optParams = array()) 
  93. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'goalId' => $goalId, 'postBody' => $postBody); 
  94. $params = array_merge($params, $optParams); 
  95. return $this->call('update', array($params), "Google_Service_Analytics_Goal");