com.google.api.ads.dfp.jaxws.v201711

Enum CustomTargetingErrorReason

java.lang.Object

java.lang.Enum<CustomTargetingErrorReason>

com.google.api.ads.dfp.jaxws.v201711.CustomTargetingErrorReason

All Implemented Interfaces:

Serializable, Comparable<CustomTargetingErrorReason>

public enum CustomTargetingErrorReason
extends Enum<CustomTargetingErrorReason>

Java class for CustomTargetingError.Reason.

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

 <simpleType name="CustomTargetingError.Reason">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="KEY_NOT_FOUND"/>
     <enumeration value="KEY_COUNT_TOO_LARGE"/>
     <enumeration value="KEY_NAME_DUPLICATE"/>
     <enumeration value="KEY_NAME_EMPTY"/>
     <enumeration value="KEY_NAME_INVALID_LENGTH"/>
     <enumeration value="KEY_NAME_INVALID_CHARS"/>
     <enumeration value="KEY_NAME_RESERVED"/>
     <enumeration value="KEY_DISPLAY_NAME_INVALID_LENGTH"/>
     <enumeration value="VALUE_NOT_FOUND"/>
     <enumeration value="GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID"/>
     <enumeration value="VALUE_COUNT_FOR_KEY_TOO_LARGE"/>
     <enumeration value="VALUE_NAME_DUPLICATE"/>
     <enumeration value="VALUE_NAME_EMPTY"/>
     <enumeration value="VALUE_NAME_INVALID_LENGTH"/>
     <enumeration value="VALUE_NAME_INVALID_CHARS"/>
     <enumeration value="VALUE_DISPLAY_NAME_INVALID_LENGTH"/>
     <enumeration value="VALUE_MATCH_TYPE_NOT_ALLOWED"/>
     <enumeration value="VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY"/>
     <enumeration value="SUFFIX_MATCH_TYPE_NOT_ALLOWED"/>
     <enumeration value="CONTAINS_MATCH_TYPE_NOT_ALLOWED"/>
     <enumeration value="KEY_WITH_MISSING_VALUES"/>
     <enumeration value="CANNOT_OR_DIFFERENT_KEYS"/>
     <enumeration value="INVALID_TARGETING_EXPRESSION"/>
     <enumeration value="DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING"/>
     <enumeration value="DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING"/>
     <enumeration value="VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING"/>
     <enumeration value="CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING"/>
     <enumeration value="CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING"/>
     <enumeration value="CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING"/>
     <enumeration value="CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING"/>
     <enumeration value="CANNOT_TARGET_AUDIENCE_SEGMENT"/>
     <enumeration value="CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT"/>
     <enumeration value="INVALID_AUDIENCE_SEGMENTS"/>
     <enumeration value="ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED"/>
     <enumeration value="UNKNOWN"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING Only active custom-criteria keys are supported in content metadata mapping.
CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING Cannot delete a custom criteria key that is targeted by an active partner assignment.
CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING Only active custom-criteria values are supported in content metadata mapping.
CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING Cannot delete a custom criteria value that is targeted by an active partner assignment.
CANNOT_OR_DIFFERENT_KEYS CustomCriteriaSet.LogicalOperator#OR operation cannot be applied to values with different keys.
CANNOT_TARGET_AUDIENCE_SEGMENT AudienceSegment object cannot be targeted.
CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT Inactive AudienceSegment object cannot be targeted.
CONTAINS_MATCH_TYPE_NOT_ALLOWED CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType#CONTAINS when adding a CustomTargetingValue to targeting expression of a line item.
DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING The key has been deleted.
DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING The value has been deleted.
GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query.
INVALID_AUDIENCE_SEGMENTS Targeted AudienceSegment object is not valid.
INVALID_TARGETING_EXPRESSION Targeting expression is invalid.
KEY_COUNT_TOO_LARGE Number of CustomTargetingKey objects created exceeds the limit allowed for the network.
KEY_DISPLAY_NAME_INVALID_LENGTH CustomTargetingKey.displayName is too long.
KEY_NAME_DUPLICATE CustomTargetingKey with the same CustomTargetingKey.name already exists.
KEY_NAME_EMPTY CustomTargetingKey.name is empty.
KEY_NAME_INVALID_CHARS CustomTargetingKey.name contains unsupported or reserved characters.
KEY_NAME_INVALID_LENGTH CustomTargetingKey.name is too long.
KEY_NAME_RESERVED CustomTargetingKey.name matches one of the reserved custom targeting key names.
KEY_NOT_FOUND Requested CustomTargetingKey is not found.
KEY_WITH_MISSING_VALUES The CustomTargetingKey does not have any CustomTargetingValue associated with it.
ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED Targeted AudienceSegment objects have not been approved.
SUFFIX_MATCH_TYPE_NOT_ALLOWED CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType#SUFFIX when adding a CustomTargetingValue to a line item.
UNKNOWN The value returned if the actual value is not exposed by the requested API version.
VALUE_COUNT_FOR_KEY_TOO_LARGE The number of CustomTargetingValue objects associated with a CustomTargetingKey exceeds the network limit.
VALUE_DISPLAY_NAME_INVALID_LENGTH CustomTargetingValue.displayName is too long.
VALUE_MATCH_TYPE_NOT_ALLOWED Only DFP Premium networks can have CustomTargetingValue.matchType other than CustomTargetingValue.MatchType#EXACT.
VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType#EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type#PREDEFINED
VALUE_NAME_DUPLICATE CustomTargetingValue with the same CustomTargetingValue.name already exists.
VALUE_NAME_EMPTY CustomTargetingValue.name is empty.
VALUE_NAME_INVALID_CHARS CustomTargetingValue.name contains unsupported or reserved characters.
VALUE_NAME_INVALID_LENGTH CustomTargetingValue.name is too long.
VALUE_NOT_FOUND Requested CustomTargetingValue is not found.
VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING The key is set as the video browse-by key, which cannot be used for custom targeting.

