Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Create or update campaign goal configs. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [CampaignGoalConfigError]() [GoalServicesError]()
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Create or update campaign goal configs. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [CampaignGoalConfigError]() [GoalServicesError]()
Args:
customerId: string, Required. The ID of the customer whose campaign goal configs are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CampaignGoalConfigService.MutateCampaignGoalConfigs.
"operations": [ # Required. The list of operations to perform on the campaign goal configs.
{ # A single mutate operation on the campaign goal config.
"create": { # A link between a campaign and a goal enabling campaign-specific optimization. # Create a new campaign goal config.
"campaign": "A String", # Immutable. The resource name of the campaign for this link.
"campaignRetentionSettings": { # Retention campaign goal settings. # Retention goal campaign settings.
"targetOption": "A String", # Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
"valueSettingsOverride": { # Lifecycle goal optimization value settings. # Retention goal campaign specific value settings.
"additionalHighLifetimeValue": 3.14, # High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set.
"additionalValue": 3.14, # Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value.
},
},
"goal": "A String", # Immutable. The resource name of the goal this link is attached to.
"goalType": "A String", # Output only. The goal type this link is attached to.
"resourceName": "A String", # Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
},
"remove": "A String", # Remove an existing campaign goal config.
"update": { # A link between a campaign and a goal enabling campaign-specific optimization. # Update an existing campaign goal config.
"campaign": "A String", # Immutable. The resource name of the campaign for this link.
"campaignRetentionSettings": { # Retention campaign goal settings. # Retention goal campaign settings.
"targetOption": "A String", # Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
"valueSettingsOverride": { # Lifecycle goal optimization value settings. # Retention goal campaign specific value settings.
"additionalHighLifetimeValue": 3.14, # High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set.
"additionalValue": 3.14, # Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value.
},
},
"goal": "A String", # Immutable. The resource name of the goal this link is attached to.
"goalType": "A String", # Output only. The goal type this link is attached to.
"resourceName": "A String", # Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
},
"updateMask": "A String", # FieldMask that determines which fields are modified in an update.
},
],
"partialFailure": True or False, # Optional. 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.
"validateOnly": True or False, # Optional. 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 a campaign goal config 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.
"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 campaign goal config mutate.
"resourceName": "A String", # Returned for successful operations.
},
],
}