1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.userRoles.html">userRoles</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(profileId, id)</a></code></p> 79 <p class="firstline">Deletes an existing user role.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(profileId, id)</a></code></p> 82 <p class="firstline">Gets one user role by ID.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(profileId, body)</a></code></p> 85 <p class="firstline">Inserts a new user role.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</a></code></p> 88 <p class="firstline">Retrieves a list of user roles, possibly filtered. This method supports paging.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 94 <p class="firstline">Updates an existing user role. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#update">update(profileId, body)</a></code></p> 97 <p class="firstline">Updates an existing user role.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="delete">delete(profileId, id)</code> 101 <pre>Deletes an existing user role. 102 103 Args: 104 profileId: string, User profile ID associated with this request. (required) 105 id: string, User role ID. (required) 106 </pre> 107 </div> 108 109 <div class="method"> 110 <code class="details" id="get">get(profileId, id)</code> 111 <pre>Gets one user role by ID. 112 113 Args: 114 profileId: string, User profile ID associated with this request. (required) 115 id: string, User role ID. (required) 116 117 Returns: 118 An object of the form: 119 120 { # Contains properties of auser role, which is used to manage user access. 121 "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. 122 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 123 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 124 "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. 125 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 126 "permissions": [ # List of permissions associated with this user role. 127 { # Contains properties of a user role permission. 128 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 129 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 130 "availability": "A String", # Levels of availability for a user role permission. 131 "name": "A String", # Name of this user role permission. 132 "id": "A String", # ID of this user role permission. 133 }, 134 ], 135 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 136 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 137 }</pre> 138 </div> 139 140 <div class="method"> 141 <code class="details" id="insert">insert(profileId, body)</code> 142 <pre>Inserts a new user role. 143 144 Args: 145 profileId: string, User profile ID associated with this request. (required) 146 body: object, The request body. (required) 147 The object takes the form of: 148 149 { # Contains properties of auser role, which is used to manage user access. 150 "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. 151 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 152 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 153 "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. 154 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 155 "permissions": [ # List of permissions associated with this user role. 156 { # Contains properties of a user role permission. 157 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 158 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 159 "availability": "A String", # Levels of availability for a user role permission. 160 "name": "A String", # Name of this user role permission. 161 "id": "A String", # ID of this user role permission. 162 }, 163 ], 164 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 165 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 166 } 167 168 169 Returns: 170 An object of the form: 171 172 { # Contains properties of auser role, which is used to manage user access. 173 "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. 174 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 175 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 176 "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. 177 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 178 "permissions": [ # List of permissions associated with this user role. 179 { # Contains properties of a user role permission. 180 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 181 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 182 "availability": "A String", # Levels of availability for a user role permission. 183 "name": "A String", # Name of this user role permission. 184 "id": "A String", # ID of this user role permission. 185 }, 186 ], 187 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 188 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 189 }</pre> 190 </div> 191 192 <div class="method"> 193 <code class="details" id="list">list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)</code> 194 <pre>Retrieves a list of user roles, possibly filtered. This method supports paging. 195 196 Args: 197 profileId: string, User profile ID associated with this request. (required) 198 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". 199 subaccountId: string, Select only user roles that belong to this subaccount. 200 pageToken: string, Value of the nextPageToken from the previous result page. 201 ids: string, Select only user roles with the specified IDs. (repeated) 202 maxResults: integer, Maximum number of results to return. 203 accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount. 204 sortOrder: string, Order of sorted results. 205 Allowed values 206 ASCENDING - 207 DESCENDING - 208 sortField: string, Field by which to sort the list. 209 Allowed values 210 ID - 211 NAME - 212 213 Returns: 214 An object of the form: 215 216 { # User Role List Response 217 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 218 "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". 219 "userRoles": [ # User role collection. 220 { # Contains properties of auser role, which is used to manage user access. 221 "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. 222 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 223 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 224 "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. 225 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 226 "permissions": [ # List of permissions associated with this user role. 227 { # Contains properties of a user role permission. 228 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 229 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 230 "availability": "A String", # Levels of availability for a user role permission. 231 "name": "A String", # Name of this user role permission. 232 "id": "A String", # ID of this user role permission. 233 }, 234 ], 235 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 236 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 237 }, 238 ], 239 }</pre> 240 </div> 241 242 <div class="method"> 243 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 244 <pre>Retrieves the next page of results. 245 246 Args: 247 previous_request: The request for the previous page. (required) 248 previous_response: The response from the request for the previous page. (required) 249 250 Returns: 251 A request object that you can call 'execute()' on to request the next 252 page. Returns None if there are no more items in the collection. 253 </pre> 254 </div> 255 256 <div class="method"> 257 <code class="details" id="patch">patch(profileId, id, body)</code> 258 <pre>Updates an existing user role. This method supports patch semantics. 259 260 Args: 261 profileId: string, User profile ID associated with this request. (required) 262 id: string, User role ID. (required) 263 body: object, The request body. (required) 264 The object takes the form of: 265 266 { # Contains properties of auser role, which is used to manage user access. 267 "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. 268 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 269 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 270 "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. 271 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 272 "permissions": [ # List of permissions associated with this user role. 273 { # Contains properties of a user role permission. 274 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 275 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 276 "availability": "A String", # Levels of availability for a user role permission. 277 "name": "A String", # Name of this user role permission. 278 "id": "A String", # ID of this user role permission. 279 }, 280 ], 281 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 282 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 283 } 284 285 286 Returns: 287 An object of the form: 288 289 { # Contains properties of auser role, which is used to manage user access. 290 "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. 291 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 292 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 293 "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. 294 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 295 "permissions": [ # List of permissions associated with this user role. 296 { # Contains properties of a user role permission. 297 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 298 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 299 "availability": "A String", # Levels of availability for a user role permission. 300 "name": "A String", # Name of this user role permission. 301 "id": "A String", # ID of this user role permission. 302 }, 303 ], 304 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 305 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 306 }</pre> 307 </div> 308 309 <div class="method"> 310 <code class="details" id="update">update(profileId, body)</code> 311 <pre>Updates an existing user role. 312 313 Args: 314 profileId: string, User profile ID associated with this request. (required) 315 body: object, The request body. (required) 316 The object takes the form of: 317 318 { # Contains properties of auser role, which is used to manage user access. 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 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 321 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 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 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 327 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 328 "availability": "A String", # Levels of availability for a user role permission. 329 "name": "A String", # Name of this user role permission. 330 "id": "A String", # ID of this user role permission. 331 }, 332 ], 333 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 334 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 335 } 336 337 338 Returns: 339 An object of the form: 340 341 { # Contains properties of auser role, which is used to manage user access. 342 "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. 343 "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". 344 "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank. 345 "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. 346 "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field. 347 "permissions": [ # List of permissions associated with this user role. 348 { # Contains properties of a user role permission. 349 "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to. 350 "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". 351 "availability": "A String", # Levels of availability for a user role permission. 352 "name": "A String", # Name of this user role permission. 353 "id": "A String", # ID of this user role permission. 354 }, 355 ], 356 "id": "A String", # ID of this user role. This is a read-only, auto-generated field. 357 "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank. 358 }</pre> 359 </div> 360 361 </body></html>
