com.google.api.ads.dfp.axis.v201204
Class CustomField

java.lang.Object
  com.google.api.ads.dfp.axis.v201204.CustomField

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DropDownCustomField

public class CustomField
extends Object
implements Serializable

An additional, user-created field on an entity.

See Also:

Serialized Form

Constructor Summary

CustomField()

CustomField(Long id, String name, String description, Boolean isActive, CustomFieldEntityType entityType, CustomFieldDataType dataType, CustomFieldVisibility visibility, String customFieldType)

Method Summary

boolean	equals(Object obj)
String	getCustomFieldType() Gets the customFieldType value for this CustomField.
CustomFieldDataType	getDataType() Gets the dataType value for this CustomField.
String	getDescription() Gets the description value for this CustomField.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
CustomFieldEntityType	getEntityType() Gets the entityType value for this CustomField.
Long	getId() Gets the id value for this CustomField.
Boolean	getIsActive() Gets the isActive value for this CustomField.
String	getName() Gets the name value for this CustomField.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
CustomFieldVisibility	getVisibility() Gets the visibility value for this CustomField.
int	hashCode()
void	setCustomFieldType(String customFieldType) Sets the customFieldType value for this CustomField.
void	setDataType(CustomFieldDataType dataType) Sets the dataType value for this CustomField.
void	setDescription(String description) Sets the description value for this CustomField.
void	setEntityType(CustomFieldEntityType entityType) Sets the entityType value for this CustomField.
void	setId(Long id) Sets the id value for this CustomField.
void	setIsActive(Boolean isActive) Sets the isActive value for this CustomField.
void	setName(String name) Sets the name value for this CustomField.
void	setVisibility(CustomFieldVisibility visibility) Sets the visibility value for this CustomField.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomField

public CustomField()

CustomField

public CustomField(Long id,
                   String name,
                   String description,
                   Boolean isActive,
                   CustomFieldEntityType entityType,
                   CustomFieldDataType dataType,
                   CustomFieldVisibility visibility,
                   String customFieldType)

Method Detail

getId

public Long getId()

Gets the id value for this CustomField.

Returns:

id * Unique ID of the CustomField. This value is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this CustomField.

Parameters:

id - * Unique ID of the CustomField. This value is readonly and is assigned by Google.

getName

public String getName()

Gets the name value for this CustomField.

Returns:

name * Name of the CustomField. This is value is required to create a custom field. The max length is 127 characters.

setName

public void setName(String name)

Sets the name value for this CustomField.

Parameters:

name - * Name of the CustomField. This is value is required to create a custom field. The max length is 127 characters.

getDescription

public String getDescription()

Gets the description value for this CustomField.

Returns:

description * A description of the custom field. This value is optional. The maximum length is 511 characters

setDescription

public void setDescription(String description)

Sets the description value for this CustomField.

Parameters:

description - * A description of the custom field. This value is optional. The maximum length is 511 characters

getIsActive

public Boolean getIsActive()

Gets the isActive value for this CustomField.

Returns:

isActive * Specifies whether or not the custom fields is active. This attribute is read-only.

setIsActive

public void setIsActive(Boolean isActive)

Sets the isActive value for this CustomField.

Parameters:

isActive - * Specifies whether or not the custom fields is active. This attribute is read-only.

getEntityType

public CustomFieldEntityType getEntityType()

Gets the entityType value for this CustomField.

Returns:

entityType * The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field.

setEntityType

public void setEntityType(CustomFieldEntityType entityType)

Sets the entityType value for this CustomField.

Parameters:

entityType - * The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field.

getDataType

public CustomFieldDataType getDataType()

Gets the dataType value for this CustomField.

Returns:

dataType * The type of data this custom field contains. This attribute is read-only if there exists a CustomFieldValue for this field.

setDataType

public void setDataType(CustomFieldDataType dataType)

Sets the dataType value for this CustomField.

Parameters:

dataType - * The type of data this custom field contains. This attribute is read-only if there exists a CustomFieldValue for this field.

getVisibility

public CustomFieldVisibility getVisibility()

Gets the visibility value for this CustomField.

Returns:

visibility * How visible/accessible this field is in the UI.

setVisibility

public void setVisibility(CustomFieldVisibility visibility)

Sets the visibility value for this CustomField.

Parameters:

visibility - * How visible/accessible this field is in the UI.

getCustomFieldType

public String getCustomFieldType()

Gets the customFieldType value for this CustomField.

Returns:

customFieldType * Indicates that this instance is a subtype of CustomField. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

setCustomFieldType

public void setCustomFieldType(String customFieldType)

Sets the customFieldType value for this CustomField.

Parameters:

customFieldType - * Indicates that this instance is a subtype of CustomField. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer