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