SetTopBoxLineItemErrorReason (DFP AppEngine components 3.14.2 API)

java.lang.Object
- java.lang.Enum<SetTopBoxLineItemErrorReason>
- - com.google.api.ads.dfp.jaxws.v201711.SetTopBoxLineItemErrorReason

All Implemented Interfaces:: Serializable, Comparable<SetTopBoxLineItemErrorReason>

public enum SetTopBoxLineItemErrorReason
extends Enum<SetTopBoxLineItemErrorReason>

Java class for SetTopBoxLineItemError.Reason.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="SetTopBoxLineItemError.Reason">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="NON_SET_TOP_BOX_AD_UNIT_TARGETED"/>
     <enumeration value="AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED"/>
     <enumeration value="CANNOT_EXCLUDE_AD_UNITS"/>
     <enumeration value="POD_POSITION_OUT_OF_RANGE"/>
     <enumeration value="MIDROLL_POSITION_OUT_OF_RANGE"/>
     <enumeration value="FEATURE_NOT_ENABLED"/>
     <enumeration value="INVALID_ENVIRONMENT_TYPE"/>
     <enumeration value="COMPANIONS_NOT_SUPPORTED"/>
     <enumeration value="INVALID_CREATIVE_SIZE"/>
     <enumeration value="INVALID_LINE_ITEM_TYPE"/>
     <enumeration value="ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS"/>
     <enumeration value="INVALID_COST_TYPE"/>
     <enumeration value="COST_PER_UNIT_NOT_ALLOWED"/>
     <enumeration value="DISCOUNT_NOT_ALLOWED"/>
     <enumeration value="FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED"/>
     <enumeration value="INVALID_LINE_ITEM_STATUS_CHANGE"/>
     <enumeration value="INVALID_LINE_ITEM_PRIORITY"/>
     <enumeration value="SYNC_REVISION_NOT_INCREASING"/>
     <enumeration value="SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO"/>
     <enumeration value="CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS"/>
     <enumeration value="COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED"/>
     <enumeration value="INVALID_LINE_ITEM_TYPE_CHANGE"/>
     <enumeration value="CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED"/>
     <enumeration value="INVALID_FREQUENCY_CAP_TIME_UNIT"/>
     <enumeration value="INVALID_FREQUENCY_CAP_TIME_RANGE"/>
     <enumeration value="INVALID_PRIMARY_GOAL_UNIT_TYPE"/>
     <enumeration value="UNKNOWN"/>
   </restriction>
 </simpleType>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED` The set-top box line item must target at least one ad unit.
`CANNOT_EXCLUDE_AD_UNITS` The set-top box line item cannot exclude ad units.
`CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS` Set Top box line items cannot be unarchived.
`COMPANIONS_NOT_SUPPORTED` Companions are not supported for set-top box line items.
`COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED` Set-top box enabled line items cannot be copied for V0 of the video Canoe campaign push.
`COST_PER_UNIT_NOT_ALLOWED` Set-top box line items do not support a cost per unit.
`CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED` Set-top box line items can only have a creative rotation type of `CreativeRotationType.EVEN` or `CreativeRotationType.MANUAL`.
`DISCOUNT_NOT_ALLOWED` Set-top box line items do not support discounts.
`FEATURE_NOT_ENABLED` The set-top box feature is not enabled.
`FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED` Set-top box line items do not support `DeliveryRateType.FRONTLOADED`.
`INVALID_COST_TYPE` Set-top box line items only support `CostType.CPM`.
`INVALID_CREATIVE_SIZE` Set-top box line items only support sizes supported by Canoe.
`INVALID_ENVIRONMENT_TYPE` Only `EnvironmentType.VIDEO_PLAYER` is supported for set-top box line items.
`INVALID_FREQUENCY_CAP_TIME_RANGE` Set-top box line items can only have specific time ranges for certain time units: `TimeUnit.HOUR` => 1, 2, 6 `TimeUnit.DAY` => 1, 3
`INVALID_FREQUENCY_CAP_TIME_UNIT` Set-top box line items can only have frequency capping with time units of `TimeUnit.DAY`, `TimeUnit.HOUR`, `TimeUnit.POD`, or `TimeUnit.STREAM`.
`INVALID_LINE_ITEM_PRIORITY` Set-top box line items can only have certain priorities for different `reservation types`: `ReservationType#SPONSORSHIP` => 1 `ReservationType#HOUSE` => 16 `ReservationType#STANDARD` => Between 1 and 16 inclusive.
`INVALID_LINE_ITEM_STATUS_CHANGE` Set-top box line items cannot go from a state that is ready to be synced to a state that is not ready to be synced.
`INVALID_LINE_ITEM_TYPE` Set-top box line items only support `LineItemType.STANDARD`, `LineItemType.HOUSE`, and `LineItemType.SPONSORSHIP` line item types.
`INVALID_LINE_ITEM_TYPE_CHANGE` Standard set-top box line items cannot be updated to be `LineItemType#House` or `LineItemType#Sponsorship` line items and vice versa.
`INVALID_PRIMARY_GOAL_UNIT_TYPE` Set-top box line items can only have a unit type of `UnitType.IMPRESSIONS`.
`MIDROLL_POSITION_OUT_OF_RANGE` The set-top box line item can only target midroll positions 4 - 100.
`NON_SET_TOP_BOX_AD_UNIT_TARGETED` The set-top box line item cannot target an ad unit that doesn't have an external set-top box channel ID.
`ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS` `orders` containing `LineItemType.STANDARD` set-top box line items cannot contain set-top box line items of type `LineItemType.HOUSE` or `LineItemType.SPONSORSHIP`.
`POD_POSITION_OUT_OF_RANGE` The set-top box line item can only target pod positions 1 - 15.
`SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO` When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that DFP synced with Canoe.
`SYNC_REVISION_NOT_INCREASING` When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that DFP synced with Canoe.
`UNKNOWN` The value returned if the actual value is not exposed by the requested API version.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SetTopBoxLineItemErrorReason`	`fromValue(String v)`
`String`	`value()`
`static SetTopBoxLineItemErrorReason`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SetTopBoxLineItemErrorReason[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NON_SET_TOP_BOX_AD_UNIT_TARGETED
```
public static final SetTopBoxLineItemErrorReason NON_SET_TOP_BOX_AD_UNIT_TARGETED
```
    The set-top box line item cannot target an ad unit that doesn't have an external set-top box channel ID.
  - AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED
```
public static final SetTopBoxLineItemErrorReason AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED
```
    The set-top box line item must target at least one ad unit.
  - CANNOT_EXCLUDE_AD_UNITS
```
public static final SetTopBoxLineItemErrorReason CANNOT_EXCLUDE_AD_UNITS
```
    The set-top box line item cannot exclude ad units.
  - POD_POSITION_OUT_OF_RANGE
```
public static final SetTopBoxLineItemErrorReason POD_POSITION_OUT_OF_RANGE
```
    The set-top box line item can only target pod positions 1 - 15.
  - MIDROLL_POSITION_OUT_OF_RANGE
```
public static final SetTopBoxLineItemErrorReason MIDROLL_POSITION_OUT_OF_RANGE
```
    The set-top box line item can only target midroll positions 4 - 100.
  - FEATURE_NOT_ENABLED
```
public static final SetTopBoxLineItemErrorReason FEATURE_NOT_ENABLED
```
    The set-top box feature is not enabled.
  - INVALID_ENVIRONMENT_TYPE
```
public static final SetTopBoxLineItemErrorReason INVALID_ENVIRONMENT_TYPE
```
    Only EnvironmentType.VIDEO_PLAYER is supported for set-top box line items.
  - COMPANIONS_NOT_SUPPORTED
```
public static final SetTopBoxLineItemErrorReason COMPANIONS_NOT_SUPPORTED
```
    Companions are not supported for set-top box line items.
  - INVALID_CREATIVE_SIZE
```
public static final SetTopBoxLineItemErrorReason INVALID_CREATIVE_SIZE
```
    Set-top box line items only support sizes supported by Canoe.
  - INVALID_LINE_ITEM_TYPE
```
public static final SetTopBoxLineItemErrorReason INVALID_LINE_ITEM_TYPE
```
    Set-top box line items only support LineItemType.STANDARD, LineItemType.HOUSE, and LineItemType.SPONSORSHIP line item types.
  - ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS
```
public static final SetTopBoxLineItemErrorReason ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS
```
    orders containing LineItemType.STANDARD set-top box line items cannot contain set-top box line items of type LineItemType.HOUSE or LineItemType.SPONSORSHIP.
  - INVALID_COST_TYPE
```
public static final SetTopBoxLineItemErrorReason INVALID_COST_TYPE
```
    Set-top box line items only support CostType.CPM.
  - COST_PER_UNIT_NOT_ALLOWED
```
public static final SetTopBoxLineItemErrorReason COST_PER_UNIT_NOT_ALLOWED
```
    Set-top box line items do not support a cost per unit.
  - DISCOUNT_NOT_ALLOWED
```
public static final SetTopBoxLineItemErrorReason DISCOUNT_NOT_ALLOWED
```
    Set-top box line items do not support discounts.
  - FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED
```
public static final SetTopBoxLineItemErrorReason FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED
```
    Set-top box line items do not support DeliveryRateType.FRONTLOADED.
  - INVALID_LINE_ITEM_STATUS_CHANGE
```
public static final SetTopBoxLineItemErrorReason INVALID_LINE_ITEM_STATUS_CHANGE
```
    Set-top box line items cannot go from a state that is ready to be synced to a state that is not ready to be synced.
  - INVALID_LINE_ITEM_PRIORITY
```
public static final SetTopBoxLineItemErrorReason INVALID_LINE_ITEM_PRIORITY
```
    Set-top box line items can only have certain priorities for different reservation types:
    - ReservationType#SPONSORSHIP => 1
    - ReservationType#HOUSE => 16
    - ReservationType#STANDARD => Between 1 and 16 inclusive.
  - SYNC_REVISION_NOT_INCREASING
```
public static final SetTopBoxLineItemErrorReason SYNC_REVISION_NOT_INCREASING
```
    When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that DFP synced with Canoe. The only changes allowed on revisions within DFP is increasing the revision number.
  - SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO
```
public static final SetTopBoxLineItemErrorReason SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO
```
    When a set-top box line item is pushed to Canoe, a revision number is used to keep track of the last version of the line item that DFP synced with Canoe. Sync revisions begin at one and can only increase in value.
  - CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS
```
public static final SetTopBoxLineItemErrorReason CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS
```
    Set Top box line items cannot be unarchived.
  - COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED
```
public static final SetTopBoxLineItemErrorReason COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED
```
    Set-top box enabled line items cannot be copied for V0 of the video Canoe campaign push.
  - INVALID_LINE_ITEM_TYPE_CHANGE
```
public static final SetTopBoxLineItemErrorReason INVALID_LINE_ITEM_TYPE_CHANGE
```
    Standard set-top box line items cannot be updated to be LineItemType#House or LineItemType#Sponsorship line items and vice versa.
  - CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED
```
public static final SetTopBoxLineItemErrorReason CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED
```
    Set-top box line items can only have a creative rotation type of CreativeRotationType.EVEN or CreativeRotationType.MANUAL.
  - INVALID_FREQUENCY_CAP_TIME_UNIT
```
public static final SetTopBoxLineItemErrorReason INVALID_FREQUENCY_CAP_TIME_UNIT
```
    Set-top box line items can only have frequency capping with time units of TimeUnit.DAY, TimeUnit.HOUR, TimeUnit.POD, or TimeUnit.STREAM.
  - INVALID_FREQUENCY_CAP_TIME_RANGE
```
public static final SetTopBoxLineItemErrorReason INVALID_FREQUENCY_CAP_TIME_RANGE
```
    Set-top box line items can only have specific time ranges for certain time units:
    - TimeUnit.HOUR => 1, 2, 6
    - TimeUnit.DAY => 1, 3
  - INVALID_PRIMARY_GOAL_UNIT_TYPE
```
public static final SetTopBoxLineItemErrorReason INVALID_PRIMARY_GOAL_UNIT_TYPE
```
    Set-top box line items can only have a unit type of UnitType.IMPRESSIONS.
  - UNKNOWN
```
public static final SetTopBoxLineItemErrorReason UNKNOWN
```
    The value returned if the actual value is not exposed by the requested API version.
- Method Detail
  - values
```
public static SetTopBoxLineItemErrorReason[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SetTopBoxLineItemErrorReason c : SetTopBoxLineItemErrorReason.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SetTopBoxLineItemErrorReason valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - value
```
public String value()
```
  - fromValue
```
public static SetTopBoxLineItemErrorReason fromValue(String v)
```

Enum SetTopBoxLineItemErrorReason

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NON_SET_TOP_BOX_AD_UNIT_TARGETED

AT_LEAST_ONE_AD_UNIT_MUST_BE_TARGETED

CANNOT_EXCLUDE_AD_UNITS

POD_POSITION_OUT_OF_RANGE

MIDROLL_POSITION_OUT_OF_RANGE

FEATURE_NOT_ENABLED

INVALID_ENVIRONMENT_TYPE

COMPANIONS_NOT_SUPPORTED

INVALID_CREATIVE_SIZE

INVALID_LINE_ITEM_TYPE

ORDERS_WITH_STANDARD_LINE_ITEMS_CANNOT_CONTAIN_HOUSE_OR_SPONSORSHIP_LINE_ITEMS

INVALID_COST_TYPE

COST_PER_UNIT_NOT_ALLOWED

DISCOUNT_NOT_ALLOWED

FRONTLOADED_DELIVERY_RATE_NOT_SUPPORTED

INVALID_LINE_ITEM_STATUS_CHANGE

INVALID_LINE_ITEM_PRIORITY

SYNC_REVISION_NOT_INCREASING

SYNC_REVISION_MUST_BE_GREATER_THAN_ZERO

CANNOT_UNARCHIVE_SET_TOP_BOX_LINE_ITEMS

COPY_SET_TOP_BOX_ENABLED_LINE_ITEM_NOT_ALLOWED

INVALID_LINE_ITEM_TYPE_CHANGE

CREATIVE_ROTATION_TYPE_MUST_BE_EVENLY_OR_WEIGHTED

INVALID_FREQUENCY_CAP_TIME_UNIT

INVALID_FREQUENCY_CAP_TIME_RANGE

INVALID_PRIMARY_GOAL_UNIT_TYPE

UNKNOWN

Method Detail

values

valueOf

value

fromValue