RoadblockingType.java

// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


package com.google.api.ads.dfp.jaxws.v201605;

import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;


/**
 * <p>Java class for RoadblockingType.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * <p>
 * <pre>
 * <simpleType name="RoadblockingType">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="ONLY_ONE"/>
 *     <enumeration value="ONE_OR_MORE"/>
 *     <enumeration value="AS_MANY_AS_POSSIBLE"/>
 *     <enumeration value="ALL_ROADBLOCK"/>
 *     <enumeration value="CREATIVE_SET"/>
 *   </restriction>
 * </simpleType>
 * </pre>
 * 
 */
@XmlType(name = "RoadblockingType")
@XmlEnum
public enum RoadblockingType {


    /**
     * 
     *                 Only one creative from a line item can serve at a time.
     *               
     * 
     */
    ONLY_ONE,

    /**
     * 
     *                 Any number of creatives from a line item can serve together at a time.
     *               
     * 
     */
    ONE_OR_MORE,

    /**
     * 
     *                 As many creatives from a line item as can fit on a page will serve. This
     *                 could mean anywhere from one to all of a line item's creatives given the
     *                 size constraints of ad slots on a page.
     *               
     * 
     */
    AS_MANY_AS_POSSIBLE,

    /**
     * 
     *                 All or none of the creatives from a line item will serve. This option will only work if
     *                 served to a GPT tag using SRA (single request architecture mode).
     *               
     * 
     */
    ALL_ROADBLOCK,

    /**
     * 
     *                 A master/companion {@link CreativeSet} roadblocking type.
     *                 A {@link LineItem#creativePlaceholders} must be set accordingly.
     *               
     * 
     */
    CREATIVE_SET;

    public String value() {
        return name();
    }

    public static RoadblockingType fromValue(String v) {
        return valueOf(v);
    }

}