com.playfab.PlayFabExperimentationModels Maven / Gradle / Ivy
package com.playfab;
import java.util.*;
import com.playfab.PlayFabUtil.*;
public class PlayFabExperimentationModels {
public static enum AnalysisTaskState {
Waiting,
ReadyForSubmission,
SubmittingToPipeline,
Running,
Completed,
Failed,
Canceled
}
/** Given a title entity token and experiment details, will create a new experiment for the title. */
public static class CreateExperimentRequest {
/** Description of the experiment. */
public String Description;
/** The duration of the experiment, in days. */
public Long Duration;
/** Type of experiment. */
public ExperimentType ExperimentType;
/** Friendly name of the experiment. */
public String Name;
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
public String SegmentId;
/** When experiment should start. */
public Date StartDate;
/**
* List of title player account IDs that automatically receive treatments in the experiment, but are not included when
* calculating experiment metrics.
*/
public ArrayList TitlePlayerAccountTestIds;
/** List of variants for the experiment. */
public ArrayList Variants;
}
public static class CreateExperimentResult {
/** The ID of the new experiment. */
public String ExperimentId;
}
/**
* Given an entity token and an experiment ID this API deletes the experiment. A running experiment must be stopped before
* it can be deleted.
*/
public static class DeleteExperimentRequest {
/** The ID of the experiment to delete. */
public String ExperimentId;
}
public static class EmptyResponse {
}
/** Combined entity type and ID structure which uniquely identifies a single entity. */
public static class EntityKey {
/** Unique ID of the entity. */
public String Id;
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
public String Type;
}
public static class Experiment {
/** Description of the experiment. */
public String Description;
/** The duration of the experiment, in days. */
public Long Duration;
/** Type of experiment. */
public ExperimentType ExperimentType;
/** Id of the experiment. */
public String Id;
/** Friendly name of the experiment. */
public String Name;
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
public String SegmentId;
/** When experiment should start/was started. */
public Date StartDate;
/** State experiment is currently in. */
public ExperimentState State;
/**
* List of title player account IDs that automatically receive treatments in the experiment, but are not included when
* calculating experiment metrics.
*/
public ArrayList TitlePlayerAccountTestIds;
/** List of variants for the experiment. */
public ArrayList Variants;
}
public static enum ExperimentState {
New,
Started,
Stopped,
Deleted
}
public static enum ExperimentType {
Active,
Snapshot
}
/**
* Given a title entity token will return the list of all experiments for a title, including scheduled, started, stopped or
* completed experiments.
*/
public static class GetExperimentsRequest {
}
public static class GetExperimentsResult {
/** List of experiments for the title. */
public ArrayList Experiments;
}
/** Given a title entity token and experiment details, will return the latest available scorecard. */
public static class GetLatestScorecardRequest {
/** The ID of the experiment. */
public String ExperimentId;
}
public static class GetLatestScorecardResult {
/** Scorecard for the experiment of the title. */
public Scorecard Scorecard;
}
/**
* Given a title player or a title entity token, returns the treatment variants and variables assigned to the entity across
* all running experiments
*/
public static class GetTreatmentAssignmentRequest {
/** The entity to perform this action on. */
public EntityKey Entity;
}
public static class GetTreatmentAssignmentResult {
/** Treatment assignment for the entity. */
public TreatmentAssignment TreatmentAssignment;
}
public static class MetricData {
/** The upper bound of the confidence interval for the relative delta (Delta.RelativeValue). */
public Double ConfidenceIntervalEnd;
/** The lower bound of the confidence interval for the relative delta (Delta.RelativeValue). */
public Double ConfidenceIntervalStart;
/** The absolute delta between TreatmentStats.Average and ControlStats.Average. */
public Float DeltaAbsoluteChange;
/** The relative delta ratio between TreatmentStats.Average and ControlStats.Average. */
public Float DeltaRelativeChange;
/** The machine name of the metric. */
public String InternalName;
/** Indicates if a movement was detected on that metric. */
public String Movement;
/** The readable name of the metric. */
public String Name;
/** The expectation that a movement is real */
public Float PMove;
/** The p-value resulting from the statistical test run for this metric */
public Float PValue;
/** The threshold for observing sample ratio mismatch. */
public Float PValueThreshold;
/** Indicates if the movement is statistically significant. */
public String StatSigLevel;
/** Observed standard deviation value of the metric. */
public Float StdDev;
/** Observed average value of the metric. */
public Float Value;
}
public static class Scorecard {
/** Represents the date the scorecard was generated. */
public String DateGenerated;
/** Represents the duration of scorecard analysis. */
public String Duration;
/** Represents the number of events processed for the generation of this scorecard */
public Double EventsProcessed;
/** Id of the experiment. */
public String ExperimentId;
/** Friendly name of the experiment. */
public String ExperimentName;
/** Represents the latest compute job status. */
public AnalysisTaskState LatestJobStatus;
/** Represents the presence of a sample ratio mismatch in the scorecard data. */
public Boolean SampleRatioMismatch;
/** Scorecard containing list of analysis. */
public ArrayList ScorecardDataRows;
}
public static class ScorecardDataRow {
/** Represents whether the variant is control or not. */
public Boolean IsControl;
/** Data of the analysis with the internal name of the metric as the key and an object of metric data as value. */
public Map MetricDataRows;
/** Represents the player count in the variant. */
public Long PlayerCount;
/** Name of the variant of analysis. */
public String VariantName;
}
/** Given a title entity token and an experiment ID, this API starts the experiment. */
public static class StartExperimentRequest {
/** The ID of the experiment to start. */
public String ExperimentId;
}
/** Given a title entity token and an experiment ID, this API stops the experiment if it is running. */
public static class StopExperimentRequest {
/** The ID of the experiment to stop. */
public String ExperimentId;
}
public static class TreatmentAssignment {
/** List of the experiment variables. */
public ArrayList Variables;
/** List of the experiment variants. */
public ArrayList Variants;
}
/**
* Given a title entity token and experiment details, this API updates the experiment. If an experiment is already running,
* only the description and duration properties can be updated.
*/
public static class UpdateExperimentRequest {
/** Description of the experiment. */
public String Description;
/** The duration of the experiment, in days. */
public Long Duration;
/** Type of experiment. */
public ExperimentType ExperimentType;
/** Id of the experiment. */
public String Id;
/** Friendly name of the experiment. */
public String Name;
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
public String SegmentId;
/** When experiment should start. */
public Date StartDate;
/**
* List of title player account IDs that automatically receive treatments in the experiment, but are not included when
* calculating experiment metrics.
*/
public ArrayList TitlePlayerAccountTestIds;
/** List of variants for the experiment. */
public ArrayList Variants;
}
public static class Variable {
/** Name of the variable. */
public String Name;
/** Value of the variable. */
public String Value;
}
public static class Variant {
/** Description of the variant. */
public String Description;
/** Id of the variant. */
public String Id;
/** Specifies if variant is control for experiment. */
public Boolean IsControl;
/** Name of the variant. */
public String Name;
/** Percentage of target audience traffic that will see this variant. */
public Long TrafficPercentage;
/** Variables returned by this variant. */
public ArrayList Variables;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy