Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes data exclusions. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes data exclusions. Operation statuses are returned.
Args:
customerId: string, Required. ID of the customer whose data exclusions are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BiddingDataExclusionService.MutateBiddingDataExclusions.
"operations": [ # Required. The list of operations to perform on individual data exclusions.
{ # A single operation (create, remove, update) on a data exclusion.
"create": { # Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts. See "About data exclusions" at https://support.google.com/google-ads/answer/10370710. Note: A customer account can have a maximum of 500 active bidding data exclusions. # Create operation: No resource name is expected for the new data exclusion.
"advertisingChannelTypes": [ # The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"dataExclusionId": "A String", # Output only. The ID of the data exclusion.
"description": "A String", # The description of the data exclusion. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the data exclusion. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
"scope": "A String", # The scope of the data exclusion.
"startDateTime": "A String", # Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
"status": "A String", # Output only. The status of the data exclusion.
},
"remove": "A String", # Remove operation: A resource name for the removed data exclusion is expected, in this format: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
"update": { # Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts. See "About data exclusions" at https://support.google.com/google-ads/answer/10370710. Note: A customer account can have a maximum of 500 active bidding data exclusions. # Update operation: The data exclusion is expected to have a valid resource name.
"advertisingChannelTypes": [ # The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"dataExclusionId": "A String", # Output only. The ID of the data exclusion.
"description": "A String", # The description of the data exclusion. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the data exclusion. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
"scope": "A String", # The scope of the data exclusion.
"startDateTime": "A String", # Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
"status": "A String", # Output only. The status of the data exclusion.
},
"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 data exclusions 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 data exclusion mutate.
"biddingDataExclusion": { # Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts. See "About data exclusions" at https://support.google.com/google-ads/answer/10370710. Note: A customer account can have a maximum of 500 active bidding data exclusions. # The mutated bidding data exclusion with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"advertisingChannelTypes": [ # The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"dataExclusionId": "A String", # Output only. The ID of the data exclusion.
"description": "A String", # The description of the data exclusion. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the data exclusion. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
"scope": "A String", # The scope of the data exclusion.
"startDateTime": "A String", # Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
"status": "A String", # Output only. The status of the data exclusion.
},
"resourceName": "A String", # Returned for successful operations.
},
],
}