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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webpropertyUserLinks.html">webpropertyUserLinks</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(accountId, webPropertyId, linkId)</a></code></p> 82<p class="firstline">Removes a user from the given web property.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p> 85<p class="firstline">Adds a new user to the given web property.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p> 88<p class="firstline">Lists webProperty-user links for a given web property.</p> 89<p class="toc_element"> 90 <code><a href="#update">update(accountId, webPropertyId, linkId, body=None)</a></code></p> 91<p class="firstline">Updates permissions for an existing user on the given web property.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="delete">delete(accountId, webPropertyId, linkId)</code> 100 <pre>Removes a user from the given web property. 101 102Args: 103 accountId: string, Account ID to delete the user link for. (required) 104 webPropertyId: string, Web Property ID to delete the user link for. (required) 105 linkId: string, Link ID to delete the user link for. (required) 106</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code> 111 <pre>Adds a new user to the given web property. 112 113Args: 114 accountId: string, Account ID to create the user link for. (required) 115 webPropertyId: string, Web Property ID to create the user link for. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. 120 "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). 121 "accountRef": { # JSON template for a linked account. # Account for this link. 122 "href": "A String", # Link for this account. 123 "id": "A String", # Account ID. 124 "kind": "analytics#accountRef", # Analytics account reference. 125 "name": "A String", # Account name. 126 }, 127 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 128 "accountId": "A String", # Account ID to which this view (profile) belongs. 129 "href": "A String", # Link for this view (profile). 130 "id": "A String", # View (Profile) ID. 131 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 132 "kind": "analytics#profileRef", # Analytics view (profile) reference. 133 "name": "A String", # Name of this view (profile). 134 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 135 }, 136 "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. 137 "accountId": "A String", # Account ID to which this web property belongs. 138 "href": "A String", # Link for this web property. 139 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 140 "internalWebPropertyId": "A String", # Internal ID for this web property. 141 "kind": "analytics#webPropertyRef", # Analytics web property reference. 142 "name": "A String", # Name of this web property. 143 }, 144 }, 145 "id": "A String", # Entity user link ID 146 "kind": "analytics#entityUserLink", # Resource type for entity user link. 147 "permissions": { # Permissions the user has for this entity. 148 "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only. 149 "A String", 150 ], 151 "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. 152 "A String", 153 ], 154 }, 155 "selfLink": "A String", # Self link for this resource. 156 "userRef": { # JSON template for a user reference. # User reference. 157 "email": "A String", # Email ID of this user. 158 "id": "A String", # User ID. 159 "kind": "analytics#userRef", 160 }, 161} 162 163 164Returns: 165 An object of the form: 166 167 { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. 168 "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). 169 "accountRef": { # JSON template for a linked account. # Account for this link. 170 "href": "A String", # Link for this account. 171 "id": "A String", # Account ID. 172 "kind": "analytics#accountRef", # Analytics account reference. 173 "name": "A String", # Account name. 174 }, 175 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 176 "accountId": "A String", # Account ID to which this view (profile) belongs. 177 "href": "A String", # Link for this view (profile). 178 "id": "A String", # View (Profile) ID. 179 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 180 "kind": "analytics#profileRef", # Analytics view (profile) reference. 181 "name": "A String", # Name of this view (profile). 182 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 183 }, 184 "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. 185 "accountId": "A String", # Account ID to which this web property belongs. 186 "href": "A String", # Link for this web property. 187 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 188 "internalWebPropertyId": "A String", # Internal ID for this web property. 189 "kind": "analytics#webPropertyRef", # Analytics web property reference. 190 "name": "A String", # Name of this web property. 191 }, 192 }, 193 "id": "A String", # Entity user link ID 194 "kind": "analytics#entityUserLink", # Resource type for entity user link. 195 "permissions": { # Permissions the user has for this entity. 196 "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only. 197 "A String", 198 ], 199 "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. 200 "A String", 201 ], 202 }, 203 "selfLink": "A String", # Self link for this resource. 204 "userRef": { # JSON template for a user reference. # User reference. 205 "email": "A String", # Email ID of this user. 206 "id": "A String", # User ID. 207 "kind": "analytics#userRef", 208 }, 209}</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code> 214 <pre>Lists webProperty-user links for a given web property. 215 216Args: 217 accountId: string, Account ID which the given web property belongs to. (required) 218 webPropertyId: string, Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required) 219 max_results: integer, The maximum number of webProperty-user Links to include in this response. 220 start_index: integer, An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 221 222Returns: 223 An object of the form: 224 225 { # An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link. 226 "items": [ # A list of entity user links. 227 { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. 228 "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). 229 "accountRef": { # JSON template for a linked account. # Account for this link. 230 "href": "A String", # Link for this account. 231 "id": "A String", # Account ID. 232 "kind": "analytics#accountRef", # Analytics account reference. 233 "name": "A String", # Account name. 234 }, 235 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 236 "accountId": "A String", # Account ID to which this view (profile) belongs. 237 "href": "A String", # Link for this view (profile). 238 "id": "A String", # View (Profile) ID. 239 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 240 "kind": "analytics#profileRef", # Analytics view (profile) reference. 241 "name": "A String", # Name of this view (profile). 242 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 243 }, 244 "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. 245 "accountId": "A String", # Account ID to which this web property belongs. 246 "href": "A String", # Link for this web property. 247 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 248 "internalWebPropertyId": "A String", # Internal ID for this web property. 249 "kind": "analytics#webPropertyRef", # Analytics web property reference. 250 "name": "A String", # Name of this web property. 251 }, 252 }, 253 "id": "A String", # Entity user link ID 254 "kind": "analytics#entityUserLink", # Resource type for entity user link. 255 "permissions": { # Permissions the user has for this entity. 256 "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only. 257 "A String", 258 ], 259 "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. 260 "A String", 261 ], 262 }, 263 "selfLink": "A String", # Self link for this resource. 264 "userRef": { # JSON template for a user reference. # User reference. 265 "email": "A String", # Email ID of this user. 266 "id": "A String", # User ID. 267 "kind": "analytics#userRef", 268 }, 269 }, 270 ], 271 "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. 272 "kind": "analytics#entityUserLinks", # Collection type. 273 "nextLink": "A String", # Next link for this account collection. 274 "previousLink": "A String", # Previous link for this account collection. 275 "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. 276 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. 277}</pre> 278</div> 279 280<div class="method"> 281 <code class="details" id="update">update(accountId, webPropertyId, linkId, body=None)</code> 282 <pre>Updates permissions for an existing user on the given web property. 283 284Args: 285 accountId: string, Account ID to update the account-user link for. (required) 286 webPropertyId: string, Web property ID to update the account-user link for. (required) 287 linkId: string, Link ID to update the account-user link for. (required) 288 body: object, The request body. 289 The object takes the form of: 290 291{ # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. 292 "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). 293 "accountRef": { # JSON template for a linked account. # Account for this link. 294 "href": "A String", # Link for this account. 295 "id": "A String", # Account ID. 296 "kind": "analytics#accountRef", # Analytics account reference. 297 "name": "A String", # Account name. 298 }, 299 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 300 "accountId": "A String", # Account ID to which this view (profile) belongs. 301 "href": "A String", # Link for this view (profile). 302 "id": "A String", # View (Profile) ID. 303 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 304 "kind": "analytics#profileRef", # Analytics view (profile) reference. 305 "name": "A String", # Name of this view (profile). 306 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 307 }, 308 "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. 309 "accountId": "A String", # Account ID to which this web property belongs. 310 "href": "A String", # Link for this web property. 311 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 312 "internalWebPropertyId": "A String", # Internal ID for this web property. 313 "kind": "analytics#webPropertyRef", # Analytics web property reference. 314 "name": "A String", # Name of this web property. 315 }, 316 }, 317 "id": "A String", # Entity user link ID 318 "kind": "analytics#entityUserLink", # Resource type for entity user link. 319 "permissions": { # Permissions the user has for this entity. 320 "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only. 321 "A String", 322 ], 323 "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. 324 "A String", 325 ], 326 }, 327 "selfLink": "A String", # Self link for this resource. 328 "userRef": { # JSON template for a user reference. # User reference. 329 "email": "A String", # Email ID of this user. 330 "id": "A String", # User ID. 331 "kind": "analytics#userRef", 332 }, 333} 334 335 336Returns: 337 An object of the form: 338 339 { # JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. 340 "entity": { # Entity for this link. It can be an account, a web property, or a view (profile). 341 "accountRef": { # JSON template for a linked account. # Account for this link. 342 "href": "A String", # Link for this account. 343 "id": "A String", # Account ID. 344 "kind": "analytics#accountRef", # Analytics account reference. 345 "name": "A String", # Account name. 346 }, 347 "profileRef": { # JSON template for a linked view (profile). # View (Profile) for this link. 348 "accountId": "A String", # Account ID to which this view (profile) belongs. 349 "href": "A String", # Link for this view (profile). 350 "id": "A String", # View (Profile) ID. 351 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. 352 "kind": "analytics#profileRef", # Analytics view (profile) reference. 353 "name": "A String", # Name of this view (profile). 354 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. 355 }, 356 "webPropertyRef": { # JSON template for a web property reference. # Web property for this link. 357 "accountId": "A String", # Account ID to which this web property belongs. 358 "href": "A String", # Link for this web property. 359 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 360 "internalWebPropertyId": "A String", # Internal ID for this web property. 361 "kind": "analytics#webPropertyRef", # Analytics web property reference. 362 "name": "A String", # Name of this web property. 363 }, 364 }, 365 "id": "A String", # Entity user link ID 366 "kind": "analytics#entityUserLink", # Resource type for entity user link. 367 "permissions": { # Permissions the user has for this entity. 368 "effective": [ # Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only. 369 "A String", 370 ], 371 "local": [ # Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable. 372 "A String", 373 ], 374 }, 375 "selfLink": "A String", # Self link for this resource. 376 "userRef": { # JSON template for a user reference. # User reference. 377 "email": "A String", # Email ID of this user. 378 "id": "A String", # User ID. 379 "kind": "analytics#userRef", 380 }, 381}</pre> 382</div> 383 384</body></html>