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
|
<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.provisioning.html">provisioning</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="#createAccountTicket">createAccountTicket(body=None)</a></code></p>
<p class="firstline">Creates an account ticket.</p>
<p class="toc_element">
<code><a href="#createAccountTree">createAccountTree(body=None)</a></code></p>
<p class="firstline">Provision account.</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="createAccountTicket">createAccountTicket(body=None)</code>
<pre>Creates an account ticket.
Args:
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
"account": { # JSON template for Analytics account entry. # Account for this ticket.
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.
"href": "A String", # Link to the list of web properties for this account.
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
},
"created": "A String", # Time the account was created.
"id": "A String", # Account ID.
"kind": "analytics#account", # Resource type for Analytics account.
"name": "A String", # Account name.
"permissions": { # Permissions the user has for this account.
"effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
"A String",
],
},
"selfLink": "A String", # Link for this account.
"starred": True or False, # Indicates whether this account is starred or not.
"updated": "A String", # Time the account was last modified.
},
"id": "A String", # Account ticket ID used to access the account ticket.
"kind": "analytics#accountTicket", # Resource type for account ticket.
"profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
"accountId": "A String", # Account ID to which this view (profile) belongs.
"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
"href": "A String", # Link to the list of goals for this view (profile).
"type": "analytics#goals", # Value is "analytics#goals".
},
"created": "A String", # Time this view (profile) was created.
"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
"defaultPage": "A String", # Default page for this view (profile).
"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
"id": "A String", # View (Profile) ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"kind": "analytics#profile", # Resource type for Analytics view (profile).
"name": "A String", # Name of this view (profile).
"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
"href": "A String", # Link to the web property to which this view (profile) belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"permissions": { # Permissions the user has for this view (profile).
"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
"A String",
],
},
"selfLink": "A String", # Link for this view (profile).
"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
"starred": True or False, # Indicates whether this view (profile) is starred or not.
"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
"type": "A String", # View (Profile) type. Supported types: WEB or APP.
"updated": "A String", # Time this view (profile) was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
"websiteUrl": "A String", # Website URL for this view (profile).
},
"redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
"webproperty": { # JSON template for an Analytics web property. # Web property for the account.
"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 account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
"account": { # JSON template for Analytics account entry. # Account for this ticket.
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.
"href": "A String", # Link to the list of web properties for this account.
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
},
"created": "A String", # Time the account was created.
"id": "A String", # Account ID.
"kind": "analytics#account", # Resource type for Analytics account.
"name": "A String", # Account name.
"permissions": { # Permissions the user has for this account.
"effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
"A String",
],
},
"selfLink": "A String", # Link for this account.
"starred": True or False, # Indicates whether this account is starred or not.
"updated": "A String", # Time the account was last modified.
},
"id": "A String", # Account ticket ID used to access the account ticket.
"kind": "analytics#accountTicket", # Resource type for account ticket.
"profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
"accountId": "A String", # Account ID to which this view (profile) belongs.
"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
"href": "A String", # Link to the list of goals for this view (profile).
"type": "analytics#goals", # Value is "analytics#goals".
},
"created": "A String", # Time this view (profile) was created.
"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
"defaultPage": "A String", # Default page for this view (profile).
"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
"id": "A String", # View (Profile) ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"kind": "analytics#profile", # Resource type for Analytics view (profile).
"name": "A String", # Name of this view (profile).
"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
"href": "A String", # Link to the web property to which this view (profile) belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"permissions": { # Permissions the user has for this view (profile).
"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
"A String",
],
},
"selfLink": "A String", # Link for this view (profile).
"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
"starred": True or False, # Indicates whether this view (profile) is starred or not.
"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
"type": "A String", # View (Profile) type. Supported types: WEB or APP.
"updated": "A String", # Time this view (profile) was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
"websiteUrl": "A String", # Website URL for this view (profile).
},
"redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
"webproperty": { # JSON template for an Analytics web property. # Web property for the account.
"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="createAccountTree">createAccountTree(body=None)</code>
<pre>Provision account.
Args:
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.
"accountName": "A String",
"kind": "analytics#accountTreeRequest", # Resource type for account ticket.
"profileName": "A String",
"timezone": "A String",
"webpropertyName": "A String",
"websiteUrl": "A String",
}
Returns:
An object of the form:
{ # JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).
"account": { # JSON template for Analytics account entry. # The account created.
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.
"href": "A String", # Link to the list of web properties for this account.
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
},
"created": "A String", # Time the account was created.
"id": "A String", # Account ID.
"kind": "analytics#account", # Resource type for Analytics account.
"name": "A String", # Account name.
"permissions": { # Permissions the user has for this account.
"effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
"A String",
],
},
"selfLink": "A String", # Link for this account.
"starred": True or False, # Indicates whether this account is starred or not.
"updated": "A String", # Time the account was last modified.
},
"kind": "analytics#accountTreeResponse", # Resource type for account ticket.
"profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
"accountId": "A String", # Account ID to which this view (profile) belongs.
"botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
"href": "A String", # Link to the list of goals for this view (profile).
"type": "analytics#goals", # Value is "analytics#goals".
},
"created": "A String", # Time this view (profile) was created.
"currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
# USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
"defaultPage": "A String", # Default page for this view (profile).
"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
"enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
"id": "A String", # View (Profile) ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"kind": "analytics#profile", # Resource type for Analytics view (profile).
"name": "A String", # Name of this view (profile).
"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
"href": "A String", # Link to the web property to which this view (profile) belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"permissions": { # Permissions the user has for this view (profile).
"effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
"A String",
],
},
"selfLink": "A String", # Link for this view (profile).
"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
"starred": True or False, # Indicates whether this view (profile) is starred or not.
"stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
"stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
"type": "A String", # View (Profile) type. Supported types: WEB or APP.
"updated": "A String", # Time this view (profile) was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
"websiteUrl": "A String", # Website URL for this view (profile).
},
"webproperty": { # JSON template for an Analytics web property. # Web property for the account.
"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>
|
