Edit

Share via

Campaign Negative Store Criterion Record - Bulk

  • Article

Defines a Campaign Negative Store Criterion that can be uploaded and downloaded in a bulk file.

Each Campaign Negative Store Criterion excludes one Microsoft Merchant Center store from your shopping campaign for brands. Each campaign can have a maximum of 10 excluded stores.

You can download all Campaign Negative Store Criterion records in the account by including the DownloadEntity value of CampaignNegativeStoreCriterions 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 campaign negative store criterion if a valid Parent Id value is provided.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Store Id,Name
Format Version,,,,,,,,,6.0
Campaign Negative Store Criterion,Active,,-114,,,ClientIdGoesHere,,StoreIdGoesHere,

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 BulkCampaignNegativeStoreCriterion 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 BulkCampaignNegativeStoreCriterion
var bulkCampaignNegativeStoreCriterion = new BulkCampaignNegativeStoreCriterion
{
    // Map properties in the Bulk file to the 
    // NegativeCampaignCriterion object of the Campaign Management service.
    NegativeCampaignCriterion = new NegativeCampaignCriterion
    {
        // 'Parent Id' column header in the Bulk file
        CampaignId = campaignIdKey,
        Criterion = new StoreCriterion
        {
            // 'Store Id' column header in the Bulk file
            StoreId = StoreIdGoesHere,
        },
        // 'Id' column header in the Bulk file
        Id = null,
    },
    // 'Campaign' column header in the Bulk file
    CampaignName = null,
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",
    // 'Status' column header in the Bulk file
    Status = Status.Active
};

uploadEntities.Add(bulkCampaignNegativeStoreCriterion);

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

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

For a Campaign Negative Store Criterion record, the following attribute fields are available in the Bulk File Schema.

Campaign

The name of the campaign that contains the store criterion.

Add: Read-only and Required
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only and Required

Note

For add, update, and delete, you must specify either the Parent Id or Campaign field.

Client Id

Used to associate records in the bulk upload file with records in the results file. The value of this field is not used or stored by the server; it is simply copied from the uploaded record to the corresponding result record. It may be any valid string to up 100 in length.

Add: Optional
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only

Id

The system-generated identifier of the store criterion.

Add: Read-only
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only and Required

Modified Time

The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).

Note

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only

Parent Id

The system-generated identifier of the campaign that contains the store criterion.

This bulk field maps to the Id field of the Campaign record.

Add: Read-only and Required. You must either specify an existing campaign identifier, or specify a negative identifier that is equal to the Id field of the parent Campaign record. This is recommended if you are adding new dynamic ad targets to a new campaign in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only

Note

For add, update, and delete, you must specify either the Parent Id or Campaign field.

Status

The status of the store criterion.

Possible values are Active or Deleted.

Add: Optional. The default value is Active.
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Required. The Status must be set to Deleted.

Store Id

The system-generated identifier of the Microsoft Merchant Center store to exclude.

Add: Required
Update: Not applicable. A negative store can be added and deleted, but cannot be updated.
Delete: Read-only