com.google.api.ads.dfp.axis.v201708

Class AdExclusionRule

java.lang.Object

com.google.api.ads.dfp.axis.v201708.AdExclusionRule

All Implemented Interfaces:

Serializable

public class AdExclusionRule
extends Object
implements Serializable

Represents an inventory blocking rule, which prevents certain ads from being served to specified ad units.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdExclusionRule()
AdExclusionRule(Long id, String name, Boolean isActive, InventoryTargeting inventoryTargeting, Boolean isBlockAll, long[] blockedLabelIds, long[] allowedLabelIds, AdExclusionRuleType type)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long[]	getAllowedLabelIds() Gets the allowedLabelIds value for this AdExclusionRule.
long	getAllowedLabelIds(int i)
long[]	getBlockedLabelIds() Gets the blockedLabelIds value for this AdExclusionRule.
long	getBlockedLabelIds(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Long	getId() Gets the id value for this AdExclusionRule.
InventoryTargeting	getInventoryTargeting() Gets the inventoryTargeting value for this AdExclusionRule.
Boolean	getIsActive() Gets the isActive value for this AdExclusionRule.
Boolean	getIsBlockAll() Gets the isBlockAll value for this AdExclusionRule.
String	getName() Gets the name value for this AdExclusionRule.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
AdExclusionRuleType	getType() Gets the type value for this AdExclusionRule.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAllowedLabelIds(int i, long _value)
void	setAllowedLabelIds(long[] allowedLabelIds) Sets the allowedLabelIds value for this AdExclusionRule.
void	setBlockedLabelIds(int i, long _value)
void	setBlockedLabelIds(long[] blockedLabelIds) Sets the blockedLabelIds value for this AdExclusionRule.
void	setId(Long id) Sets the id value for this AdExclusionRule.
void	setInventoryTargeting(InventoryTargeting inventoryTargeting) Sets the inventoryTargeting value for this AdExclusionRule.
void	setIsActive(Boolean isActive) Sets the isActive value for this AdExclusionRule.
void	setIsBlockAll(Boolean isBlockAll) Sets the isBlockAll value for this AdExclusionRule.
void	setName(String name) Sets the name value for this AdExclusionRule.
void	setType(AdExclusionRuleType type) Sets the type value for this AdExclusionRule.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdExclusionRule

public AdExclusionRule()

AdExclusionRule

public AdExclusionRule(Long id,
                       String name,
                       Boolean isActive,
                       InventoryTargeting inventoryTargeting,
                       Boolean isBlockAll,
                       long[] blockedLabelIds,
                       long[] allowedLabelIds,
                       AdExclusionRuleType type)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getId

public Long getId()

Gets the id value for this AdExclusionRule.

Returns:

id * The unique ID of the AdExclusionRule. This attribute is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this AdExclusionRule.

Parameters:

id - * The unique ID of the AdExclusionRule. This attribute is readonly and is assigned by Google.

getName

public String getName()

Gets the name value for this AdExclusionRule.

Returns:

name * The name of the AdExclusionRule. This attribute is required.

setName

public void setName(String name)

Sets the name value for this AdExclusionRule.

Parameters:

name - * The name of the AdExclusionRule. This attribute is required.

getIsActive

public Boolean getIsActive()

Gets the isActive value for this AdExclusionRule.

Returns:

isActive * Whether or not the AdExclusionRule is active. An inactive rule will have no effect on adserving. This attribute is readonly.

setIsActive

public void setIsActive(Boolean isActive)

Sets the isActive value for this AdExclusionRule.

Parameters:

isActive - * Whether or not the AdExclusionRule is active. An inactive rule will have no effect on adserving. This attribute is readonly.

getInventoryTargeting

public InventoryTargeting getInventoryTargeting()

Gets the inventoryTargeting value for this AdExclusionRule.

Returns:

inventoryTargeting * The targeting information about which AdUnitTargeting objects this rule is in effect for. Any AdUnitTargeting objects included here will have their children included implicitly. Children of a targeted ad unit can be excluded. This attribute is required.

setInventoryTargeting

public void setInventoryTargeting(InventoryTargeting inventoryTargeting)

Sets the inventoryTargeting value for this AdExclusionRule.

Parameters:

inventoryTargeting - * The targeting information about which AdUnitTargeting objects this rule is in effect for. Any AdUnitTargeting objects included here will have their children included implicitly. Children of a targeted ad unit can be excluded. This attribute is required.

getIsBlockAll

public Boolean getIsBlockAll()

Gets the isBlockAll value for this AdExclusionRule.

Returns:

isBlockAll * Whether or not this rule blocks all ads from serving other than the labels or advertisers specified. This attribute is optional and defaults to false.

setIsBlockAll

public void setIsBlockAll(Boolean isBlockAll)

Sets the isBlockAll value for this AdExclusionRule.

Parameters:

isBlockAll - * Whether or not this rule blocks all ads from serving other than the labels or advertisers specified. This attribute is optional and defaults to false.

getBlockedLabelIds

public long[] getBlockedLabelIds()

Gets the blockedLabelIds value for this AdExclusionRule.

Returns:

blockedLabelIds * The labels that will be blocked from serving. Any advertiser, order or line item with one of these labels will not serve on the relevant ad units and their children.

setBlockedLabelIds

public void setBlockedLabelIds(long[] blockedLabelIds)

Sets the blockedLabelIds value for this AdExclusionRule.

Parameters:

blockedLabelIds - * The labels that will be blocked from serving. Any advertiser, order or line item with one of these labels will not serve on the relevant ad units and their children.

getBlockedLabelIds

public long getBlockedLabelIds(int i)

setBlockedLabelIds

public void setBlockedLabelIds(int i,
                               long _value)

getAllowedLabelIds

public long[] getAllowedLabelIds()

Gets the allowedLabelIds value for this AdExclusionRule.

Returns:

allowedLabelIds * The allowed list of labels that will not be blocked by this rule. This trumps the values of #isBlockAllLabels and blockedLabelIds. For example, if a rule specifies a blocked label "Cars", and an allowed label "Sports", any ad that is labeled both "Sports" and "Cars" will not be blocked by this rule.

setAllowedLabelIds

public void setAllowedLabelIds(long[] allowedLabelIds)

Sets the allowedLabelIds value for this AdExclusionRule.

Parameters:

allowedLabelIds - * The allowed list of labels that will not be blocked by this rule. This trumps the values of #isBlockAllLabels and blockedLabelIds. For example, if a rule specifies a blocked label "Cars", and an allowed label "Sports", any ad that is labeled both "Sports" and "Cars" will not be blocked by this rule.

getAllowedLabelIds

public long getAllowedLabelIds(int i)

setAllowedLabelIds

public void setAllowedLabelIds(int i,
                               long _value)

getType

public AdExclusionRuleType getType()

Gets the type value for this AdExclusionRule.

Returns:

type * The derived type of this rule: whether it is associated with labels, unified entities, or competitive groups. Because it is derived, it is also read-only, so changes made to this field will not be persisted.

setType

public void setType(AdExclusionRuleType type)

Sets the type value for this AdExclusionRule.

Parameters:

type - * The derived type of this rule: whether it is associated with labels, unified entities, or competitive groups. Because it is derived, it is also read-only, so changes made to this field will not be persisted.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer