mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
865 lines
33 KiB
HTML
865 lines
33 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Experiments Patch - analytics v2.0.4+20190807</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> analytics v2.0.4+20190807</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Data</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../data_ga-get">Ga Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../data_mcf-get">Mcf Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../data_realtime-get">Realtime Get</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Management</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_account-summaries-list">Account Summaries List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_account-user-links-delete">Account User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_account-user-links-insert">Account User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_account-user-links-list">Account User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_account-user-links-update">Account User Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_accounts-list">Accounts List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_client-id-hash-client-id">Client Id Hash Client Id</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-data-sources-list">Custom Data Sources List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-dimensions-get">Custom Dimensions Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-dimensions-insert">Custom Dimensions Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-dimensions-list">Custom Dimensions List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-dimensions-patch">Custom Dimensions Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-dimensions-update">Custom Dimensions Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-metrics-get">Custom Metrics Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-metrics-insert">Custom Metrics Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-metrics-list">Custom Metrics List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-metrics-patch">Custom Metrics Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_custom-metrics-update">Custom Metrics Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_experiments-delete">Experiments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_experiments-get">Experiments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_experiments-insert">Experiments Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_experiments-list">Experiments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Experiments Patch</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_experiments-update">Experiments Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-delete">Filters Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-get">Filters Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-insert">Filters Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-list">Filters List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-patch">Filters Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_filters-update">Filters Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_goals-get">Goals Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_goals-insert">Goals Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_goals-list">Goals List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_goals-patch">Goals Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_goals-update">Goals Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-delete">Profile Filter Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-get">Profile Filter Links Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-insert">Profile Filter Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-list">Profile Filter Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-patch">Profile Filter Links Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-filter-links-update">Profile Filter Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-user-links-delete">Profile User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-user-links-insert">Profile User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-user-links-list">Profile User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profile-user-links-update">Profile User Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-delete">Profiles Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-get">Profiles Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-insert">Profiles Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-list">Profiles List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-patch">Profiles Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_profiles-update">Profiles Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-delete">Remarketing Audience Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-get">Remarketing Audience Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-insert">Remarketing Audience Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-list">Remarketing Audience List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-patch">Remarketing Audience Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_remarketing-audience-update">Remarketing Audience Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_segments-list">Segments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_unsampled-reports-delete">Unsampled Reports Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_unsampled-reports-get">Unsampled Reports Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_unsampled-reports-insert">Unsampled Reports Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_unsampled-reports-list">Unsampled Reports List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_uploads-delete-upload-data">Uploads Delete Upload Data</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_uploads-get">Uploads Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_uploads-list">Uploads List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_uploads-upload-data">Uploads Upload Data</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-delete">Web Property Ad Words Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-get">Web Property Ad Words Links Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-insert">Web Property Ad Words Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-list">Web Property Ad Words Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-patch">Web Property Ad Words Links Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_web-property-ad-words-links-update">Web Property Ad Words Links Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperties-get">Webproperties Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperties-insert">Webproperties Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperties-list">Webproperties List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperties-patch">Webproperties Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperties-update">Webproperties Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperty-user-links-delete">Webproperty User Links Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperty-user-links-insert">Webproperty User Links Insert</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperty-user-links-list">Webproperty User Links List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../management_webproperty-user-links-update">Webproperty User Links Update</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Metadata</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../metadata_columns-list">Columns List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Provisioning</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../provisioning_create-account-ticket">Create Account Ticket</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../provisioning_create-account-tree">Create Account Tree</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>User Deletion</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../user-deletion_user-deletion-request-upsert">User Deletion Request Upsert</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Experiments Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/analytics3-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Update an existing experiment. This method supports patch semantics.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
|
|
<ul>
|
|
<li><em>https://www.googleapis.com/auth/analytics</em></li>
|
|
<li><em>https://www.googleapis.com/auth/analytics.edit</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/analytics</em>.
|
|
You can set the scope for this method like this: <code>analytics3 --scope <scope> management experiments-patch ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><account-id></strong> <em>(string)</em><ul>
|
|
<li>Account ID of the experiment to update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><web-property-id></strong> <em>(string)</em><ul>
|
|
<li>Web property ID of the experiment to update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><profile-id></strong> <em>(string)</em><ul>
|
|
<li>View (Profile) ID of the experiment to update.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><experiment-id></strong> <em>(string)</em><ul>
|
|
<li>Experiment ID of the experiment to update.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Experiment:
|
|
account-id: string
|
|
created: string
|
|
description: string
|
|
editable-in-ga-ui: boolean
|
|
end-time: string
|
|
equal-weighting: boolean
|
|
id: string
|
|
internal-web-property-id: string
|
|
kind: string
|
|
minimum-experiment-length-in-days: integer
|
|
name: string
|
|
objective-metric: string
|
|
optimization-type: string
|
|
parent-link:
|
|
href: string
|
|
type: string
|
|
profile-id: string
|
|
reason-experiment-ended: string
|
|
rewrite-variation-urls-as-original: boolean
|
|
self-link: string
|
|
serving-framework: string
|
|
snippet: string
|
|
start-time: string
|
|
status: string
|
|
traffic-coverage: number
|
|
updated: string
|
|
web-property-id: string
|
|
winner-confidence-level: number
|
|
winner-found: boolean
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . account-id=aliquyam</code><ul>
|
|
<li>Account ID to which this experiment belongs. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>created=eos</code><ul>
|
|
<li>Time the experiment was created. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=at</code><ul>
|
|
<li>Notes about this experiment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>editable-in-ga-ui=true</code><ul>
|
|
<li>If true, the end user will be able to edit the experiment via the Google Analytics user interface.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-time=gubergren</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>equal-weighting=true</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>id=amet.</code><ul>
|
|
<li>Experiment ID. Required for patch and update. Disallowed for create.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>internal-web-property-id=ipsum</code><ul>
|
|
<li>Internal ID for the web property to which this experiment belongs. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=lorem</code><ul>
|
|
<li>Resource type for an Analytics experiment. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>minimum-experiment-length-in-days=28</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=gubergren</code><ul>
|
|
<li>Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>objective-metric=sadipscing</code><ul>
|
|
<li>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".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>optimization-type=at</code><ul>
|
|
<li>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".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>parent-link href=sit</code><ul>
|
|
<li>Link to the view (profile) to which this experiment belongs. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=duo</code></p>
|
|
<ul>
|
|
<li>Value is "analytics#profile". This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. profile-id=sit</code></p>
|
|
<ul>
|
|
<li>View (Profile) ID to which this experiment belongs. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reason-experiment-ended=magna</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>rewrite-variation-urls-as-original=true</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>self-link=dolor</code><ul>
|
|
<li>Link for this experiment. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>serving-framework=lorem</code><ul>
|
|
<li>The framework used to serve the experiment variations and evaluate the results. One of: <ul>
|
|
<li>REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.</li>
|
|
<li>API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.</li>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>snippet=justo</code><ul>
|
|
<li>The snippet of code to include on the control page(s). This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-time=amet.</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status=no</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>traffic-coverage=0.08583127305487803</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>updated=kasd</code><ul>
|
|
<li>Time the experiment was last modified. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>web-property-id=lorem</code><ul>
|
|
<li>Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>winner-confidence-level=0.342498288197713</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>winner-found=true</code><ul>
|
|
<li>Boolean specifying whether a winner has been found for this experiment. This field is read-only.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for the response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p user-ip=string</strong></p>
|
|
<ul>
|
|
<li>Deprecated. Please use quotaUser instead.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../management_experiments-update" class="btn btn-neutral float-right" title="Experiments Update"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../management_experiments-list" class="btn btn-neutral" title="Experiments List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../management_experiments-list" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../management_experiments-update" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |