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