1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.userRoles.html">userRoles</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(profileId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an existing user role.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets one user role by ID.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a new user role.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(profileId, accountUserRoleOnly=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of user roles, possibly filtered. This method supports paging.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing user role. This method supports patch semantics.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing user role.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code> 109 <pre>Deletes an existing user role. 110 111Args: 112 profileId: string, User profile ID associated with this request. (required) 113 id: string, User role ID. (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118</pre> 119</div> 120 121<div class="method"> 122 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 123 <pre>Gets one user role by ID. 124 125Args: 126 profileId: string, User profile ID associated with this request. (required) 127 id: string, User role ID. (required) 128 x__xgafv: string, V1 error format. 129 Allowed values 130 1 - v1 error format 131 2 - v2 error format 132 133Returns: 134 An object of the form: 135 136 { # Contains properties of auser role, which is used to manage user access. 137 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 138 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 139 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 140 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 141 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 142 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 143 "permissions": [ # List of permissions associated with this user role. 144 { # Contains properties of a user role permission. 145 "availability": "A String", # Levels of availability for a user role permission. 146 "id": "A String", # ID of this user role permission. 147 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 148 "name": "A String", # Name of this user role permission. 149 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 150 }, 151 ], 152 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 153}</pre> 154</div> 155 156<div class="method"> 157 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 158 <pre>Inserts a new user role. 159 160Args: 161 profileId: string, User profile ID associated with this request. (required) 162 body: object, The request body. 163 The object takes the form of: 164 165{ # Contains properties of auser role, which is used to manage user access. 166 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 167 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 168 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 169 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 170 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 171 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 172 "permissions": [ # List of permissions associated with this user role. 173 { # Contains properties of a user role permission. 174 "availability": "A String", # Levels of availability for a user role permission. 175 "id": "A String", # ID of this user role permission. 176 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 177 "name": "A String", # Name of this user role permission. 178 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 179 }, 180 ], 181 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 182} 183 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # Contains properties of auser role, which is used to manage user access. 193 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 194 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 195 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 196 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 197 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 198 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 199 "permissions": [ # List of permissions associated with this user role. 200 { # Contains properties of a user role permission. 201 "availability": "A String", # Levels of availability for a user role permission. 202 "id": "A String", # ID of this user role permission. 203 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 204 "name": "A String", # Name of this user role permission. 205 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 206 }, 207 ], 208 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 209}</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="list">list(profileId, accountUserRoleOnly=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</code> 214 <pre>Retrieves a list of user roles, possibly filtered. This method supports paging. 215 216Args: 217 profileId: string, User profile ID associated with this request. (required) 218 accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount. 219 ids: string, Select only user roles with the specified IDs. (repeated) 220 maxResults: integer, Maximum number of results to return. 221 pageToken: string, Value of the nextPageToken from the previous result page. 222 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". 223 sortField: string, Field by which to sort the list. 224 Allowed values 225 ID - 226 NAME - 227 sortOrder: string, Order of sorted results. 228 Allowed values 229 ASCENDING - 230 DESCENDING - 231 subaccountId: string, Select only user roles that belong to this subaccount. 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # User Role List Response 241 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". 242 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 243 "userRoles": [ # User role collection. 244 { # Contains properties of auser role, which is used to manage user access. 245 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 246 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 247 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 248 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 249 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 250 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 251 "permissions": [ # List of permissions associated with this user role. 252 { # Contains properties of a user role permission. 253 "availability": "A String", # Levels of availability for a user role permission. 254 "id": "A String", # ID of this user role permission. 255 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 256 "name": "A String", # Name of this user role permission. 257 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 258 }, 259 ], 260 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 261 }, 262 ], 263}</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 268 <pre>Retrieves the next page of results. 269 270Args: 271 previous_request: The request for the previous page. (required) 272 previous_response: The response from the request for the previous page. (required) 273 274Returns: 275 A request object that you can call 'execute()' on to request the next 276 page. Returns None if there are no more items in the collection. 277 </pre> 278</div> 279 280<div class="method"> 281 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 282 <pre>Updates an existing user role. This method supports patch semantics. 283 284Args: 285 profileId: string, User profile ID associated with this request. (required) 286 id: string, UserRole ID. (required) 287 body: object, The request body. 288 The object takes the form of: 289 290{ # Contains properties of auser role, which is used to manage user access. 291 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 292 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 293 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 294 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 295 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 296 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 297 "permissions": [ # List of permissions associated with this user role. 298 { # Contains properties of a user role permission. 299 "availability": "A String", # Levels of availability for a user role permission. 300 "id": "A String", # ID of this user role permission. 301 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 302 "name": "A String", # Name of this user role permission. 303 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 304 }, 305 ], 306 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 307} 308 309 x__xgafv: string, V1 error format. 310 Allowed values 311 1 - v1 error format 312 2 - v2 error format 313 314Returns: 315 An object of the form: 316 317 { # Contains properties of auser role, which is used to manage user access. 318 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 319 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 320 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 321 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 322 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 323 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 324 "permissions": [ # List of permissions associated with this user role. 325 { # Contains properties of a user role permission. 326 "availability": "A String", # Levels of availability for a user role permission. 327 "id": "A String", # ID of this user role permission. 328 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 329 "name": "A String", # Name of this user role permission. 330 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 331 }, 332 ], 333 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 334}</pre> 335</div> 336 337<div class="method"> 338 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 339 <pre>Updates an existing user role. 340 341Args: 342 profileId: string, User profile ID associated with this request. (required) 343 body: object, The request body. 344 The object takes the form of: 345 346{ # Contains properties of auser role, which is used to manage user access. 347 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 348 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 349 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 350 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 351 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 352 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 353 "permissions": [ # List of permissions associated with this user role. 354 { # Contains properties of a user role permission. 355 "availability": "A String", # Levels of availability for a user role permission. 356 "id": "A String", # ID of this user role permission. 357 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 358 "name": "A String", # Name of this user role permission. 359 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 360 }, 361 ], 362 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 363} 364 365 x__xgafv: string, V1 error format. 366 Allowed values 367 1 - v1 error format 368 2 - v2 error format 369 370Returns: 371 An object of the form: 372 373 { # Contains properties of auser role, which is used to manage user access. 374 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 375 "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. 376 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 377 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 378 "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. 379 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 380 "permissions": [ # List of permissions associated with this user role. 381 { # Contains properties of a user role permission. 382 "availability": "A String", # Levels of availability for a user role permission. 383 "id": "A String", # ID of this user role permission. 384 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 385 "name": "A String", # Name of this user role permission. 386 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 387 }, 388 ], 389 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 390}</pre> 391</div> 392 393</body></html>