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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
|
<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.experiments.html">experiments</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="#delete">delete(accountId, webPropertyId, profileId, experimentId)</a></code></p>
<p class="firstline">Delete an experiment.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, profileId, experimentId)</a></code></p>
<p class="firstline">Returns an experiment to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p>
<p class="firstline">Create a new experiment.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists experiments to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, profileId, experimentId, body=None)</a></code></p>
<p class="firstline">Update an existing experiment. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, profileId, experimentId, body=None)</a></code></p>
<p class="firstline">Update an existing experiment.</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="delete">delete(accountId, webPropertyId, profileId, experimentId)</code>
<pre>Delete an experiment.
Args:
accountId: string, Account ID to which the experiment belongs (required)
webPropertyId: string, Web property ID to which the experiment belongs (required)
profileId: string, View (Profile) ID to which the experiment belongs (required)
experimentId: string, ID of the experiment to delete (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, profileId, experimentId)</code>
<pre>Returns an experiment to which the user has access.
Args:
accountId: string, Account ID to retrieve the experiment for. (required)
webPropertyId: string, Web property ID to retrieve the experiment for. (required)
profileId: string, View (Profile) ID to retrieve the experiment for. (required)
experimentId: string, Experiment ID to retrieve the experiment for. (required)
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code>
<pre>Create a new experiment.
Args:
accountId: string, Account ID to create the experiment for. (required)
webPropertyId: string, Web property ID to create the experiment for. (required)
profileId: string, View (Profile) ID to create the experiment for. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
<pre>Lists experiments to which the user has access.
Args:
accountId: string, Account ID to retrieve experiments for. (required)
webPropertyId: string, Web property ID to retrieve experiments for. (required)
profileId: string, View (Profile) ID to retrieve experiments for. (required)
max_results: integer, The maximum number of experiments to include in this response.
start_index: integer, An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.
"items": [ # A list of experiments.
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
},
],
"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#experiments", # Collection type.
"nextLink": "A String", # Link to next page for this experiment collection.
"previousLink": "A String", # Link to previous page for this experiment 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 resources in the result.
"username": "A String", # Email ID of the authenticated user
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, webPropertyId, profileId, experimentId, body=None)</code>
<pre>Update an existing experiment. This method supports patch semantics.
Args:
accountId: string, Account ID of the experiment to update. (required)
webPropertyId: string, Web property ID of the experiment to update. (required)
profileId: string, View (Profile) ID of the experiment to update. (required)
experimentId: string, Experiment ID of the experiment to update. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, webPropertyId, profileId, experimentId, body=None)</code>
<pre>Update an existing experiment.
Args:
accountId: string, Account ID of the experiment to update. (required)
webPropertyId: string, Web property ID of the experiment to update. (required)
profileId: string, View (Profile) ID of the experiment to update. (required)
experimentId: string, Experiment ID of the experiment to update. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"created": "A String", # Time the experiment was created. This field is read-only.
"description": "A String", # Notes about this experiment.
"editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"equalWeighting": True or False, # Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"minimumExperimentLengthInDays": 42, # An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"selfLink": "A String", # Link for this experiment. This field is read-only.
"servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"trafficCoverage": 3.14, # A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
},
],
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
}</pre>
</div>
</body></html>
|
