package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Variations : sig ... end
type t = {
  1. accountId : string;
    (*

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

    *)
  2. created : GapiDate.t;
    (*

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

    *)
  3. description : string;
    (*

    Notes about this experiment.

    *)
  4. editableInGaUi : bool;
    (*

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

    *)
  5. endTime : GapiDate.t;
    (*

    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.

    *)
  6. equalWeighting : bool;
    (*

    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.

    *)
  7. id : string;
    (*

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

    *)
  8. internalWebPropertyId : string;
    (*

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

    *)
  9. kind : string;
    (*

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

    *)
  10. minimumExperimentLengthInDays : int;
    (*

    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.

    *)
  11. name : string;
    (*

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

    *)
  12. objectiveMetric : 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".

    *)
  13. optimizationType : 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".

    *)
  14. profileId : string;
    (*

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

    *)
  15. reasonExperimentEnded : 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.

    *)
  16. rewriteVariationUrlsAsOriginal : bool;
    (*

    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.

    *)
  17. servingFramework : string;
    (*

    The framework used to serve the experiment variations and evaluate the results. One of:

    • REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
    • API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
    • EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
    *)
  18. snippet : string;
    (*

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

    *)
  19. startTime : GapiDate.t;
    (*

    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.

    *)
  20. status : 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.

    *)
  21. trafficCoverage : float;
    (*

    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.

    *)
  22. updated : GapiDate.t;
    (*

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

    *)
  23. variations : Variations.t list;
    (*

    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.

    *)
  24. webPropertyId : 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.

    *)
  25. winnerConfidenceLevel : float;
    (*

    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.

    *)
  26. winnerFound : bool;
    (*

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

    *)
}
val accountId : (t, string) GapiLens.t
val created : (t, GapiDate.t) GapiLens.t
val description : (t, string) GapiLens.t
val editableInGaUi : (t, bool) GapiLens.t
val endTime : (t, GapiDate.t) GapiLens.t
val equalWeighting : (t, bool) GapiLens.t
val id : (t, string) GapiLens.t
val internalWebPropertyId : (t, string) GapiLens.t
val kind : (t, string) GapiLens.t
val minimumExperimentLengthInDays : (t, int) GapiLens.t
val name : (t, string) GapiLens.t
val objectiveMetric : (t, string) GapiLens.t
val optimizationType : (t, string) GapiLens.t
val profileId : (t, string) GapiLens.t
val reasonExperimentEnded : (t, string) GapiLens.t
val rewriteVariationUrlsAsOriginal : (t, bool) GapiLens.t
val servingFramework : (t, string) GapiLens.t
val snippet : (t, string) GapiLens.t
val startTime : (t, GapiDate.t) GapiLens.t
val status : (t, string) GapiLens.t
val trafficCoverage : (t, float) GapiLens.t
val updated : (t, GapiDate.t) GapiLens.t
val variations : (t, Variations.t list) GapiLens.t
val webPropertyId : (t, string) GapiLens.t
val winnerConfidenceLevel : (t, float) GapiLens.t
val winnerFound : (t, bool) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t