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 an image to your media library.
// The image asset is needed later to create the responsive ad.
var landscapeImageMedia = GetImageMedia(
"Image191x100",
MediaFilePath + ResponsiveAdMediaFileName,
System.Drawing.Imaging.ImageFormat.Png);
var media = new Media[]
{
landscapeImageMedia,
};
OutputStatusMessage("-----\nAddMedia:");
AddMediaResponse addMediaResponse = await CampaignManagementExampleHelper.AddMediaAsync(
accountId : authorizationData.AccountId,
media : media);
long[] mediaIds = addMediaResponse.MediaIds.ToArray();
OutputStatusMessage("MediaIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(mediaIds);
// Create an Audience campaign with one ad group and a responsive ad.
var campaigns = new[] {
new Campaign
{
BudgetType = BudgetLimitType.DailyBudgetStandard,
// CampaignType must be set for Audience campaigns
CampaignType = CampaignType.Audience,
DailyBudget = 50,
Description = "Red shoes line.",
// Languages must be set for Audience campaigns
Languages = new string[] { "All" },
Name = "Women's Shoes " + DateTime.UtcNow,
TimeZone = "PacificTimeUSCanadaTijuana",
},
};
OutputStatusMessage("-----\nAddCampaigns:");
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(
accountId : authorizationData.AccountId,
campaigns : campaigns,
includeDynamicSearchAdsSource : false);
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
},
// Network cannot be set for ad groups in Audience campaigns
Network = null,
}
};
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 a responsive ad within the ad group.
var ads = new Ad[] {
new ResponsiveAd
{
BusinessName = "Contoso",
CallToAction = CallToAction.AddToCart,
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
Headline = "Fast & Easy Setup",
Images = new []
{
// You are only required to provide a landscape image asset.
// Optionally you can include additional asset links, i.e., one image asset for each supported sub type.
// For any image asset sub types that you do not explicitly set,
// the service will automatically create image asset links by cropping the LandscapeImageMedia.
new AssetLink
{
Asset = new ImageAsset
{
CropHeight = null,
CropWidth = null,
CropX = null,
CropY = null,
Id = mediaIds[0],
Name = "My LandscapeImageMedia",
SubType = "LandscapeImageMedia",
},
},
},
LongHeadline = "Find New Customers & Increase Sales!",
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
},
};
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 account's media.
OutputStatusMessage("-----\nDeleteMedia:");
await CampaignManagementExampleHelper.DeleteMediaAsync(
accountId : authorizationData.AccountId,
mediaIds : mediaIds);
foreach (var id in mediaIds)
{
OutputStatusMessage(string.Format("Deleted Media Id {0}", id));
}
// 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 <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
{
ApiEnvironment environment = ((OAuthDesktopMobileAuthCodeGrant)authorizationData.Authentication).Environment;
CampaignManagementExampleHelper CampaignManagementExampleHelper =
new CampaignManagementExampleHelper(this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService =
new ServiceClient <ICampaignManagementService>(authorizationData, environment);
// Get a list of all Bing Merchant Center stores associated with your CustomerId
IList <BMCStore> stores = (await CampaignManagementExampleHelper.GetBMCStoresByCustomerIdAsync())?.BMCStores;
if (stores == null)
{
OutputStatusMessage(
string.Format("You do not have any BMC stores registered for CustomerId {0}.\n", authorizationData.CustomerId)
);
return;
}
#region ManageCampaign
/* Add a new Bing Shopping campaign that will be associated with a ProductScope criterion.
* - Set the CampaignType element of the Campaign to Shopping.
* - Create a ShoppingSetting instance and set its Priority (0, 1, or 2), SalesCountryCode, and StoreId elements.
* Add this shopping setting to the Settings list of the Campaign.
*/
var campaigns = new[] {
new Campaign
{
CampaignType = CampaignType.Shopping,
Settings = new[] {
new ShoppingSetting()
{
Priority = 0,
SalesCountryCode = "US",
StoreId = (int)stores[0].Id
}
},
Name = "Bing Shopping Campaign " + DateTime.UtcNow,
Description = "Bing Shopping Campaign Example.",
// 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 = null,
DailyBudget = 50,
BudgetType = BudgetLimitType.DailyBudgetStandard,
TimeZone = "PacificTimeUSCanadaTijuana",
// Used with CustomParameters defined in lower level entities such as ad group criterion.
TrackingUrlTemplate =
"http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}"
}
};
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(authorizationData.AccountId, campaigns);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
long campaignId = (long)campaignIds[0];
/* Optionally, you can create a ProductScope criterion that will be associated with your Bing Shopping campaign.
* Use the product scope criterion to include a subset of your product catalog, for example a specific brand,
* category, or product type. A campaign can only be associated with one ProductScope, which contains a list
* of up to 7 ProductCondition. You'll also be able to specify more specific product conditions for each ad group.
*/
var campaignCriterions = new BiddableCampaignCriterion[] {
new BiddableCampaignCriterion()
{
CampaignId = campaignId,
CriterionBid = null, // Not applicable for product scope
Criterion = new ProductScope()
{
Conditions = new ProductCondition[] {
new ProductCondition {
Operand = "Condition",
Attribute = "New"
},
new ProductCondition {
Operand = "CustomLabel0",
Attribute = "MerchantDefinedCustomLabel"
},
}
},
}
};
var addCampaignCriterionsResponse = await(CampaignManagementExampleHelper.AddCampaignCriterionsAsync(
campaignCriterions,
CampaignCriterionType.ProductScope)
);
#endregion ManageCampaign
#region ManageAdGroup
// Create the ad group that will have the product partitions.
var adGroups = new[] {
new AdGroup
{
Name = "Product Categories",
StartDate = null,
EndDate = new Microsoft.BingAds.V12.CampaignManagement.Date {
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
Language = "English",
CpcBid = new Bid {
Amount = 0.090
}
}
};
AddAdGroupsResponse addAdGroupsResponse = await CampaignManagementExampleHelper.AddAdGroupsAsync((long)campaignId, adGroups, null);
long?[] adGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
long adGroupId = (long)adGroupIds[0];
#region BidAllProducts
var helper = new PartitionActionHelper(adGroupId);
var root = helper.AddUnit(
null,
new ProductCondition {
Operand = "All", Attribute = null
},
0.35,
false
);
OutputStatusMessage("Applying only the root as a Unit with a bid . . . \n");
var applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(helper.PartitionActions);
var adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
adGroupId,
AdGroupCriterionType.ProductPartition
);
OutputStatusMessage("The ad group's product partition only has a tree root node: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
/*
* Let's update the bid of the root Unit we just added.
*/
BiddableAdGroupCriterion updatedRoot = new BiddableAdGroupCriterion
{
Id = applyProductPartitionActionsResponse.AdGroupCriterionIds[0],
CriterionBid = new FixedBid
{
Amount = 0.45
}
};
helper = new PartitionActionHelper(adGroupId);
helper.UpdatePartition(updatedRoot);
OutputStatusMessage("Updating the bid for the tree root node . . . \n");
await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(helper.PartitionActions);
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
adGroupId,
AdGroupCriterionType.ProductPartition
);
OutputStatusMessage("Updated the bid for the tree root node: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
#endregion BidAllProducts
#region InitializeTree
/*
* Now we will overwrite any existing tree root, and build a product partition group tree structure in multiple steps.
* You could build the entire tree in a single call since there are less than 5,000 nodes; however,
* we will build it in steps to demonstrate how to use the results from ApplyProductPartitionActions to update the tree.
*
* For a list of validation rules, see the Product Ads technical guide:
* https://docs.microsoft.com/en-us/bingads/guides/product-ads
*/
helper = new PartitionActionHelper(adGroupId);
/*
* Check whether a root node exists already.
*/
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
adGroupId,
AdGroupCriterionType.ProductPartition
);
var existingRoot = GetRootNode(adGroupCriterions?.AdGroupCriterions);
if (existingRoot != null)
{
helper.DeletePartition(existingRoot);
}
root = helper.AddSubdivision(
null,
new ProductCondition {
Operand = "All", Attribute = null
}
);
/*
* The direct children of any node must have the same Operand.
* For this example we will use CategoryL1 nodes as children of the root.
* For a list of valid CategoryL1 through CategoryL5 values, see the Bing Category Taxonomy:
* http://go.microsoft.com/fwlink?LinkId=507666
*/
var animalsSubdivision = helper.AddSubdivision(
root,
new ProductCondition {
Operand = "CategoryL1", Attribute = "Animals & Pet Supplies"
}
);
/*
* If you use a CategoryL2 node, it must be a descendant (child or later) of a CategoryL1 node.
* In other words you cannot have a CategoryL2 node as parent of a CategoryL1 node.
* For this example we will a CategoryL2 node as child of the CategoryL1 Animals & Pet Supplies node.
*/
var petSuppliesSubdivision = helper.AddSubdivision(
animalsSubdivision,
new ProductCondition {
Operand = "CategoryL2", Attribute = "Pet Supplies"
}
);
var brandA = helper.AddUnit(
petSuppliesSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = "Brand A"
},
0.35,
false
);
/*
* If you won't bid on Brand B, set the helper method's bidAmount to '0' and isNegative to true.
* The helper method will create a NegativeAdGroupCriterion and apply the condition.
*/
var brandB = helper.AddUnit(
petSuppliesSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = "Brand B"
},
0,
true
);
var otherBrands = helper.AddUnit(
petSuppliesSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = null
},
0.35,
false
);
var otherPetSupplies = helper.AddUnit(
animalsSubdivision,
new ProductCondition {
Operand = "CategoryL2", Attribute = null
},
0.35,
false
);
var electronics = helper.AddUnit(
root,
new ProductCondition {
Operand = "CategoryL1", Attribute = "Electronics"
},
0.35,
false
);
var otherCategoryL1 = helper.AddUnit(
root,
new ProductCondition {
Operand = "CategoryL1", Attribute = null
},
0.35,
false
);
OutputStatusMessage("Applying product partitions to the ad group . . . \n");
applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(helper.PartitionActions);
// To retrieve product partitions after they have been applied, call GetAdGroupCriterionsByIds.
// The product partition with ParentCriterionId set to null is the root node.
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
adGroupId,
AdGroupCriterionType.ProductPartition
);
/*
* The product partition group tree now has 9 nodes.
*
* All other (Root Node)
|
+-- Animals & Pet Supplies (CategoryL1)
| |
| +-- Pet Supplies (CategoryL2)
| | |
| | +-- Brand A
| | |
| | +-- Brand B
| | |
| | +-- All other (Brand)
| |
| +-- All other (CategoryL2)
|
+-- Electronics (CategoryL1)
|
+-- All other (CategoryL1)
|
*/
OutputStatusMessage("The product partition group tree now has 9 nodes: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
#endregion InitializeTree
#region UpdateTree
/*
* Let's replace the Electronics (CategoryL1) node created above with an Electronics (CategoryL1) node that
* has children i.e. Brand C (Brand), Brand D (Brand), and All other (Brand) as follows:
*
* Electronics (CategoryL1)
|
+-- Brand C (Brand)
|
+-- Brand D (Brand)
|
+-- All other (Brand)
|
*/
helper = new PartitionActionHelper(adGroupId);
/*
* To replace a node we must know its Id and its ParentCriterionId. In this case the parent of the node
* we are replacing is All other (Root Node), and was created at Index 1 of the previous ApplyProductPartitionActions call.
* The node that we are replacing is Electronics (CategoryL1), and was created at Index 8.
*/
var rootId = applyProductPartitionActionsResponse.AdGroupCriterionIds[1];
electronics.Id = applyProductPartitionActionsResponse.AdGroupCriterionIds[8];
helper.DeletePartition(electronics);
var parent = new BiddableAdGroupCriterion()
{
Id = rootId
};
var electronicsSubdivision = helper.AddSubdivision(
parent,
new ProductCondition {
Operand = "CategoryL1", Attribute = "Electronics"
}
);
var brandC = helper.AddUnit(
electronicsSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = "Brand C"
},
0.35,
false
);
var brandD = helper.AddUnit(
electronicsSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = "Brand D"
},
0.35,
false
);
var otherElectronicsBrands = helper.AddUnit(
electronicsSubdivision,
new ProductCondition {
Operand = "Brand", Attribute = null
},
0.35,
false
);
OutputStatusMessage(
"Updating the product partition group to refine Electronics (CategoryL1) with 3 child nodes . . . \n"
);
applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(helper.PartitionActions);
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
adGroupId,
AdGroupCriterionType.ProductPartition
);
/*
* The product partition group tree now has 12 nodes, including the children of Electronics (CategoryL1):
*
* All other (Root Node)
|
+-- Animals & Pet Supplies (CategoryL1)
| |
| +-- Pet Supplies (CategoryL2)
| | |
| | +-- Brand A
| | |
| | +-- Brand B
| | |
| | +-- All other (Brand)
| |
| +-- All other (CategoryL2)
|
+-- Electronics (CategoryL1)
| |
| +-- Brand C (Brand)
| |
| +-- Brand D (Brand)
| |
| +-- All other (Brand)
|
+-- All other (CategoryL1)
|
*/
OutputStatusMessage(
"The product partition group tree now has 12 nodes, including the children of Electronics (CategoryL1): \n"
);
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
#endregion UpdateTree
#endregion ManageAdGroup
#region ManageAds
/*
* Create a product ad. You must add at least one product ad to the ad group.
* The product ad identifier can be used for reporting analytics.
* Use Merchant Promotions if you want tags to appear at the bottom of your product ad
* as "special offer" links, helping to increase customer engagement. For details
* on Merchant Promotions see https://help.bingads.microsoft.com/#apex/3/en/56805/0.
*/
var ads = new Ad[] {
new ProductAd {
}
};
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);
#endregion ManageAds
#region CleanUp
/* Delete the campaign, ad group, criterion, and ad that were previously added.
* You should remove this region if you want to view the added entities in the
* Bing Ads web application or another tool.
*/
await CampaignManagementExampleHelper.DeleteCampaignsAsync(authorizationData.AccountId, new[] { campaignId });
OutputStatusMessage(string.Format("Deleted Campaign Id {0}\n", campaignId));
#endregion CleanUp
}
// 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);
// Get a list of all Bing Merchant Center stores associated with your CustomerId.
OutputStatusMessage("-----\nGetBMCStoresByCustomerId:");
IList <BMCStore> stores = (await CampaignManagementExampleHelper.GetBMCStoresByCustomerIdAsync())?.BMCStores;
if (stores == null || stores.Count <= 0)
{
OutputStatusMessage(
string.Format("You do not have any BMC stores registered for CustomerId {0}.", authorizationData.CustomerId)
);
return;
}
OutputStatusMessage("BMCStores:");
CampaignManagementExampleHelper.OutputArrayOfBMCStore(stores);
// Create a Shopping campaign with product conditions.
var campaigns = new[] {
new Campaign
{
CampaignType = CampaignType.Shopping,
Languages = new string[] { "All" },
Name = "Women's Shoes " + DateTime.UtcNow,
Description = "Red shoes line.",
DailyBudget = 50,
BudgetType = BudgetLimitType.DailyBudgetStandard,
Settings = new[] {
new ShoppingSetting()
{
Priority = 0,
SalesCountryCode = "US",
StoreId = (int)stores[0].Id
}
},
TimeZone = "PacificTimeUSCanadaTijuana",
}
};
OutputStatusMessage("-----\nAddCampaigns:");
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(
accountId : authorizationData.AccountId,
campaigns : campaigns,
includeDynamicSearchAdsSource : false);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
OutputStatusMessage("CampaignIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
long campaignId = (long)campaignIds[0];
// Optionally, you can create a ProductScope criterion that will be associated with your Bing Shopping campaign.
// You'll also be able to add more specific product conditions for each ad group.
var campaignCriterions = new BiddableCampaignCriterion[] {
new BiddableCampaignCriterion()
{
CampaignId = campaignId,
CriterionBid = null, // Not applicable for product scope
Criterion = new ProductScope()
{
Conditions = new ProductCondition[] {
new ProductCondition {
Operand = "Condition",
Attribute = "New"
},
new ProductCondition {
Operand = "CustomLabel0",
Attribute = "MerchantDefinedCustomLabel"
},
}
},
Status = CampaignCriterionStatus.Active
}
};
OutputStatusMessage("-----\nAddCampaignCriterions:");
var addCampaignCriterionsResponse = await CampaignManagementExampleHelper.AddCampaignCriterionsAsync(
campaignCriterions : campaignCriterions,
criterionType : CampaignCriterionType.ProductScope);
long?[] campaignCriterionIds = addCampaignCriterionsResponse.CampaignCriterionIds.ToArray();
OutputStatusMessage("CampaignCriterionIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignCriterionIds);
BatchErrorCollection[] campaignCriterionErrors =
addCampaignCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("NestedPartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(campaignCriterionErrors);
// Create the ad group that will have the product partitions.
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);
long adGroupId = (long)adGroupIds[0];
// Bid all products
var helper = new PartitionActionHelper(adGroupId);
var root = helper.AddUnit(
parent: null,
condition: new ProductCondition {
Operand = "All", Attribute = null
},
bidAmount: 0.35,
isNegative: false);
OutputStatusMessage("-----\nApplyProductPartitionActions:");
OutputStatusMessage("Applying only the root as a Unit with a bid...");
var applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(
criterionActions : helper.PartitionActions);
OutputStatusMessage("-----\nGetAdGroupCriterionsByIds:");
var adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
adGroupCriterionIds : null,
adGroupId : adGroupId,
criterionType : AdGroupCriterionType.ProductPartition,
returnAdditionalFields : AdGroupCriterionAdditionalField.FinalUrlSuffix);
OutputStatusMessage("The ad group's product partition only has a tree root node: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
// Let's update the bid of the root Unit we just added.
BiddableAdGroupCriterion updatedRoot = new BiddableAdGroupCriterion
{
Id = applyProductPartitionActionsResponse.AdGroupCriterionIds[0],
CriterionBid = new FixedBid
{
Amount = 0.45
}
};
helper = new PartitionActionHelper(adGroupId);
helper.UpdatePartition(updatedRoot);
OutputStatusMessage("-----\nApplyProductPartitionActions:");
OutputStatusMessage("Updating the bid for the tree root node...");
await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(
criterionActions : helper.PartitionActions);
OutputStatusMessage("-----\nGetAdGroupCriterionsByIds:");
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
adGroupCriterionIds : null,
adGroupId : adGroupId,
criterionType : AdGroupCriterionType.ProductPartition,
returnAdditionalFields : AdGroupCriterionAdditionalField.FinalUrlSuffix);
OutputStatusMessage("Updated the bid for the tree root node: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
// Initialize and overwrite any existing tree root, and build a product partition group tree structure in multiple steps.
// You could build the entire tree in a single call since there are less than 5,000 nodes; however,
// we will build it in steps to demonstrate how to use the results from ApplyProductPartitionActions to update the tree.
helper = new PartitionActionHelper(adGroupId);
// Check whether a root node exists already.
OutputStatusMessage("-----\nGetAdGroupCriterionsByIds:");
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
adGroupCriterionIds : null,
adGroupId : adGroupId,
criterionType : AdGroupCriterionType.ProductPartition,
returnAdditionalFields : AdGroupCriterionAdditionalField.FinalUrlSuffix);
var existingRoot = GetRootNode(adGroupCriterions?.AdGroupCriterions);
if (existingRoot != null)
{
helper.DeletePartition(existingRoot);
}
root = helper.AddSubdivision(
null,
new ProductCondition {
Operand = "All", Attribute = null
}
);
// The direct children of any node must have the same Operand.
// For this example we will use CategoryL1 nodes as children of the root.
// For a list of valid CategoryL1 through CategoryL5 values, see the Bing Category Taxonomy:
// http://go.microsoft.com/fwlink?LinkId=507666
var animalsSubdivision = helper.AddSubdivision(
parent: root,
condition: new ProductCondition {
Operand = "CategoryL1", Attribute = "Animals & Pet Supplies"
});
// If you use a CategoryL2 node, it must be a descendant (child or later) of a CategoryL1 node.
// In other words you cannot have a CategoryL2 node as parent of a CategoryL1 node.
// For this example we will a CategoryL2 node as child of the CategoryL1 Animals & Pet Supplies node.
var petSuppliesSubdivision = helper.AddSubdivision(
parent: animalsSubdivision,
condition: new ProductCondition {
Operand = "CategoryL2", Attribute = "Pet Supplies"
});
var brandA = helper.AddUnit(
parent: petSuppliesSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = "Brand A"
},
bidAmount: 0.35,
isNegative: false);
// If you won't bid on Brand B, set the helper method's bidAmount to '0' and isNegative to true.
// The helper method will create a NegativeAdGroupCriterion and apply the condition.
var brandB = helper.AddUnit(
parent: petSuppliesSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = "Brand B"
},
bidAmount: 0,
isNegative: true);
var otherBrands = helper.AddUnit(
parent: petSuppliesSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = null
},
bidAmount: 0.35,
isNegative: false);
var otherPetSupplies = helper.AddUnit(
parent: animalsSubdivision,
condition: new ProductCondition {
Operand = "CategoryL2", Attribute = null
},
bidAmount: 0.35,
isNegative: false);
var electronics = helper.AddUnit(
parent: root,
condition: new ProductCondition {
Operand = "CategoryL1", Attribute = "Electronics"
},
bidAmount: 0.35,
isNegative: false);
var otherCategoryL1 = helper.AddUnit(
root,
new ProductCondition {
Operand = "CategoryL1", Attribute = null
},
0.35,
false
);
OutputStatusMessage("-----\nApplyProductPartitionActions:");
OutputStatusMessage("Applying product partitions to the ad group...");
applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(
criterionActions : helper.PartitionActions);
// To retrieve product partitions after they have been applied, call GetAdGroupCriterionsByIds.
// The product partition with ParentCriterionId set to null is the root node.
OutputStatusMessage("-----\nGetAdGroupCriterionsByIds:");
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
adGroupCriterionIds : null,
adGroupId : adGroupId,
criterionType : AdGroupCriterionType.ProductPartition,
returnAdditionalFields : AdGroupCriterionAdditionalField.FinalUrlSuffix);
// The product partition group tree now has 9 nodes.
//All other (Root Node)
// |
// +-- Animals & Pet Supplies (CategoryL1)
// | |
// | +-- Pet Supplies (CategoryL2)
// | | |
// | | +-- Brand A
// | | |
// | | +-- Brand B
// | | |
// | | +-- All other (Brand)
// | |
// | +-- All other (CategoryL2)
// |
// +-- Electronics (CategoryL1)
// |
// +-- All other (CategoryL1)
OutputStatusMessage("The product partition group tree now has 9 nodes: \n");
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
// Let's replace the Electronics (CategoryL1) node created above with an Electronics (CategoryL1) node that
// has children i.e. Brand C (Brand), Brand D (Brand), and All other (Brand) as follows:
//Electronics (CategoryL1)
//|
//+-- Brand C (Brand)
//|
//+-- Brand D (Brand)
//|
//+-- All other (Brand)
helper = new PartitionActionHelper(adGroupId);
// To replace a node we must know its Id and its ParentCriterionId. In this case the parent of the node
// we are replacing is All other (Root Node), and was created at Index 1 of the previous ApplyProductPartitionActions call.
// The node that we are replacing is Electronics (CategoryL1), and was created at Index 8.
var rootId = applyProductPartitionActionsResponse.AdGroupCriterionIds[1];
electronics.Id = applyProductPartitionActionsResponse.AdGroupCriterionIds[8];
helper.DeletePartition(electronics);
var parent = new BiddableAdGroupCriterion()
{
Id = rootId
};
var electronicsSubdivision = helper.AddSubdivision(
parent: parent,
condition: new ProductCondition {
Operand = "CategoryL1", Attribute = "Electronics"
}
);
var brandC = helper.AddUnit(
parent: electronicsSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = "Brand C"
},
bidAmount: 0.35,
isNegative: false);
var brandD = helper.AddUnit(
parent: electronicsSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = "Brand D"
},
bidAmount: 0.35,
isNegative: false);
var otherElectronicsBrands = helper.AddUnit(
parent: electronicsSubdivision,
condition: new ProductCondition {
Operand = "Brand", Attribute = null
},
bidAmount: 0.35,
isNegative: false);
OutputStatusMessage("-----\nApplyProductPartitionActions:");
OutputStatusMessage(
"Updating the product partition group to refine Electronics (CategoryL1) with 3 child nodes..."
);
applyProductPartitionActionsResponse = await CampaignManagementExampleHelper.ApplyProductPartitionActionsAsync(
criterionActions : helper.PartitionActions);
OutputStatusMessage("-----\nGetAdGroupCriterionsByIds:");
adGroupCriterions = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
adGroupCriterionIds : null,
adGroupId : adGroupId,
criterionType : AdGroupCriterionType.ProductPartition,
returnAdditionalFields : AdGroupCriterionAdditionalField.FinalUrlSuffix);
// The product partition group tree now has 12 nodes, including the children of Electronics (CategoryL1):
//All other (Root Node)
// |
// +-- Animals & Pet Supplies (CategoryL1)
// | |
// | +-- Pet Supplies (CategoryL2)
// | | |
// | | +-- Brand A
// | | |
// | | +-- Brand B
// | | |
// | | +-- All other (Brand)
// | |
// | +-- All other (CategoryL2)
// |
// +-- Electronics (CategoryL1)
// | |
// | +-- Brand C (Brand)
// | |
// | +-- Brand D (Brand)
// | |
// | +-- All other (Brand)
// |
// +-- All other (CategoryL1)
OutputStatusMessage(
"The product partition group tree now has 12 nodes, including the children of Electronics (CategoryL1): \n"
);
OutputProductPartitions(adGroupCriterions?.AdGroupCriterions);
// Create a product ad. You must add at least one product ad to the ad group.
// The product ad identifier can be used for reporting analytics.
// Use Merchant Promotions if you want tags to appear at the bottom of your product ad
// as "special offer" links, helping to increase customer engagement. For details
// on Merchant Promotions see https://help.bingads.microsoft.com/#apex/3/en/56805/0.
var ads = new Ad[] {
new ProductAd {
}
};
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 <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;
AdInsightExampleHelper AdInsightExampleHelper =
new AdInsightExampleHelper(this.OutputStatusMessage);
AdInsightExampleHelper.AdInsightService =
new ServiceClient <IAdInsightService>(authorizationData, environment);
CampaignManagementExampleHelper CampaignManagementExampleHelper =
new CampaignManagementExampleHelper(this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService =
new ServiceClient <ICampaignManagementService>(authorizationData, environment);
// To get started with dynamic search ads, first you'll need to add a new Campaign
// with its type set to DynamicSearchAds. When you create the campaign, you'll need to
// include a DynamicSearchAdsSetting that specifies the target website domain and language.
var campaigns = new[] {
new Campaign
{
CampaignType = CampaignType.DynamicSearchAds,
Settings = new [] {
new DynamicSearchAdsSetting
{
DomainName = "contoso.com",
Language = "English"
}
},
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 = null,
DailyBudget = 50,
BudgetType = Microsoft.BingAds.V12.CampaignManagement.BudgetLimitType.DailyBudgetStandard,
// You can set your campaign bid strategy to Enhanced CPC (EnhancedCpcBiddingScheme)
// and then, at any time, set an individual ad group bid strategy to
// Manual CPC (ManualCpcBiddingScheme).
BiddingScheme = new EnhancedCpcBiddingScheme {
},
TimeZone = "PacificTimeUSCanadaTijuana",
// Used with CustomParameters defined in lower level entities such as ads.
TrackingUrlTemplate =
"http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}"
},
};
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(authorizationData.AccountId, campaigns);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
Microsoft.BingAds.V12.CampaignManagement.BatchError[] campaignErrors =
addCampaignsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
// Next, create a new AdGroup within the dynamic search ads 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
},
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 {
},
}
};
AddAdGroupsResponse addAdGroupsResponse = await CampaignManagementExampleHelper.AddAdGroupsAsync((long)campaignIds[0], adGroups, null);
long?[] adGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
Microsoft.BingAds.V12.CampaignManagement.BatchError[] adGroupErrors =
addAdGroupsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
// You can add one or more Webpage criterion to each ad group that helps determine
// whether or not to serve dynamic search ads.
var adGroupCriterions = new List <AdGroupCriterion>();
var adGroupWebpagePositivePageContent = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = "flowers",
Operand = WebpageConditionOperand.PageContent,
}
},
CriterionName = "Ad Group Webpage Positive Page Content Criterion"
},
},
// DestinationUrl and FinalUrls are not supported with Webpage criterion.
// The Final URL is dynamically created at the ad level.
DestinationUrl = null,
FinalUrls = null,
// 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 webpage criterion,
// and can be used by the criterion, 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"
},
}
}
};
adGroupCriterions.Add(adGroupWebpagePositivePageContent);
// To discover the categories that you can use for Webpage criterion (positive or negative),
// use the GetDomainCategories operation with the Ad Insight service.
var getDomainCategoriesResponse = await AdInsightExampleHelper.GetDomainCategoriesAsync(
null,
DOMAIN_NAME,
LANGUAGE);
var categories = getDomainCategoriesResponse.Categories;
// If any categories are available let's use one as a condition.
if (categories.Count > 0)
{
var adGroupWebpagePositiveCategory = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = categories[0].CategoryName,
Operand = WebpageConditionOperand.Category,
}
},
CriterionName = "Ad Group Webpage Positive Category Criterion"
},
}
};
adGroupCriterions.Add(adGroupWebpagePositiveCategory);
}
// If you want to exclude certain portions of your website, you can add negative Webpage
// criterion at the campaign and ad group level.
var adGroupWebpageNegativeUrl = new NegativeAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
// You can choose whether you want the criterion argument to match partial URLs,
// page content, page title, or categories that Bing thinks applies to your website.
Conditions = new[]
{
new WebpageCondition
{
Argument = DOMAIN_NAME,
Operand = WebpageConditionOperand.Url,
}
},
// If you do not specify any name, then it will be set to a concatenated list of conditions.
CriterionName = null
}
},
};
adGroupCriterions.Add(adGroupWebpageNegativeUrl);
OutputStatusMessage("Adding Ad Group Webpage Criterion . . . \n");
CampaignManagementExampleHelper.OutputArrayOfAdGroupCriterion(adGroupCriterions);
AddAdGroupCriterionsResponse addAdGroupCriterionsResponse =
await CampaignManagementExampleHelper.AddAdGroupCriterionsAsync(adGroupCriterions, AdGroupCriterionType.Webpage);
long?[] adGroupCriterionIds = addAdGroupCriterionsResponse.AdGroupCriterionIds.ToArray();
OutputStatusMessage("New Ad Group Criterion Ids:\n");
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupCriterionIds);
BatchErrorCollection[] adGroupCriterionErrors =
addAdGroupCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("\nAddAdGroupCriterions Errors:\n");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(adGroupCriterionErrors);
// The negative Webpage criterion at the campaign level applies to all ad groups
// within the campaign; however, if you define ad group level negative Webpage criterion,
// the campaign criterion is ignored for that ad group.
var campaignCriterions = new List <CampaignCriterion>();
var campaignWebpageNegative = new NegativeCampaignCriterion
{
CampaignId = (long)campaignIds[0],
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = DOMAIN_NAME + "\\seattle",
Operand = WebpageConditionOperand.Url,
}
},
CriterionName = "Campaign Negative Webpage Url Criterion"
}
}
};
campaignCriterions.Add(campaignWebpageNegative);
OutputStatusMessage("Adding Campaign Webpage Criterion . . . \n");
CampaignManagementExampleHelper.OutputArrayOfCampaignCriterion(campaignCriterions);
AddCampaignCriterionsResponse addCampaignCriterionsResponse =
await CampaignManagementExampleHelper.AddCampaignCriterionsAsync(campaignCriterions, CampaignCriterionType.Webpage);
long?[] campaignCriterionIds = addCampaignCriterionsResponse.CampaignCriterionIds.ToArray();
OutputStatusMessage("\nNew Campaign Criterion Ids:\n");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignCriterionIds);
BatchErrorCollection[] campaignCriterionErrors =
addCampaignCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("\nAddCampaignCriterions Errors:\n");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(campaignCriterionErrors);
// Finally you can add a DynamicSearchAd into the ad group. The ad title and display URL
// are generated automatically based on the website domain and language that you want to target.
var ads = new Ad[] {
new DynamicSearchAd
{
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// You cannot set FinalUrls. The Final URL will be a dynamically selected landing page.
// The final URL is distinct from the path that customers will see and click on in your ad.
FinalUrls = null,
// 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, webpage, 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"
},
}
}
},
};
AddAdsResponse addAdsResponse = await CampaignManagementExampleHelper.AddAdsAsync((long)adGroupIds[0], ads);
long?[] adIds = addAdsResponse.AdIds.ToArray();
Microsoft.BingAds.V12.CampaignManagement.BatchError[] adErrors =
addAdsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adErrors);
// Retrieve the Webpage criterion for the campaign.
var getCampaignCriterionsByIdsResponse = await CampaignManagementExampleHelper.GetCampaignCriterionsByIdsAsync(
null,
(long)campaignIds[0],
CampaignCriterionType.Webpage
);
OutputStatusMessage("Retrieving the Campaign Webpage Criterions that we added . . . \n");
campaignCriterions = getCampaignCriterionsByIdsResponse.CampaignCriterions.ToList();
CampaignManagementExampleHelper.OutputArrayOfCampaignCriterion(campaignCriterions);
// Retrieve the Webpage criterion for the ad group and then test some update scenarios.
var getAdGroupCriterionsByIdsResponse = await CampaignManagementExampleHelper.GetAdGroupCriterionsByIdsAsync(
null,
(long)adGroupIds[0],
AdGroupCriterionType.Webpage
);
OutputStatusMessage("Retrieving the Ad Group Webpage Criterions that we added . . . \n");
adGroupCriterions = getAdGroupCriterionsByIdsResponse.AdGroupCriterions.ToList();
CampaignManagementExampleHelper.OutputArrayOfAdGroupCriterion(adGroupCriterions);
// You can update the bid for BiddableAdGroupCriterion
var updateBid = new FixedBid
{
Amount = 0.75
};
// You can update the Webpage criterion name but cannot update the conditions.
// To update the conditions you must delete the criterion and add a new criterion.
// This update attempt will return an error.
var updateCriterionAttemptFailure = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = "Books",
Operand = WebpageConditionOperand.PageContent,
}
},
CriterionName = "Update Attempt Failure"
},
};
var updateCriterionAttemptSuccess = new Webpage
{
Parameter = new WebpageParameter
{
CriterionName = "Update Attempt Success"
},
};
foreach (var adGroupCriterion in adGroupCriterions)
{
var biddableAdGroupCriterion = adGroupCriterion as BiddableAdGroupCriterion;
if (biddableAdGroupCriterion != null)
{
((BiddableAdGroupCriterion)(adGroupCriterion)).CriterionBid = updateBid;
((BiddableAdGroupCriterion)(adGroupCriterion)).Criterion = updateCriterionAttemptSuccess;
}
else
{
var negativeAdGroupCriterion = adGroupCriterion as NegativeAdGroupCriterion;
if (negativeAdGroupCriterion != null)
{
((NegativeAdGroupCriterion)(adGroupCriterion)).Criterion = updateCriterionAttemptFailure;
}
}
}
OutputStatusMessage("Updating Ad Group Webpage Criterion . . . \n");
CampaignManagementExampleHelper.OutputArrayOfAdGroupCriterion(adGroupCriterions);
UpdateAdGroupCriterionsResponse updateAdGroupCriterionsResponse =
await CampaignManagementExampleHelper.UpdateAdGroupCriterionsAsync(adGroupCriterions, AdGroupCriterionType.Webpage);
adGroupCriterionErrors =
updateAdGroupCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("UpdateAdGroupCriterions Errors:\n");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(adGroupCriterionErrors);
// Delete the campaign, ad group, criterion, and ad that were previously added.
// You should remove this operation 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]));
}
// 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
{
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
{
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);
}
}
public async override Task RunAsync(AuthorizationData authorizationData)
{
try
{
ApiEnvironment environment = ((OAuthDesktopMobileAuthCodeGrant)authorizationData.Authentication).Environment;
AdInsightExampleHelper AdInsightExampleHelper = new AdInsightExampleHelper(
OutputStatusMessageDefault: this.OutputStatusMessage);
AdInsightExampleHelper.AdInsightService = new ServiceClient <IAdInsightService>(
authorizationData: authorizationData,
environment: environment);
CampaignManagementExampleHelper CampaignManagementExampleHelper = new CampaignManagementExampleHelper(
OutputStatusMessageDefault: this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient <ICampaignManagementService>(
authorizationData: authorizationData,
environment: environment);
// To get started with dynamic search ads, first you'll need to add a new Campaign
// with its type set to DynamicSearchAds. When you create the campaign, you'll need to
// include a DynamicSearchAdsSetting that specifies the target website domain and language.
var campaigns = new[] {
new Campaign
{
BudgetType = Microsoft.BingAds.V13.CampaignManagement.BudgetLimitType.DailyBudgetStandard,
DailyBudget = 50,
CampaignType = CampaignType.DynamicSearchAds,
Languages = new string[] { "All" },
Name = "Women's Shoes " + DateTime.UtcNow,
TimeZone = "PacificTimeUSCanadaTijuana",
Settings = new [] {
new DynamicSearchAdsSetting
{
DomainName = "contoso.com",
Language = "English"
}
},
},
};
OutputStatusMessage("-----\nAddCampaigns:");
AddCampaignsResponse addCampaignsResponse = await CampaignManagementExampleHelper.AddCampaignsAsync(
accountId : authorizationData.AccountId,
campaigns : campaigns);
long?[] campaignIds = addCampaignsResponse.CampaignIds.ToArray();
Microsoft.BingAds.V13.CampaignManagement.BatchError[] campaignErrors = addCampaignsResponse.PartialErrors.ToArray();
OutputStatusMessage("CampaignIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(campaignErrors);
// Create a new ad group within the dynamic search ads 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();
Microsoft.BingAds.V13.CampaignManagement.BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
OutputStatusMessage("AdGroupIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
OutputStatusMessage("PartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
// You can add one or more Webpage criteria to each ad group that helps determine
// whether or not to serve dynamic search ads.
var adGroupCriterions = new List <AdGroupCriterion>();
var adGroupWebpagePositivePageContent = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = "flowers",
Operand = WebpageConditionOperand.PageContent,
}
},
CriterionName = "Ad Group Webpage Positive Page Content Criterion"
},
},
};
adGroupCriterions.Add(adGroupWebpagePositivePageContent);
// To discover the categories that you can use for Webpage criteria (positive or negative),
// use the GetDomainCategories operation with the Ad Insight service.
OutputStatusMessage("-----\nGetDomainCategories:");
var getDomainCategoriesResponse = await AdInsightExampleHelper.GetDomainCategoriesAsync(
categoryName : null,
domainName : DOMAIN_NAME,
language : LANGUAGE);
var categories = getDomainCategoriesResponse.Categories;
OutputStatusMessage("Categories:");
AdInsightExampleHelper.OutputArrayOfDomainCategory(categories);
// If any categories are available let's use one as a condition.
if (categories.Count > 0)
{
var adGroupWebpagePositiveCategory = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = categories[0].CategoryName,
Operand = WebpageConditionOperand.Category,
}
},
CriterionName = "Ad Group Webpage Positive Category Criterion"
},
}
};
adGroupCriterions.Add(adGroupWebpagePositiveCategory);
}
// If you want to exclude certain portions of your website, you can add negative Webpage
// criterion at the campaign and ad group level.
var adGroupWebpageNegativeUrl = new NegativeAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
// You can choose whether you want the criterion argument to match partial URLs,
// page content, page title, or categories that Bing thinks applies to your website.
Conditions = new[]
{
new WebpageCondition
{
Argument = DOMAIN_NAME,
Operand = WebpageConditionOperand.Url,
}
},
// If you do not specify any name, then it will be set to a concatenated list of conditions.
CriterionName = null
}
},
};
adGroupCriterions.Add(adGroupWebpageNegativeUrl);
OutputStatusMessage("-----\nAddAdGroupCriterions:");
CampaignManagementExampleHelper.OutputArrayOfAdGroupCriterion(adGroupCriterions);
AddAdGroupCriterionsResponse addAdGroupCriterionsResponse = await CampaignManagementExampleHelper.AddAdGroupCriterionsAsync(
adGroupCriterions : adGroupCriterions,
criterionType : AdGroupCriterionType.Webpage);
long?[] adGroupCriterionIds = addAdGroupCriterionsResponse.AdGroupCriterionIds.ToArray();
OutputStatusMessage("AdGroupCriterionIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupCriterionIds);
BatchErrorCollection[] adGroupCriterionErrors =
addAdGroupCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("NestedPartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(adGroupCriterionErrors);
// The negative Webpage criterion at the campaign level applies to all ad groups
// within the campaign; however, if you define ad group level negative Webpage criterion,
// the campaign criterion is ignored for that ad group.
var campaignCriterions = new List <CampaignCriterion>();
var campaignWebpageNegative = new NegativeCampaignCriterion
{
CampaignId = (long)campaignIds[0],
Criterion = new Webpage
{
Parameter = new WebpageParameter
{
Conditions = new[]
{
new WebpageCondition
{
Argument = DOMAIN_NAME + "\\seattle",
Operand = WebpageConditionOperand.Url,
}
},
CriterionName = "Campaign Negative Webpage Url Criterion"
}
}
};
campaignCriterions.Add(campaignWebpageNegative);
OutputStatusMessage("-----\nAddCampaignCriterions:");
CampaignManagementExampleHelper.OutputArrayOfCampaignCriterion(campaignCriterions);
AddCampaignCriterionsResponse addCampaignCriterionsResponse = await CampaignManagementExampleHelper.AddCampaignCriterionsAsync(
campaignCriterions : campaignCriterions,
criterionType : CampaignCriterionType.Webpage);
long?[] campaignCriterionIds = addCampaignCriterionsResponse.CampaignCriterionIds.ToArray();
OutputStatusMessage("CampaignCriterionIds:");
CampaignManagementExampleHelper.OutputArrayOfLong(campaignCriterionIds);
BatchErrorCollection[] campaignCriterionErrors =
addCampaignCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("NestedPartialErrors:");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(campaignCriterionErrors);
// Finally you must add at least one DynamicSearchAd into the ad group. The ad title and display URL
// are generated automatically based on the website domain and language that you want to target.
var ads = new Ad[] {
new DynamicSearchAd
{
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
Path1 = "seattle",
Path2 = "shoe sale",
// You cannot set FinalUrls for dynamic search ads.
// The Final URL will be a dynamically selected landing page.
// The final URL is distinct from the path that customers will see and click on in your ad.
FinalUrls = null,
},
};
OutputStatusMessage("-----\nAddAds:");
AddAdsResponse addAdsResponse = await CampaignManagementExampleHelper.AddAdsAsync(
adGroupId : (long)adGroupIds[0],
ads : ads);
long?[] adIds = addAdsResponse.AdIds.ToArray();
Microsoft.BingAds.V13.CampaignManagement.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 <Microsoft.BingAds.V13.CampaignManagement.AdApiFaultDetail> ex)
{
OutputStatusMessage(string.Join("; ", ex.Detail.Errors.Select(error => string.Format("{0}: {1}", error.Code, error.Message))));
}
catch (FaultException <Microsoft.BingAds.V13.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.V13.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
{
CampaignManagementExampleHelper CampaignManagementExampleHelper = new CampaignManagementExampleHelper(this.OutputStatusMessage);
CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient <ICampaignManagementService>(authorizationData);
// Setup an Audience campaign with one ad group and a responsive ad.
var campaigns = new[] {
new Campaign
{
// CampaignType must be set for Audience campaigns
CampaignType = CampaignType.Audience,
// Languages must be set for Audience campaigns
Languages = new string[] { "All" },
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",
StartDate = null,
EndDate = new Date {
Month = 12,
Day = 31,
Year = DateTime.UtcNow.Year + 1
},
CpcBid = new Bid {
Amount = 0.09
},
// Language cannot be set for ad groups in Audience campaigns
Language = null,
// Network cannot be set for ad groups in Audience campaigns
Network = null,
Settings = new[]
{
new TargetSetting
{
// By including the corresponding TargetSettingDetail,
// this example sets the "target and bid" option for
// CompanyName, Industry, and JobFunction. We will only deliver ads to
// people who meet at least one of your criteria.
// By default the "bid only" option is set for Audience, Age, and Gender.
// We will deliver ads to all audiences, ages, and genders, if they meet
// your company name, industry, or job function criteria.
Details = new []
{
new TargetSettingDetail
{
CriterionTypeGroup = CriterionTypeGroup.CompanyName,
TargetAndBid = true
},
new TargetSettingDetail
{
CriterionTypeGroup = CriterionTypeGroup.Industry,
TargetAndBid = true
},
new TargetSettingDetail
{
CriterionTypeGroup = CriterionTypeGroup.JobFunction,
TargetAndBid = true
},
}
}
},
}
};
var ads = new Ad[] {
new ResponsiveAd
{
// Not applicable for responsive ads
AdFormatPreference = null,
BusinessName = "Contoso",
CallToAction = CallToAction.AddToCart,
// Not applicable for responsive ads
DevicePreference = null,
EditorialStatus = null,
FinalAppUrls = null,
FinalMobileUrls = new[] {
"http://mobile.contoso.com/womenshoesale"
},
FinalUrls = new[] {
"http://www.contoso.com/womenshoesale"
},
ForwardCompatibilityMap = null,
Headline = "Fast & Easy Setup",
Id = null,
LandscapeImageMediaId = LandscapeImageMediaId,
LandscapeLogoMediaId = LandscapeLogoMediaId,
LongHeadline = "Find New Customers & Increase Sales!",
SquareImageMediaId = SquareImageMediaId,
SquareLogoMediaId = SquareLogoMediaId,
Status = null,
Text = "Find New Customers & Increase Sales! Start Advertising on Contoso Today.",
TrackingUrlTemplate = null,
Type = null,
UrlCustomParameters = null,
}
};
// Add the campaign, ad group, and ad
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,
false);
long?[] adGroupIds = addAdGroupsResponse.AdGroupIds.ToArray();
BatchError[] adGroupErrors = addAdGroupsResponse.PartialErrors.ToArray();
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupIds);
CampaignManagementExampleHelper.OutputArrayOfBatchError(adGroupErrors);
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);
// Whether or not the "target and bid" option has been set for a given
// criterion type group, you can set bid adjustments for specific criteria.
var adGroupCriterions = new List <AdGroupCriterion>();
var adGroupCompanyNameCriterion = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new ProfileCriterion
{
ProfileId = 808251207, // Microsoft
ProfileType = ProfileType.CompanyName
},
};
adGroupCriterions.Add(adGroupCompanyNameCriterion);
var adGroupIndustryCriterion = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new ProfileCriterion
{
ProfileId = 807658654, // Computer & Network Security
ProfileType = ProfileType.Industry
},
};
adGroupCriterions.Add(adGroupIndustryCriterion);
var adGroupJobFunctionCriterion = new BiddableAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
CriterionBid = new FixedBid
{
Amount = 0.50
},
Criterion = new ProfileCriterion
{
ProfileId = 807658477, // Engineering
ProfileType = ProfileType.JobFunction
},
};
adGroupCriterions.Add(adGroupJobFunctionCriterion);
// Exclude ages twenty-five through thirty-four.
var adGroupNegativeAgeCriterion = new NegativeAdGroupCriterion
{
AdGroupId = (long)adGroupIds[0],
Criterion = new AgeCriterion
{
AgeRange = AgeRange.TwentyFiveToThirtyFour
},
};
adGroupCriterions.Add(adGroupNegativeAgeCriterion);
OutputStatusMessage("Adding Ad Group Criteria . . . \n");
CampaignManagementExampleHelper.OutputArrayOfAdGroupCriterion(adGroupCriterions);
AddAdGroupCriterionsResponse addAdGroupCriterionsResponse =
await CampaignManagementExampleHelper.AddAdGroupCriterionsAsync(
adGroupCriterions,
AdGroupCriterionType.Targets);
long?[] adGroupCriterionIds = addAdGroupCriterionsResponse.AdGroupCriterionIds.ToArray();
OutputStatusMessage("New Ad Group Criterion Ids:\n");
CampaignManagementExampleHelper.OutputArrayOfLong(adGroupCriterionIds);
BatchErrorCollection[] adGroupCriterionErrors =
addAdGroupCriterionsResponse.NestedPartialErrors.ToArray();
OutputStatusMessage("\nAddAdGroupCriterions Errors:\n");
CampaignManagementExampleHelper.OutputArrayOfBatchErrorCollection(adGroupCriterionErrors);
// Delete the campaign, ad group, criteria, 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]));
}
// 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);
}
}