Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes conversion value rule sets. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes conversion value rule sets. Operation statuses are returned.
Args:
customerId: string, Required. The ID of the customer whose conversion value rule sets are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ConversionValueRuleSetService.MutateConversionValueRuleSets.
"operations": [ # Required. The list of operations to perform on individual conversion value rule sets.
{ # A single operation (create, update, remove) on a conversion value rule set.
"create": { # A conversion value rule set is a collection of conversion value rules that lets you adjust conversion values based on the dimensions specified in the `dimensions` field. # Create operation: No resource name is expected for the new conversion value rule set.
"attachmentType": "A String", # Immutable. Defines the scope where the conversion value rule set is attached.
"campaign": "A String", # The resource name of the campaign when the conversion value rule set is attached to a campaign.
"conversionActionCategories": [ # Immutable. The conversion action categories of the conversion value rule set.
"A String",
],
"conversionValueRules": [ # Resource names of rules within the rule set.
"A String",
],
"dimensions": [ # Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
"A String",
],
"id": "A String", # Output only. The ID of the conversion value rule set.
"ownerCustomer": "A String", # Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
"resourceName": "A String", # Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
"status": "A String", # Output only. The status of the conversion value rule set. ** Read-only **
},
"remove": "A String", # Remove operation: A resource name for the removed conversion value rule set is expected, in this format: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
"update": { # A conversion value rule set is a collection of conversion value rules that lets you adjust conversion values based on the dimensions specified in the `dimensions` field. # Update operation: The conversion value rule set is expected to have a valid resource name.
"attachmentType": "A String", # Immutable. Defines the scope where the conversion value rule set is attached.
"campaign": "A String", # The resource name of the campaign when the conversion value rule set is attached to a campaign.
"conversionActionCategories": [ # Immutable. The conversion action categories of the conversion value rule set.
"A String",
],
"conversionValueRules": [ # Resource names of rules within the rule set.
"A String",
],
"dimensions": [ # Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
"A String",
],
"id": "A String", # Output only. The ID of the conversion value rule set.
"ownerCustomer": "A String", # Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
"resourceName": "A String", # Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
"status": "A String", # Output only. The status of the conversion value rule set. ** Read-only **
},
"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 ConversionValueRuleSetService.MutateConversionValueRuleSets.
"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 conversion value rule set mutate.
"conversionValueRuleSet": { # A conversion value rule set is a collection of conversion value rules that lets you adjust conversion values based on the dimensions specified in the `dimensions` field. # The mutated conversion value rule set with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"attachmentType": "A String", # Immutable. Defines the scope where the conversion value rule set is attached.
"campaign": "A String", # The resource name of the campaign when the conversion value rule set is attached to a campaign.
"conversionActionCategories": [ # Immutable. The conversion action categories of the conversion value rule set.
"A String",
],
"conversionValueRules": [ # Resource names of rules within the rule set.
"A String",
],
"dimensions": [ # Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
"A String",
],
"id": "A String", # Output only. The ID of the conversion value rule set.
"ownerCustomer": "A String", # Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
"resourceName": "A String", # Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
"status": "A String", # Output only. The status of the conversion value rule set. ** Read-only **
},
"resourceName": "A String", # Returned for successful operations.
},
],
}