private FileUploadParameters CreateFileUploadParameters(EntityUploadParameters parameters)
{
CreateWorkingDirectoryIfNeeded();
var fileName = Path.Combine(WorkingDirectory, Guid.NewGuid() + ".csv");
using (var writer = new BulkFileWriter(fileName))
{
foreach (var entity in parameters.Entities)
{
writer.WriteEntity(entity);
}
}
var fileUploadParameters = new FileUploadParameters
{
UploadFilePath = fileName,
ResponseMode = parameters.ResponseMode,
ResultFileDirectory = parameters.ResultFileDirectory,
ResultFileName = parameters.ResultFileName,
OverwriteResultFile = parameters.OverwriteResultFile,
RenameUploadFileToMatchRequestId = true
};
return(fileUploadParameters);
}
/// <summary>
/// Uploads the specified Bulk file.
/// </summary>
/// <param name="parameters">Determines various upload parameters, for example what file to upload. Please see <see cref="FileUploadParameters"/> for more information about available parameters.</param>
/// <param name="progress">A class implementing <see cref="IProgress{T}"/> for tracking the percent complete progress information for the bulk operation.</param>
/// <param name="cancellationToken">Cancellation token that can be used to cancel the tracking of the bulk operation on the client. Doesn't cancel the actual bulk operation on the server.</param>
/// <returns>A task that represents the asynchronous operation. The task result will be an enumerable list of <see cref="BulkEntity"/> objects.</returns>
/// <exception cref="FaultException{TDetail}">Thrown if a fault is returned from the Bing Ads service.</exception>
/// <exception cref="OAuthTokenRequestException">Thrown if tokens can't be refreshed due to an error received from the Microsoft Account authorization server.</exception>
/// <exception cref="BulkOperationCouldNotBeCompletedException{TStatus}">Thrown if the bulk operation has failed.</exception>
public Task <string> UploadFileAsync(FileUploadParameters parameters, IProgress <BulkOperationProgressInfo> progress, CancellationToken cancellationToken)
{
ValidateSubmitUploadParameters(parameters.SubmitUploadParameters);
ValidateUserData();
return(UploadFileAsyncImpl(parameters, progress, cancellationToken));
}
private async Task <string> UploadFileAsyncImpl(FileUploadParameters parameters, IProgress <BulkOperationProgressInfo> progress, CancellationToken cancellationToken)
{
using (var operation = await SubmitUploadAsync(parameters.SubmitUploadParameters).ConfigureAwait(false))
{
await operation.TrackAsync(progress, cancellationToken).ConfigureAwait(false);
return(await DownloadBulkFile(parameters.ResultFileDirectory, parameters.ResultFileName, parameters.OverwriteResultFile, operation).ConfigureAwait(false));
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
BulkService = new BulkServiceManager(authorizationData);
var progress = new Progress<BulkOperationProgressInfo>(x =>
OutputStatusMessage(String.Format("{0} % Complete", x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
#region Add
const int appAdExtensionIdKey = -11;
const int callAdExtensionIdKey = -12;
const int locationAdExtensionIdKey = -13;
const int siteLinksAdExtensionIdKey = -14;
const int campaignIdKey = -123;
// Prepare the bulk entities that you want to upload. Each bulk entity contains the corresponding campaign management object,
// and additional elements needed to read from and write to a bulk file.
var bulkCampaign = new BulkCampaign
{
// ClientId may be 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.
// Note: This bulk file Client Id is not related to an application Client Id for OAuth.
ClientId = "YourClientIdGoesHere",
Campaign = new Campaign
{
// When using the Campaign Management service, the Id cannot be set. In the context of a BulkCampaign, the Id is optional
// and may be used as a negative reference key during bulk upload. For example the same negative value set for the campaign Id
// will be used when associating this new campaign with a new call ad extension in the BulkCampaignCallAdExtension object below.
Id = campaignIdKey,
Name = "Women's Shoes " + DateTime.UtcNow,
Description = "Red shoes line.",
BudgetType = BudgetLimitType.MonthlyBudgetSpendUntilDepleted,
MonthlyBudget = 1000.00,
TimeZone = "PacificTimeUSCanadaTijuana",
}
};
// Prepare ad extensions for upload
var bulkAppAdExtension = new BulkAppAdExtension
{
AccountId = authorizationData.AccountId,
AppAdExtension = new AppAdExtension
{
AppPlatform = "Windows",
AppStoreId = "AppStoreIdGoesHere",
DestinationUrl = "DestinationUrlGoesHere",
DisplayText = "Contoso",
Id = appAdExtensionIdKey,
}
};
var bulkCallAdExtension = new BulkCallAdExtension
{
AccountId = authorizationData.AccountId,
CallAdExtension = new CallAdExtension
{
CountryCode = "US",
PhoneNumber = "2065550100",
IsCallOnly = false,
Id = callAdExtensionIdKey
}
};
var bulkLocationAdExtension = new BulkLocationAdExtension
{
AccountId = authorizationData.AccountId,
LocationAdExtension = new LocationAdExtension
{
Id = locationAdExtensionIdKey,
PhoneNumber = "206-555-0100",
CompanyName = "Contoso Shoes",
IconMediaId = null,
ImageMediaId = null,
Address = new Address
{
StreetAddress = "1234 Washington Place",
StreetAddress2 = "Suite 1210",
CityName = "Woodinville",
ProvinceName = "WA",
CountryCode = "US",
PostalCode = "98608"
}
}
};
// Note that when written to file using the BulkFileWriter, an extra Sitelink Ad Extension record with Deleted
// status precedes the actual site link record or records that you want to upload. All bulk entities
// that are derived from MultiRecordBulkEntiy are preceded with a Deleted record using the BulkFileWriter.
// In this example it is a moot point because we are creating a new ad extension. If the specified
// ad extension Id already exists in your account, the Deleted record effectively deletes the existing
// extension and replaces it with the SiteLinksAdExtension specified below.
var bulkSiteLinkAdExtension = new BulkSiteLinkAdExtension
{
AccountId = authorizationData.AccountId,
SiteLinksAdExtension = new SiteLinksAdExtension
{
// Note that if you do not specify a negative Id as reference key, each of SiteLinks items will
// be split during upload into separate sitelink ad extensions with unique ad extension identifiers.
Id = siteLinksAdExtensionIdKey,
SiteLinks = new List<SiteLink>
{
new SiteLink
{
DestinationUrl = "Contoso.com",
DisplayText = "Women's Shoe Sale 1"
},
new SiteLink
{
DestinationUrl = "Contoso.com/WomenShoeSale/2",
DisplayText = "Women's Shoe Sale 2"
}
}
}
// Note that BulkSiteLinkAdExtension.SiteLinks is read only and only
// accessible when reading results from the download or upload results file.
// To upload new site links for a new site links ad extension, you should specify
// BulkSiteLinkAdExtension.SiteLinksAdExtension.SiteLinks as shown above.
};
// Prepare ad extension associations for upload
var bulkCampaignAppAdExtension = new BulkCampaignAppAdExtension
{
AdExtensionIdToEntityIdAssociation = new AdExtensionIdToEntityIdAssociation
{
AdExtensionId = appAdExtensionIdKey,
EntityId = campaignIdKey
}
};
var bulkCampaignCallAdExtension = new BulkCampaignCallAdExtension
{
AdExtensionIdToEntityIdAssociation = new AdExtensionIdToEntityIdAssociation
{
AdExtensionId = callAdExtensionIdKey,
EntityId = campaignIdKey
}
};
var bulkCampaignLocationAdExtension = new BulkCampaignLocationAdExtension
{
AdExtensionIdToEntityIdAssociation = new AdExtensionIdToEntityIdAssociation
{
AdExtensionId = locationAdExtensionIdKey,
EntityId = campaignIdKey
}
};
var bulkCampaignSiteLinkAdExtension = new BulkCampaignSiteLinkAdExtension
{
AdExtensionIdToEntityIdAssociation = new AdExtensionIdToEntityIdAssociation
{
AdExtensionId = siteLinksAdExtensionIdKey,
EntityId = campaignIdKey
}
};
// Write the entities created above, to the specified file.
// Dependent entities such as BulkCampaignCallAdExtension must be written after any dependencies,
// for example the BulkCampaign and BulkCallAdExtension.
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
Writer.WriteEntity(bulkCampaign);
Writer.WriteEntity(bulkAppAdExtension);
Writer.WriteEntity(bulkCallAdExtension);
Writer.WriteEntity(bulkLocationAdExtension);
Writer.WriteEntity(bulkSiteLinkAdExtension);
Writer.WriteEntity(bulkCampaignAppAdExtension);
Writer.WriteEntity(bulkCampaignCallAdExtension);
Writer.WriteEntity(bulkCampaignLocationAdExtension);
Writer.WriteEntity(bulkCampaignSiteLinkAdExtension);
Writer.Dispose();
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("\nAdding campaign, ad extensions, and associations . . .\n");
var bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path: " + Reader.BulkFilePath + "\n");
// Write the upload output
var bulkEntities = Reader.ReadEntities().ToList();
var campaignResults = bulkEntities.OfType<BulkCampaign>().ToList();
OutputBulkCampaigns(campaignResults);
var appAdExtensionResults = bulkEntities.OfType<BulkAppAdExtension>().ToList();
OutputBulkAppAdExtensions(appAdExtensionResults);
var callAdExtensionResults = bulkEntities.OfType<BulkCallAdExtension>().ToList();
OutputBulkCallAdExtensions(callAdExtensionResults);
var locationAdExtensionResults = bulkEntities.OfType<BulkLocationAdExtension>().ToList();
OutputBulkLocationAdExtensions(locationAdExtensionResults);
var siteLinkAdExtensionResults = bulkEntities.OfType<BulkSiteLinkAdExtension>().ToList();
OutputBulkSiteLinkAdExtensions(siteLinkAdExtensionResults);
OutputBulkCampaignAppAdExtensions(bulkEntities.OfType<BulkCampaignAppAdExtension>().ToList());
OutputBulkCampaignCallAdExtensions(bulkEntities.OfType<BulkCampaignCallAdExtension>().ToList());
OutputBulkCampaignLocationAdExtensions(bulkEntities.OfType<BulkCampaignLocationAdExtension>().ToList());
OutputBulkCampaignSiteLinkAdExtensions(bulkEntities.OfType<BulkCampaignSiteLinkAdExtension>().ToList());
Reader.Dispose();
#endregion Add
#region Update
// Update the site links ad extension.
// Do not create a BulkSiteLinkAdExtension for update, unless you want to replace all existing SiteLinks
// with the specified SiteLinks for the specified ad extension.
// Instead you should upload one or more site links as a list of BulkSiteLink.
var bulkSiteLinks = new List<BulkSiteLink>
{
new BulkSiteLink
{
SiteLink = new SiteLink
{
DestinationUrl = "Contoso.com",
DisplayText = "Red Shoe Sale"
}
}
};
// Add an additional site link, and update an existing site link
if (siteLinkAdExtensionResults.ToArray().Any() &&
siteLinkAdExtensionResults.ToArray()[0].SiteLinks.ToArray().Any())
{
var existingSiteLink = siteLinkAdExtensionResults.ToArray()[0].SiteLinks[0];
existingSiteLink.SiteLink.DisplayText = "Red Shoes Super Sale";
// Associate the new site links with the identifier of the existing site links ad extension
foreach (var bulkSiteLink in bulkSiteLinks)
{
bulkSiteLink.AdExtensionId = existingSiteLink.AdExtensionId;
}
bulkSiteLinks.Add(existingSiteLink);
}
// Write the new site link and updated site link to the file
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
foreach (var bulkSiteLink in bulkSiteLinks)
{
Writer.WriteEntity(bulkSiteLink);
}
Writer.Dispose();
fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("\nUpdating sitelinks . . .\n");
bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path: " + Reader.BulkFilePath + "\n");
// Write any upload errors
bulkEntities = Reader.ReadEntities().ToList();
var siteLinkResults = bulkEntities.OfType<BulkSiteLink>().ToList();
OutputBulkSiteLinks(siteLinkResults);
Reader.Dispose();
#endregion Update
#region Delete
// Prepare the bulk entities that you want to delete. You must set the Id field to the corresponding
// entity identifier, and the Status field to Deleted.
var campaignId = campaignResults[0].Campaign.Id;
bulkCampaign = new BulkCampaign
{
Campaign = new Campaign
{
Id = campaignId,
Status = CampaignStatus.Deleted
}
};
var appAdExtensionId = appAdExtensionResults[0].AppAdExtension.Id;
bulkAppAdExtension = new BulkAppAdExtension
{
AppAdExtension = new AppAdExtension
{
Id = appAdExtensionId,
Status = AdExtensionStatus.Deleted
}
};
var callAdExtensionId = callAdExtensionResults[0].CallAdExtension.Id;
bulkCallAdExtension = new BulkCallAdExtension
{
CallAdExtension = new CallAdExtension
{
Id = callAdExtensionId,
Status = AdExtensionStatus.Deleted
}
};
var locationAdExtensionId = locationAdExtensionResults[0].LocationAdExtension.Id;
bulkLocationAdExtension = new BulkLocationAdExtension
{
LocationAdExtension = new LocationAdExtension
{
Id = locationAdExtensionId,
Status = AdExtensionStatus.Deleted
}
};
var siteLinkAdExtensionId = siteLinkAdExtensionResults[0].SiteLinksAdExtension.Id;
bulkSiteLinkAdExtension = new BulkSiteLinkAdExtension
{
SiteLinksAdExtension = new SiteLinksAdExtension
{
Id = siteLinkAdExtensionId,
Status = AdExtensionStatus.Deleted
}
};
// Write the entities that you want deleted, to the specified file.
// Dependent entities such as BulkCampaignCallAdExtension are deleted without being specified explicitly.
// For example, if you delete either BulkCampaign or BulkCallAdExtension, then the equivalent of
// BulkCampaignCallAdExtension is effectively deleted.
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
Writer.WriteEntity(bulkCampaign);
Writer.WriteEntity(bulkAppAdExtension);
Writer.WriteEntity(bulkCallAdExtension);
Writer.WriteEntity(bulkLocationAdExtension);
Writer.WriteEntity(bulkSiteLinkAdExtension);
Writer.Dispose();
fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("\nDeleting campaign and ad extensions . . .\n");
bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path: " + Reader.BulkFilePath + "\n");
// Write the upload output
bulkEntities = Reader.ReadEntities().ToList();
campaignResults = bulkEntities.OfType<BulkCampaign>().ToList();
OutputBulkCampaigns(campaignResults);
appAdExtensionResults = bulkEntities.OfType<BulkAppAdExtension>().ToList();
OutputBulkAppAdExtensions(appAdExtensionResults);
callAdExtensionResults = bulkEntities.OfType<BulkCallAdExtension>().ToList();
OutputBulkCallAdExtensions(callAdExtensionResults);
locationAdExtensionResults = bulkEntities.OfType<BulkLocationAdExtension>().ToList();
OutputBulkLocationAdExtensions(locationAdExtensionResults);
siteLinkAdExtensionResults = bulkEntities.OfType<BulkSiteLinkAdExtension>().ToList();
OutputBulkSiteLinkAdExtensions(siteLinkAdExtensionResults);
OutputBulkCampaignAppAdExtensions(bulkEntities.OfType<BulkCampaignAppAdExtension>().ToList());
OutputBulkCampaignCallAdExtensions(bulkEntities.OfType<BulkCampaignCallAdExtension>().ToList());
OutputBulkCampaignLocationAdExtensions(bulkEntities.OfType<BulkCampaignLocationAdExtension>().ToList());
OutputBulkCampaignSiteLinkAdExtensions(bulkEntities.OfType<BulkCampaignSiteLinkAdExtension>().ToList());
Reader.Dispose();
#endregion Delete
}
// Catch Microsoft Account authorization exceptions.
catch (OAuthTokenRequestException ex)
{
OutputStatusMessage(string.Format("Couldn't get OAuth tokens. Error: {0}. Description: {1}", ex.Details.Error, ex.Details.Description));
}
// Catch Bulk service exceptions
catch (FaultException<Microsoft.BingAds.Bulk.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException<Microsoft.BingAds.Bulk.ApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.OperationErrors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
OutputStatusMessage(string.Join("; ", ex.Detail.BatchErrors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (BulkOperationInProgressException ex)
{
OutputStatusMessage("The result file for the bulk operation is not yet available for download.");
OutputStatusMessage(ex.Message);
}
catch (BulkOperationCouldNotBeCompletedException<DownloadStatus> ex)
{
OutputStatusMessage(string.Join("; ", ex.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (BulkOperationCouldNotBeCompletedException<UploadStatus> ex)
{
OutputStatusMessage(string.Join("; ", ex.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (Exception ex)
{
OutputStatusMessage(ex.Message);
}
finally
{
if (Reader != null) { Reader.Dispose(); }
if (Writer != null) { Writer.Dispose(); }
}
}
/// <summary>
/// Uploads a list of BulkAdGroupProductPartition objects that must represent
/// a product partition tree for one ad group. You can include BulkAdGroupProductPartition records for more than one
/// ad group per upload, however, this code example assumes that only one ad group is in scope.
/// </summary>
/// <param name="partitionActions">The list of BulkAdGroupProductPartition objects that must represent
/// a product partition tree.</param>
/// <returns>The BulkAdGroupProductPartition upload results.</returns>
private async Task<IList<BulkAdGroupProductPartition>> ApplyBulkProductPartitionActions(
IList<BulkAdGroupProductPartition> partitionActions)
{
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
foreach (var partitionAction in partitionActions)
{
Writer.WriteEntity(partitionAction);
}
Writer.Dispose();
var bulkFilePath =
await BulkService.UploadFileAsync(fileUploadParameters);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
var bulkEntities = Reader.ReadEntities().ToList();
var bulkAdGroupProductPartitionResults = bulkEntities.OfType<BulkAdGroupProductPartition>().ToList();
OutputBulkAdGroupProductPartitions(bulkAdGroupProductPartitionResults);
Reader.Dispose();
return bulkAdGroupProductPartitionResults;
}
/// <summary>
/// Writes the specified entities to a local file and uploads the file. We could have uploaded directly
/// without writing to file. This example writes to file as an exercise so that you can view the structure
/// of the bulk records being uploaded as needed.
/// </summary>
/// <param name="uploadEntities"></param>
/// <returns></returns>
private async Task<BulkFileReader> UploadEntities(IEnumerable<BulkEntity> uploadEntities)
{
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
foreach (var entity in uploadEntities)
{
Writer.WriteEntity(entity);
}
Writer.Dispose();
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
CompressUploadFile = true,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
var bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters);
return new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
BulkService = new BulkServiceManager(authorizationData);
var progress = new Progress<BulkOperationProgressInfo>(x =>
OutputStatusMessage(String.Format("{0} % Complete",
x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
#region Add
const int targetIdKey = -1;
const int campaignIdKey = -123;
// Prepare the bulk entities that you want to upload. Each bulk entity contains the corresponding campaign management object,
// and additional elements needed to read from and write to a bulk file.
var bulkCampaign = new BulkCampaign
{
// ClientId may be 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.
// Note: This bulk file Client Id is not related to an application Client Id for OAuth.
ClientId = "YourClientIdGoesHere",
Campaign = new Campaign
{
// When using the Campaign Management service, the Id cannot be set. In the context of a BulkCampaign, the Id is optional
// and may be used as a negative reference key during bulk upload. For example the same negative value set for the campaign Id
// will be used when associating this new campaign with a new call ad extension in the BulkCampaignCallAdExtension object below.
Id = campaignIdKey,
Name = "Women's Shoes " + DateTime.UtcNow,
Description = "Red shoes line.",
BudgetType = BudgetLimitType.MonthlyBudgetSpendUntilDepleted,
MonthlyBudget = 1000.00,
TimeZone = "PacificTimeUSCanadaTijuana",
DaylightSaving = true
}
};
// Prepare targets for upload
var bulkCampaignDayTimeTarget = new BulkCampaignDayTimeTarget
{
CampaignId = campaignIdKey,
TargetId = targetIdKey,
DayTimeTarget = new DayTimeTarget
{
Bids = new List<DayTimeTargetBid>
{
new DayTimeTargetBid
{
BidAdjustment = 10,
Day = Day.Friday,
FromHour = 11,
FromMinute = Minute.Zero,
ToHour = 13,
ToMinute = Minute.Fifteen
},
new DayTimeTargetBid
{
BidAdjustment = 20,
Day = Day.Saturday,
FromHour = 11,
FromMinute = Minute.Zero,
ToHour = 13,
ToMinute = Minute.Fifteen
}
}
}
};
var bulkCampaignLocationTarget = new BulkCampaignLocationTarget
{
CampaignId = campaignIdKey,
TargetId = targetIdKey,
IntentOption = IntentOption.PeopleIn,
CityTarget = new CityTarget
{
Bids = new List<CityTargetBid>
{
new CityTargetBid
{
BidAdjustment = 15,
City = "Toronto, Toronto ON CA",
IsExcluded = false
}
}
},
CountryTarget = new CountryTarget
{
Bids = new List<CountryTargetBid>
{
new CountryTargetBid
{
BidAdjustment = 15,
CountryAndRegion = "CA",
IsExcluded = false
}
}
},
MetroAreaTarget = new MetroAreaTarget
{
Bids = new List<MetroAreaTargetBid>
{
new MetroAreaTargetBid
{
BidAdjustment = 15,
MetroArea = "Seattle-Tacoma, WA, WA US",
IsExcluded = false
}
}
},
StateTarget = new StateTarget
{
Bids = new List<StateTargetBid>
{
new StateTargetBid
{
BidAdjustment = 15,
State = "US-WA",
IsExcluded = false
}
}
},
PostalCodeTarget = new PostalCodeTarget
{
Bids = new List<PostalCodeTargetBid>
{
new PostalCodeTargetBid
{
// Bid adjustments are not allowed for location exclusions.
// If IsExcluded is true, this element will be ignored.
BidAdjustment = 10,
PostalCode = "98052, WA US",
IsExcluded = false
}
}
}
};
var bulkCampaignRadiusTarget = new BulkCampaignRadiusTarget
{
CampaignId = campaignIdKey,
TargetId = targetIdKey,
RadiusTarget = new RadiusTarget2
{
Bids = new List<RadiusTargetBid2>
{
new RadiusTargetBid2
{
BidAdjustment = 50,
LatitudeDegrees = 47.755367,
LongitudeDegrees = -122.091827,
Radius = 11,
RadiusUnit = DistanceUnit.Kilometers
}
}
}
};
// Write the entities created above, to the specified file.
// Dependent entities such as BulkCampaignLocationTarget must be written after any dependencies,
// for example a BulkCampaign.
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
Writer.WriteEntity(bulkCampaign);
Writer.WriteEntity(bulkCampaignDayTimeTarget);
Writer.WriteEntity(bulkCampaignLocationTarget);
Writer.WriteEntity(bulkCampaignRadiusTarget);
Writer.Dispose();
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("Starting UploadFileAsync . . .\n");
var bulkFilePath =
await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path" + Reader.BulkFilePath + "\n");
OutputStatusMessage("Added Entities\n");
// Write the upload output
var bulkEntities = Reader.ReadEntities().ToList();
var campaignResults = bulkEntities.OfType<BulkCampaign>().ToList();
OutputBulkCampaigns(campaignResults);
var campaignDayTimeTargetResults = bulkEntities.OfType<BulkCampaignDayTimeTarget>().ToList();
OutputBulkCampaignDayTimeTargets(campaignDayTimeTargetResults);
var campaignLocationTargetResults = bulkEntities.OfType<BulkCampaignLocationTarget>().ToList();
OutputBulkCampaignLocationTargets(campaignLocationTargetResults);
var campaignRadiusTargetResults = bulkEntities.OfType<BulkCampaignRadiusTarget>().ToList();
OutputBulkCampaignRadiusTargets(campaignRadiusTargetResults);
Reader.Dispose();
#endregion Add
#region Update
// Update the day and time target.
// Do not create a BulkAdGroupDayTimeTarget for update, unless you want to replace all existing DayTime target bids
// with the specified day and time target set for the current bulk upload.
// Instead you should upload one or more bids as a list of BulkCampaignDayTimeTargetBid.
var bulkCampaignDayTimeTargetBids = new List<BulkCampaignDayTimeTargetBid>
{
new BulkCampaignDayTimeTargetBid
{
CampaignId = campaignDayTimeTargetResults[0].CampaignId,
TargetId = targetIdKey,
DayTimeTargetBid = new DayTimeTargetBid
{
BidAdjustment = 15,
Day = Day.Friday,
FromHour = 11,
FromMinute = Minute.Zero,
ToHour = 13,
ToMinute = Minute.Fifteen
}
}
};
// Write the updated target to the file
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
foreach (var bulkCampaignDayTimeTargetBid in bulkCampaignDayTimeTargetBids)
{
Writer.WriteEntity(bulkCampaignDayTimeTargetBid);
}
Writer.Dispose();
fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("Starting UploadFileAsync . . .\n");
bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path: " + Reader.BulkFilePath + "\n");
OutputStatusMessage("Updated Entities\n");
// Write any upload errors
var campaignDayTimeTargetBidResults =
Reader.ReadEntities().OfType<BulkCampaignDayTimeTargetBid>().ToList();
OutputBulkCampaignDayTimeTargetBids(campaignDayTimeTargetBidResults);
Reader.Dispose();
#endregion Update
#region Delete
// Prepare the bulk entities that you want to delete. You must set the Id field to the corresponding
// entity identifier, and the Status field to Deleted.
var campaignId = campaignResults[0].Campaign.Id;
bulkCampaign = new BulkCampaign
{
Campaign = new Campaign
{
Id = campaignId,
Status = CampaignStatus.Deleted
}
};
var targetId = campaignDayTimeTargetResults[0].TargetId;
bulkCampaignDayTimeTarget = new BulkCampaignDayTimeTarget
{
Status = Status.Deleted,
CampaignId = campaignId,
TargetId = targetId
};
bulkCampaignLocationTarget = new BulkCampaignLocationTarget
{
Status = Status.Deleted,
CampaignId = campaignId,
TargetId = targetId
};
bulkCampaignRadiusTarget = new BulkCampaignRadiusTarget
{
Status = Status.Deleted,
CampaignId = campaignId,
TargetId = targetId
};
// Write the entities that you want deleted, to the specified file.
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
Writer.WriteEntity(bulkCampaign);
Writer.WriteEntity(bulkCampaignDayTimeTarget);
Writer.WriteEntity(bulkCampaignLocationTarget);
Writer.WriteEntity(bulkCampaignRadiusTarget);
Writer.Dispose();
fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
// UploadFileAsync will upload the file you finished writing and will download the results file
OutputStatusMessage("Starting UploadFileAsync . . .\n");
bulkFilePath = await BulkService.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
OutputStatusMessage("Upload Results Bulk File Path" + Reader.BulkFilePath + "\n");
OutputStatusMessage("Deleted Entities\n");
// Write the upload output
bulkEntities = Reader.ReadEntities().ToList();
campaignResults = bulkEntities.OfType<BulkCampaign>().ToList();
OutputBulkCampaigns(campaignResults);
campaignDayTimeTargetResults = bulkEntities.OfType<BulkCampaignDayTimeTarget>().ToList();
OutputBulkCampaignDayTimeTargets(campaignDayTimeTargetResults);
campaignLocationTargetResults = bulkEntities.OfType<BulkCampaignLocationTarget>().ToList();
OutputBulkCampaignLocationTargets(campaignLocationTargetResults);
campaignRadiusTargetResults = bulkEntities.OfType<BulkCampaignRadiusTarget>().ToList();
OutputBulkCampaignRadiusTargets(campaignRadiusTargetResults);
Reader.Dispose();
#endregion Delete
}
// Catch Microsoft Account authorization exceptions.
catch (OAuthTokenRequestException ex)
{
OutputStatusMessage(string.Format("Couldn't get OAuth tokens. Error: {0}. Description: {1}", ex.Details.Error, ex.Details.Description));
}
// Catch Bulk service exceptions
catch (FaultException<Microsoft.BingAds.Bulk.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException<Microsoft.BingAds.Bulk.ApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.OperationErrors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
OutputStatusMessage(string.Join("; ", ex.Detail.BatchErrors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (BulkOperationInProgressException ex)
{
OutputStatusMessage("The result file for the bulk operation is not yet available for download.");
OutputStatusMessage(ex.Message);
}
catch (BulkOperationCouldNotBeCompletedException<DownloadStatus> ex)
{
OutputStatusMessage(string.Join("; ", ex.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (BulkOperationCouldNotBeCompletedException<UploadStatus> ex)
{
OutputStatusMessage(string.Join("; ", ex.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (Exception ex)
{
OutputStatusMessage(ex.Message);
}
finally
{
if (Reader != null) { Reader.Dispose(); }
if (Writer != null) { Writer.Dispose(); }
}
}
private async Task <IEnumerable <BulkEntity> > UploadEntitiesAsyncImpl(IProgress <BulkOperationProgressInfo> progress, CancellationToken cancellationToken, FileUploadParameters fileUploadParameters)
{
var resultFile = await UploadFileAsyncImpl(fileUploadParameters, progress, cancellationToken).ConfigureAwait(false);
return(new BulkFileReaderEnumerable(BulkFileReaderFactory.CreateBulkFileReader(resultFile, ResultFileType.Upload, DownloadFileType.Csv)));
}
/// <summary>
/// Uploads the specified Bulk file.
/// </summary>
/// <param name="parameters">Determines various upload parameters, for example what file to upload. Please see <see cref="FileUploadParameters"/> for more information about available parameters.</param>
/// <returns>A task that represents the asynchronous operation. The task result will be an enumerable list of <see cref="BulkEntity"/> objects.</returns>
/// <exception cref="FaultException{TDetail}">Thrown if a fault is returned from the Bing Ads service.</exception>
/// <exception cref="OAuthTokenRequestException">Thrown if tokens can't be refreshed due to an error received from the Microsoft Account authorization server.</exception>
/// <exception cref="BulkOperationCouldNotBeCompletedException{TStatus}">Thrown if the bulk operation has failed.</exception>
public Task <string> UploadFileAsync(FileUploadParameters parameters)
{
return(UploadFileAsync(parameters, null, CancellationToken.None));
}