1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webproperties.html">webproperties</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId)</a></code></p>
<p class="firstline">Gets a web property to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, body=None)</a></code></p>
<p class="firstline">Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists web properties to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, body=None)</a></code></p>
<p class="firstline">Updates an existing web property. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, body=None)</a></code></p>
<p class="firstline">Updates an existing web property.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId)</code>
<pre>Gets a web property to which the user has access.
Args:
accountId: string, Account ID to retrieve the web property for. (required)
webPropertyId: string, ID to retrieve the web property for. (required)
Returns:
An object of the form:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, body=None)</code>
<pre>Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.
Args:
accountId: string, Account ID to create the web property for. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}
Returns:
An object of the form:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, max_results=None, start_index=None)</code>
<pre>Lists web properties to which the user has access.
Args:
accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
max_results: integer, The maximum number of web properties to include in this response.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
"items": [ # A list of web properties.
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"kind": "analytics#webproperties", # Collection type.
"nextLink": "A String", # Link to next page for this web property collection.
"previousLink": "A String", # Link to previous page for this web property collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
"username": "A String", # Email ID of the authenticated user
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, webPropertyId, body=None)</code>
<pre>Updates an existing web property. This method supports patch semantics.
Args:
accountId: string, Account ID to which the web property belongs (required)
webPropertyId: string, Web property ID (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}
Returns:
An object of the form:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, webPropertyId, body=None)</code>
<pre>Updates an existing web property.
Args:
accountId: string, Account ID to which the web property belongs (required)
webPropertyId: string, Web property ID (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}
Returns:
An object of the form:
{ # JSON template for an Analytics web property.
"accountId": "A String", # Account ID to which this web property belongs.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"created": "A String", # Time this web property was created.
"dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
# Set to false to delete data associated with the user identifier automatically after the rentention period.
# This property cannot be set on insert.
"dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
# This property cannot be set on insert.
"defaultProfileId": "A String", # Default view (profile) ID.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"name": "A String", # Name of this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"permissions": { # Permissions the user has for this web property.
"effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
"A String",
],
},
"profileCount": 42, # View (Profile) count for this web property.
"selfLink": "A String", # Link for this web property.
"starred": True or False, # Indicates whether this web property is starred or not.
"updated": "A String", # Time this web property was last modified.
"websiteUrl": "A String", # Website url for this web property.
}</pre>
</div>
</body></html>
|
