Interface AdRuleOrBuilder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface AdRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

Required. The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEndTime()

public abstract Timestamp getEndTime()

Optional. This end time of the AdRule. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time.

optional .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

Optional. This end time of the AdRule. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time.

optional .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getEndTimeUnlimited()

public abstract boolean getEndTimeUnlimited()

Optional. Specifies whether or not the AdRule has an end time. This attribute is optional and defaults to false.

optional bool end_time_unlimited = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The endTimeUnlimited.

getFrequencyCapBehavior()

public abstract AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior getFrequencyCapBehavior()

Optional. The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to [FrequencyCapBehavior.DEFER][].

optional .google.ads.admanager.v1.AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior frequency_cap_behavior = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior	The frequencyCapBehavior.

getFrequencyCapBehaviorValue()

public abstract int getFrequencyCapBehaviorValue()

Optional. The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to [FrequencyCapBehavior.DEFER][].

optional .google.ads.admanager.v1.AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior frequency_cap_behavior = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for frequencyCapBehavior.

getMaxImpressionsPerLineItemPerPod()

public abstract int getMaxImpressionsPerLineItemPerPod()

Optional. This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

optional int32 max_impressions_per_line_item_per_pod = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The maxImpressionsPerLineItemPerPod.

getMaxImpressionsPerLineItemPerStream()

public abstract int getMaxImpressionsPerLineItemPerStream()

Optional. This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

optional int32 max_impressions_per_line_item_per_stream = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The maxImpressionsPerLineItemPerStream.

getMidrolls(int index)

public abstract AdRuleSlot getMidrolls(int index)

Required. This AdRule object's video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

repeated .google.ads.admanager.v1.AdRuleSlot midrolls = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
AdRuleSlot

getMidrollsCount()

public abstract int getMidrollsCount()

Required. This AdRule object's video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

repeated .google.ads.admanager.v1.AdRuleSlot midrolls = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getMidrollsList()

public abstract List<AdRuleSlot> getMidrollsList()

Required. This AdRule object's video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

repeated .google.ads.admanager.v1.AdRuleSlot midrolls = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<AdRuleSlot>

getMidrollsOrBuilder(int index)

public abstract AdRuleSlotOrBuilder getMidrollsOrBuilder(int index)

Required. This AdRule object's video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

repeated .google.ads.admanager.v1.AdRuleSlot midrolls = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
AdRuleSlotOrBuilder

getMidrollsOrBuilderList()

public abstract List<? extends AdRuleSlotOrBuilder> getMidrollsOrBuilderList()

Required. This AdRule object's video mid-roll slots. This attribute is required, and there must be at least one mid-roll.

repeated .google.ads.admanager.v1.AdRuleSlot midrolls = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.ads.admanager.v1.AdRuleSlotOrBuilder>

getName()

public abstract String getName()

Identifier. The resource name of the AdRule. Format: networks/{network_code}/adRules/{ad_rule_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the AdRule. Format: networks/{network_code}/adRules/{ad_rule_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getPostroll()

public abstract AdRuleSlot getPostroll()

Required. This AdRule object's post-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot postroll = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AdRuleSlot	The postroll.

getPostrollOrBuilder()

public abstract AdRuleSlotOrBuilder getPostrollOrBuilder()

Required. This AdRule object's post-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot postroll = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AdRuleSlotOrBuilder

getPreroll()

public abstract AdRuleSlot getPreroll()

Required. This AdRule object's pre-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot preroll = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AdRuleSlot	The preroll.

getPrerollOrBuilder()

public abstract AdRuleSlotOrBuilder getPrerollOrBuilder()

Required. This AdRule object's pre-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot preroll = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AdRuleSlotOrBuilder

getPriority()

public abstract int getPriority()

Optional. The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule's priority can affect the priorities of other ad rules. For example, increasing an ad rule's priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

optional int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The priority.

getStartTime()

public abstract Timestamp getStartTime()

Required. The start time of the AdRule. This attribute is required and must be a date in the future for new ad rules.

optional .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Required. The start time of the AdRule. This attribute is required and must be a date in the future for new ad rules.

optional .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TimestampOrBuilder

getStatus()

public abstract AdRuleStatusEnum.AdRuleStatus getStatus()

Output only. The AdRuleStatus of the AdRule. This attribute is read-only and defaults to [AdRuleStatus.INACTIVE][].

optional .google.ads.admanager.v1.AdRuleStatusEnum.AdRuleStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AdRuleStatusEnum.AdRuleStatus	The status.

getStatusValue()

public abstract int getStatusValue()

Output only. The AdRuleStatus of the AdRule. This attribute is read-only and defaults to [AdRuleStatus.INACTIVE][].

optional .google.ads.admanager.v1.AdRuleStatusEnum.AdRuleStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for status.

getTargeting()

public abstract Targeting getTargeting()

Required. The targeting of the AdRule.

optional .google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Targeting	The targeting.

getTargetingOrBuilder()

public abstract TargetingOrBuilder getTargetingOrBuilder()

Required. The targeting of the AdRule.

optional .google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TargetingOrBuilder

hasDisplayName()

public abstract boolean hasDisplayName()

Required. The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the displayName field is set.

hasEndTime()

public abstract boolean hasEndTime()

Optional. This end time of the AdRule. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time.

optional .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endTime field is set.

hasEndTimeUnlimited()

public abstract boolean hasEndTimeUnlimited()

Optional. Specifies whether or not the AdRule has an end time. This attribute is optional and defaults to false.

optional bool end_time_unlimited = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endTimeUnlimited field is set.

hasFrequencyCapBehavior()

public abstract boolean hasFrequencyCapBehavior()

Optional. The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to [FrequencyCapBehavior.DEFER][].

optional .google.ads.admanager.v1.AdRuleFrequencyCapBehaviorEnum.AdRuleFrequencyCapBehavior frequency_cap_behavior = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the frequencyCapBehavior field is set.

hasMaxImpressionsPerLineItemPerPod()

public abstract boolean hasMaxImpressionsPerLineItemPerPod()

Optional. This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

optional int32 max_impressions_per_line_item_per_pod = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the maxImpressionsPerLineItemPerPod field is set.

hasMaxImpressionsPerLineItemPerStream()

public abstract boolean hasMaxImpressionsPerLineItemPerStream()

Optional. This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

optional int32 max_impressions_per_line_item_per_stream = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the maxImpressionsPerLineItemPerStream field is set.

hasPostroll()

public abstract boolean hasPostroll()

Required. This AdRule object's post-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot postroll = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the postroll field is set.

hasPreroll()

public abstract boolean hasPreroll()

Required. This AdRule object's pre-roll slot. This attribute is required.

optional .google.ads.admanager.v1.AdRuleSlot preroll = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the preroll field is set.

hasPriority()

public abstract boolean hasPriority()

Optional. The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule's priority can affect the priorities of other ad rules. For example, increasing an ad rule's priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

optional int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the priority field is set.

hasStartTime()

public abstract boolean hasStartTime()

Required. The start time of the AdRule. This attribute is required and must be a date in the future for new ad rules.

optional .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the startTime field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. The AdRuleStatus of the AdRule. This attribute is read-only and defaults to [AdRuleStatus.INACTIVE][].

optional .google.ads.admanager.v1.AdRuleStatusEnum.AdRuleStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the status field is set.

hasTargeting()

public abstract boolean hasTargeting()

Required. The targeting of the AdRule.

optional .google.ads.admanager.v1.Targeting targeting = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the targeting field is set.