public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
CampaignManagementExampleHelper CampaignManagementExampleHelper = new CampaignManagementExampleHelper(this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient <ICampaignManagementService>(authorizationData);
var budgetIds = new List <long?>();
var budgets = new List <Budget>();
budgets.Add(new Budget
{
Amount = 50,
BudgetType = BudgetLimitType.DailyBudgetStandard,
Name = "My Shared Budget " + DateTime.UtcNow,
});
budgetIds = (await CampaignManagementExampleHelper.AddBudgetsAsync(budgets)).BudgetIds.ToList();
// Specify one or more campaigns.
var campaigns = new[] {
new Campaign
{
Name = "Women's Shoes " + DateTime.UtcNow,
Description = "Red shoes line.",
// You must choose to set either the shared budget ID or daily amount.
// You can set one or the other, but you may not set both.
BudgetId = budgetIds.Count > 0 ? budgetIds[0] : null,
DailyBudget = budgetIds.Count > 0 ? 0 : 50,
BudgetType = BudgetLimitType.DailyBudgetStandard,
// You can set your campaign bid strategy to Enhanced CPC (EnhancedCpcBiddingScheme)
// and then, at any time, set an individual ad group or keyword bid strategy to
// Manual CPC (ManualCpcBiddingScheme).
// For campaigns you can use either of the EnhancedCpcBiddingScheme or ManualCpcBiddingScheme objects.
// If you do not set this element, then EnhancedCpcBiddingScheme is used by default.
BiddingScheme = new EnhancedCpcBiddingScheme {
},
TimeZone = "PacificTimeUSCanadaTijuana",
// Used with FinalUrls shown in the text ads that we will add below.
TrackingUrlTemplate =
"http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}"
},
};
// Specify one or more ad groups.
var adGroups = new[] {
new AdGroup
{
Name = "Women's Red Shoe Sale",
StartDate = null,
EndDate = new Microsoft.BingAds.V12.CampaignManagement.Date {
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
CpcBid = new Bid {
Amount = 0.09
},
Language = "English",
// For ad groups you can use either of the InheritFromParentBiddingScheme or ManualCpcBiddingScheme objects.
// If you do not set this element, then InheritFromParentBiddingScheme is used by default.
BiddingScheme = new ManualCpcBiddingScheme {
},
Settings = new[]
{
new TargetSetting
{
Details = new []
{
new TargetSettingDetail
{
CriterionTypeGroup = CriterionTypeGroup.Audience,
TargetAndBid = true
}
}
}
},
}
};
// In this example only the second keyword should succeed. The Text of the first keyword exceeds the limit,
// and the third keyword is a duplicate of the second keyword.
var keywords = new[] {
new Keyword
{
Bid = new Bid {
Amount = 0.47
},
Param2 = "10% Off",
MatchType = MatchType.Broad,
Text = "Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes " +
"Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes " +
"Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes Brand-A Shoes",
// For keywords you can use either of the InheritFromParentBiddingScheme or ManualCpcBiddingScheme objects.
// If you do not set this element, then InheritFromParentBiddingScheme is used by default.
BiddingScheme = new InheritFromParentBiddingScheme {
},
},
new Keyword
{
Bid = new Bid {
Amount = 0.47
},
Param2 = "10% Off",
MatchType = MatchType.Phrase,
Text = "Brand-A Shoes",
// For keywords you can use either of the InheritFromParentBiddingScheme or ManualCpcBiddingScheme objects.
// If you do not set this element, then InheritFromParentBiddingScheme is used by default.
BiddingScheme = new InheritFromParentBiddingScheme {
},
},
new Keyword
{
Bid = new Bid {
Amount = 0.47
},
Param2 = "10% Off",
MatchType = MatchType.Phrase,
Text = "Brand-A Shoes",
// For keywords you can use either of the InheritFromParentBiddingScheme or ManualCpcBiddingScheme objects.
// If you do not set this element, then InheritFromParentBiddingScheme is used by default.
BiddingScheme = new InheritFromParentBiddingScheme {
},
}
};
// In this example only the first 3 ads should succeed.
// The TitlePart2 of the fourth ad is empty and not valid,
// and the fifth ad is a duplicate of the second ad.
var ads = new Ad[] {
new ExpandedTextAd
{
TitlePart1 = "Contoso",
TitlePart2 = "Fast & Easy Setup",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// With FinalUrls you can separate the tracking template, custom parameters, and
// landing page URLs.
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
// Final Mobile URLs can also be used if you want to direct the user to a different page
// for mobile devices.
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
// You could use a tracking template which would override the campaign level
// tracking template. Tracking templates defined for lower level entities
// override those set for higher level entities.
// In this example we are using the campaign level tracking template.
TrackingUrlTemplate = null,
// Set custom parameters that are specific to this ad,
// and can be used by the ad, ad group, campaign, or account level tracking template.
// In this example we are using the campaign level tracking template.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "PROMO1"
},
new CustomParameter()
{
Key = "season",
Value = "summer"
},
}
}
},
new ExpandedTextAd {
TitlePart1 = "Contoso",
TitlePart2 = "Quick & Easy Setup",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// With FinalUrls you can separate the tracking template, custom parameters, and
// landing page URLs.
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
// Final Mobile URLs can also be used if you want to direct the user to a different page
// for mobile devices.
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
// You could use a tracking template which would override the campaign level
// tracking template. Tracking templates defined for lower level entities
// override those set for higher level entities.
// In this example we are using the campaign level tracking template.
TrackingUrlTemplate = null,
// Set custom parameters that are specific to this ad,
// and can be used by the ad, ad group, campaign, or account level tracking template.
// In this example we are using the campaign level tracking template.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "PROMO2"
},
new CustomParameter()
{
Key = "season",
Value = "summer"
},
}
},
},
new ExpandedTextAd {
TitlePart1 = "Contoso",
TitlePart2 = "Fast & Simple Setup",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// With FinalUrls you can separate the tracking template, custom parameters, and
// landing page URLs.
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
// Final Mobile URLs can also be used if you want to direct the user to a different page
// for mobile devices.
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
// You could use a tracking template which would override the campaign level
// tracking template. Tracking templates defined for lower level entities
// override those set for higher level entities.
// In this example we are using the campaign level tracking template.
TrackingUrlTemplate = null,
// Set custom parameters that are specific to this ad,
// and can be used by the ad, ad group, campaign, or account level tracking template.
// In this example we are using the campaign level tracking template.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "PROMO3"
},
new CustomParameter()
{
Key = "season",
Value = "summer"
},
}
},
},
new ExpandedTextAd {
TitlePart1 = "Contoso",
TitlePart2 = "",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// With FinalUrls you can separate the tracking template, custom parameters, and
// landing page URLs.
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
// Final Mobile URLs can also be used if you want to direct the user to a different page
// for mobile devices.
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
// You could use a tracking template which would override the campaign level
// tracking template. Tracking templates defined for lower level entities
// override those set for higher level entities.
// In this example we are using the campaign level tracking template.
TrackingUrlTemplate = null,
// Set custom parameters that are specific to this ad,
// and can be used by the ad, ad group, campaign, or account level tracking template.
// In this example we are using the campaign level tracking template.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "PROMO4"
},
new CustomParameter()
{
Key = "season",
Value = "summer"
},
}
},
},
new ExpandedTextAd {
TitlePart1 = "Contoso",
TitlePart2 = "Quick & Easy Setup",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// With FinalUrls you can separate the tracking template, custom parameters, and
// landing page URLs.
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
// Final Mobile URLs can also be used if you want to direct the user to a different page
// for mobile devices.
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
// You could use a tracking template which would override the campaign level
// tracking template. Tracking templates defined for lower level entities
// override those set for higher level entities.
// In this example we are using the campaign level tracking template.
TrackingUrlTemplate = null,
// Set custom parameters that are specific to this ad,
// and can be used by the ad, ad group, campaign, or account level tracking template.
// In this example we are using the campaign level tracking template.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "PROMO5"
},
new CustomParameter()
{
Key = "season",
Value = "summer"
},
}
},
},
};
// Add the campaign, ad group, keywords, and ads
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(authorizationData.AccountId, campaigns);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
AddAdGroupsResponse addAdGroupsResponse = await CampaignManagementExampleHelper.AddAdGroupsAsync((long)campaignIds[0], adGroups, null);
long?[] adGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
AddKeywordsResponse addKeywordsResponse = await CampaignManagementExampleHelper.AddKeywordsAsync((long)adGroupIds[0], keywords, null);
long?[] keywordIds = addKeywordsResponse.KeywordIds.ToArray();
BatchError[] keywordErrors = addKeywordsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(keywordIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(keywordErrors);
AddAdsResponse addAdsResponse = await CampaignManagementExampleHelper.AddAdsAsync((long)adGroupIds[0], ads);
long?[] adIds = addAdsResponse.AdIds.ToArray();
BatchError[] adErrors = addAdsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adErrors);
// Here is a simple example that updates the campaign budget.
// If the campaign has a shared budget you cannot update the Campaign budget amount,
// and you must instead update the amount in the Budget object. If you try to update
// the budget amount of a campaign that has a shared budget, the service will return
// the CampaignServiceCannotUpdateSharedBudget error code.
var getCampaigns = (await CampaignManagementExampleHelper.GetCampaignsByAccountIdAsync(
authorizationData.AccountId,
AllCampaignTypes
)).Campaigns;
var updateCampaigns = new List <Campaign>();
var updateBudgets = new List <Budget>();
var getCampaignIds = new List <long>();
var getBudgetIds = new List <long>();
// Increase existing budgets by 20%
foreach (var campaign in getCampaigns)
{
// If the campaign has a shared budget, let's add the budget ID to the list we will update later.
if (campaign != null && campaign.BudgetId > 0)
{
getBudgetIds.Add((long)campaign.BudgetId);
}
// If the campaign has its own budget, let's add it to the list of campaigns to update later.
else if (campaign != null)
{
// Increase budget by 20 %
var updateCampaign = new Campaign
{
DailyBudget = campaign.DailyBudget * 1.2,
Id = campaign.Id,
};
updateCampaigns.Add(updateCampaign);
}
}
// Update shared budgets in Budget objects.
if (getBudgetIds.Count > 0)
{
// The UpdateBudgets operation only accepts 100 Budget objects per call.
// To simply the example we will update the first 100.
getBudgetIds = getBudgetIds.Distinct().Take(100).ToList();
var getBudgets = (await CampaignManagementExampleHelper.GetBudgetsByIdsAsync(getBudgetIds)).Budgets;
OutputStatusMessage("List of shared budgets BEFORE update:\n");
foreach (var budget in getBudgets)
{
OutputStatusMessage("Budget:");
CampaignManagementExampleHelper.OutputBudget(budget);
}
OutputStatusMessage("List of campaigns that share each budget:\n");
var getCampaignIdCollection = (await CampaignManagementExampleHelper.GetCampaignIdsByBudgetIdsAsync(getBudgetIds)).CampaignIdCollection;
for (int index = 0; index < getCampaignIdCollection.Count; index++)
{
OutputStatusMessage(string.Format("BudgetId: {0}", getBudgetIds[index]));
OutputStatusMessage("Campaign Ids:");
if (getCampaignIdCollection[index] != null)
{
foreach (var id in getCampaignIdCollection[index].Ids)
{
OutputStatusMessage(string.Format("\t{0}", id));
}
}
}
foreach (var budget in getBudgets)
{
if (budget != null)
{
// Increase budget by 20 %
budget.Amount *= 1.2m;
updateBudgets.Add(budget);
}
}
await CampaignManagementExampleHelper.UpdateBudgetsAsync(updateBudgets);
getBudgets = (await CampaignManagementExampleHelper.GetBudgetsByIdsAsync(getBudgetIds)).Budgets;
OutputStatusMessage("List of shared budgets AFTER update:\n");
foreach (var budget in getBudgets)
{
OutputStatusMessage("Budget:");
CampaignManagementExampleHelper.OutputBudget(budget);
}
}
// Update unshared budgets in Campaign objects.
if (updateCampaigns.Count > 0)
{
// The UpdateCampaigns operation only accepts 100 Campaign objects per call.
// To simply the example we will update the first 100.
updateCampaigns = updateCampaigns.Take(100).ToList();
foreach (var campaign in updateCampaigns)
{
getCampaignIds.Add((long)campaign.Id);
}
await CampaignManagementExampleHelper.UpdateCampaignsAsync(authorizationData.AccountId, updateCampaigns);
getCampaigns = (await CampaignManagementExampleHelper.GetCampaignsByIdsAsync(
authorizationData.AccountId,
getCampaignIds,
CampaignType.Search | CampaignType.Shopping | CampaignType.DynamicSearchAds
)).Campaigns;
OutputStatusMessage("List of campaigns with unshared budget AFTER budget update:\n");
foreach (var campaign in getCampaigns)
{
OutputStatusMessage("Campaign:");
CampaignManagementExampleHelper.OutputCampaign(campaign);
}
}
// Update the Text for the 3 successfully created ads, and update some UrlCustomParameters.
var updateAds = new Ad[] {
new ExpandedTextAd {
Id = adIds[0],
Text = "Huge Savings on All Red Shoes.",
// Set the UrlCustomParameters element to null or empty to retain any
// existing custom parameters.
UrlCustomParameters = null,
},
new ExpandedTextAd {
Id = adIds[1],
Text = "Huge Savings on All Red Shoes.",
// To remove all custom parameters, set the Parameters element of the
// CustomParameters object to null or empty.
UrlCustomParameters = new CustomParameters {
Parameters = null,
},
},
new ExpandedTextAd {
Id = adIds[2],
Text = "Huge Savings on All Red Shoes.",
// To remove a subset of custom parameters, specify the custom parameters that
// you want to keep in the Parameters element of the CustomParameters object.
UrlCustomParameters = new CustomParameters {
Parameters = new[] {
new CustomParameter()
{
Key = "promoCode",
Value = "updatedpromo"
},
}
}
},
};
// As an exercise you can step through using the debugger and view the results.
var getAdsByAdGroupIdResponse = await CampaignManagementExampleHelper.GetAdsByAdGroupIdAsync(
(long)adGroupIds[0],
AllAdTypes
);
var updateAdsResponse = await CampaignManagementExampleHelper.UpdateAdsAsync((long)adGroupIds[0], updateAds);
getAdsByAdGroupIdResponse = await CampaignManagementExampleHelper.GetAdsByAdGroupIdAsync(
(long)adGroupIds[0],
AllAdTypes
);
// Here is a simple example that updates the keyword bid to use the ad group bid.
var updateKeyword = new Keyword
{
// Set Bid.Amount null (new empty Bid) to use the ad group bid.
// If the Bid property is null, your keyword bid will not be updated.
Bid = new Bid(),
Id = keywordIds[1],
};
// As an exercise you can step through using the debugger and view the results.
var getKeywordsByAdGroupIdResponse =
await CampaignManagementExampleHelper.GetKeywordsByAdGroupIdAsync((long)adGroupIds[0]);
var updateKeywordsResponse =
await CampaignManagementExampleHelper.UpdateKeywordsAsync((long)adGroupIds[0], new[] { updateKeyword }, null);
getKeywordsByAdGroupIdResponse =
await CampaignManagementExampleHelper.GetKeywordsByAdGroupIdAsync((long)adGroupIds[0]);
// Delete the campaign, ad group, keyword, and ad that were previously added.
// You should remove this line if you want to view the added entities in the
// Bing Ads web application or another tool.
await CampaignManagementExampleHelper.DeleteCampaignsAsync(authorizationData.AccountId, new[] { (long)campaignIds[0] });
OutputStatusMessage(string.Format("\nDeleted Campaign Id {0}\n", campaignIds[0]));
// This sample will attempt to delete the budget that was created above.
if (budgetIds.Count > 0)
{
await CampaignManagementExampleHelper.DeleteBudgetsAsync(new[] { (long)budgetIds[0] });
OutputStatusMessage(string.Format("\nDeleted Budget Id {0}\n", budgetIds[0]));
}
}
// 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 Campaign Management service exceptions
catch (FaultException <Microsoft.BingAds.V12.CampaignManagement.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <Microsoft.BingAds.V12.CampaignManagement.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 (FaultException <Microsoft.BingAds.V12.CampaignManagement.EditorialApiFaultDetail> 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 (Exception ex)
{
OutputStatusMessage(ex.Message);
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
ApiEnvironment environment = ((OAuthDesktopMobileAuthCodeGrant)authorizationData.Authentication).Environment;
CampaignManagementExampleHelper CampaignManagementExampleHelper = new CampaignManagementExampleHelper(
OutputStatusMessageDefault: this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient <ICampaignManagementService>(
authorizationData: authorizationData,
environment: environment);
// Add a search campaign.
var campaigns = new[] {
new Campaign
{
BudgetType = BudgetLimitType.DailyBudgetStandard,
DailyBudget = 50,
CampaignType = CampaignType.Search,
Languages = new string[] { "All" },
Name = "Women's Shoes " + DateTime.UtcNow,
TimeZone = "PacificTimeUSCanadaTijuana",
},
};
OutputStatusMessage("-----\nAddCampaigns:");
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(
accountId : authorizationData.AccountId,
campaigns : campaigns);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
OutputStatusMessage("CampaignIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
// Add an ad group within the campaign.
var adGroups = new[] {
new AdGroup
{
Name = "Women's Red Shoe Sale",
StartDate = null,
EndDate = new Date {
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
CpcBid = new Bid {
Amount = 0.09
},
}
};
OutputStatusMessage("-----\nAddAdGroups:");
AddAdGroupsResponse addAdGroupsResponse = await CampaignManagementExampleHelper.AddAdGroupsAsync(
campaignId : (long)campaignIds[0],
adGroups : adGroups,
returnInheritedBidStrategyTypes : false);
long?[] adGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
OutputStatusMessage("AdGroupIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
// Add keywords and ads within the ad group.
var keywords = new[] {
new Keyword
{
Bid = new Bid {
Amount = 0.47
},
Param2 = "10% Off",
MatchType = MatchType.Phrase,
Text = "Brand-A Shoes",
},
};
OutputStatusMessage("-----\nAddKeywords:");
AddKeywordsResponse addKeywordsResponse = await CampaignManagementExampleHelper.AddKeywordsAsync(
adGroupId : (long)adGroupIds[0],
keywords : keywords,
returnInheritedBidStrategyTypes : false);
long?[] keywordIds = addKeywordsResponse.KeywordIds.ToArray();
BatchError[] keywordErrors = addKeywordsResponse.PartialErrors.ToArray();
OutputStatusMessage("KeywordIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(keywordIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(keywordErrors);
var ads = new Ad[] {
new ExpandedTextAd
{
TitlePart1 = "Contoso",
TitlePart2 = "Quick & Easy Setup",
TitlePart3 = "Seemless Integration",
Text = "Find New Customers & Increase Sales!",
TextPart2 = "Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
},
};
OutputStatusMessage("-----\nAddAds:");
AddAdsResponse addAdsResponse = await CampaignManagementExampleHelper.AddAdsAsync(
adGroupId : (long)adGroupIds[0],
ads : ads);
long?[] adIds = addAdsResponse.AdIds.ToArray();
BatchError[] adErrors = addAdsResponse.PartialErrors.ToArray();
OutputStatusMessage("AdIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(adIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(adErrors);
// Delete the campaign and everything it contains e.g., ad groups and ads.
OutputStatusMessage("-----\nDeleteCampaigns:");
await CampaignManagementExampleHelper.DeleteCampaignsAsync(
accountId : authorizationData.AccountId,
campaignIds : new[] { (long)campaignIds[0] });
OutputStatusMessage(string.Format("Deleted Campaign Id {0}", campaignIds[0]));
}
// 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 Campaign Management service exceptions
catch (FaultException <AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <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 (FaultException <EditorialApiFaultDetail> 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 (Exception ex)
{
OutputStatusMessage(ex.Message);
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
CampaignManagementExampleHelper CampaignManagementExampleHelper = new CampaignManagementExampleHelper(this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient <ICampaignManagementService>(authorizationData);
// Specify one or more campaigns.
var campaigns = new[] {
new Campaign
{
Name = "Women's Shoes " + DateTime.UtcNow,
Description = "Red shoes line.",
DailyBudget = 50,
BudgetType = BudgetLimitType.DailyBudgetStandard,
TimeZone = "PacificTimeUSCanadaTijuana",
},
};
var adGroups = new[] {
new AdGroup
{
Name = "Women's Red Shoe Sale",
AdDistribution = AdDistribution.Search,
StartDate = null,
EndDate = new Microsoft.BingAds.V11.CampaignManagement.Date {
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
SearchBid = new Bid {
Amount = 0.09
},
Language = "English",
}
};
var keywords = new[]
{
new Keyword
{
Bid = new Bid {
Amount = 0.47
},
Param2 = "10% Off",
MatchType = MatchType.Phrase,
Text = "Brand-A Shoes",
},
};
var ads = new Ad[] {
new ExpandedTextAd
{
TitlePart1 = "Contoso",
TitlePart2 = "Fast & Easy Setup",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
},
};
var random = new Random();
var labels = new List <Label>();
for (var labelIndex = 0; labelIndex < 50; labelIndex++)
{
var color = string.Format("#{0:X6}", random.Next(0x100000));
labels.Add(new Label
{
ColorCode = color,
Description = "Label Description",
Name = "Label Name " + color + " " + DateTime.UtcNow
});
}
AddLabelsResponse addLabelsResponse = await CampaignManagementExampleHelper.AddLabelsAsync(labels);
long?[] nullableLabelIds = addLabelsResponse.LabelIds.ToArray();
BatchError[] labelErrors = addLabelsResponse.PartialErrors.ToArray();
OutputStatusMessage("New Label Ids:");
CampaignManagementExampleHelper.OutputArrayOfLong(nullableLabelIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(labelErrors);
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(authorizationData.AccountId, campaigns);
long?[] nullableCampaignIds = addCampaignsResponse.CampaignIds.ToArray();
BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
OutputStatusMessage("New Campaign Ids:");
CampaignManagementExampleHelper.OutputArrayOfLong(nullableCampaignIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
AddAdGroupsResponse addAdGroupsResponse = await CampaignManagementExampleHelper.AddAdGroupsAsync((long)nullableCampaignIds[0], adGroups);
long?[] nullableAdGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
OutputStatusMessage("New Ad Group Ids:");
CampaignManagementExampleHelper.OutputArrayOfLong(nullableAdGroupIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
AddKeywordsResponse addKeywordsResponse = await CampaignManagementExampleHelper.AddKeywordsAsync((long)nullableAdGroupIds[0], keywords);
long?[] nullableKeywordIds = addKeywordsResponse.KeywordIds.ToArray();
BatchError[] keywordErrors = addKeywordsResponse.PartialErrors.ToArray();
OutputStatusMessage("New Keyword Ids:");
CampaignManagementExampleHelper.OutputArrayOfLong(nullableKeywordIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(keywordErrors);
AddAdsResponse addAdsResponse = await CampaignManagementExampleHelper.AddAdsAsync((long)nullableAdGroupIds[0], ads);
long?[] nullableAdIds = addAdsResponse.AdIds.ToArray();
BatchError[] adErrors = addAdsResponse.PartialErrors.ToArray();
OutputStatusMessage("New Ad Ids:");
CampaignManagementExampleHelper.OutputArrayOfLong(nullableAdIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adErrors);
var labelIds = GetNonNullableIds(nullableLabelIds);
OutputStatusMessage("\nGet all the labels that we added above...");
var getLabelsByIdsResponse = await CampaignManagementExampleHelper.GetLabelsByIdsAsync(
labelIds,
new Paging
{
Index = 0,
Size = MaxGetLabelsByIds
}
);
CampaignManagementExampleHelper.OutputArrayOfLabel(getLabelsByIdsResponse.Labels);
OutputStatusMessage("\nUpdate the label color and then retrieve the labels again to confirm the changes....");
var updateLabels = new List <Label>();
foreach (var label in getLabelsByIdsResponse.Labels)
{
label.ColorCode = string.Format("#{0:X6}", random.Next(0x100000));
updateLabels.Add(label);
}
var updateLabelsResponse = await CampaignManagementExampleHelper.UpdateLabelsAsync(updateLabels);
getLabelsByIdsResponse = await CampaignManagementExampleHelper.GetLabelsByIdsAsync(
labelIds,
new Paging
{
Index = 0,
Size = MaxGetLabelsByIds
}
);
CampaignManagementExampleHelper.OutputArrayOfLabel(getLabelsByIdsResponse.Labels);
var campaignLabelAssociations = CreateExampleLabelAssociationsByEntityId((long)nullableCampaignIds[0], labelIds);
OutputStatusMessage("\nAssociating all of the labels with a campaign...");
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(campaignLabelAssociations);
var setLabelAssociationsResponse = await CampaignManagementExampleHelper.SetLabelAssociationsAsync(EntityType.Campaign, campaignLabelAssociations);
var adGroupLabelAssociations = CreateExampleLabelAssociationsByEntityId((long)nullableAdGroupIds[0], labelIds);
OutputStatusMessage("\nAssociating all of the labels with an ad group...");
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(adGroupLabelAssociations);
setLabelAssociationsResponse = await CampaignManagementExampleHelper.SetLabelAssociationsAsync(EntityType.AdGroup, adGroupLabelAssociations);
var keywordLabelAssociations = CreateExampleLabelAssociationsByEntityId((long)nullableKeywordIds[0], labelIds);
OutputStatusMessage("\nAssociating all of the labels with a keyword...");
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(keywordLabelAssociations);
setLabelAssociationsResponse = await CampaignManagementExampleHelper.SetLabelAssociationsAsync(EntityType.Keyword, keywordLabelAssociations);
var adLabelAssociations = CreateExampleLabelAssociationsByEntityId((long)nullableAdIds[0], labelIds);
OutputStatusMessage("\nAssociating all of the labels with an ad...");
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(adLabelAssociations);
setLabelAssociationsResponse = await CampaignManagementExampleHelper.SetLabelAssociationsAsync(EntityType.Ad, adLabelAssociations);
OutputStatusMessage("\nUse paging to get all campaign label associations...");
var getLabelAssociationsByLabelIds = await GetLabelAssociationsByLabelIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Campaign,
labelIds);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByLabelIds);
OutputStatusMessage("\nUse paging to get all ad group label associations...");
getLabelAssociationsByLabelIds = await GetLabelAssociationsByLabelIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.AdGroup,
labelIds);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByLabelIds);
OutputStatusMessage("\nUse paging to get all keyword label associations...");
getLabelAssociationsByLabelIds = await GetLabelAssociationsByLabelIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Keyword,
labelIds);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByLabelIds);
OutputStatusMessage("\nUse paging to get all ad label associations...");
getLabelAssociationsByLabelIds = await GetLabelAssociationsByLabelIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Ad,
labelIds);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByLabelIds);
OutputStatusMessage("\nGet all label associations for all specified campaigns...");
var getLabelAssociationsByEntityIds = await GetLabelAssociationsByEntityIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Campaign,
GetNonNullableIds(nullableCampaignIds)
);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByEntityIds);
OutputStatusMessage("\nGet all label associations for all specified ad groups...");
getLabelAssociationsByEntityIds = await GetLabelAssociationsByEntityIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.AdGroup,
GetNonNullableIds(nullableAdGroupIds)
);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByEntityIds);
OutputStatusMessage("\nGet all label associations for all specified keywords...");
getLabelAssociationsByEntityIds = await GetLabelAssociationsByEntityIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Keyword,
GetNonNullableIds(nullableKeywordIds)
);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByEntityIds);
OutputStatusMessage("\nGet all label associations for all specified ads...");
getLabelAssociationsByEntityIds = await GetLabelAssociationsByEntityIdsHelperAsync(
CampaignManagementExampleHelper,
EntityType.Ad,
GetNonNullableIds(nullableAdIds)
);
CampaignManagementExampleHelper.OutputArrayOfLabelAssociation(getLabelAssociationsByEntityIds);
OutputStatusMessage("\nDelete all label associations that we set above....");
// This is not necessary if you are deleting the corresponding campaign(s), as the
// contained ad groups, keywords, ads, and associations would also be deleted.
var deleteLabelAssociationsResponse = await CampaignManagementExampleHelper.DeleteLabelAssociationsAsync(EntityType.Campaign, campaignLabelAssociations);
deleteLabelAssociationsResponse = await CampaignManagementExampleHelper.DeleteLabelAssociationsAsync(EntityType.AdGroup, adGroupLabelAssociations);
deleteLabelAssociationsResponse = await CampaignManagementExampleHelper.DeleteLabelAssociationsAsync(EntityType.Keyword, keywordLabelAssociations);
deleteLabelAssociationsResponse = await CampaignManagementExampleHelper.DeleteLabelAssociationsAsync(EntityType.Ad, adLabelAssociations);
OutputStatusMessage("\nDelete all labels that we added above....");
// Deleting the campaign(s) removes the corresponding label associations but not remove the labels.
var deleteLabelsResponse = await CampaignManagementExampleHelper.DeleteLabelsAsync(labelIds);
OutputStatusMessage("\nDelete the campaign, ad group, keyword, and ad that were added above....");
await CampaignManagementExampleHelper.DeleteCampaignsAsync(authorizationData.AccountId, new[] { (long)nullableCampaignIds[0] });
}
// 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 Campaign Management service exceptions
catch (FaultException <Microsoft.BingAds.V11.CampaignManagement.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <Microsoft.BingAds.V11.CampaignManagement.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 (FaultException <Microsoft.BingAds.V11.CampaignManagement.EditorialApiFaultDetail> 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 (Exception ex)
{
OutputStatusMessage(ex.Message);
}
}
