Google_Service_Dfareporting_UserRoles_Resource

The "userRoles" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Dfareporting.php  
  1. class Google_Service_Dfareporting_UserRoles_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes an existing user role. (userRoles.delete) 
  5. * @param string $profileId User profile ID associated with this request. 
  6. * @param string $id User role ID. 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($profileId, $id, $optParams = array()) 
  10. $params = array('profileId' => $profileId, 'id' => $id); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Gets one user role by ID. (userRoles.get) 
  16. * @param string $profileId User profile ID associated with this request. 
  17. * @param string $id User role ID. 
  18. * @param array $optParams Optional parameters. 
  19. * @return Google_Service_Dfareporting_UserRole 
  20. */ 
  21. public function get($profileId, $id, $optParams = array()) 
  22. $params = array('profileId' => $profileId, 'id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('get', array($params), "Google_Service_Dfareporting_UserRole"); 
  25.  
  26. /** 
  27. * Inserts a new user role. (userRoles.insert) 
  28. * @param string $profileId User profile ID associated with this request. 
  29. * @param Google_UserRole $postBody 
  30. * @param array $optParams Optional parameters. 
  31. * @return Google_Service_Dfareporting_UserRole 
  32. */ 
  33. public function insert($profileId, Google_Service_Dfareporting_UserRole $postBody, $optParams = array()) 
  34. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  35. $params = array_merge($params, $optParams); 
  36. return $this->call('insert', array($params), "Google_Service_Dfareporting_UserRole"); 
  37.  
  38. /** 
  39. * Retrieves a list of user roles, possibly filtered. (userRoles.listUserRoles) 
  40. * @param string $profileId User profile ID associated with this request. 
  41. * @param array $optParams Optional parameters. 
  42. * @opt_param string searchString Allows searching for objects by name or ID. 
  43. * Wildcards (*) are allowed. For example, "userrole*2015" will return objects 
  44. * with names like "userrole June 2015", "userrole April 2015" or simply 
  45. * "userrole 2015". Most of the searches also add wildcards implicitly at the 
  46. * start and the end of the search string. For example, a search string of 
  47. * "userrole" will match objects with name "my userrole", "userrole 2015" or 
  48. * simply "userrole". 
  49. * @opt_param string subaccountId Select only user roles that belong to this 
  50. * subaccount. 
  51. * @opt_param string sortField Field by which to sort the list. 
  52. * @opt_param string ids Select only user roles with the specified IDs. 
  53. * @opt_param int maxResults Maximum number of results to return. 
  54. * @opt_param string pageToken Value of the nextPageToken from the previous 
  55. * result page. 
  56. * @opt_param string sortOrder Order of sorted results, default is ASCENDING. 
  57. * @opt_param bool accountUserRoleOnly Select only account level user roles not 
  58. * associated with any specific subaccount. 
  59. * @return Google_Service_Dfareporting_UserRolesListResponse 
  60. */ 
  61. public function listUserRoles($profileId, $optParams = array()) 
  62. $params = array('profileId' => $profileId); 
  63. $params = array_merge($params, $optParams); 
  64. return $this->call('list', array($params), "Google_Service_Dfareporting_UserRolesListResponse"); 
  65.  
  66. /** 
  67. * Updates an existing user role. This method supports patch semantics. 
  68. * (userRoles.patch) 
  69. * @param string $profileId User profile ID associated with this request. 
  70. * @param string $id User role ID. 
  71. * @param Google_UserRole $postBody 
  72. * @param array $optParams Optional parameters. 
  73. * @return Google_Service_Dfareporting_UserRole 
  74. */ 
  75. public function patch($profileId, $id, Google_Service_Dfareporting_UserRole $postBody, $optParams = array()) 
  76. $params = array('profileId' => $profileId, 'id' => $id, 'postBody' => $postBody); 
  77. $params = array_merge($params, $optParams); 
  78. return $this->call('patch', array($params), "Google_Service_Dfareporting_UserRole"); 
  79.  
  80. /** 
  81. * Updates an existing user role. (userRoles.update) 
  82. * @param string $profileId User profile ID associated with this request. 
  83. * @param Google_UserRole $postBody 
  84. * @param array $optParams Optional parameters. 
  85. * @return Google_Service_Dfareporting_UserRole 
  86. */ 
  87. public function update($profileId, Google_Service_Dfareporting_UserRole $postBody, $optParams = array()) 
  88. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  89. $params = array_merge($params, $optParams); 
  90. return $this->call('update', array($params), "Google_Service_Dfareporting_UserRole");