更新实验

Updates an existing experiment for a title.

Allowed entity token types: title

Error codes

This operation may return the following PlayFab errors:

Error	Code
ExperimentationExclusionGroupInsufficientCapacity	7019
ExperimentationExclusionGroupInvalidTrafficAllocation	7021
ExperimentationExclusionGroupNotFound	7018
ExperimentationExperimentNotFound	7002
ExperimentationExperimentRunning	7001
ExperimentationExperimentStopped	7000
ExperimentationInvalidDuration	7012
ExperimentationInvalidEndDate	7015
ExperimentationInvalidStartDate	7016
ExperimentationLegacyExperimentInvalidOperation	7023
ExperimentationMaxDurationExceeded	7017
FeatureNotConfiguredForTitle	1177
ProductDisabledForTitle	1609
SegmentNotFound	1220

POST

Experimentation

UpdateExperiment

Update Experiment

curl --request POST \
  --url https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Name": "BackgroundColor Experiment",
  "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
  "Description": "Tests whether a green background color increases revenue",
  "StartDate": "2019-10-25T20:37:00Z",
  "EndDate": "2019-11-13T20:37:00Z",
  "SegmentId": "0",
  "Variants": [
    {
      "Name": "Control",
      "Description": "Control variant",
      "TrafficPercentage": 10,
      "Variables": [
        {
          "Name": "BackgroundColor",
          "Value": "White"
        }
      ],
      "IsControl": true
    },
    {
      "Name": "Treatment",
      "Description": "Treatment variant",
      "TrafficPercentage": 90,
      "Variables": [
        {
          "Name": "BackgroundColor",
          "Value": "Green"
        }
      ]
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment"

payload = {
    "Name": "BackgroundColor Experiment",
    "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
    "Description": "Tests whether a green background color increases revenue",
    "StartDate": "2019-10-25T20:37:00Z",
    "EndDate": "2019-11-13T20:37:00Z",
    "SegmentId": "0",
    "Variants": [
        {
            "Name": "Control",
            "Description": "Control variant",
            "TrafficPercentage": 10,
            "Variables": [
                {
                    "Name": "BackgroundColor",
                    "Value": "White"
                }
            ],
            "IsControl": True
        },
        {
            "Name": "Treatment",
            "Description": "Treatment variant",
            "TrafficPercentage": 90,
            "Variables": [
                {
                    "Name": "BackgroundColor",
                    "Value": "Green"
                }
            ]
        }
    ]
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'BackgroundColor Experiment',
    Id: 'B9A90E90-A009-4254-80A4-46B5933E9D26',
    Description: 'Tests whether a green background color increases revenue',
    StartDate: '2019-10-25T20:37:00Z',
    EndDate: '2019-11-13T20:37:00Z',
    SegmentId: '0',
    Variants: [
      {
        Name: 'Control',
        Description: 'Control variant',
        TrafficPercentage: 10,
        Variables: [{Name: 'BackgroundColor', Value: 'White'}],
        IsControl: true
      },
      {
        Name: 'Treatment',
        Description: 'Treatment variant',
        TrafficPercentage: 90,
        Variables: [{Name: 'BackgroundColor', Value: 'Green'}]
      }
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'BackgroundColor Experiment',
    'Id' => 'B9A90E90-A009-4254-80A4-46B5933E9D26',
    'Description' => 'Tests whether a green background color increases revenue',
    'StartDate' => '2019-10-25T20:37:00Z',
    'EndDate' => '2019-11-13T20:37:00Z',
    'SegmentId' => '0',
    'Variants' => [
        [
                'Name' => 'Control',
                'Description' => 'Control variant',
                'TrafficPercentage' => 10,
                'Variables' => [
                                [
                                                                'Name' => 'BackgroundColor',
                                                                'Value' => 'White'
                                ]
                ],
                'IsControl' => true
        ],
        [
                'Name' => 'Treatment',
                'Description' => 'Treatment variant',
                'TrafficPercentage' => 90,
                'Variables' => [
                                [
                                                                'Name' => 'BackgroundColor',
                                                                'Value' => 'Green'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment"

	payload := strings.NewReader("{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

授权

X-EntityToken

string

header

必填

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

请求体

application/json

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.

string

必填

Id of the experiment.

Name

string

必填

Friendly name of the experiment.

StartDate

string

必填

When experiment should start.

Variants

object[]

必填

List of variants for the experiment.

Show child attributes

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Description

string

Description of the experiment.

EndDate

string

When experiment should end.

ExclusionGroupId

string

Id of the exclusion group.

ExclusionGroupTrafficAllocation

number

Percentage of exclusion group traffic that will see this experiment.

ExperimentType

enum<string>

Type of experiment.

可用选项:

Active,

Snapshot

SegmentId

string

Id of the segment to which this experiment applies. Defaults to the 'All Players' segment.

TitlePlayerAccountTestIds

string[]

List of title player account IDs that automatically receive treatments in the experiment, but are not included when calculating experiment metrics.

响应

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

最后修改于 2026年10月6日

⌘I

Update Experiment

curl --request POST \
  --url https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Name": "BackgroundColor Experiment",
  "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
  "Description": "Tests whether a green background color increases revenue",
  "StartDate": "2019-10-25T20:37:00Z",
  "EndDate": "2019-11-13T20:37:00Z",
  "SegmentId": "0",
  "Variants": [
    {
      "Name": "Control",
      "Description": "Control variant",
      "TrafficPercentage": 10,
      "Variables": [
        {
          "Name": "BackgroundColor",
          "Value": "White"
        }
      ],
      "IsControl": true
    },
    {
      "Name": "Treatment",
      "Description": "Treatment variant",
      "TrafficPercentage": 90,
      "Variables": [
        {
          "Name": "BackgroundColor",
          "Value": "Green"
        }
      ]
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment"

payload = {
    "Name": "BackgroundColor Experiment",
    "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
    "Description": "Tests whether a green background color increases revenue",
    "StartDate": "2019-10-25T20:37:00Z",
    "EndDate": "2019-11-13T20:37:00Z",
    "SegmentId": "0",
    "Variants": [
        {
            "Name": "Control",
            "Description": "Control variant",
            "TrafficPercentage": 10,
            "Variables": [
                {
                    "Name": "BackgroundColor",
                    "Value": "White"
                }
            ],
            "IsControl": True
        },
        {
            "Name": "Treatment",
            "Description": "Treatment variant",
            "TrafficPercentage": 90,
            "Variables": [
                {
                    "Name": "BackgroundColor",
                    "Value": "Green"
                }
            ]
        }
    ]
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'BackgroundColor Experiment',
    Id: 'B9A90E90-A009-4254-80A4-46B5933E9D26',
    Description: 'Tests whether a green background color increases revenue',
    StartDate: '2019-10-25T20:37:00Z',
    EndDate: '2019-11-13T20:37:00Z',
    SegmentId: '0',
    Variants: [
      {
        Name: 'Control',
        Description: 'Control variant',
        TrafficPercentage: 10,
        Variables: [{Name: 'BackgroundColor', Value: 'White'}],
        IsControl: true
      },
      {
        Name: 'Treatment',
        Description: 'Treatment variant',
        TrafficPercentage: 90,
        Variables: [{Name: 'BackgroundColor', Value: 'Green'}]
      }
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'BackgroundColor Experiment',
    'Id' => 'B9A90E90-A009-4254-80A4-46B5933E9D26',
    'Description' => 'Tests whether a green background color increases revenue',
    'StartDate' => '2019-10-25T20:37:00Z',
    'EndDate' => '2019-11-13T20:37:00Z',
    'SegmentId' => '0',
    'Variants' => [
        [
                'Name' => 'Control',
                'Description' => 'Control variant',
                'TrafficPercentage' => 10,
                'Variables' => [
                                [
                                                                'Name' => 'BackgroundColor',
                                                                'Value' => 'White'
                                ]
                ],
                'IsControl' => true
        ],
        [
                'Name' => 'Treatment',
                'Description' => 'Treatment variant',
                'TrafficPercentage' => 90,
                'Variables' => [
                                [
                                                                'Name' => 'BackgroundColor',
                                                                'Value' => 'Green'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment"

	payload := strings.NewReader("{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Experimentation/UpdateExperiment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"BackgroundColor Experiment\",\n  \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n  \"Description\": \"Tests whether a green background color increases revenue\",\n  \"StartDate\": \"2019-10-25T20:37:00Z\",\n  \"EndDate\": \"2019-11-13T20:37:00Z\",\n  \"SegmentId\": \"0\",\n  \"Variants\": [\n    {\n      \"Name\": \"Control\",\n      \"Description\": \"Control variant\",\n      \"TrafficPercentage\": 10,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"White\"\n        }\n      ],\n      \"IsControl\": true\n    },\n    {\n      \"Name\": \"Treatment\",\n      \"Description\": \"Treatment variant\",\n      \"TrafficPercentage\": 90,\n      \"Variables\": [\n        {\n          \"Name\": \"BackgroundColor\",\n          \"Value\": \"Green\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

更新实验

Error codes

授权

请求体

响应