Google_ManagementProfilesServiceResource

The "profiles" collection of methods.

Defined (1)

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

/google-api-php-client/api-code/contrib/Google_AnalyticsService.php  
  1. class Google_ManagementProfilesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes a view (profile). (profiles.delete) 
  5. * @param string $accountId Account ID to delete the view (profile) for. 
  6. * @param string $webPropertyId Web property ID to delete the view (profile) for. 
  7. * @param string $profileId ID of the view (profile) to be deleted. 
  8. * @param array $optParams Optional parameters. 
  9. */ 
  10. public function delete($accountId, $webPropertyId, $profileId, $optParams = array()) { 
  11. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId); 
  12. $params = array_merge($params, $optParams); 
  13. $data = $this->__call('delete', array($params)); 
  14. return $data; 
  15. /** 
  16. * Gets a view (profile) to which the user has access. (profiles.get) 
  17. * @param string $accountId Account ID to retrieve the goal for. 
  18. * @param string $webPropertyId Web property ID to retrieve the goal for. 
  19. * @param string $profileId View (Profile) ID to retrieve the goal for. 
  20. * @param array $optParams Optional parameters. 
  21. * @return Google_Profile 
  22. */ 
  23. public function get($accountId, $webPropertyId, $profileId, $optParams = array()) { 
  24. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId); 
  25. $params = array_merge($params, $optParams); 
  26. $data = $this->__call('get', array($params)); 
  27. if ($this->useObjects()) { 
  28. return new Google_Profile($data); 
  29. } else { 
  30. return $data; 
  31. /** 
  32. * Create a new view (profile). (profiles.insert) 
  33. * @param string $accountId Account ID to create the view (profile) for. 
  34. * @param string $webPropertyId Web property ID to create the view (profile) for. 
  35. * @param Google_Profile $postBody 
  36. * @param array $optParams Optional parameters. 
  37. * @return Google_Profile 
  38. */ 
  39. public function insert($accountId, $webPropertyId, Google_Profile $postBody, $optParams = array()) { 
  40. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody); 
  41. $params = array_merge($params, $optParams); 
  42. $data = $this->__call('insert', array($params)); 
  43. if ($this->useObjects()) { 
  44. return new Google_Profile($data); 
  45. } else { 
  46. return $data; 
  47. /** 
  48. * Lists views (profiles) to which the user has access. (profiles.list) 
  49. * @param string $accountId Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. 
  50. * @param string $webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. 
  51. * @param array $optParams Optional parameters. 
  52. * @opt_param int max-results The maximum number of views (profiles) to include in this response. 
  53. * @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. 
  54. * @return Google_Profiles 
  55. */ 
  56. public function listManagementProfiles($accountId, $webPropertyId, $optParams = array()) { 
  57. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId); 
  58. $params = array_merge($params, $optParams); 
  59. $data = $this->__call('list', array($params)); 
  60. if ($this->useObjects()) { 
  61. return new Google_Profiles($data); 
  62. } else { 
  63. return $data; 
  64. /** 
  65. * Updates an existing view (profile). This method supports patch semantics. 
  66. * (profiles.patch) 
  67. * @param string $accountId Account ID to which the view (profile) belongs 
  68. * @param string $webPropertyId Web property ID to which the view (profile) belongs 
  69. * @param string $profileId ID of the view (profile) to be updated. 
  70. * @param Google_Profile $postBody 
  71. * @param array $optParams Optional parameters. 
  72. * @return Google_Profile 
  73. */ 
  74. public function patch($accountId, $webPropertyId, $profileId, Google_Profile $postBody, $optParams = array()) { 
  75. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody); 
  76. $params = array_merge($params, $optParams); 
  77. $data = $this->__call('patch', array($params)); 
  78. if ($this->useObjects()) { 
  79. return new Google_Profile($data); 
  80. } else { 
  81. return $data; 
  82. /** 
  83. * Updates an existing view (profile). (profiles.update) 
  84. * @param string $accountId Account ID to which the view (profile) belongs 
  85. * @param string $webPropertyId Web property ID to which the view (profile) belongs 
  86. * @param string $profileId ID of the view (profile) to be updated. 
  87. * @param Google_Profile $postBody 
  88. * @param array $optParams Optional parameters. 
  89. * @return Google_Profile 
  90. */ 
  91. public function update($accountId, $webPropertyId, $profileId, Google_Profile $postBody, $optParams = array()) { 
  92. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody); 
  93. $params = array_merge($params, $optParams); 
  94. $data = $this->__call('update', array($params)); 
  95. if ($this->useObjects()) { 
  96. return new Google_Profile($data); 
  97. } else { 
  98. return $data;