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

A ProductPartitionTree is a container for a root ProductPartitionNode that also handles applying changes made to the tree under the root. More...

Public Member Functions

AdGroupCriterionOperation[] GetMutateOperations ()
 Gets the mutate operations that will apply the changes made to this tree. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Static Public Member Functions

static ProductPartitionTree DownloadAdGroupTree (AdWordsUser user, long adGroupId)
 Creates a new tree by retrieving the product partition of the specified ad group. More...
 
static ProductPartitionTree CreateAdGroupTree (List< AdGroupCriterion > adGroupCriteria)
 Creates a new ProductPartitionTree based on the collection of ad group criteria provided. More...
 
static ProductPartitionTree CreateAdGroupTree (long adGroupId, List< AdGroupCriterion > adGroupCriteria)
 Creates a new ProductPartitionTree based on the collection of ad group criteria provided. More...
 

Public Attributes

const int ROOT_PARENT_ID = 0
 The parent ID for root node. More...
 
const int NEW_ROOT_ID = -1
 The ID for a new root node. More...
 

Properties

long AdGroupId [get]
 Gets the ad group ID for this tree. More...
 
ProductPartitionNode Root [get]
 Gets the root node of this tree. More...
 

Detailed Description

A ProductPartitionTree is a container for a root ProductPartitionNode that also handles applying changes made to the tree under the root.

Member Function Documentation

static ProductPartitionTree Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.CreateAdGroupTree ( List< AdGroupCriterion adGroupCriteria)
inlinestatic

Creates a new ProductPartitionTree based on the collection of ad group criteria provided.

If retrieving existing criteria for use with this method, you must include all of the fields in REQUIRED_SELECTOR_FIELD_ENUMS in your selector.

Parameters
adGroupCriteriaThe list of ad group criteria.
Returns
static ProductPartitionTree Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.CreateAdGroupTree ( long  adGroupId,
List< AdGroupCriterion adGroupCriteria 
)
inlinestatic

Creates a new ProductPartitionTree based on the collection of ad group criteria provided.

If retrieving existing criteria for use with this method, you must include all of the fields in REQUIRED_SELECTOR_FIELD_ENUMS in your selector.

Parameters
adGroupIdThe ad group ID.
adGroupCriteriaThe list of ad group criteria.
Returns
static ProductPartitionTree Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.DownloadAdGroupTree ( AdWordsUser  user,
long  adGroupId 
)
inlinestatic

Creates a new tree by retrieving the product partition of the specified ad group.

Parameters
userThe user that owns the ad group..
adGroupIdThe ad group ID.
Returns
An in-memory representation of the product partition tree in this ad group.
AdGroupCriterionOperation [] Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.GetMutateOperations ( )
inline

Gets the mutate operations that will apply the changes made to this tree.

Returns
The list of mutate operations.
override string Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Member Data Documentation

const int Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.NEW_ROOT_ID = -1

The ID for a new root node.

const int Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.ROOT_PARENT_ID = 0

The parent ID for root node.

Property Documentation

long Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.AdGroupId
get

Gets the ad group ID for this tree.

ProductPartitionNode Google.Api.Ads.AdWords.Util.Shopping.v201809.ProductPartitionTree.Root
get

Gets the root node of this tree.


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