Data Exclusion Record - Bulk

Defines the Data Exclusion fields that can be uploaded and downloaded in a bulk file.

You can download all Data Exclusion records in the account by including the DownloadEntity value of SeasonalityAdjustments in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.

The following Bulk CSV example would add a new Data Exclusion.

Type,AccountId,Id,Campaign Type,Start Date,End Date,Name,Description,Data Exclusion,Device Type,Campaign Associations
Format Version,,,,,,6.0,,,,
Data Exclusion,,,Search,3/15/2024 3:00,3/16/2024 3:00,,Description,TestDE,Tablets,

If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to upload and download the BulkAdGroupDataExclusion object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkDataExclusion
var bulkDataExclusion = new BulkDataExclusion
{
    // Map properties in the Bulk file to the
    // DataExclusion object of the Campaign Management service.
    DataExclusion = new DataExclusion
    {
        // 'Campaign Associations' column header in the Bulk file
        CampaignAssociations = new List<CampaignAssociation>(),
        // 'Campaign Type' column header in the Bulk file
        CampaignTypeFilter = CampaignType.Search,
        // 'Description' column header in the Bulk file
        Description = "Description",
        // 'Device Type' column header in the Bulk file
        DeviceTypeFilter = DeviceType.Computers,
        // 'Id' column header in the Bulk file
        Id = null,
        // 'Start Date' column header in the Bulk file
        StartDate = DateTime.UtcNow,
        // 'End Date' column header in the Bulk file
        EndDate = DateTime.UtcNow.AddDays(7),
        // 'Data Exclusion' column header in the Bulk file
        Name = "Data Exclusion",
    },
};

uploadEntities.Add(bulkDataExclusion);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

For an Data Exclusion record, the following attribute fields are available in the Bulk File Schema.

Campaign Associations

Make the data exclusion to these campaigns.

Add: Optional
Update: Optional
Delete: Optional. Only one of "Campaign Associations" and "Campaign Type" can be specified. If you set "Campaign Type," this will be null.

Campaign Type

Make the data exclusion to these campaign types.

Add: Optional
Update: Optional
Delete: Optional. Only one of "Campaign Associations" and "Campaign Type" can be specified. If you set "Campaign Associations," this will be null.

Description

A description for the data exclusion.

Add: Required
Update: Optional
Delete: Read-only

Device Type

Make the data exclusion to these device types.

Add: Required
Update: Optional
Delete: Read-only

End Date

The end date.

Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Required
Update: Optional
Delete: Read-only

Id

The system-generated identifier for the data exclusion.

Add: None
Update: Required
Delete: Read-only

Data Exclusion

The name of the data exclusion.

Add: Required
Update: Optional
Delete: Read-only

Start Date

The start date.

Important: The value must be in Coordinated Universal Time (UTC). This differs from the time zone options when you upload offline conversions in the Microsoft Advertising web application. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Required
Update: Optional
Delete: Read-only