com.google.api.ads.dfp.axis.v201306

Class ReportQuery

java.lang.Object

com.google.api.ads.dfp.axis.v201306.ReportQuery

All Implemented Interfaces:

Serializable

public class ReportQuery
extends Object
implements Serializable

A ReportQuery object allows you to specify the selection criteria for generating a report.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportQuery()
ReportQuery(Dimension[] dimensions, ReportQueryAdUnitView adUnitView, Column[] columns, DimensionAttribute[] dimensionAttributes, long[] customFieldIds, Date startDate, Date endDate, DateRangeType dateRangeType, DimensionFilter[] dimensionFilters, Statement statement, String timeZone)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
ReportQueryAdUnitView	getAdUnitView() Gets the adUnitView value for this ReportQuery.
Column[]	getColumns() Gets the columns value for this ReportQuery.
Column	getColumns(int i)
long[]	getCustomFieldIds() Gets the customFieldIds value for this ReportQuery.
long	getCustomFieldIds(int i)
DateRangeType	getDateRangeType() Gets the dateRangeType value for this ReportQuery.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
DimensionAttribute[]	getDimensionAttributes() Gets the dimensionAttributes value for this ReportQuery.
DimensionAttribute	getDimensionAttributes(int i)
DimensionFilter[]	getDimensionFilters() Gets the dimensionFilters value for this ReportQuery.
DimensionFilter	getDimensionFilters(int i)
Dimension[]	getDimensions() Gets the dimensions value for this ReportQuery.
Dimension	getDimensions(int i)
Date	getEndDate() Gets the endDate value for this ReportQuery.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Date	getStartDate() Gets the startDate value for this ReportQuery.
Statement	getStatement() Gets the statement value for this ReportQuery.
String	getTimeZone() Gets the timeZone value for this ReportQuery.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAdUnitView(ReportQueryAdUnitView adUnitView) Sets the adUnitView value for this ReportQuery.
void	setColumns(Column[] columns) Sets the columns value for this ReportQuery.
void	setColumns(int i, Column _value)
void	setCustomFieldIds(int i, long _value)
void	setCustomFieldIds(long[] customFieldIds) Sets the customFieldIds value for this ReportQuery.
void	setDateRangeType(DateRangeType dateRangeType) Sets the dateRangeType value for this ReportQuery.
void	setDimensionAttributes(DimensionAttribute[] dimensionAttributes) Sets the dimensionAttributes value for this ReportQuery.
void	setDimensionAttributes(int i, DimensionAttribute _value)
void	setDimensionFilters(DimensionFilter[] dimensionFilters) Sets the dimensionFilters value for this ReportQuery.
void	setDimensionFilters(int i, DimensionFilter _value)
void	setDimensions(Dimension[] dimensions) Sets the dimensions value for this ReportQuery.
void	setDimensions(int i, Dimension _value)
void	setEndDate(Date endDate) Sets the endDate value for this ReportQuery.
void	setStartDate(Date startDate) Sets the startDate value for this ReportQuery.
void	setStatement(Statement statement) Sets the statement value for this ReportQuery.
void	setTimeZone(String timeZone) Sets the timeZone value for this ReportQuery.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportQuery

public ReportQuery()

ReportQuery

public ReportQuery(Dimension[] dimensions,
           ReportQueryAdUnitView adUnitView,
           Column[] columns,
           DimensionAttribute[] dimensionAttributes,
           long[] customFieldIds,
           Date startDate,
           Date endDate,
           DateRangeType dateRangeType,
           DimensionFilter[] dimensionFilters,
           Statement statement,
           String timeZone)

Method Detail

getDimensions

public Dimension[] getDimensions()

Gets the dimensions value for this ReportQuery.

Returns:

dimensions * The list of break-down types being requested in the report. The generated report will contain the dimensions in the same order as requested.

setDimensions

public void setDimensions(Dimension[] dimensions)

Sets the dimensions value for this ReportQuery.

Parameters:

dimensions - * The list of break-down types being requested in the report. The generated report will contain the dimensions in the same order as requested.

getDimensions

