com.google.api.ads.adwords.axis.utils.v201809.shopping

Class ProductPartitionTree

java.lang.Object

com.google.api.ads.adwords.axis.utils.v201809.shopping.ProductPartitionTree

All Implemented Interfaces:

ProductPartitionTreeInterface<ProductPartitionNode,com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>

public class ProductPartitionTree
extends Object
implements ProductPartitionTreeInterface<ProductPartitionNode,com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>

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

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableList<AdGroupCriterionField>	REQUIRED_SELECTOR_FIELD_ENUMS Required fields for any Selector used to fetch AdGroupCriterion objects used by an instance of this class.
static com.google.common.collect.ImmutableList<String>	REQUIRED_SELECTOR_FIELDS Deprecated. Use the REQUIRED_SELECTOR_FIELD_ENUMS instead.

Method Summary

Modifier and Type	Method and Description
static ProductPartitionTree	createAdGroupTree(AdWordsServicesInterface services, AdWordsSession session, Long adGroupId) Returns a new instance of this class by retrieving the product partitions of the specified ad group.
static ProductPartitionTree	createAdGroupTree(Long adGroupId, com.google.api.ads.adwords.axis.v201809.cm.BiddingStrategyConfiguration biddingStrategyConfig, List<com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterion> adGroupCriteria) Returns a new instance of this class based on the collection of ad group criteria provided.
Long	getAdGroupId() Returns the ID of the ad group for this tree.
List<com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>	getMutateOperations() Returns the AdGroupCriterionOperations that will apply the changes made to this tree.
ProductPartitionNode	getRoot() Returns the root node of this tree.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REQUIRED_SELECTOR_FIELD_ENUMS

public static final com.google.common.collect.ImmutableList<AdGroupCriterionField> REQUIRED_SELECTOR_FIELD_ENUMS

Required fields for any Selector used to fetch AdGroupCriterion objects used by an instance of this class.

REQUIRED_SELECTOR_FIELDS

@Deprecated
public static final com.google.common.collect.ImmutableList<String> REQUIRED_SELECTOR_FIELDS

Deprecated. Use the REQUIRED_SELECTOR_FIELD_ENUMS instead.

Required fields for any Selector used to fetch AdGroupCriterion objects used by an instance of this class.

Method Detail

createAdGroupTree

public static ProductPartitionTree createAdGroupTree(AdWordsServicesInterface services,
                                                     AdWordsSession session,
                                                     Long adGroupId)
                                              throws com.google.api.ads.adwords.axis.v201809.cm.ApiException,
                                                     RemoteException

Returns a new instance of this class by retrieving the product partitions of the specified ad group. All parameters are required.

Throws:

com.google.api.ads.adwords.axis.v201809.cm.ApiException

RemoteException

createAdGroupTree

public static ProductPartitionTree createAdGroupTree(Long adGroupId,
                                                     com.google.api.ads.adwords.axis.v201809.cm.BiddingStrategyConfiguration biddingStrategyConfig,
                                                     List<com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterion> adGroupCriteria)

Returns a new instance of this class based on the collection of ad group criteria provided.

NOTE: 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:

adGroupId - the ID of the ad group

biddingStrategyConfig - the BiddingStrategyConfiguration for the ad group

adGroupCriteria - the non-null (but possibly empty) list of ad group criteria

Throws:

NullPointerException - if any argument is null, any element in adGroupCriteria is null, or any required field from REQUIRED_SELECTOR_FIELD_ENUMS is missing from an element in adGroupCriteria

IllegalArgumentException - if adGroupCriteria does not include the root criterion of the product partition tree

getAdGroupId

public Long getAdGroupId()

Description copied from interface: ProductPartitionTreeInterface

Returns the ID of the ad group for this tree.

Specified by:

getAdGroupId in interface ProductPartitionTreeInterface<ProductPartitionNode,com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>

getRoot

public ProductPartitionNode getRoot()

Description copied from interface: ProductPartitionTreeInterface

Returns the root node of this tree. This will not be null.

Specified by:

getRoot in interface ProductPartitionTreeInterface<ProductPartitionNode,com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>

toString

public String toString()

Overrides:

toString in class Object

getMutateOperations

public List<com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation> getMutateOperations()

Description copied from interface: ProductPartitionTreeInterface

Returns the AdGroupCriterionOperations that will apply the changes made to this tree.

Specified by:

getMutateOperations in interface ProductPartitionTreeInterface<ProductPartitionNode,com.google.api.ads.adwords.axis.v201809.cm.AdGroupCriterionOperation>