Google_ManagementWebpropertiesServiceResource

The "webproperties" 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_ManagementWebpropertiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Gets a web property to which the user has access. (webproperties.get) 
  5. * @param string $accountId Account ID to retrieve the web property for. 
  6. * @param string $webPropertyId ID to retrieve the web property for. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Webproperty 
  9. */ 
  10. public function get($accountId, $webPropertyId, $optParams = array()) { 
  11. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId); 
  12. $params = array_merge($params, $optParams); 
  13. $data = $this->__call('get', array($params)); 
  14. if ($this->useObjects()) { 
  15. return new Google_Webproperty($data); 
  16. } else { 
  17. return $data; 
  18. /** 
  19. * Create a new property if the account has fewer than 20 properties. 
  20. * (webproperties.insert) 
  21. * @param string $accountId Account ID to create the web property for. 
  22. * @param Google_Webproperty $postBody 
  23. * @param array $optParams Optional parameters. 
  24. * @return Google_Webproperty 
  25. */ 
  26. public function insert($accountId, Google_Webproperty $postBody, $optParams = array()) { 
  27. $params = array('accountId' => $accountId, 'postBody' => $postBody); 
  28. $params = array_merge($params, $optParams); 
  29. $data = $this->__call('insert', array($params)); 
  30. if ($this->useObjects()) { 
  31. return new Google_Webproperty($data); 
  32. } else { 
  33. return $data; 
  34. /** 
  35. * Lists web properties to which the user has access. (webproperties.list) 
  36. * @param string $accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. 
  37. * @param array $optParams Optional parameters. 
  38. * @opt_param int max-results The maximum number of web properties to include in this response. 
  39. * @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. 
  40. * @return Google_Webproperties 
  41. */ 
  42. public function listManagementWebproperties($accountId, $optParams = array()) { 
  43. $params = array('accountId' => $accountId); 
  44. $params = array_merge($params, $optParams); 
  45. $data = $this->__call('list', array($params)); 
  46. if ($this->useObjects()) { 
  47. return new Google_Webproperties($data); 
  48. } else { 
  49. return $data; 
  50. /** 
  51. * Updates an existing web property. This method supports patch semantics. 
  52. * (webproperties.patch) 
  53. * @param string $accountId Account ID to which the web property belongs 
  54. * @param string $webPropertyId Web property ID 
  55. * @param Google_Webproperty $postBody 
  56. * @param array $optParams Optional parameters. 
  57. * @return Google_Webproperty 
  58. */ 
  59. public function patch($accountId, $webPropertyId, Google_Webproperty $postBody, $optParams = array()) { 
  60. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody); 
  61. $params = array_merge($params, $optParams); 
  62. $data = $this->__call('patch', array($params)); 
  63. if ($this->useObjects()) { 
  64. return new Google_Webproperty($data); 
  65. } else { 
  66. return $data; 
  67. /** 
  68. * Updates an existing web property. (webproperties.update) 
  69. * @param string $accountId Account ID to which the web property belongs 
  70. * @param string $webPropertyId Web property ID 
  71. * @param Google_Webproperty $postBody 
  72. * @param array $optParams Optional parameters. 
  73. * @return Google_Webproperty 
  74. */ 
  75. public function update($accountId, $webPropertyId, Google_Webproperty $postBody, $optParams = array()) { 
  76. $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody); 
  77. $params = array_merge($params, $optParams); 
  78. $data = $this->__call('update', array($params)); 
  79. if ($this->useObjects()) { 
  80. return new Google_Webproperty($data); 
  81. } else { 
  82. return $data;