AdExclusionRuleErrorReason.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 AdExclusionRuleError.Reason.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * <p>
 * <pre>
 * <simpleType name="AdExclusionRuleError.Reason">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="BLOCK_ALL_RULE_CANNOT_INCLUDE_ROOT_AD_UNIT"/>
 *     <enumeration value="BLOCK_ALL_RULE_CANNOT_HAVE_BLOCKED_LABELS"/>
 *     <enumeration value="BLOCK_ALL_RULE_MUST_CONTAIN_ALLOWED_LABELS"/>
 *     <enumeration value="RULE_MUST_CONTAIN_BLOCKING"/>
 *     <enumeration value="BLOCKED_LABEL_ALSO_ALLOWED"/>
 *     <enumeration value="LABELS_MUST_BE_AD_EXCLUSION_TYPE"/>
 *     <enumeration value="EXCLUDED_AD_UNIT_ALSO_INCLUDED"/>
 *     <enumeration value="UNKNOWN"/>
 *   </restriction>
 * </simpleType>
 * </pre>
 * 
 */
@XmlType(name = "AdExclusionRuleError.Reason")
@XmlEnum
public enum AdExclusionRuleErrorReason {


    /**
     * 
     *                 The {@link AdExclusionRule#inventoryTargeting} cannot target the root ad unit if
     *                 {@link AdExclusionRule#isBlockAll} is true.
     *               
     * 
     */
    BLOCK_ALL_RULE_CANNOT_INCLUDE_ROOT_AD_UNIT,

    /**
     * 
     *                 The {@link AdExclusionRule#blockedLabelIds} must be empty if
     *                 {@link AdExclusionRule#isBlockAll} is true.
     *               
     * 
     */
    BLOCK_ALL_RULE_CANNOT_HAVE_BLOCKED_LABELS,

    /**
     * 
     *                 The {@link AdExclusionRule#allowedLabelIds} must contain allowed labels if
     *                 {@link AdExclusionRule#isBlockAll} is true.
     *               
     * 
     */
    BLOCK_ALL_RULE_MUST_CONTAIN_ALLOWED_LABELS,

    /**
     * 
     *                 The {@link AdExclusionRule} must contain blocking information.
     *               
     * 
     */
    RULE_MUST_CONTAIN_BLOCKING,

    /**
     * 
     *                 The same label ID cannot be contained in both {@link AdExclusionRule#allowedLabelIds} and
     *                 {@link AdExclusionRule#blockedLabelIds}.
     *               
     * 
     */
    BLOCKED_LABEL_ALSO_ALLOWED,

    /**
     * 
     *                 Label IDs included in {@link AdExclusionRule#allowedLabelIds} and
     *                 {@link AdExclusionRule#blockedLabelIds} must correspond to {@link Label} objects with type
     *                 {@link Label#AD_EXCLUSION}.
     *               
     * 
     */
    LABELS_MUST_BE_AD_EXCLUSION_TYPE,

    /**
     * 
     *                 The same ad unit cannot be included in both {@link InventoryTargeting#targetedAdUnits} and
     *                 {@link InventoryTargeting#excludedAdUnits} in {@link AdExclusionRule#inventoryTargeting}.
     *               
     * 
     */
    EXCLUDED_AD_UNIT_ALSO_INCLUDED,

    /**
     * 
     *                 The value returned if the actual value is not exposed by the requested API version.
     *               
     * 
     */
    UNKNOWN;

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

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

}