public Dimension getDimensions(int i)

setDimensions

public void setDimensions(int i,
                 Dimension _value)

getAdUnitView

public ReportQueryAdUnitView getAdUnitView()

Gets the adUnitView value for this ReportQuery.

Returns:

adUnitView * The ad unit view for the report. Defaults to AdUnitView#TOP_LEVEL.

setAdUnitView

public void setAdUnitView(ReportQueryAdUnitView adUnitView)

Sets the adUnitView value for this ReportQuery.

Parameters:

adUnitView - * The ad unit view for the report. Defaults to AdUnitView#TOP_LEVEL.

getColumns

public Column[] getColumns()

Gets the columns value for this ReportQuery.

Returns:

columns * The list of trafficking statistics and revenue information being requested in the report. The generated report will contain the columns in the same order as requested.

setColumns

public void setColumns(Column[] columns)

Sets the columns value for this ReportQuery.

Parameters:

columns - * The list of trafficking statistics and revenue information being requested in the report. The generated report will contain the columns in the same order as requested.

getColumns

public Column getColumns(int i)

setColumns

public void setColumns(int i,
              Column _value)

getDimensionAttributes

public DimensionAttribute[] getDimensionAttributes()

Gets the dimensionAttributes value for this ReportQuery.

Returns:

dimensionAttributes * The list of break-down attributes being requested in this report. Some DimensionAttribute values can only be used with certain Dimension values that must be included in the dimensions attribute. The generated report will contain the attributes in the same order as requested.

setDimensionAttributes

public void setDimensionAttributes(DimensionAttribute[] dimensionAttributes)

Sets the dimensionAttributes value for this ReportQuery.

Parameters:

dimensionAttributes - * The list of break-down attributes being requested in this report. Some DimensionAttribute values can only be used with certain Dimension values that must be included in the dimensions attribute. The generated report will contain the attributes in the same order as requested.

getDimensionAttributes

public DimensionAttribute getDimensionAttributes(int i)

setDimensionAttributes

public void setDimensionAttributes(int i,
                          DimensionAttribute _value)

getCustomFieldIds

public long[] getCustomFieldIds()

Gets the customFieldIds value for this ReportQuery.

Returns:

customFieldIds * The list of CustomField.id being requested in this report. To add a CustomField to the report, you must include its corresponding Dimension, determined by the CustomField.entityType, as a dimension.

CustomFieldEntityType#entityType	Dimension
CustomFieldEntityType.LINE_ITEM	Dimension.LINE_ITEM_NAME
CustomFieldEntityType.ORDER	Dimension.ORDER_NAME
CustomFieldEntityType.CREATIVE	Dimension.CREATIVE_NAME

setCustomFieldIds

public void setCustomFieldIds(long[] customFieldIds)

Sets the customFieldIds value for this ReportQuery.

Parameters:

customFieldIds - * The list of CustomField.id being requested in this report. To add a CustomField to the report, you must include its corresponding Dimension, determined by the CustomField.entityType, as a dimension.

CustomFieldEntityType#entityType	Dimension
CustomFieldEntityType.LINE_ITEM	Dimension.LINE_ITEM_NAME
CustomFieldEntityType.ORDER	Dimension.ORDER_NAME
CustomFieldEntityType.CREATIVE	Dimension.CREATIVE_NAME

getCustomFieldIds

public long getCustomFieldIds(int i)

setCustomFieldIds

public void setCustomFieldIds(int i,
                     long _value)

getStartDate

public Date getStartDate()

Gets the startDate value for this ReportQuery.

Returns:

startDate * The start date from which the reporting information is gathered. The ReportQuery#dateRangeType field must be set to DateRangeType.CUSTOM_DATE in order to use this.

setStartDate

public void setStartDate(Date startDate)

Sets the startDate value for this ReportQuery.

Parameters:

startDate - * The start date from which the reporting information is gathered. The ReportQuery#dateRangeType field must be set to DateRangeType.CUSTOM_DATE in order to use this.

getEndDate

public Date getEndDate()

Gets the endDate value for this ReportQuery.

Returns:

