| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.experiments.html">experiments</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 81 | <code><a href="#delete">delete(accountId, webPropertyId, profileId, experimentId)</a></code></p> |
| 82 | <p class="firstline">Delete an experiment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(accountId, webPropertyId, profileId, experimentId)</a></code></p> |
| 85 | <p class="firstline">Returns an experiment to which the user has access.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Create a new experiment.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 90 | <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Lists experiments to which the user has access.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(accountId, webPropertyId, profileId, experimentId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Update an existing experiment. This method supports patch semantics.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#update">update(accountId, webPropertyId, profileId, experimentId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 97 | <p class="firstline">Update an existing experiment.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | <code class="details" id="delete">delete(accountId, webPropertyId, profileId, experimentId)</code> |
| 106 | <pre>Delete an experiment. |
| 107 | |
| 108 | Args: |
| 109 | accountId: string, Account ID to which the experiment belongs (required) |
| 110 | webPropertyId: string, Web property ID to which the experiment belongs (required) |
| 111 | profileId: string, View (Profile) ID to which the experiment belongs (required) |
| 112 | experimentId: string, ID of the experiment to delete (required) |
| 113 | </pre> |
| 114 | </div> |
| 115 | |
| 116 | <div class="method"> |
| 117 | <code class="details" id="get">get(accountId, webPropertyId, profileId, experimentId)</code> |
| 118 | <pre>Returns an experiment to which the user has access. |
| 119 | |
| 120 | Args: |
| 121 | accountId: string, Account ID to retrieve the experiment for. (required) |
| 122 | webPropertyId: string, Web property ID to retrieve the experiment for. (required) |
| 123 | profileId: string, View (Profile) ID to retrieve the experiment for. (required) |
| 124 | experimentId: string, Experiment ID to retrieve the experiment for. (required) |
| 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| 129 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 130 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 131 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 132 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 133 | }, |
| 134 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 135 | "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. |
| 136 | { |
| 137 | "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. |
| 138 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 139 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 140 | "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. |
| 141 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 142 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 143 | ], |
| 144 | "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. |
| 145 | "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. |
| 146 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 147 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 148 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 149 | # - 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. |
| 150 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 151 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 152 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 153 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 154 | "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". |
| 155 | "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. |
| 156 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 157 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 158 | "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. |
| 159 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 160 | "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. |
| 161 | "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. |
| 162 | "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. |
| 163 | "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". |
| 164 | "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. |
| 165 | "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. |
| 166 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 167 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 168 | "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. |
| 169 | "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. |
| 170 | "description": "A String", # Notes about this experiment. |
| 171 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 172 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 173 | </div> |
| 174 | |
| 175 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 176 | <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 177 | <pre>Create a new experiment. |
| 178 | |
| 179 | Args: |
| 180 | accountId: string, Account ID to create the experiment for. (required) |
| 181 | webPropertyId: string, Web property ID to create the experiment for. (required) |
| 182 | profileId: string, View (Profile) ID to create the experiment for. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 183 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 184 | The object takes the form of: |
| 185 | |
| 186 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 187 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 188 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 189 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 190 | }, |
| 191 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 192 | "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. |
| 193 | { |
| 194 | "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. |
| 195 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 196 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 197 | "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. |
| 198 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 199 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 200 | ], |
| 201 | "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. |
| 202 | "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. |
| 203 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 204 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 205 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 206 | # - 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. |
| 207 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 208 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 209 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 210 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 211 | "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". |
| 212 | "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. |
| 213 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 214 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 215 | "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. |
| 216 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 217 | "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. |
| 218 | "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. |
| 219 | "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. |
| 220 | "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". |
| 221 | "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. |
| 222 | "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. |
| 223 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 224 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 225 | "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. |
| 226 | "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. |
| 227 | "description": "A String", # Notes about this experiment. |
| 228 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 229 | } |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 230 | |
| 231 | |
| 232 | Returns: |
| 233 | An object of the form: |
| 234 | |
| 235 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 236 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 237 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 238 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 239 | }, |
| 240 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 241 | "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. |
| 242 | { |
| 243 | "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. |
| 244 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 245 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 246 | "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. |
| 247 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 248 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 249 | ], |
| 250 | "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. |
| 251 | "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. |
| 252 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 253 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 254 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 255 | # - 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. |
| 256 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 257 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 258 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 259 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 260 | "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". |
| 261 | "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. |
| 262 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 263 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 264 | "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. |
| 265 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 266 | "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. |
| 267 | "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. |
| 268 | "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. |
| 269 | "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". |
| 270 | "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. |
| 271 | "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. |
| 272 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 273 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 274 | "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. |
| 275 | "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. |
| 276 | "description": "A String", # Notes about this experiment. |
| 277 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 278 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 279 | </div> |
| 280 | |
| 281 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 282 | <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 283 | <pre>Lists experiments to which the user has access. |
| 284 | |
| 285 | Args: |
| 286 | accountId: string, Account ID to retrieve experiments for. (required) |
| 287 | webPropertyId: string, Web property ID to retrieve experiments for. (required) |
| 288 | profileId: string, View (Profile) ID to retrieve experiments for. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 289 | max_results: integer, The maximum number of experiments to include in this response. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 290 | start_index: integer, An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 291 | |
| 292 | Returns: |
| 293 | An object of the form: |
| 294 | |
| 295 | { # 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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 296 | "items": [ # A list of experiments. |
| 297 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 298 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 299 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 300 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 301 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 302 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 303 | "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. |
| 304 | { |
| 305 | "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. |
| 306 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 307 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 308 | "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. |
| 309 | "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. |
| 310 | }, |
| 311 | ], |
| 312 | "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. |
| 313 | "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. |
| 314 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 315 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 316 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 317 | # - 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. |
| 318 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 319 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 320 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 321 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 322 | "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". |
| 323 | "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. |
| 324 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 325 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 326 | "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. |
| 327 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 328 | "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. |
| 329 | "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. |
| 330 | "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. |
| 331 | "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". |
| 332 | "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. |
| 333 | "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. |
| 334 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 335 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 336 | "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. |
| 337 | "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. |
| 338 | "description": "A String", # Notes about this experiment. |
| 339 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 340 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 341 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 342 | "kind": "analytics#experiments", # Collection type. |
| 343 | "nextLink": "A String", # Link to next page for this experiment collection. |
| 344 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| 345 | "previousLink": "A String", # Link to previous page for this experiment collection. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 346 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 347 | "username": "A String", # Email ID of the authenticated user |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 348 | "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 349 | }</pre> |
| 350 | </div> |
| 351 | |
| 352 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 353 | <code class="details" id="patch">patch(accountId, webPropertyId, profileId, experimentId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 354 | <pre>Update an existing experiment. This method supports patch semantics. |
| 355 | |
| 356 | Args: |
| 357 | accountId: string, Account ID of the experiment to update. (required) |
| 358 | webPropertyId: string, Web property ID of the experiment to update. (required) |
| 359 | profileId: string, View (Profile) ID of the experiment to update. (required) |
| 360 | experimentId: string, Experiment ID of the experiment to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 361 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 362 | The object takes the form of: |
| 363 | |
| 364 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 365 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 366 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 367 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 368 | }, |
| 369 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 370 | "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. |
| 371 | { |
| 372 | "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. |
| 373 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 374 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 375 | "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. |
| 376 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 377 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 378 | ], |
| 379 | "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. |
| 380 | "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. |
| 381 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 382 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 383 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 384 | # - 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. |
| 385 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 386 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 387 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 388 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 389 | "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". |
| 390 | "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. |
| 391 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 392 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 393 | "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. |
| 394 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 395 | "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. |
| 396 | "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. |
| 397 | "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. |
| 398 | "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". |
| 399 | "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. |
| 400 | "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. |
| 401 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 402 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 403 | "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. |
| 404 | "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. |
| 405 | "description": "A String", # Notes about this experiment. |
| 406 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 407 | } |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 408 | |
| 409 | |
| 410 | Returns: |
| 411 | An object of the form: |
| 412 | |
| 413 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 414 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 415 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 416 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 417 | }, |
| 418 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 419 | "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. |
| 420 | { |
| 421 | "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. |
| 422 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 423 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 424 | "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. |
| 425 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 426 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 427 | ], |
| 428 | "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. |
| 429 | "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. |
| 430 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 431 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 432 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 433 | # - 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. |
| 434 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 435 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 436 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 437 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 438 | "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". |
| 439 | "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. |
| 440 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 441 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 442 | "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. |
| 443 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 444 | "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. |
| 445 | "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. |
| 446 | "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. |
| 447 | "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". |
| 448 | "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. |
| 449 | "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. |
| 450 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 451 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 452 | "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. |
| 453 | "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. |
| 454 | "description": "A String", # Notes about this experiment. |
| 455 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 456 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 457 | </div> |
| 458 | |
| 459 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 460 | <code class="details" id="update">update(accountId, webPropertyId, profileId, experimentId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 461 | <pre>Update an existing experiment. |
| 462 | |
| 463 | Args: |
| 464 | accountId: string, Account ID of the experiment to update. (required) |
| 465 | webPropertyId: string, Web property ID of the experiment to update. (required) |
| 466 | profileId: string, View (Profile) ID of the experiment to update. (required) |
| 467 | experimentId: string, Experiment ID of the experiment to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 468 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 469 | The object takes the form of: |
| 470 | |
| 471 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 472 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 473 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 474 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 475 | }, |
| 476 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 477 | "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. |
| 478 | { |
| 479 | "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. |
| 480 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 481 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 482 | "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. |
| 483 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 484 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 485 | ], |
| 486 | "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. |
| 487 | "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. |
| 488 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 489 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 490 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 491 | # - 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. |
| 492 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 493 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 494 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 495 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 496 | "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". |
| 497 | "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. |
| 498 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 499 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 500 | "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. |
| 501 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 502 | "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. |
| 503 | "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. |
| 504 | "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. |
| 505 | "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". |
| 506 | "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. |
| 507 | "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. |
| 508 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 509 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 510 | "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. |
| 511 | "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. |
| 512 | "description": "A String", # Notes about this experiment. |
| 513 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 514 | } |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 515 | |
| 516 | |
| 517 | Returns: |
| 518 | An object of the form: |
| 519 | |
| 520 | { # JSON template for Analytics experiment resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 521 | "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| 522 | "type": "analytics#profile", # Value is "analytics#profile". This field is read-only. |
| 523 | "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only. |
| 524 | }, |
| 525 | "created": "A String", # Time the experiment was created. This field is read-only. |
| 526 | "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. |
| 527 | { |
| 528 | "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. |
| 529 | "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED. |
| 530 | "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only. |
| 531 | "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. |
| 532 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 533 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 534 | ], |
| 535 | "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. |
| 536 | "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. |
| 537 | "servingFramework": "A String", # The framework used to serve the experiment variations and evaluate the results. One of: |
| 538 | # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. |
| 539 | # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. |
| 540 | # - 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. |
| 541 | "updated": "A String", # Time the experiment was last modified. This field is read-only. |
| 542 | "editableInGaUi": True or False, # If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| 543 | "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
| 544 | "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only. |
| 545 | "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". |
| 546 | "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. |
| 547 | "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only. |
| 548 | "selfLink": "A String", # Link for this experiment. This field is read-only. |
| 549 | "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. |
| 550 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only. |
| 551 | "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. |
| 552 | "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. |
| 553 | "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. |
| 554 | "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". |
| 555 | "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. |
| 556 | "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. |
| 557 | "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only. |
| 558 | "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create. |
| 559 | "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. |
| 560 | "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. |
| 561 | "description": "A String", # Notes about this experiment. |
| 562 | "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only. |
| 563 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 564 | </div> |
| 565 | |
| 566 | </body></html> |