Google_ManagementExperimentsServiceResource

The "experiments" 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_ManagementExperimentsServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Delete an experiment. (experiments.delete) 
  5. * @param string $accountId Account ID to which the experiment belongs 
  6. * @param string $webPropertyId Web property ID to which the experiment belongs 
  7. * @param string $profileId View (Profile) ID to which the experiment belongs 
  8. * @param string $experimentId ID of the experiment to delete 
  9. * @param array $optParams Optional parameters. 
  10. */ 
  11. public function delete($accountId, $webPropertyId, $profileId, $experimentId, $optParams = array()) { 
  12. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'experimentId' => $experimentId); 
  13. $params = array_merge($params, $optParams); 
  14. $data = $this->__call('delete', array($params)); 
  15. return $data; 
  16. /** 
  17. * Returns an experiment to which the user has access. (experiments.get) 
  18. * @param string $accountId Account ID to retrieve the experiment for. 
  19. * @param string $webPropertyId Web property ID to retrieve the experiment for. 
  20. * @param string $profileId View (Profile) ID to retrieve the experiment for. 
  21. * @param string $experimentId Experiment ID to retrieve the experiment for. 
  22. * @param array $optParams Optional parameters. 
  23. * @return Google_Experiment 
  24. */ 
  25. public function get($accountId, $webPropertyId, $profileId, $experimentId, $optParams = array()) { 
  26. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'experimentId' => $experimentId); 
  27. $params = array_merge($params, $optParams); 
  28. $data = $this->__call('get', array($params)); 
  29. if ($this->useObjects()) { 
  30. return new Google_Experiment($data); 
  31. } else { 
  32. return $data; 
  33. /** 
  34. * Create a new experiment. (experiments.insert) 
  35. * @param string $accountId Account ID to create the experiment for. 
  36. * @param string $webPropertyId Web property ID to create the experiment for. 
  37. * @param string $profileId View (Profile) ID to create the experiment for. 
  38. * @param Google_Experiment $postBody 
  39. * @param array $optParams Optional parameters. 
  40. * @return Google_Experiment 
  41. */ 
  42. public function insert($accountId, $webPropertyId, $profileId, Google_Experiment $postBody, $optParams = array()) { 
  43. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody); 
  44. $params = array_merge($params, $optParams); 
  45. $data = $this->__call('insert', array($params)); 
  46. if ($this->useObjects()) { 
  47. return new Google_Experiment($data); 
  48. } else { 
  49. return $data; 
  50. /** 
  51. * Lists experiments to which the user has access. (experiments.list) 
  52. * @param string $accountId Account ID to retrieve experiments for. 
  53. * @param string $webPropertyId Web property ID to retrieve experiments for. 
  54. * @param string $profileId View (Profile) ID to retrieve experiments for. 
  55. * @param array $optParams Optional parameters. 
  56. * @opt_param int max-results The maximum number of experiments to include in this response. 
  57. * @opt_param int start-index An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 
  58. * @return Google_Experiments 
  59. */ 
  60. public function listManagementExperiments($accountId, $webPropertyId, $profileId, $optParams = array()) { 
  61. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId); 
  62. $params = array_merge($params, $optParams); 
  63. $data = $this->__call('list', array($params)); 
  64. if ($this->useObjects()) { 
  65. return new Google_Experiments($data); 
  66. } else { 
  67. return $data; 
  68. /** 
  69. * Update an existing experiment. This method supports patch semantics. 
  70. * (experiments.patch) 
  71. * @param string $accountId Account ID of the experiment to update. 
  72. * @param string $webPropertyId Web property ID of the experiment to update. 
  73. * @param string $profileId View (Profile) ID of the experiment to update. 
  74. * @param string $experimentId Experiment ID of the experiment to update. 
  75. * @param Google_Experiment $postBody 
  76. * @param array $optParams Optional parameters. 
  77. * @return Google_Experiment 
  78. */ 
  79. public function patch($accountId, $webPropertyId, $profileId, $experimentId, Google_Experiment $postBody, $optParams = array()) { 
  80. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'experimentId' => $experimentId, 'postBody' => $postBody); 
  81. $params = array_merge($params, $optParams); 
  82. $data = $this->__call('patch', array($params)); 
  83. if ($this->useObjects()) { 
  84. return new Google_Experiment($data); 
  85. } else { 
  86. return $data; 
  87. /** 
  88. * Update an existing experiment. (experiments.update) 
  89. * @param string $accountId Account ID of the experiment to update. 
  90. * @param string $webPropertyId Web property ID of the experiment to update. 
  91. * @param string $profileId View (Profile) ID of the experiment to update. 
  92. * @param string $experimentId Experiment ID of the experiment to update. 
  93. * @param Google_Experiment $postBody 
  94. * @param array $optParams Optional parameters. 
  95. * @return Google_Experiment 
  96. */ 
  97. public function update($accountId, $webPropertyId, $profileId, $experimentId, Google_Experiment $postBody, $optParams = array()) { 
  98. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'experimentId' => $experimentId, 'postBody' => $postBody); 
  99. $params = array_merge($params, $optParams); 
  100. $data = $this->__call('update', array($params)); 
  101. if ($this->useObjects()) { 
  102. return new Google_Experiment($data); 
  103. } else { 
  104. return $data;