django-gwo v0.4 documentation
Ways of accessing the Google Website Optimizer API
Query all combinations or a specific combination of a multivariate experiment
Parameters: |
|
---|
The path section of the URI to this query
Query all experiments or a specific experiment
Parameters: | exp_id (None, int, str, unicode. Default: None) – The experiment id, if a specific experiment is requested. |
---|
The path section of the URI to this query
Query all sections or a specific section of an experiment
Parameters: |
|
---|
The path section of the URI to this query
Query all variations or a specific variation of a section of an experiment
In order to be flexible with the parameters, you can query variations with:
All variations of section 1 of experiment 12345:
VariationQuery('12345', '1')
VariationQuery(experiment_id='12345', section_id='1')
VariationQuery(section1) # Assuming section1 is a SectionEntry instance
VariationQuery(section=section1) # Assuming section1 is a SectionEntry instance
Variation 0 of section 1 of experiment 12345:
VariationQuery('12345', '1', '0')
VariationQuery(experiment_id='12345', section_id='1', variation_id='0')
VariationQuery(section1, '0') # Assuming section1 is a SectionEntry instance
VariationQuery(section=section1, variation='0') # Assuming section1 is a SectionEntry instance
The path section of the URI to this query
Client extension for the Google Website Optimizer API service.
Create a new experiment
On failure, a RequestError is raised of the form:
{'status': HTTP status code from server,
'reason': HTTP reason from the server,
'body': HTTP body of the server's response}
Parameters: |
|
---|---|
Returns: | ExperimentEntry |
Raises : | RequestError |
Add a section to an experiment
Parameters: |
|
---|
Add a variation to an experiment section.
Parameters: |
|
---|
Deletes the item specified by entry_or_uri.
Parameters: | entry_or_uri – Either an Entry or Query object |
---|
Information about a single combination within an experiment
Parameters: | feed_uri (CombinationQuery) – The CombinationQuery to specify the combination |
---|---|
Returns: | CombinationEntry |
A list of all combinations in the specified experiment
Parameters: | feed_uri (CombinationQuery) – The CombinationQuery to get all the combinations |
---|---|
Returns: | CombinationFeed |
Get a specific experiment.
Parameters: | feed_uri (ExperimentQuery) – The REST URI to get the feeds |
---|---|
Returns: | ExperimentEntry |
Get all the experiments the current user has access to.
Parameters: | feed_uri (None, ExperimentQuery) – The REST URI to get the feeds. Defaults to all experiments |
---|---|
Returns: | ExperimentFeed |
Get a section for an experiment.
Parameters: | feed_uri (SectionQuery) – The SectionQuery from which to get the SectionEntry |
---|---|
Returns: | SectionEntry |
Get a section feed for an experiment.
Parameters: | feed_uri (SectionQuery) – The SectionQuery from which to get the feed |
---|---|
Returns: | SectionFeed |
Get a variation for an experiment section.
Parameters: | feed_uri (VariationQuery) – The VariationQuery from which to get the VariationEntry |
---|---|
Returns: | VariationEntry |
Get a variation feed for an experiment section.
Parameters: | feed_uri (VariationQuery) – The VariationQuery from which to get the VariationFeed |
---|---|
Returns: | VariationFeed |
Pause an experiment
Parameters: | feed_uri (ExperimentQuery) – The REST URI to get the feeds |
---|
Start an experiment
Parameters: | feed_uri (ExperimentQuery) – The REST URI to get the feeds |
---|
Stop an experiment
Parameters: | feed_uri (ExperimentQuery) – The REST URI to get the feeds |
---|
Edits the entry on the server by sending the XML for this entry.
Performs a PUT and converts the response to a new entry object with a matching class to the entry passed in.
Parameters: |
|
---|---|
Returns: | A new Entry object of a matching type to the entry which was passed in. |