com.google.api.ads.dfp.axis.v201211

Class ReportDownloadOptions

java.lang.Object

com.google.api.ads.dfp.axis.v201211.ReportDownloadOptions

All Implemented Interfaces:

Serializable

public class ReportDownloadOptions
extends Object
implements Serializable

Represents the options for an API report download request. See ReportService#getReportDownloadUrlWithOptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportDownloadOptions()
ReportDownloadOptions(ExportFormat exportFormat, Boolean includeReportProperties, Boolean includeTotalsRow, Boolean useGzipCompression)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
ExportFormat	getExportFormat() Gets the exportFormat value for this ReportDownloadOptions.
Boolean	getIncludeReportProperties() Gets the includeReportProperties value for this ReportDownloadOptions.
Boolean	getIncludeTotalsRow() Gets the includeTotalsRow value for this ReportDownloadOptions.
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
Boolean	getUseGzipCompression() Gets the useGzipCompression value for this ReportDownloadOptions.
int	hashCode()
void	setExportFormat(ExportFormat exportFormat) Sets the exportFormat value for this ReportDownloadOptions.
void	setIncludeReportProperties(Boolean includeReportProperties) Sets the includeReportProperties value for this ReportDownloadOptions.
void	setIncludeTotalsRow(Boolean includeTotalsRow) Sets the includeTotalsRow value for this ReportDownloadOptions.
void	setUseGzipCompression(Boolean useGzipCompression) Sets the useGzipCompression value for this ReportDownloadOptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDownloadOptions

public ReportDownloadOptions()

ReportDownloadOptions

public ReportDownloadOptions(ExportFormat exportFormat,
                     Boolean includeReportProperties,
                     Boolean includeTotalsRow,
                     Boolean useGzipCompression)

Method Detail

getExportFormat

public ExportFormat getExportFormat()

Gets the exportFormat value for this ReportDownloadOptions.

Returns:

exportFormat * The ExportFormat used to generate the report. Default value is ExportFormat.CSV_DUMP.

setExportFormat

public void setExportFormat(ExportFormat exportFormat)

Sets the exportFormat value for this ReportDownloadOptions.

Parameters:

exportFormat - * The ExportFormat used to generate the report. Default value is ExportFormat.CSV_DUMP.

getIncludeReportProperties

public Boolean getIncludeReportProperties()

Gets the includeReportProperties value for this ReportDownloadOptions.

Returns:

includeReportProperties * Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false.

setIncludeReportProperties

public void setIncludeReportProperties(Boolean includeReportProperties)

Sets the includeReportProperties value for this ReportDownloadOptions.

Parameters:

includeReportProperties - * Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false.

getIncludeTotalsRow

public Boolean getIncludeTotalsRow()

Gets the includeTotalsRow value for this ReportDownloadOptions.

Returns:

includeTotalsRow * Whether or not to include the totals row. Default is true for all formats except ExportFormat.CSV_DUMP.

setIncludeTotalsRow

public void setIncludeTotalsRow(Boolean includeTotalsRow)

Sets the includeTotalsRow value for this ReportDownloadOptions.

Parameters:

includeTotalsRow - * Whether or not to include the totals row. Default is true for all formats except ExportFormat.CSV_DUMP.

getUseGzipCompression

public Boolean getUseGzipCompression()

Gets the useGzipCompression value for this ReportDownloadOptions.

Returns:

useGzipCompression * Whether or not to compress the report file to a gzip file. Default is true.

Regardless of value, gzip http compression is available from the URL by normal means.

setUseGzipCompression

public void setUseGzipCompression(Boolean useGzipCompression)

Sets the useGzipCompression value for this ReportDownloadOptions.

Parameters:

useGzipCompression - * Whether or not to compress the report file to a gzip file. Default is true.

Regardless of value, gzip http compression is available from the URL by normal means.

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