public interface AdSpotOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAllowedLineItemTypes(int index)
public abstract LineItemTypeEnum.LineItemType getAllowedLineItemTypes(int index) Optional. The set of line item types that may appear in the ad spot. This
field is optional and defaults to an empty set, which means that all types
are allowed. Note, backfill reservation types are controlled by the
backfillBlocked field.
repeated .google.ads.admanager.v1.LineItemTypeEnum.LineItemType allowed_line_item_types = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
LineItemTypeEnum.LineItemType |
The allowedLineItemTypes at the given index. |
getAllowedLineItemTypesCount()
public abstract int getAllowedLineItemTypesCount() Optional. The set of line item types that may appear in the ad spot. This
field is optional and defaults to an empty set, which means that all types
are allowed. Note, backfill reservation types are controlled by the
backfillBlocked field.
repeated .google.ads.admanager.v1.LineItemTypeEnum.LineItemType allowed_line_item_types = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of allowedLineItemTypes. |
getAllowedLineItemTypesList()
public abstract List<LineItemTypeEnum.LineItemType> getAllowedLineItemTypesList() Optional. The set of line item types that may appear in the ad spot. This
field is optional and defaults to an empty set, which means that all types
are allowed. Note, backfill reservation types are controlled by the
backfillBlocked field.
repeated .google.ads.admanager.v1.LineItemTypeEnum.LineItemType allowed_line_item_types = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<LineItemType> |
A list containing the allowedLineItemTypes. |
getAllowedLineItemTypesValue(int index)
public abstract int getAllowedLineItemTypesValue(int index) Optional. The set of line item types that may appear in the ad spot. This
field is optional and defaults to an empty set, which means that all types
are allowed. Note, backfill reservation types are controlled by the
backfillBlocked field.
repeated .google.ads.admanager.v1.LineItemTypeEnum.LineItemType allowed_line_item_types = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of allowedLineItemTypes at the given index. |
getAllowedLineItemTypesValueList()
public abstract List<Integer> getAllowedLineItemTypesValueList() Optional. The set of line item types that may appear in the ad spot. This
field is optional and defaults to an empty set, which means that all types
are allowed. Note, backfill reservation types are controlled by the
backfillBlocked field.
repeated .google.ads.admanager.v1.LineItemTypeEnum.LineItemType allowed_line_item_types = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for allowedLineItemTypes. |
getBackfillBlocked()
public abstract boolean getBackfillBlocked()Optional. Whether backfill is blocked in this ad spot. This field is optional and defaults to false.
optional bool backfill_blocked = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The backfillBlocked. |
getCanonicalDisplayName()
public abstract String getCanonicalDisplayName() Optional. Name of the AdSpot. The name is case insensitive and can be
referenced in ad tags. This value is required if customSpot is true, and
cannot be set otherwise. You can use alphanumeric characters and symbols
other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
the white space character.
optional string canonical_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The canonicalDisplayName. |
getCanonicalDisplayNameBytes()
public abstract ByteString getCanonicalDisplayNameBytes() Optional. Name of the AdSpot. The name is case insensitive and can be
referenced in ad tags. This value is required if customSpot is true, and
cannot be set otherwise. You can use alphanumeric characters and symbols
other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
the white space character.
optional string canonical_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for canonicalDisplayName. |
getCustomSpot()
public abstract boolean getCustomSpot()Optional. Whether this ad spot is a custom spot. This field is optional and defaults to false. Custom spots can be reused and targeted in the targeting picker.
optional bool custom_spot = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The customSpot. |
getDisplayName()
public abstract String getDisplayName() Optional. Descriptive name for the AdSpot.This value is optional if
customSpot is true, and cannot be set otherwise.
optional string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes() Optional. Descriptive name for the AdSpot.This value is optional if
customSpot is true, and cannot be set otherwise.
optional string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getFlexible()
public abstract boolean getFlexible()Optional. Whether this ad spot is a flexible spot. This field is optional and defaults to false. Flexible spots are allowed to have no max number of ads.
optional bool flexible = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The flexible. |
getInventorySharingBlocked()
public abstract boolean getInventorySharingBlocked()Optional. Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.
optional bool inventory_sharing_blocked = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The inventorySharingBlocked. |
getMaxAdDuration()
public abstract Duration getMaxAdDuration() Required. The maximum allowed duration for ads in the AdSpot. This field
is required and must be greater than
min_ad_duration.
optional .google.protobuf.Duration max_ad_duration = 13 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxAdDuration. |
getMaxAdDurationOrBuilder()
public abstract DurationOrBuilder getMaxAdDurationOrBuilder() Required. The maximum allowed duration for ads in the AdSpot. This field
is required and must be greater than
min_ad_duration.
optional .google.protobuf.Duration max_ad_duration = 13 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMaxAds()
public abstract int getMaxAds()Optional. The maximum number of ads allowed in the AdSpot. This field is optional and defaults to 0. A value of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.
optional int32 max_ads = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The maxAds. |
getMaxDuration()
public abstract Duration getMaxDuration()Optional. The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.
optional .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxDuration. |
getMaxDurationOrBuilder()
public abstract DurationOrBuilder getMaxDurationOrBuilder()Optional. The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.
optional .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMinAdDuration()
public abstract Duration getMinAdDuration()Optional. The minimum allowed duration for ads in the AdSpot. This field is optional and defaults to 0.
optional .google.protobuf.Duration min_ad_duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The minAdDuration. |
getMinAdDurationOrBuilder()
public abstract DurationOrBuilder getMinAdDurationOrBuilder()Optional. The minimum allowed duration for ads in the AdSpot. This field is optional and defaults to 0.
optional .google.protobuf.Duration min_ad_duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getName()
public abstract String getName() Identifier. The resource name of the AdSpot.
Format: networks/{network_code}/adSpots/{ad_spot_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 AdSpot.
Format: networks/{network_code}/adSpots/{ad_spot_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getTargetingType()
public abstract AdSpotTargetingTypeEnum.AdSpotTargetingType getTargetingType()Optional. The AdSpot TargetingType determines how this ad spot can be targeted. This field is required.
optional .google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType targeting_type = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdSpotTargetingTypeEnum.AdSpotTargetingType |
The targetingType. |
getTargetingTypeValue()
public abstract int getTargetingTypeValue()Optional. The AdSpot TargetingType determines how this ad spot can be targeted. This field is required.
optional .google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType targeting_type = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for targetingType. |
hasBackfillBlocked()
public abstract boolean hasBackfillBlocked()Optional. Whether backfill is blocked in this ad spot. This field is optional and defaults to false.
optional bool backfill_blocked = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the backfillBlocked field is set. |
hasCanonicalDisplayName()
public abstract boolean hasCanonicalDisplayName() Optional. Name of the AdSpot. The name is case insensitive and can be
referenced in ad tags. This value is required if customSpot is true, and
cannot be set otherwise. You can use alphanumeric characters and symbols
other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ],
the white space character.
optional string canonical_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the canonicalDisplayName field is set. |
hasCustomSpot()
public abstract boolean hasCustomSpot()Optional. Whether this ad spot is a custom spot. This field is optional and defaults to false. Custom spots can be reused and targeted in the targeting picker.
optional bool custom_spot = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customSpot field is set. |
hasDisplayName()
public abstract boolean hasDisplayName() Optional. Descriptive name for the AdSpot.This value is optional if
customSpot is true, and cannot be set otherwise.
optional string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayName field is set. |
hasFlexible()
public abstract boolean hasFlexible()Optional. Whether this ad spot is a flexible spot. This field is optional and defaults to false. Flexible spots are allowed to have no max number of ads.
optional bool flexible = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the flexible field is set. |
hasInventorySharingBlocked()
public abstract boolean hasInventorySharingBlocked()Optional. Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.
optional bool inventory_sharing_blocked = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inventorySharingBlocked field is set. |
hasMaxAdDuration()
public abstract boolean hasMaxAdDuration() Required. The maximum allowed duration for ads in the AdSpot. This field
is required and must be greater than
min_ad_duration.
optional .google.protobuf.Duration max_ad_duration = 13 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxAdDuration field is set. |
hasMaxAds()
public abstract boolean hasMaxAds()Optional. The maximum number of ads allowed in the AdSpot. This field is optional and defaults to 0. A value of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.
optional int32 max_ads = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxAds field is set. |
hasMaxDuration()
public abstract boolean hasMaxDuration()Optional. The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.
optional .google.protobuf.Duration max_duration = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxDuration field is set. |
hasMinAdDuration()
public abstract boolean hasMinAdDuration()Optional. The minimum allowed duration for ads in the AdSpot. This field is optional and defaults to 0.
optional .google.protobuf.Duration min_ad_duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the minAdDuration field is set. |
hasTargetingType()
public abstract boolean hasTargetingType()Optional. The AdSpot TargetingType determines how this ad spot can be targeted. This field is required.
optional .google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType targeting_type = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the targetingType field is set. |