1,007
edits
Labs/Test Pilot/ExperimentAPI: Difference between revisions
→experimentInfo
| Line 128: | Line 128: | ||
* startDate: if null, then the experiment will start automatically as soon as it is installed. If you want to instead schedule a date in the future for the test to start, instead set it to a parseable date string. | * startDate: if null, then the experiment will start automatically as soon as it is installed. If you want to instead schedule a date in the future for the test to start, instead set it to a parseable date string. | ||
* duration: an integer, giving the number of days the test is to run for. E.g. if duration is 14 then the test will run from startDate to startDate + 2 weeks. Optional; duration defaults to 7 days if not specified. | * duration: an integer, giving the number of days the test is to run for. E.g. if duration is 14 then the test will run from startDate to startDate + 2 weeks. Optional; duration defaults to 7 days if not specified. | ||
* testName: The human readable name of the experiment, as it will be displayed in menus and status pages, etc. Required. | * testName: The human readable name of the experiment, as it will be displayed in menus and status pages, etc. (The word "Study" will be appended by the client, so the testName should not ''also'' have the word "Study" in it or the end result will look silly.) Required. | ||
* testId: | * testId: A unique number, used by the client to track the progress of multiple experiments running at once. An experiment must not have the same testId as any other experiment or survey. Required. | ||
* testInfoUrl: the URL of a page where the user can go to get more information about the experiment. | * testInfoUrl: the URL of a page where the user can go to get more information about the experiment. | ||
* optInRequired: Set this to true if the test should not start automatically on the start date, but should instead only start if the user explicitly tells it to start. This should be the case for tests that change the Firefox UI, such as A-B tests. Note that the UI to support optInRequired has not yet been implemented in the client as of version 1.0. | * optInRequired: Set this to true if the test should not start automatically on the start date, but should instead only start if the user explicitly tells it to start. This should be the case for tests that change the Firefox UI, such as A-B tests. Note that the UI to support optInRequired has not yet been implemented in the client as of version 1.0. | ||