Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes experiment arms. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentArmError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes experiment arms. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ExperimentArmError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
Args:
customerId: string, Required. The ID of the customer whose experiments are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ExperimentArmService.MutateExperimentArms.
"operations": [ # Required. The list of operations to perform on individual experiment arm.
{ # A single operation on an experiment arm.
"create": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Create operation
"assetGroups": [ # List of asset groups in the experiment arm.
{ # Holds the asset groups included in an arm of an Optimize Assets experiment.
"assetGroup": "A String", # Asset group resource name.
"assetGroupAssets": [ # List of asset group assets under the asset group.
{ # Holds the details of an asset within an asset group for an Optimize Assets experiment arm.
"asset": "A String", # Asset resource name of the asset group asset.
"fieldType": "A String", # Field type of the asset group asset.
},
],
},
],
"campaigns": [ # List of campaigns in the trial arm. The max length is one.
"A String",
],
"control": True or False, # Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
"experiment": "A String", # Immutable. The experiment to which the ExperimentArm belongs.
"inDesignCampaigns": [ # Output only. The in design campaigns in the treatment experiment arm.
"A String",
],
"name": "A String", # Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
"resourceName": "A String", # Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
"trafficSplit": "A String", # Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
},
"remove": "A String", # Remove operation: The experiment arm is expected to have a valid resource name, in this format: `customers/{customer_id}/experiments/{campaign_experiment_id}`
"update": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # Update operation: The experiment arm is expected to have a valid resource name.
"assetGroups": [ # List of asset groups in the experiment arm.
{ # Holds the asset groups included in an arm of an Optimize Assets experiment.
"assetGroup": "A String", # Asset group resource name.
"assetGroupAssets": [ # List of asset group assets under the asset group.
{ # Holds the details of an asset within an asset group for an Optimize Assets experiment arm.
"asset": "A String", # Asset resource name of the asset group asset.
"fieldType": "A String", # Field type of the asset group asset.
},
],
},
],
"campaigns": [ # List of campaigns in the trial arm. The max length is one.
"A String",
],
"control": True or False, # Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
"experiment": "A String", # Immutable. The experiment to which the ExperimentArm belongs.
"inDesignCampaigns": [ # Output only. The in design campaigns in the treatment experiment arm.
"A String",
],
"name": "A String", # Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
"resourceName": "A String", # Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
"trafficSplit": "A String", # Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
"responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for experiment arm mutate.
"partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"results": [ # All results for the mutate.
{ # The result for the experiment arm mutate.
"experimentArm": { # A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes. # The mutated experiment arm with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"assetGroups": [ # List of asset groups in the experiment arm.
{ # Holds the asset groups included in an arm of an Optimize Assets experiment.
"assetGroup": "A String", # Asset group resource name.
"assetGroupAssets": [ # List of asset group assets under the asset group.
{ # Holds the details of an asset within an asset group for an Optimize Assets experiment arm.
"asset": "A String", # Asset resource name of the asset group asset.
"fieldType": "A String", # Field type of the asset group asset.
},
],
},
],
"campaigns": [ # List of campaigns in the trial arm. The max length is one.
"A String",
],
"control": True or False, # Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
"experiment": "A String", # Immutable. The experiment to which the ExperimentArm belongs.
"inDesignCampaigns": [ # Output only. The in design campaigns in the treatment experiment arm.
"A String",
],
"name": "A String", # Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
"resourceName": "A String", # Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
"trafficSplit": "A String", # Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
},
"resourceName": "A String", # Returned for successful operations.
},
],
}