Method Summary

Modifier and Type	Method and Description
static CustomTargetingErrorReason	fromValue(String v)
String	value()
static CustomTargetingErrorReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static CustomTargetingErrorReason[]	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

KEY_NOT_FOUND

public static final CustomTargetingErrorReason KEY_NOT_FOUND

Requested CustomTargetingKey is not found.

KEY_COUNT_TOO_LARGE

public static final CustomTargetingErrorReason KEY_COUNT_TOO_LARGE

Number of CustomTargetingKey objects created exceeds the limit allowed for the network.

KEY_NAME_DUPLICATE

public static final CustomTargetingErrorReason KEY_NAME_DUPLICATE

CustomTargetingKey with the same CustomTargetingKey.name already exists.

KEY_NAME_EMPTY

public static final CustomTargetingErrorReason KEY_NAME_EMPTY

CustomTargetingKey.name is empty.

KEY_NAME_INVALID_LENGTH

public static final CustomTargetingErrorReason KEY_NAME_INVALID_LENGTH

CustomTargetingKey.name is too long.

KEY_NAME_INVALID_CHARS

public static final CustomTargetingErrorReason KEY_NAME_INVALID_CHARS

CustomTargetingKey.name contains unsupported or reserved characters.

KEY_NAME_RESERVED

public static final CustomTargetingErrorReason KEY_NAME_RESERVED

CustomTargetingKey.name matches one of the reserved custom targeting key names.

KEY_DISPLAY_NAME_INVALID_LENGTH

public static final CustomTargetingErrorReason KEY_DISPLAY_NAME_INVALID_LENGTH

CustomTargetingKey.displayName is too long.

VALUE_NOT_FOUND

public static final CustomTargetingErrorReason VALUE_NOT_FOUND

Requested CustomTargetingValue is not found.

GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID

public static final CustomTargetingErrorReason GET_VALUES_BY_STATEMENT_MUST_CONTAIN_KEY_ID

The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query.

VALUE_COUNT_FOR_KEY_TOO_LARGE

public static final CustomTargetingErrorReason VALUE_COUNT_FOR_KEY_TOO_LARGE

The number of CustomTargetingValue objects associated with a CustomTargetingKey exceeds the network limit. This is only applicable for keys of type CustomTargetingKey.Type#PREDEFINED.

VALUE_NAME_DUPLICATE

public static final CustomTargetingErrorReason VALUE_NAME_DUPLICATE

CustomTargetingValue with the same CustomTargetingValue.name already exists.

VALUE_NAME_EMPTY

public static final CustomTargetingErrorReason VALUE_NAME_EMPTY

CustomTargetingValue.name is empty.

VALUE_NAME_INVALID_LENGTH

public static final CustomTargetingErrorReason VALUE_NAME_INVALID_LENGTH

CustomTargetingValue.name is too long.

VALUE_NAME_INVALID_CHARS

public static final CustomTargetingErrorReason VALUE_NAME_INVALID_CHARS

CustomTargetingValue.name contains unsupported or reserved characters.

VALUE_DISPLAY_NAME_INVALID_LENGTH

public static final CustomTargetingErrorReason VALUE_DISPLAY_NAME_INVALID_LENGTH

CustomTargetingValue.displayName is too long.

VALUE_MATCH_TYPE_NOT_ALLOWED

public static final CustomTargetingErrorReason VALUE_MATCH_TYPE_NOT_ALLOWED

Only DFP Premium networks can have CustomTargetingValue.matchType other than CustomTargetingValue.MatchType#EXACT.

VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY

public static final CustomTargetingErrorReason VALUE_MATCH_TYPE_NOT_EXACT_FOR_PREDEFINED_KEY

You can only create CustomTargetingValue objects with match type CustomTargetingValue.MatchType#EXACT when associating with CustomTargetingKey objects of type CustomTargetingKey.Type#PREDEFINED

SUFFIX_MATCH_TYPE_NOT_ALLOWED

public static final CustomTargetingErrorReason SUFFIX_MATCH_TYPE_NOT_ALLOWED

CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType#SUFFIX when adding a CustomTargetingValue to a line item.

CONTAINS_MATCH_TYPE_NOT_ALLOWED

public static final CustomTargetingErrorReason CONTAINS_MATCH_TYPE_NOT_ALLOWED

CustomTargetingValue object cannot have match type of CustomTargetingValue.MatchType#CONTAINS when adding a CustomTargetingValue to targeting expression of a line item.

KEY_WITH_MISSING_VALUES

public static final CustomTargetingErrorReason KEY_WITH_MISSING_VALUES

The CustomTargetingKey does not have any CustomTargetingValue associated with it.

CANNOT_OR_DIFFERENT_KEYS

public static final CustomTargetingErrorReason CANNOT_OR_DIFFERENT_KEYS

CustomCriteriaSet.LogicalOperator#OR operation cannot be applied to values with different keys.

INVALID_TARGETING_EXPRESSION

public static final CustomTargetingErrorReason INVALID_TARGETING_EXPRESSION

Targeting expression is invalid. This can happen if the sequence of operators is wrong, or a node contains invalid number of children.

DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING

public static final CustomTargetingErrorReason DELETED_KEY_CANNOT_BE_USED_FOR_TARGETING

The key has been deleted. CustomCriteria cannot have deleted keys.

DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING

public static final CustomTargetingErrorReason DELETED_VALUE_CANNOT_BE_USED_FOR_TARGETING

The value has been deleted. CustomCriteria cannot have deleted values.

VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING

public static final CustomTargetingErrorReason VIDEO_BROWSE_BY_KEY_CANNOT_BE_USED_FOR_CUSTOM_TARGETING

The key is set as the video browse-by key, which cannot be used for custom targeting.

CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING

public static final CustomTargetingErrorReason CANNOT_DELETE_CUSTOM_KEY_USED_IN_CONTENT_METADATA_MAPPING

Only active custom-criteria keys are supported in content metadata mapping.

CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING

public static final CustomTargetingErrorReason CANNOT_DELETE_CUSTOM_VALUE_USED_IN_CONTENT_METADATA_MAPPING

Only active custom-criteria values are supported in content metadata mapping.

CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING

public static final CustomTargetingErrorReason CANNOT_DELETE_CUSTOM_KEY_USED_IN_PARTNER_ASSIGNMENT_TARGETING

Cannot delete a custom criteria key that is targeted by an active partner assignment.

CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING

public static final CustomTargetingErrorReason CANNOT_DELETE_CUSTOM_VALUE_USED_IN_PARTNER_ASSIGNMENT_TARGETING

Cannot delete a custom criteria value that is targeted by an active partner assignment.

CANNOT_TARGET_AUDIENCE_SEGMENT

public static final CustomTargetingErrorReason CANNOT_TARGET_AUDIENCE_SEGMENT

AudienceSegment object cannot be targeted.

CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT

public static final CustomTargetingErrorReason CANNOT_TARGET_INACTIVE_AUDIENCE_SEGMENT

Inactive AudienceSegment object cannot be targeted.

INVALID_AUDIENCE_SEGMENTS

public static final CustomTargetingErrorReason INVALID_AUDIENCE_SEGMENTS

Targeted AudienceSegment object is not valid.

ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED

public static final CustomTargetingErrorReason ONLY_APPROVED_AUDIENCE_SEGMENTS_CAN_BE_TARGETED

Targeted AudienceSegment objects have not been approved.

UNKNOWN

public static final CustomTargetingErrorReason UNKNOWN

The value returned if the actual value is not exposed by the requested API version.

Method Detail

values

public static CustomTargetingErrorReason[] 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 (CustomTargetingErrorReason c : CustomTargetingErrorReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CustomTargetingErrorReason 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 CustomTargetingErrorReason fromValue(String v)