Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode Class Reference

A node in a tree of ProductPartitions. Used to construct AdGroupCriterion objects for shopping campaigns. More...

Public Member Functions

 ProductPartitionNode (ProductPartitionNode parentNode, ProductDimension dimension)
 Initializes a new instance of the ProductPartitionNode class. More...
 
 ProductPartitionNode (ProductPartitionNode parentNode, ProductDimension dimension, long productPartitionId)
 Initializes a new instance of the ProductPartitionNode class. More...
 
 ProductPartitionNode (ProductPartitionNode parentNode, ProductDimension dimension, long productPartitionId, IEqualityComparer< ProductDimension > comparer)
 Initializes a new instance of the ProductPartitionNode class. More...
 
ProductPartitionNode AsSubdivision ()
 Modifies this node to be a SUBDIVISION node. More...
 
ProductPartitionNode GetChild (ProductDimension dimension)
 Returns the child node with the specified ProductDimension. More...
 
bool HasChild (ProductDimension dimension)
 Determines whether this node has a child with the specified dimension. More...
 
ProductPartitionNode AddChild (ProductDimension childDimension)
 Adds a NEW child for More...
 
ProductPartitionNode AddChild (ProductPartitionNode childNode)
 Adds the childNode as a child under this node. More...
 
ProductPartitionNode RemoveChild (ProductPartitionNode childNode)
 Removes a child node that has matching dimension with the child node. More...
 
ProductPartitionNode RemoveChild (ProductDimension childDimension)
 Removes the child with the specified dimension. More...
 
ProductPartitionNode RemoveAllChildren ()
 Removes all children of this node. More...
 
ProductPartitionNode AsExcludedUnit ()
 Removes all children from this node and modifies this node to be a UNIT node excluded from bidding. More...
 
ProductPartitionNode AsBiddableUnit ()
 Removes all children from this node and modifies this node to be a UNIT node that is biddable. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Static Public Member Functions

static ProductPartitionNode CopyProperties (ProductPartitionNode fromNode, ProductPartitionNode toNode)
 Performs a shallow copy of properties from fromNode to toNode . More...
 

Properties

long ProductPartitionId [get, set]
 Gets or sets the product partition ID. More...
 
ProductDimension Dimension [get]
 Gets the product dimension. More...
 
bool IsSubdivision [get]
 Returns true if this node's partition type is SUBDIVISION, false otherwise. More...
 
bool IsUnit [get]
 Returns true if this node's partition type is UNIT, false otherwise. More...
 
IEnumerable< ProductPartitionNodeChildren [get]
 Gets all the children of this node. More...
 
ProductPartitionNode Parent [get]
 Returns the parent node of this node. The returned node will be More...
 
bool IsBiddableUnit [get]
 Returns true if this node's partition type is UNIT and is biddable (not excluded), false otherwise. More...
 
bool IsExcludedUnit [get]
 Returns true if this node's partition type is UNIT and is excluded (not biddable), false otherwise. More...
 
long CpcBid [get, set]
 Gets or sets the bid. More...
 
bool CpcBidSpecified [get, set]
 Gets or sets a value indicating whether bid is specified. More...
 

Detailed Description

A node in a tree of ProductPartitions. Used to construct AdGroupCriterion objects for shopping campaigns.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.ProductPartitionNode ( ProductPartitionNode  parentNode,
ProductDimension  dimension 
)
inline

Initializes a new instance of the ProductPartitionNode class.

Parameters
parentNodeThe parent node.
dimensionThe product dimension that this node wraps.
Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.ProductPartitionNode ( ProductPartitionNode  parentNode,
ProductDimension  dimension,
long  productPartitionId 
)
inline

Initializes a new instance of the ProductPartitionNode class.

Parameters
parentNodeThe parent node.
dimensionThe product dimension that this node wraps.
productPartitionIdThe product partition ID.
Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.ProductPartitionNode ( ProductPartitionNode  parentNode,
ProductDimension  dimension,
long  productPartitionId,
IEqualityComparer< ProductDimension comparer 
)
inline

Initializes a new instance of the ProductPartitionNode class.

Parameters
parentNodeThe parent node.
dimensionThe product dimension that this node wraps.
productPartitionIdThe product partition ID.
comparerThe comparer for comparing instances of this product dimension.

Member Function Documentation

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.AddChild ( ProductDimension  childDimension)
inline

Adds a NEW child for

childDimension under this node.

Parameters
childDimensionThe ProductDimension for the new child
Returns
The newly created child node.
ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.AddChild ( ProductPartitionNode  childNode)
inline

Adds the childNode as a child under this node.

Parameters
childNodeThe child node.
Returns
The child node.
Exceptions
System.ArgumentExceptionif the parent node already contains the child node's dimension.

References Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.Dimension.

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.AsBiddableUnit ( )
inline

Removes all children from this node and modifies this node to be a UNIT node that is biddable.

Returns
This node, updated to a biddable node.
ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.AsExcludedUnit ( )
inline

Removes all children from this node and modifies this node to be a UNIT node excluded from bidding.

Returns
This node, updated to an excluded node.
ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.AsSubdivision ( )
inline

Modifies this node to be a SUBDIVISION node.

Returns
This node, updated to a subdivision node.
static ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.CopyProperties ( ProductPartitionNode  fromNode,
ProductPartitionNode  toNode 
)
inlinestatic

Performs a shallow copy of properties from fromNode to toNode .

Parameters
fromNodeThe node to copy from.
toNodeThe node to copy to.
Returns
toNode , with its properties updated.

Does not change the parent node of toNode .

References Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.CpcBidSpecified.

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.GetChild ( ProductDimension  dimension)
inline

Returns the child node with the specified ProductDimension.

Parameters
dimensionThe product dimension.
Returns
bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.HasChild ( ProductDimension  dimension)
inline

Determines whether this node has a child with the specified dimension.

Parameters
dimensionThe child dimension.
Returns
True, if the child node exists, false otherwise.
ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.RemoveAllChildren ( )
inline

Removes all children of this node.

Returns
This node.
ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.RemoveChild ( ProductPartitionNode  childNode)
inline

Removes a child node that has matching dimension with the child node.

Parameters
childNodeThe child node.
Returns
This node.

References Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.Dimension.

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.RemoveChild ( ProductDimension  childDimension)
inline

Removes the child with the specified dimension.

Parameters
childDimensionThe child dimension.
Returns
This node.
override string Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Property Documentation

IEnumerable<ProductPartitionNode> Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.Children
get

Gets all the children of this node.

long Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.CpcBid
getset

Gets or sets the bid.

bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.CpcBidSpecified
getset

Gets or sets a value indicating whether bid is specified.

Referenced by Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.CopyProperties().

ProductDimension Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.Dimension
get
bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.IsBiddableUnit
get

Returns true if this node's partition type is UNIT and is biddable (not excluded), false otherwise.

bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.IsExcludedUnit
get

Returns true if this node's partition type is UNIT and is excluded (not biddable), false otherwise.

bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.IsSubdivision
get

Returns true if this node's partition type is SUBDIVISION, false otherwise.

bool Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.IsUnit
get

Returns true if this node's partition type is UNIT, false otherwise.

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.Parent
get

Returns the parent node of this node. The returned node will be

null if this is the root node.

long Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionNode.ProductPartitionId
getset

Gets or sets the product partition ID.


The documentation for this class was generated from the following file: