com.google.api.ads.dfp.axis.v201311

Class LineItemCreativeAssociation

java.lang.Object

com.google.api.ads.dfp.axis.v201311.LineItemCreativeAssociation

All Implemented Interfaces:

Serializable

public class LineItemCreativeAssociation
extends Object
implements Serializable

A LineItemCreativeAssociation associates a Creative or CreativeSet with a LineItem so that the creative can be served in ad units targeted by the line item.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LineItemCreativeAssociation()
LineItemCreativeAssociation(Long lineItemId, Long creativeId, Long creativeSetId, Double manualCreativeRotationWeight, Integer sequentialCreativeRotationIndex, DateTime startDateTime, StartDateTimeType startDateTimeType, DateTime endDateTime, String destinationUrl, Size[] sizes, LineItemCreativeAssociationStatus status, LineItemCreativeAssociationStats stats, DateTime lastModifiedDateTime)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getCreativeId() Gets the creativeId value for this LineItemCreativeAssociation.
Long	getCreativeSetId() Gets the creativeSetId value for this LineItemCreativeAssociation.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getDestinationUrl() Gets the destinationUrl value for this LineItemCreativeAssociation.
DateTime	getEndDateTime() Gets the endDateTime value for this LineItemCreativeAssociation.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this LineItemCreativeAssociation.
Long	getLineItemId() Gets the lineItemId value for this LineItemCreativeAssociation.
Double	getManualCreativeRotationWeight() Gets the manualCreativeRotationWeight value for this LineItemCreativeAssociation.
Integer	getSequentialCreativeRotationIndex() Gets the sequentialCreativeRotationIndex value for this LineItemCreativeAssociation.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Size[]	getSizes() Gets the sizes value for this LineItemCreativeAssociation.
Size	getSizes(int i)
DateTime	getStartDateTime() Gets the startDateTime value for this LineItemCreativeAssociation.
StartDateTimeType	getStartDateTimeType() Gets the startDateTimeType value for this LineItemCreativeAssociation.
LineItemCreativeAssociationStats	getStats() Gets the stats value for this LineItemCreativeAssociation.
LineItemCreativeAssociationStatus	getStatus() Gets the status value for this LineItemCreativeAssociation.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setCreativeId(Long creativeId) Sets the creativeId value for this LineItemCreativeAssociation.
void	setCreativeSetId(Long creativeSetId) Sets the creativeSetId value for this LineItemCreativeAssociation.
void	setDestinationUrl(String destinationUrl) Sets the destinationUrl value for this LineItemCreativeAssociation.
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this LineItemCreativeAssociation.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this LineItemCreativeAssociation.
void	setLineItemId(Long lineItemId) Sets the lineItemId value for this LineItemCreativeAssociation.
void	setManualCreativeRotationWeight(Double manualCreativeRotationWeight) Sets the manualCreativeRotationWeight value for this LineItemCreativeAssociation.
void	setSequentialCreativeRotationIndex(Integer sequentialCreativeRotationIndex) Sets the sequentialCreativeRotationIndex value for this LineItemCreativeAssociation.
void	setSizes(int i, Size _value)
void	setSizes(Size[] sizes) Sets the sizes value for this LineItemCreativeAssociation.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this LineItemCreativeAssociation.
void	setStartDateTimeType(StartDateTimeType startDateTimeType) Sets the startDateTimeType value for this LineItemCreativeAssociation.
void	setStats(LineItemCreativeAssociationStats stats) Sets the stats value for this LineItemCreativeAssociation.
void	setStatus(LineItemCreativeAssociationStatus status) Sets the status value for this LineItemCreativeAssociation.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineItemCreativeAssociation

public LineItemCreativeAssociation()

LineItemCreativeAssociation

public LineItemCreativeAssociation(Long lineItemId,
                           Long creativeId,
                           Long creativeSetId,
                           Double manualCreativeRotationWeight,
                           Integer sequentialCreativeRotationIndex,
                           DateTime startDateTime,
                           StartDateTimeType startDateTimeType,
                           DateTime endDateTime,
                           String destinationUrl,
                           Size[] sizes,
                           LineItemCreativeAssociationStatus status,
                           LineItemCreativeAssociationStats stats,
                           DateTime lastModifiedDateTime)

Method Detail

getLineItemId

public Long getLineItemId()

Gets the lineItemId value for this LineItemCreativeAssociation.

Returns:

lineItemId * The ID of the LineItem to which the Creative should be associated. This attribute is required.

setLineItemId

public void setLineItemId(Long lineItemId)

Sets the lineItemId value for this LineItemCreativeAssociation.

Parameters:

lineItemId - * The ID of the LineItem to which the Creative should be associated. This attribute is required.

getCreativeId

public Long getCreativeId()

Gets the creativeId value for this LineItemCreativeAssociation.

Returns:

creativeId * The ID of the Creative being associated with a LineItem.

This attribute is required if this is an association between a line item and a creative.
This attribute is ignored if this is an association between a line item and a creative set.

If this is an association between a line item and a creative, when retrieving the line item creative association, the #creativeId] will be the creative's ID.
If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

setCreativeId

public void setCreativeId(Long creativeId)

Sets the creativeId value for this LineItemCreativeAssociation.

Parameters:

creativeId - * The ID of the Creative being associated with a LineItem.

This attribute is required if this is an association between a line item and a creative.
This attribute is ignored if this is an association between a line item and a creative set.

If this is an association between a line item and a creative, when retrieving the line item creative association, the #creativeId] will be the creative's ID.
If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

getCreativeSetId

public Long getCreativeSetId()

Gets the creativeSetId value for this LineItemCreativeAssociation.

Returns:

creativeSetId * The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set.

This field will be null when retrieving associations between line items and creatives not belonging to a set.

setCreativeSetId

public void setCreativeSetId(Long creativeSetId)

Sets the creativeSetId value for this LineItemCreativeAssociation.

Parameters:

creativeSetId - * The ID of the CreativeSet being associated with a LineItem. This attribute is required if this is an association between a line item and a creative set.

This field will be null when retrieving associations between line items and creatives not belonging to a set.

getManualCreativeRotationWeight

public Double getManualCreativeRotationWeight()

Gets the manualCreativeRotationWeight value for this LineItemCreativeAssociation.

Returns:

manualCreativeRotationWeight * The weight of the Creative. This value is only used if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10.

setManualCreativeRotationWeight

public void setManualCreativeRotationWeight(Double manualCreativeRotationWeight)

Sets the manualCreativeRotationWeight value for this LineItemCreativeAssociation.

Parameters:

manualCreativeRotationWeight - * The weight of the Creative. This value is only used if the line item's creativeRotationType is set to CreativeRotationType.MANUAL. This attribute is optional and defaults to 10.

getSequentialCreativeRotationIndex

public Integer getSequentialCreativeRotationIndex()

Gets the sequentialCreativeRotationIndex value for this LineItemCreativeAssociation.

Returns:

sequentialCreativeRotationIndex * The sequential rotation index of the Creative. This value is used only if the associated line item's LineItemSummary.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1.

setSequentialCreativeRotationIndex

public void setSequentialCreativeRotationIndex(Integer sequentialCreativeRotationIndex)

Sets the sequentialCreativeRotationIndex value for this LineItemCreativeAssociation.

Parameters:

sequentialCreativeRotationIndex - * The sequential rotation index of the Creative. This value is used only if the associated line item's LineItemSummary.creativeRotationType is set to CreativeRotationType.SEQUENTIAL. This attribute is optional and defaults to 1.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this LineItemCreativeAssociation.

Returns:

startDateTime * Overrides the value set for LineItemSummary.startDateTime. This value is optional and is only valid for DFP premium networks.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this LineItemCreativeAssociation.

Parameters:

startDateTime - * Overrides the value set for LineItemSummary.startDateTime. This value is optional and is only valid for DFP premium networks.

getStartDateTimeType

public StartDateTimeType getStartDateTimeType()

Gets the startDateTimeType value for this LineItemCreativeAssociation.

Returns:

startDateTimeType * Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

setStartDateTimeType

public void setStartDateTimeType(StartDateTimeType startDateTimeType)

Sets the startDateTimeType value for this LineItemCreativeAssociation.

Parameters:

startDateTimeType - * Specifies whether to start serving to the LineItemCreativeAssociation right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this LineItemCreativeAssociation.

Returns:

endDateTime * Overrides LineItemSummary.endDateTime. This value is optional and is only valid for DFP premium networks.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this LineItemCreativeAssociation.

Parameters:

endDateTime - * Overrides LineItemSummary.endDateTime. This value is optional and is only valid for DFP premium networks.

getDestinationUrl

public String getDestinationUrl()

Gets the destinationUrl value for this LineItemCreativeAssociation.

Returns:

destinationUrl * Overrides the value set for HasDestinationUrlCreative.destinationUrl. This value is optional and is only valid for DFP premium networks.

setDestinationUrl

public void setDestinationUrl(String destinationUrl)

Sets the destinationUrl value for this LineItemCreativeAssociation.

Parameters:

destinationUrl - * Overrides the value set for HasDestinationUrlCreative.destinationUrl. This value is optional and is only valid for DFP premium networks.

getSizes

public Size[] getSizes()

Gets the sizes value for this LineItemCreativeAssociation.

Returns:

sizes * Overrides the value set for Creative.size, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.

setSizes

public void setSizes(Size[] sizes)

Sets the sizes value for this LineItemCreativeAssociation.

Parameters:

sizes - * Overrides the value set for Creative.size, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.

getSizes

public Size getSizes(int i)

setSizes

public void setSizes(int i,
            Size _value)

getStatus

public LineItemCreativeAssociationStatus getStatus()

Gets the status value for this LineItemCreativeAssociation.

Returns:

status * The status of the association. This attribute is read-only.

setStatus

public void setStatus(LineItemCreativeAssociationStatus status)

Sets the status value for this LineItemCreativeAssociation.

Parameters:

status - * The status of the association. This attribute is read-only.

getStats

public LineItemCreativeAssociationStats getStats()

Gets the stats value for this LineItemCreativeAssociation.

Returns:

stats * Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for the association yet.

setStats

public void setStats(LineItemCreativeAssociationStats stats)

Sets the stats value for this LineItemCreativeAssociation.

Parameters:

stats - * Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for the association yet.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this LineItemCreativeAssociation.

Returns:

lastModifiedDateTime * The date and time this association was last modified.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this LineItemCreativeAssociation.

Parameters:

lastModifiedDateTime - * The date and time this association was last modified.

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