com.google.api.ads.adwords.v201109.cm
Class ReportDefinition

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.ReportDefinition

All Implemented Interfaces:

Serializable

public class ReportDefinition
extends Object
implements Serializable

Represents a report definition.

See Also:

Serialized Form

Constructor Summary

ReportDefinition()

ReportDefinition(Long id, Selector selector, String reportName, ReportDefinitionReportType reportType, Boolean hasAttachment, ReportDefinitionDateRangeType dateRangeType, DownloadFormat downloadFormat, String creationTime, Boolean includeZeroImpressions)

Method Summary

boolean	equals(Object obj)
String	getCreationTime() Gets the creationTime value for this ReportDefinition.
ReportDefinitionDateRangeType	getDateRangeType() Gets the dateRangeType value for this ReportDefinition.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
DownloadFormat	getDownloadFormat() Gets the downloadFormat value for this ReportDefinition.
Boolean	getHasAttachment() Gets the hasAttachment value for this ReportDefinition.
Long	getId() Gets the id value for this ReportDefinition.
Boolean	getIncludeZeroImpressions() Gets the includeZeroImpressions value for this ReportDefinition.
String	getReportName() Gets the reportName value for this ReportDefinition.
ReportDefinitionReportType	getReportType() Gets the reportType value for this ReportDefinition.
Selector	getSelector() Gets the selector value for this ReportDefinition.
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
int	hashCode()
void	setCreationTime(String creationTime) Sets the creationTime value for this ReportDefinition.
void	setDateRangeType(ReportDefinitionDateRangeType dateRangeType) Sets the dateRangeType value for this ReportDefinition.
void	setDownloadFormat(DownloadFormat downloadFormat) Sets the downloadFormat value for this ReportDefinition.
void	setHasAttachment(Boolean hasAttachment) Sets the hasAttachment value for this ReportDefinition.
void	setId(Long id) Sets the id value for this ReportDefinition.
void	setIncludeZeroImpressions(Boolean includeZeroImpressions) Sets the includeZeroImpressions value for this ReportDefinition.
void	setReportName(String reportName) Sets the reportName value for this ReportDefinition.
void	setReportType(ReportDefinitionReportType reportType) Sets the reportType value for this ReportDefinition.
void	setSelector(Selector selector) Sets the selector value for this ReportDefinition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDefinition

public ReportDefinition()

ReportDefinition

public ReportDefinition(Long id,
                        Selector selector,
                        String reportName,
                        ReportDefinitionReportType reportType,
                        Boolean hasAttachment,
                        ReportDefinitionDateRangeType dateRangeType,
                        DownloadFormat downloadFormat,
                        String creationTime,
                        Boolean includeZeroImpressions)

Method Detail

getId

public Long getId()

Gets the id value for this ReportDefinition.

Returns:

id * ID of this report definition. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored. This field is required and should not be null when it is contained within Operators : SET, REMOVE.

setId

public void setId(Long id)

Sets the id value for this ReportDefinition.

Parameters:

id - * ID of this report definition. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored. This field is required and should not be null when it is contained within Operators : SET, REMOVE.

getSelector

public Selector getSelector()

Gets the selector value for this ReportDefinition.

Returns:

selector * Defines the report fields and the filters for this report definition. This field is required when creating a new report definition.

setSelector

public void setSelector(Selector selector)

Sets the selector value for this ReportDefinition.

Parameters:

selector - * Defines the report fields and the filters for this report definition. This field is required when creating a new report definition.

getReportName

public String getReportName()

Gets the reportName value for this ReportDefinition.

Returns:

reportName * Name of the report definition. This field is required and should not be null when it is contained within Operators : ADD. This string must not be empty.

setReportName

public void setReportName(String reportName)

Sets the reportName value for this ReportDefinition.

Parameters:

reportName - * Name of the report definition. This field is required and should not be null when it is contained within Operators : ADD. This string must not be empty.

getReportType

public ReportDefinitionReportType getReportType()

Gets the reportType value for this ReportDefinition.

Returns:

reportType * Type of the report. This field is required and should not be null when it is contained within Operators : ADD.

setReportType

public void setReportType(ReportDefinitionReportType reportType)

Sets the reportType value for this ReportDefinition.

Parameters:

reportType - * Type of the report. This field is required and should not be null when it is contained within Operators : ADD.

getHasAttachment

public Boolean getHasAttachment()

Gets the hasAttachment value for this ReportDefinition.

Returns:

hasAttachment * Flag to indicate whether report will be sent as email attachment.

setHasAttachment

public void setHasAttachment(Boolean hasAttachment)

Sets the hasAttachment value for this ReportDefinition.

Parameters:

hasAttachment - * Flag to indicate whether report will be sent as email attachment.

getDateRangeType

public ReportDefinitionDateRangeType getDateRangeType()

Gets the dateRangeType value for this ReportDefinition.

Returns:

dateRangeType * Date range for running report. This field is required and should not be null when it is contained within Operators : ADD.

setDateRangeType

public void setDateRangeType(ReportDefinitionDateRangeType dateRangeType)

Sets the dateRangeType value for this ReportDefinition.

Parameters:

dateRangeType - * Date range for running report. This field is required and should not be null when it is contained within Operators : ADD.

getDownloadFormat

public DownloadFormat getDownloadFormat()

Gets the downloadFormat value for this ReportDefinition.

Returns:

downloadFormat * Download format of report contents. This field is required and should not be null when it is contained within Operators : ADD.

setDownloadFormat

public void setDownloadFormat(DownloadFormat downloadFormat)

Sets the downloadFormat value for this ReportDefinition.

Parameters:

downloadFormat - * Download format of report contents. This field is required and should not be null when it is contained within Operators : ADD.

getCreationTime

public String getCreationTime()

Gets the creationTime value for this ReportDefinition.

Returns:

creationTime * Creation time of ReportDefinition. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setCreationTime

public void setCreationTime(String creationTime)

Sets the creationTime value for this ReportDefinition.

Parameters:

creationTime - * Creation time of ReportDefinition. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getIncludeZeroImpressions

public Boolean getIncludeZeroImpressions()

Gets the includeZeroImpressions value for this ReportDefinition.

Returns:

includeZeroImpressions * Indicates whether the report output should include rows that do not have any impressions associated with them. Setting this value to false will guarantee that zero impression rows will not be returned. Some fields do not support zero impression rows, so when those fields are selected zero impression rows will not be included even though this field is set to true.

setIncludeZeroImpressions

public void setIncludeZeroImpressions(Boolean includeZeroImpressions)

Sets the includeZeroImpressions value for this ReportDefinition.

Parameters:

includeZeroImpressions - * Indicates whether the report output should include rows that do not have any impressions associated with them. Setting this value to false will guarantee that zero impression rows will not be returned. Some fields do not support zero impression rows, so when those fields are selected zero impression rows will not be included even though this field is set to true.

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