list_experiments: Experiments

Description Usage Arguments Value References See Also

View source: R/experiments.R

Description

Lists experiments to which the user has access.

Usage

1
2
list_experiments(accountId, webPropertyId, profileId, start.index = NULL,
  max.results = NULL, token)

Arguments

accountId

character. Account ID to retrieve experiments for.

webPropertyId

character. Web property ID to retrieve experiments for.

profileId

character. View (Profile) ID to retrieve experiments for.

start.index

integer. An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

max.results

integer. The maximum number of experiments to include in this response.

token

Token2.0 class object with a valid authorization data.

Value

The experiments collection is a set of experiment resources, each of which describes a content experiment available to an authenticated user.

id

Experiment ID. Required for patch and update. Disallowed for create.

kind

Resource type for an Analytics experiment. This field is read-only.

accountId

Account ID to which this experiment belongs. This field is read-only.

webPropertyId

Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.

internalWebPropertyId

Internal ID for the web property to which this experiment belongs. This field is read-only.

profileId

View (Profile) ID to which this experiment belongs. This field is read-only.

name

Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.

description

Notes about this experiment.

created

Time the experiment was created. This field is read-only.

updated

Time the experiment was last modified. This field is read-only.

objectiveMetric

The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".

optimizationType

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".

status

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.

winnerFound

Boolean specifying whether a winner has been found for this experiment. This field is read-only.

startTime

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.

endTime

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.

reasonExperimentEnded

Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.

rewriteVariationUrlsAsOriginal

Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiment whose status is ENDED.

winnerConfidenceLevel

A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiment whose status is ENDED.

minimumExperimentLengthInDays

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 experiment whose status is ENDED.

trafficCoverage

A floating-point number between 0 and 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 experiment whose status is ENDED.

equalWeighting

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.

snippet

The snippet of code to include on the control page(s). This field is read-only.

variations

Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.

servingFramework

The framework used to serve the experiment variations and evaluate the results. One of: REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.

editableInGaUi

If true, the end user will be able to edit the experiment via the Google Analytics user interface.

variations.name

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.

variations.url

The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.

variations.status

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.

variations.weight

Weight that this variation should receive. Only present if the experiment is running. This field is read-only.

variations.won

True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.

References

Management API - Experiments Overview

See Also

Other Management API: get_custom_dimension, get_custom_metric, get_experiment, get_filter, get_goal, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_filters, list_goals, list_profiles, list_segments, list_unsampled_reports, list_uploads, list_webproperties


RGA documentation built on May 2, 2019, 6:47 a.m.