public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
BulkService = new BulkServiceManager(authorizationData);
BulkService.StatusPollIntervalInMilliseconds = 5000;
var progress = new Progress<BulkOperationProgressInfo>(x =>
OutputStatusMessage(String.Format("{0} % Complete",
x.PercentComplete.ToString(CultureInfo.InvariantCulture))));
// In this example we will download all ads and keywords in the account.
var entities = BulkDownloadEntity.Ads |
BulkDownloadEntity.Keywords;
// DownloadParameters is used for Option A below.
var downloadParameters = new DownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData | DataScope.EntityPerformanceData,
PerformanceStatsDateRange = new PerformanceStatsDateRange { PredefinedTime = ReportTimePeriod.LastFourWeeks },
Entities = entities,
FileType = FileType,
LastSyncTimeInUTC = null,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true
};
// SubmitDownloadParameters is used for Option B and Option C below.
var submitDownloadParameters = new SubmitDownloadParameters
{
CampaignIds = null,
DataScope = DataScope.EntityData | DataScope.EntityPerformanceData,
PerformanceStatsDateRange = new PerformanceStatsDateRange { PredefinedTime = ReportTimePeriod.LastFourWeeks },
Entities = entities,
FileType = FileType,
LastSyncTimeInUTC = null
};
// Option A - Background Completion with BulkServiceManager
// 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.
OutputStatusMessage("Awaiting Background Completion . . .");
await BackgroundCompletionAsync(downloadParameters, progress);
// Option B - Submit and Download with BulkServiceManager
// Submit the download request and then use the BulkDownloadOperation result to
// track status until the download is complete e.g. either using
// TrackAsync or GetStatusAsync.
//OutputStatusMessage("Awaiting Submit and Download . . .");
//await SubmitAndDownloadAsync(submitDownloadParameters);
// Option C - Download Results with BulkServiceManager
// If for any reason you have to resume from a previous application state,
// you can use an existing download request identifier and use it
// to download the result file.
// For example you might have previously retrieved a request ID using SubmitDownloadAsync.
//var bulkDownloadOperation = await BulkService.SubmitDownloadAsync(submitDownloadParameters);
//var requestId = bulkDownloadOperation.RequestId;
// Given the request ID above, you can resume the workflow and download the bulk file.
// The download request identifier is valid for two days.
// If you do not download the bulk file within two days, you must request it again.
//OutputStatusMessage("Awaiting Download Results . . .");
//await DownloadResultsAsync(requestId, authorizationData);
}
// 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.V10.Bulk.AdApiFaultDetail> ex)
{
OutputStatusMessage(String.Join("; ", ex.Detail.Errors.Select(error => String.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException<Microsoft.BingAds.V10.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);
}
}
private async Task <BulkDownloadOperation> SubmitDownloadAsyncImpl(SubmitDownloadParameters parameters)
{
if (parameters.CampaignIds == null)
{
var request = new DownloadCampaignsByAccountIdsRequest
{
AccountIds = new[] { _authorizationData.AccountId },
DataScope = parameters.DataScope,
DownloadFileType = parameters.FileType,
Entities = parameters.Entities,
FormatVersion = FormatVersion,
LastSyncTimeInUTC = parameters.LastSyncTimeInUTC,
PerformanceStatsDateRange = parameters.PerformanceStatsDateRange,
};
DownloadCampaignsByAccountIdsResponse response;
using (var apiService = new ServiceClient <IBulkService>(_authorizationData, _apiEnvironment))
{
try
{
response = await apiService.CallAsync((s, r) => s.DownloadCampaignsByAccountIdsAsync(r), request).ConfigureAwait(false);
}
catch (Exception e)
{
throw new CouldNotSubmitBulkDownloadException("Submit download operation failed.", e);
}
}
return(new BulkDownloadOperation(response.DownloadRequestId, _authorizationData, response.TrackingId, _apiEnvironment)
{
StatusPollIntervalInMilliseconds = StatusPollIntervalInMilliseconds,
DownloadHttpTimeout = DownloadHttpTimeout
});
}
else
{
var request = new DownloadCampaignsByCampaignIdsRequest
{
Campaigns = parameters.CampaignIds.Select(c => new CampaignScope {
CampaignId = c, ParentAccountId = _authorizationData.AccountId
}).ToList(),
DataScope = parameters.DataScope,
DownloadFileType = parameters.FileType,
Entities = parameters.Entities,
FormatVersion = FormatVersion,
LastSyncTimeInUTC = parameters.LastSyncTimeInUTC,
PerformanceStatsDateRange = parameters.PerformanceStatsDateRange
};
DownloadCampaignsByCampaignIdsResponse response;
using (var apiService = new ServiceClient <IBulkService>(_authorizationData, _apiEnvironment))
{
try
{
response = await apiService.CallAsync((s, r) => s.DownloadCampaignsByCampaignIdsAsync(r), request).ConfigureAwait(false);
}
catch (Exception e)
{
throw new CouldNotSubmitBulkDownloadException("Submit download operation failed.", e);
}
}
return(new BulkDownloadOperation(response.DownloadRequestId, _authorizationData, response.TrackingId, _apiEnvironment)
{
StatusPollIntervalInMilliseconds = StatusPollIntervalInMilliseconds,
DownloadHttpTimeout = DownloadHttpTimeout
});
}
}
/// <summary>
/// Submit the download request and then use the BulkDownloadOperation result to
/// track status until the download is complete e.g. either using
/// TrackAsync or GetStatusAsync.
/// </summary>
/// <param name="submitDownloadParameters"></param>
/// <returns></returns>
private async Task SubmitAndDownloadAsync(SubmitDownloadParameters submitDownloadParameters)
{
var bulkDownloadOperation = await BulkService.SubmitDownloadAsync(submitDownloadParameters);
// You may optionally cancel the TrackAsync operation after a specified time interval.
var tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(TimeoutInMilliseconds);
BulkOperationStatus<DownloadStatus> downloadStatus = await bulkDownloadOperation.TrackAsync(null, tokenSource.Token);
// You can use TrackAsync to poll until complete as shown above,
// or use custom polling logic with GetStatusAsync as shown below.
//BulkOperationStatus<DownloadStatus> downloadStatus;
//var waitTime = new TimeSpan(0, 0, 5);
//for (int i = 0; i < 24; i++)
//{
// Thread.Sleep(waitTime);
// downloadStatus = await bulkDownloadOperation.GetStatusAsync();
// if (downloadStatus.Status == DownloadStatus.Completed)
// {
// break;
// }
//}
var resultFilePath = await bulkDownloadOperation.DownloadResultFileAsync(
FileDirectory,
ResultFileName,
decompress: true,
overwrite: true // Set this value true if you want to overwrite the same file.
);
OutputStatusMessage(String.Format("Download result file: {0}\n", resultFilePath));
}