/// <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));
}
/// <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 BulkServiceManager.UploadFileAsync(fileUploadParameters);
Reader = new BulkFileReader(bulkFilePath, ResultFileType.Upload, FileType);
var downloadEntities = Reader.ReadEntities().ToList();
var bulkAdGroupProductPartitionResults = downloadEntities.OfType <BulkAdGroupProductPartition>().ToList();
// Add this output line if you want to view details of each BulkAdGroupProductPartition.
//OutputBulkAdGroupProductPartitions(bulkAdGroupProductPartitionResults);
Reader.Dispose();
return(bulkAdGroupProductPartitionResults);
}
/// <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
};
var progress = new Progress <BulkOperationProgressInfo>(x =>
OutputStatusMessage(string.Format("{0} % Complete",
x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(TimeoutInMilliseconds);
Writer = new BulkFileWriter(
filePath: FileDirectory + UploadFileName);
foreach (var partitionAction in partitionActions)
{
Writer.WriteEntity(partitionAction);
}
Writer.Dispose();
var bulkFilePath = await BulkServiceManager.UploadFileAsync(
parameters : fileUploadParameters,
progress : progress,
cancellationToken : tokenSource.Token);
Reader = new BulkFileReader(
filePath: bulkFilePath,
resultFileType: ResultFileType.Upload,
fileFormat: FileType);
OutputStatusMessage("Upload results:");
var downloadEntities = Reader.ReadEntities().ToList();
var bulkAdGroupProductPartitionResults = downloadEntities.OfType <BulkAdGroupProductPartition>().ToList();
OutputBulkAdGroupProductPartitions(bulkAdGroupProductPartitionResults);
Reader.Dispose();
return(bulkAdGroupProductPartitionResults);
}
private void OpenOutput()
{
outputStream = new FileStream(output, FileMode.Create, FileAccess.Write, FileShare.None, Constants.WriteBufferSize);
if (binary)
{
outputBinary = new BinaryWriter(outputStream);
bulkWriter = new BulkFileWriter(outputBinary);
}
else
{
outputWriter = new StreamWriter(outputStream, Encoding.Unicode);
bulkWriter = new BulkFileWriter(outputWriter);
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
ApiEnvironment environment = ((OAuthDesktopMobileAuthCodeGrant)authorizationData.Authentication).Environment;
CampaignManagementExampleHelper = new CampaignManagementExampleHelper(this.OutputStatusMessage);
BulkServiceManager = new BulkServiceManager(authorizationData, environment);
BulkServiceManager.StatusPollIntervalInMilliseconds = 5000;
var progress = new Progress <BulkOperationProgressInfo>(x =>
OutputStatusMessage(string.Format("{0} % Complete",
x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
#region Download
// In this example we will download all ad groups in the account.
var entities = new[] {
DownloadEntity.AdGroups,
};
// You can limit by specific campaign IDs and request performance data.
var downloadParameters = new DownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData,
PerformanceStatsDateRange = null,
DownloadEntities = entities,
FileType = FileType,
LastSyncTimeInUTC = null,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true
};
// You can submit a download or upload request and the BulkServiceManager will automatically
// return results. The BulkServiceManager abstracts the details of checking for result file
// completion, and you don't have to write any code for results polling.
var bulkFilePath = await BulkServiceManager.DownloadFileAsync(downloadParameters);
OutputStatusMessage("Downloaded all ad groups in the account.\n");
#endregion Download
#region Parse
Reader = new BulkFileReader(bulkFilePath, ResultFileType.FullDownload, FileType);
var bulkAdGroups = Reader.ReadEntities().ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
// We will activate ad groups for one month starting from today as an example.
var nextMonth = DateTime.UtcNow.AddMonths(1);
// Within the downloaded records, find all ad groups that you want to update.
foreach (var bulkAdGroup in bulkAdGroups)
{
var adGroup = bulkAdGroup.AdGroup;
if (adGroup != null && bulkAdGroup.IsExpired)
{
// For best performance, only upload the properties that you want to update.
Writer.WriteEntity(new BulkAdGroup
{
CampaignId = bulkAdGroup.CampaignId,
AdGroup = new AdGroup
{
Id = adGroup.Id,
EndDate = new Microsoft.BingAds.V12.CampaignManagement.Date
{
Month = nextMonth.Month,
Day = nextMonth.Day,
Year = nextMonth.Year
},
Status = AdGroupStatus.Active,
}
});
}
}
Reader.Dispose();
Writer.Dispose();
#endregion Parse
#region Upload
// Upload the local file that we already prepared
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
CompressUploadFile = true,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
var resultFilePath = await BulkServiceManager.UploadFileAsync(fileUploadParameters, progress, CancellationToken.None);
OutputStatusMessage("Updated ad groups.\n");
Reader = new BulkFileReader(resultFilePath, ResultFileType.Upload, FileType);
bulkAdGroups = Reader.ReadEntities().ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
Reader.Dispose();
#endregion Upload
#region Entities
// We can make the same update without explicitly reading or writing a local file.
// When working with entities a file is downloaded to the temp directory,
// although you don't need to manage it.
var downloadEntities = await BulkServiceManager.DownloadEntitiesAsync(downloadParameters);
OutputStatusMessage("Downloaded all ad groups in the account.\n");
bulkAdGroups = downloadEntities.ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
var uploadEntities = new List <BulkEntity>();
foreach (var bulkAdGroup in bulkAdGroups)
{
var adGroup = bulkAdGroup.AdGroup;
if (adGroup != null && bulkAdGroup.IsExpired)
{
// Instead of Writer.WriteEntity, we will add to the in-memory list
uploadEntities.Add(new BulkAdGroup
{
CampaignId = bulkAdGroup.CampaignId,
AdGroup = new AdGroup
{
Id = adGroup.Id,
EndDate = new Microsoft.BingAds.V12.CampaignManagement.Date
{
Month = nextMonth.Month,
Day = nextMonth.Day,
Year = nextMonth.Year
},
Status = AdGroupStatus.Active,
}
});
}
}
var entityUploadParameters = new EntityUploadParameters
{
Entities = uploadEntities,
ResponseMode = ResponseMode.ErrorsAndResults,
};
var resultEntities = await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters, progress, CancellationToken.None);
OutputStatusMessage("Updated ad groups.\n");
bulkAdGroups = resultEntities.ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
#endregion Entities
}
// Catch authentication 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.V12.Bulk.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <Microsoft.BingAds.V12.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);
}
}
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 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",
DaylightSaving = true
}
};
// Prepare ad extensions for upload
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 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(bulkCallAdExtension);
Writer.WriteEntity(bulkLocationAdExtension);
Writer.WriteEntity(bulkSiteLinkAdExtension);
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("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 callAdExtensionResults = bulkEntities.OfType <BulkCallAdExtension>().ToList();
OutputBulkCallAdExtensions(callAdExtensionResults);
var locationAdExtensionResults = bulkEntities.OfType <BulkLocationAdExtension>().ToList();
OutputBulkLocationAdExtensions(locationAdExtensionResults);
var siteLinkAdExtensionResults = bulkEntities.OfType <BulkSiteLinkAdExtension>().ToList();
OutputBulkSiteLinkAdExtensions(siteLinkAdExtensionResults);
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("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
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 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(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("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);
callAdExtensionResults = bulkEntities.OfType <BulkCallAdExtension>().ToList();
OutputBulkCallAdExtensions(callAdExtensionResults);
locationAdExtensionResults = bulkEntities.OfType <BulkLocationAdExtension>().ToList();
OutputBulkLocationAdExtensions(locationAdExtensionResults);
siteLinkAdExtensionResults = bulkEntities.OfType <BulkSiteLinkAdExtension>().ToList();
OutputBulkSiteLinkAdExtensions(siteLinkAdExtensionResults);
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();
}
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
ApiEnvironment environment = ((OAuthDesktopMobileAuthCodeGrant)authorizationData.Authentication).Environment;
// Used to output the Campaign Management objects within Bulk entities.
CampaignManagementExampleHelper = new CampaignManagementExampleHelper(
OutputStatusMessageDefault: this.OutputStatusMessage);
BulkServiceManager = new BulkServiceManager(
authorizationData: authorizationData,
apiEnvironment: environment);
var progress = new Progress <BulkOperationProgressInfo>(x =>
OutputStatusMessage(string.Format("{0} % Complete",
x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(TimeoutInMilliseconds);
// In this example we will download all ad groups in the account.
var downloadParameters = new DownloadParameters
{
DataScope = DataScope.EntityData,
DownloadEntities = new[] { DownloadEntity.AdGroups },
FileType = FileType,
LastSyncTimeInUTC = null,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true
};
OutputStatusMessage("-----\nDownloading all ad groups in the account.");
var bulkFilePath = await BulkServiceManager.DownloadFileAsync(
parameters : downloadParameters,
progress : progress,
cancellationToken : tokenSource.Token);
OutputStatusMessage("Download results:");
Reader = new BulkFileReader(
filePath: bulkFilePath,
resultFileType: ResultFileType.FullDownload,
fileFormat: FileType);
var bulkAdGroups = Reader.ReadEntities().ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
Writer = new BulkFileWriter(FileDirectory + UploadFileName);
// We will activate ad groups for one month starting from today as an example.
var nextMonth = DateTime.UtcNow.AddMonths(1);
// Within the downloaded records, find all ad groups that you want to update.
foreach (var bulkAdGroup in bulkAdGroups)
{
var adGroup = bulkAdGroup.AdGroup;
if (adGroup != null && bulkAdGroup.AdGroup.Status.ToString().CompareTo("Active") != 0)
{
// For best performance, only upload the properties that you want to update.
Writer.WriteEntity(new BulkAdGroup
{
CampaignId = bulkAdGroup.CampaignId,
AdGroup = new AdGroup
{
Id = adGroup.Id,
EndDate = new Microsoft.BingAds.V13.CampaignManagement.Date
{
Month = nextMonth.Month,
Day = nextMonth.Day,
Year = nextMonth.Year
},
Status = AdGroupStatus.Active,
}
});
}
}
Reader.Dispose();
Writer.Dispose();
// Upload the local file that we already prepared
var fileUploadParameters = new FileUploadParameters
{
ResultFileDirectory = FileDirectory,
CompressUploadFile = true,
ResultFileName = ResultFileName,
OverwriteResultFile = true,
UploadFilePath = FileDirectory + UploadFileName,
ResponseMode = ResponseMode.ErrorsAndResults
};
OutputStatusMessage("-----\nActivating the ad groups...");
var resultFilePath = await BulkServiceManager.UploadFileAsync(
parameters : fileUploadParameters,
progress : progress,
cancellationToken : tokenSource.Token);
Reader = new BulkFileReader(
filePath: resultFilePath,
resultFileType: ResultFileType.Upload,
fileFormat: FileType);
OutputStatusMessage("Upload results:");
bulkAdGroups = Reader.ReadEntities().ToList().OfType <BulkAdGroup>().ToList();
OutputBulkAdGroups(bulkAdGroups);
Reader.Dispose();
}
// Catch authentication 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.V13.Bulk.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <Microsoft.BingAds.V13.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);
}
}
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();
}
}
}
