public void TestAddChildToUnitFails()
{
Assert.True(rootNode.IsUnit, "Root should be a unit by default.");
Assert.Throws <ArgumentException>(delegate() {
rootNode.AddChild(ProductDimensions.CreateBrand("google"));
});
}
public void TestRemoveChildThatDoesNotExistFails()
{
rootNode = rootNode.AsSubdivision();
Assert.Throws <ArgumentException>(delegate() {
rootNode.RemoveChild(ProductDimensions.CreateBrand("google"));
});
}
public void TestChildNodeBasicFunctionality()
{
rootNode = rootNode.AsSubdivision();
Assert.False(rootNode.IsUnit, "Parent should not be a unit.");
Assert.True(rootNode.IsSubdivision, "Parent should be a subdivision.");
ProductBrand childDimension = ProductDimensions.CreateBrand("google");
ProductPartitionNode childNode = rootNode.AddChild(childDimension);
Assert.AreSame(childDimension, childNode.Dimension,
"Child node merely wraps the " + "underlying dimension node.");
Assert.AreSame(rootNode, childNode.Parent, "child.GetParent should return parentNode.");
Assert.That(childNode.ProductPartitionId == 0, "Partition ID is incorrect.");
Assert.That(childNode.Children.Count() == 0, "ChildNode should not have any children.");
Assert.True(childNode.IsUnit, "New node should be a unit node by default.");
Assert.True(childNode.IsBiddableUnit,
"New node should be a biddable unit node by default.");
Assert.That(rootNode.HasChild(childDimension),
"rootNode.HasChild should return true when " +
"passed the dimension of the added child");
Assert.False(rootNode.HasChild(ProductDimensions.CreateBrand("xyz")),
"rootNode.HasChild " +
"should return false when passed a dimension for a nonexistent child");
Assert.False(rootNode.HasChild(null),
"rootNode.HasChild should return false when passed " +
"a dimension for a nonexistent child");
}
public void TestNavigation() {
rootNode = rootNode.AsSubdivision();
ProductBrand brandGoogle = ProductDimensions.CreateBrand("google");
ProductBrand brandOther = ProductDimensions.CreateBrand(null);
ProductCanonicalCondition conditionNew =
ProductDimensions.CreateCanonicalCondition(ProductCanonicalConditionCondition.NEW);
ProductCanonicalCondition conditionUsed =
ProductDimensions.CreateCanonicalCondition(ProductCanonicalConditionCondition.USED);
ProductCanonicalCondition conditionOther = ProductDimensions.CreateCanonicalCondition();
// Build up the brand = Google node under the root.
ProductPartitionNode brandGoogleNode = rootNode.AddChild(brandGoogle).AsSubdivision();
brandGoogleNode.AddChild(conditionNew);
brandGoogleNode.AddChild(conditionUsed);
brandGoogleNode.AddChild(conditionOther);
Assert.True(brandGoogleNode.HasChild(conditionNew),
"HasChild should return true for existing child dimension.");
Assert.AreSame(brandGoogleNode, brandGoogleNode.GetChild(conditionNew).Parent,
"parent->GetChild->getParent should return parent.");
Assert.True(brandGoogleNode.HasChild(conditionUsed),
"HasChild should return true for existing child dimension.");
Assert.AreSame(brandGoogleNode, brandGoogleNode.GetChild(conditionUsed).Parent,
"parent->GetChild->getParent should return parent.");
Assert.True(brandGoogleNode.HasChild(conditionOther),
"HasChild should return true for existing child dimension.");
Assert.AreSame(brandGoogleNode, brandGoogleNode.GetChild(conditionOther).Parent,
"parent->GetChild->getParent should return parent.");
// Build up the brand = null (other) node under the root.
ProductPartitionNode brandOtherNode = rootNode.AddChild(brandOther).AsSubdivision();
brandOtherNode.AddChild(conditionNew);
Assert.True(brandOtherNode.HasChild(conditionNew),
"HasChild should return true for existing child dimension.");
Assert.AreSame(brandOtherNode, brandOtherNode.GetChild(conditionNew).Parent,
"parent->GetChild->getParent should return parent.");
Assert.False(brandOtherNode.HasChild(conditionUsed),
"HasChild should return false for nonexistent child dimension.");
Assert.False(brandOtherNode.HasChild(conditionOther),
"HasChild should return false for nonexistent child dimension.");
brandOtherNode.AddChild(conditionOther);
Assert.True(brandOtherNode.HasChild(conditionOther),
"HasChild should return true for existing child dimension.");
Assert.AreSame(brandOtherNode, brandOtherNode.GetChild(conditionOther).Parent,
"parent->GetChild->getParent should return parent.");
// Remove one of the children of brand = null.
brandOtherNode.RemoveChild(conditionOther);
Assert.False(brandOtherNode.HasChild(conditionOther),
"HasChild should return false for a removed child dimension.");
// Remove the rest of the children of brand = null.
brandOtherNode.RemoveAllChildren();
Assert.False(brandOtherNode.HasChild(conditionNew),
"HasChild should return false for any removed child dimension.");
Assert.False(brandOtherNode.HasChild(conditionUsed),
"HasChild should return false for any removed child dimension.");
}
public void TestAddChildThatExistsFails() {
rootNode = rootNode.AsSubdivision();
rootNode.AddChild(ProductDimensions.CreateBrand("google"));
// Add the same child again. The call should fail.
Assert.Throws<ArgumentException>(delegate() {
rootNode.AddChild(ProductDimensions.CreateBrand("google"));
});
// Add the same child again, this time with a different case.
// The call should fail.
Assert.Throws<ArgumentException>(delegate() {
rootNode.AddChild(ProductDimensions.CreateBrand("GOOGLE"));
});
}
public void TestCreateMultiNodeTreeFromScratch()
{
ProductPartitionTree tree =
ProductPartitionTree.CreateAdGroupTree(new List <AdGroupCriterion>());
ProductPartitionNode rootNode = tree.Root.AsSubdivision();
ProductPartitionNode brand1 = rootNode.AddChild(ProductDimensions.CreateBrand("google"))
.AsSubdivision();
ProductPartitionNode brand1Offer1 =
brand1.AddChild(ProductDimensions.CreateOfferId("A"));
brand1Offer1.AsBiddableUnit().CpcBid = 1000000L;
ProductPartitionNode brand1Offer2 =
brand1.AddChild(ProductDimensions.CreateOfferId()).AsExcludedUnit();
ProductPartitionNode brand2 =
rootNode.AddChild(ProductDimensions.CreateBrand()).AsExcludedUnit();
ProductPartitionNode[] nodes = new ProductPartitionNode[]
{
rootNode,
brand1,
brand1Offer1,
brand1Offer2,
brand2
};
AdGroupCriterionOperation[] mutateOperations = tree.GetMutateOperations();
for (int i = 0; i < nodes.Length; i++)
{
List <AdGroupCriterionOperation> nodeOperations =
shoppingTestUtils.GetOperationsForNode(nodes[i], mutateOperations);
Assert.That(nodeOperations.Count == 1);
Assert.That(nodeOperations[0].@operator == Operator.ADD);
ProductPartition partition = (ProductPartition)nodeOperations[0].operand.criterion;
Assert.That(partition.id == nodes[i].ProductPartitionId);
if (nodes[i].Parent == null)
{
Assert.That(partition.parentCriterionIdSpecified == false);
}
else
{
Assert.That(partition.parentCriterionId == nodes[i].Parent.ProductPartitionId);
}
Assert.That(partition.caseValue == nodes[i].Dimension);
}
}
public void TestCreateBrand() {
ProductBrand brandA = new ProductBrand() {
value = "google"
};
ProductBrand brandB = ProductDimensions.CreateBrand("google");
Assert.True(comparer.Equals(brandA, brandB));
ProductBrand brandC = new ProductBrand() {
};
ProductBrand brandD = ProductDimensions.CreateBrand();
Assert.True(comparer.Equals(brandC, brandD));
}
public void TestSetBidOnUnit() {
rootNode = rootNode.AsSubdivision();
ProductBrand childDimension = ProductDimensions.CreateBrand("google");
ProductPartitionNode childNode = rootNode.AddChild(childDimension);
Assert.That(childNode.CpcBidSpecified == false, "Bid should be null by default.");
childNode.CpcBid = 1L;
Assert.AreEqual(1L, childNode.CpcBid, "Bid does not reflect setBid.");
Assert.True(childNode.IsBiddableUnit, "Node should be a biddable unit.");
childNode = childNode.AsExcludedUnit();
Assert.True(childNode.IsExcludedUnit, "Node should be an excluded unit.");
Assert.False(childNode.IsBiddableUnit, "Node should not be a biddable unit.");
Assert.False(childNode.CpcBidSpecified, "Excluded unit should have a null bid");
// Set back to biddable.
childNode = childNode.AsBiddableUnit();
Assert.True(childNode.IsBiddableUnit, "Node should be a biddable unit.");
}
public void TestRemovedCriteriaIgnored()
{
AdGroupCriterion rootCriterion = ShoppingTestUtils.CreateCriterionForProductPartition(
1L, 0L, null, true, false);
List <AdGroupCriterion> criteria = new List <AdGroupCriterion>();
criteria.Add(rootCriterion);
// Create a criteria for a child node and set its UserStatus to REMOVED.
ProductBrand brandGoogle = ProductDimensions.CreateBrand("google");
AdGroupCriterion removedCriterion = ShoppingTestUtils.CreateCriterionForProductPartition(
2L, 1L, brandGoogle, true, false);
((BiddableAdGroupCriterion)removedCriterion).userStatus = UserStatus.REMOVED;
criteria.Add(removedCriterion);
ProductPartitionTree tree =
ProductPartitionTree.CreateAdGroupTree(criteria);
Assert.False(tree.Root.HasChild(brandGoogle),
"Brand = google criteria had status removed, but it is in the tree.");
}
public void TestCreateUltimatelyEmptyTree()
{
ProductPartitionTree tree =
ProductPartitionTree.CreateAdGroupTree(new List <AdGroupCriterion>());
ProductPartitionNode rootNode = tree.Root.AsSubdivision();
ProductPartitionNode brand1 = rootNode.AddChild(ProductDimensions.CreateBrand("google"))
.AsSubdivision();
ProductPartitionNode offerNode = brand1.AddChild(ProductDimensions.CreateOfferId("A"));
offerNode.AsBiddableUnit().CpcBid = 1000000L;
brand1.AddChild(ProductDimensions.CreateOfferId()).AsExcludedUnit();
ProductPartitionNode brand2 =
rootNode.AddChild(ProductDimensions.CreateBrand()).AsExcludedUnit();
// Now remove the two child nodes under the root and set the root back
// to a UNIT. This should result in operations that simply create the
// root node.
rootNode.RemoveChild(brand1.Dimension);
rootNode.RemoveChild(brand2.Dimension);
rootNode = rootNode.AsBiddableUnit();
AdGroupCriterionOperation[] mutateOperations = tree.GetMutateOperations();
Assert.AreEqual(mutateOperations.Count(), 1, "Number of operations is incorrect.");
AdGroupCriterionOperation operation = mutateOperations[0];
Assert.AreEqual(Operator.ADD, operation.@operator,
"Should have a single operation to ADD the root node.");
BiddableAdGroupCriterion adGroupCriterion =
(BiddableAdGroupCriterion)operation.operand;
Assert.Null(((ProductPartition)adGroupCriterion.criterion).caseValue,
"Product dimension of operation's operand should be null.");
Assert.True(adGroupCriterion.criterion.id < 0L,
"Partition ID of the operand should be negative.");
}
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="user">The AdWords user.</param>
/// <param name="adGroupId">The ad group to which product partition is
/// added.</param>
public void Run(AdWordsUser user, long adGroupId)
{
using (AdGroupCriterionService adGroupCriterionService =
(AdGroupCriterionService)user.GetService(
AdWordsService.v201802.AdGroupCriterionService)) {
// Build a new ProductPartitionTree using the ad group's current set of criteria.
ProductPartitionTree partitionTree =
ProductPartitionTree.DownloadAdGroupTree(user, adGroupId);
Console.WriteLine("Original tree: {0}", partitionTree);
// Clear out any existing criteria.
ProductPartitionNode rootNode = partitionTree.Root.RemoveAllChildren();
// Make the root node a subdivision.
rootNode = rootNode.AsSubdivision();
// Add a unit node for condition = NEW.
ProductPartitionNode newConditionNode = rootNode.AddChild(
ProductDimensions.CreateCanonicalCondition(ProductCanonicalConditionCondition.NEW));
newConditionNode.AsBiddableUnit().CpcBid = 200000;
ProductPartitionNode usedConditionNode = rootNode.AddChild(
ProductDimensions.CreateCanonicalCondition(ProductCanonicalConditionCondition.USED));
usedConditionNode.AsBiddableUnit().CpcBid = 100000;
// Add a subdivision node for condition = null (everything else).
ProductPartitionNode otherConditionNode =
rootNode.AddChild(ProductDimensions.CreateCanonicalCondition()).AsSubdivision();
// Add a unit node under condition = null for brand = "CoolBrand".
ProductPartitionNode coolBrandNode = otherConditionNode.AddChild(
ProductDimensions.CreateBrand("CoolBrand"));
coolBrandNode.AsBiddableUnit().CpcBid = 900000L;
// Add a unit node under condition = null for brand = "CheapBrand".
ProductPartitionNode cheapBrandNode = otherConditionNode.AddChild(
ProductDimensions.CreateBrand("CheapBrand"));
cheapBrandNode.AsBiddableUnit().CpcBid = 10000L;
// Add a subdivision node under condition = null for brand = null (everything else).
ProductPartitionNode otherBrandNode = otherConditionNode.AddChild(
ProductDimensions.CreateBrand(null)).AsSubdivision();
// Add unit nodes under condition = null/brand = null.
// The value for each bidding category is a fixed ID for a specific
// category. You can retrieve IDs for categories from the ConstantDataService.
// See the 'GetProductCategoryTaxonomy' example for more details.
// Add a unit node under condition = null/brand = null for product type
// level 1 = 'Luggage & Bags'.
ProductPartitionNode luggageAndBagNode = otherBrandNode.AddChild(
ProductDimensions.CreateBiddingCategory(ProductDimensionType.BIDDING_CATEGORY_L1,
-5914235892932915235L));
luggageAndBagNode.AsBiddableUnit().CpcBid = 750000L;
// Add a unit node under condition = null/brand = null for product type
// level 1 = null (everything else).
ProductPartitionNode everythingElseNode = otherBrandNode.AddChild(
ProductDimensions.CreateBiddingCategory(ProductDimensionType.BIDDING_CATEGORY_L1));
everythingElseNode.AsBiddableUnit().CpcBid = 110000L;
try {
// Make the mutate request, using the operations returned by the ProductPartitionTree.
AdGroupCriterionOperation[] mutateOperations = partitionTree.GetMutateOperations();
if (mutateOperations.Length == 0)
{
Console.WriteLine("Skipping the mutate call because the original tree and the " +
"current tree are logically identical.");
}
else
{
adGroupCriterionService.mutate(mutateOperations);
}
// The request was successful, so create a new ProductPartitionTree based on the updated
// state of the ad group.
partitionTree = ProductPartitionTree.DownloadAdGroupTree(user, adGroupId);
Console.WriteLine("Final tree: {0}", partitionTree);
} catch (Exception e) {
throw new System.ApplicationException("Failed to set shopping product partition.", e);
}
}
}