endDate * The end date upto which the reporting information is gathered. The ReportQuery#dateRangeType field must be set to DateRangeType.CUSTOM_DATE in order to use this.

setEndDate

public void setEndDate(Date endDate)

Sets the endDate value for this ReportQuery.

Parameters:

endDate - * The end date upto which the reporting information is gathered. The ReportQuery#dateRangeType field must be set to DateRangeType.CUSTOM_DATE in order to use this.

getDateRangeType

public DateRangeType getDateRangeType()

Gets the dateRangeType value for this ReportQuery.

Returns:

dateRangeType * The period of time for which the reporting data is being generated. In order to define custom time periods, set this to DateRangeType.CUSTOM_DATE. If set to DateRangeType.CUSTOM_DATE, then startDate and endDate will be used.

setDateRangeType

public void setDateRangeType(DateRangeType dateRangeType)

Sets the dateRangeType value for this ReportQuery.

Parameters:

dateRangeType - * The period of time for which the reporting data is being generated. In order to define custom time periods, set this to DateRangeType.CUSTOM_DATE. If set to DateRangeType.CUSTOM_DATE, then startDate and endDate will be used.

getDimensionFilters

public DimensionFilter[] getDimensionFilters()

Gets the dimensionFilters value for this ReportQuery.

Returns:

dimensionFilters * The restrictions that apply to Dimension objects. These filters are AND'ed together to produce the result.

setDimensionFilters

public void setDimensionFilters(DimensionFilter[] dimensionFilters)

Sets the dimensionFilters value for this ReportQuery.

Parameters:

dimensionFilters - * The restrictions that apply to Dimension objects. These filters are AND'ed together to produce the result.

getDimensionFilters

public DimensionFilter getDimensionFilters(int i)

setDimensionFilters

public void setDimensionFilters(int i,
                       DimensionFilter _value)

getStatement

public Statement getStatement()

Gets the statement value for this ReportQuery.

Returns:

statement * Specifies a filter to use for reporting on data. This filter will be used in conjunction (joined with an AND statement) with the date range selected through dateRangeType, startDate, and endDate and the dimension filters selected through dimensionFilters. The syntax currently allowed for Statement.query is
[WHERE {AND ...}]



:= =

:= =
:= IN
:= :
where property is the enumeration name of a Dimension that can be filtered.

For example, the statement "WHERE LINE_ITEM_ID IN (34344, 23235)" can be used to generate a report for a specific set of line items

Filtering on IDs is highly recommended over filtering on names, especially for geographical entities. When filtering on names, matching is case sensitive.

setStatement

public void setStatement(Statement statement)

Sets the statement value for this ReportQuery.

Parameters:

statement - * Specifies a filter to use for reporting on data. This filter will be used in conjunction (joined with an AND statement) with the date range selected through dateRangeType, startDate, and endDate and the dimension filters selected through dimensionFilters. The syntax currently allowed for Statement.query is
[WHERE {AND ...}]



:= =

:= =
:= IN
:= :
where property is the enumeration name of a Dimension that can be filtered.

For example, the statement "WHERE LINE_ITEM_ID IN (34344, 23235)" can be used to generate a report for a specific set of line items

Filtering on IDs is highly recommended over filtering on names, especially for geographical entities. When filtering on names, matching is case sensitive.

getTimeZone

public String getTimeZone()

Gets the timeZone value for this ReportQuery.

Returns:

timeZone * The time zone in the form of America/New_York which the startDate and endDate are in, and the reporting information is gathered in. Defaults to Network.timeZone if it is null. All supported time zones can be found in the Time_Zone PQL table with SupportedInReports being true. Only time zones that are full hour offsets from Network.timeZone are supported.

setTimeZone

public void setTimeZone(String timeZone)

Sets the timeZone value for this ReportQuery.

Parameters:

timeZone - * The time zone in the form of America/New_York which the startDate and endDate are in, and the reporting information is gathered in. Defaults to Network.timeZone if it is null. All supported time zones can be found in the Time_Zone PQL table with SupportedInReports being true. Only time zones that are full hour offsets from Network.timeZone are supported.

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