com.google.api.ads.dfp.jaxws.v201805

Class ReportQuery

java.lang.Object

com.google.api.ads.dfp.jaxws.v201805.ReportQuery

public class ReportQuery
extends Object

A ReportQuery object allows you to specify the selection criteria for generating a report. Only reports with at least one Column are supported.

Java class for ReportQuery complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ReportQuery">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="dimensions" type="{https://www.google.com/apis/ads/publisher/v201805}Dimension" maxOccurs="unbounded" minOccurs="0"/>
         <element name="adUnitView" type="{https://www.google.com/apis/ads/publisher/v201805}ReportQuery.AdUnitView" minOccurs="0"/>
         <element name="columns" type="{https://www.google.com/apis/ads/publisher/v201805}Column" maxOccurs="unbounded" minOccurs="0"/>
         <element name="dimensionAttributes" type="{https://www.google.com/apis/ads/publisher/v201805}DimensionAttribute" maxOccurs="unbounded" minOccurs="0"/>
         <element name="customFieldIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
         <element name="contentMetadataKeyHierarchyCustomTargetingKeyIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
         <element name="startDate" type="{https://www.google.com/apis/ads/publisher/v201805}Date" minOccurs="0"/>
         <element name="endDate" type="{https://www.google.com/apis/ads/publisher/v201805}Date" minOccurs="0"/>
         <element name="dateRangeType" type="{https://www.google.com/apis/ads/publisher/v201805}DateRangeType" minOccurs="0"/>
         <element name="statement" type="{https://www.google.com/apis/ads/publisher/v201805}Statement" minOccurs="0"/>
         <element name="includeZeroSalesRows" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="adxReportCurrency" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="timeZoneType" type="{https://www.google.com/apis/ads/publisher/v201805}TimeZoneType" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ReportQueryAdUnitView	adUnitView
protected String	adxReportCurrency
protected List<Column>	columns
protected List<Long>	contentMetadataKeyHierarchyCustomTargetingKeyIds
protected List<Long>	customFieldIds
protected DateRangeType	dateRangeType
protected List<DimensionAttribute>	dimensionAttributes
protected List<Dimension>	dimensions
protected Date	endDate
protected Boolean	includeZeroSalesRows
protected Date	startDate
protected Statement	statement
protected TimeZoneType	timeZoneType

Constructor Summary

Constructors

Constructor and Description
ReportQuery()

Method Summary

Modifier and Type	Method and Description
ReportQueryAdUnitView	getAdUnitView() Gets the value of the adUnitView property.
String	getAdxReportCurrency() Gets the value of the adxReportCurrency property.
List<Column>	getColumns() Gets the value of the columns property.
List<Long>	getContentMetadataKeyHierarchyCustomTargetingKeyIds() Gets the value of the contentMetadataKeyHierarchyCustomTargetingKeyIds property.
List<Long>	getCustomFieldIds() Gets the value of the customFieldIds property.
DateRangeType	getDateRangeType() Gets the value of the dateRangeType property.
List<DimensionAttribute>	getDimensionAttributes() Gets the value of the dimensionAttributes property.
List<Dimension>	getDimensions() Gets the value of the dimensions property.
Date	getEndDate() Gets the value of the endDate property.
Date	getStartDate() Gets the value of the startDate property.
Statement	getStatement() Gets the value of the statement property.
TimeZoneType	getTimeZoneType() Gets the value of the timeZoneType property.
Boolean	isIncludeZeroSalesRows() Gets the value of the includeZeroSalesRows property.
void	setAdUnitView(ReportQueryAdUnitView value) Sets the value of the adUnitView property.
void	setAdxReportCurrency(String value) Sets the value of the adxReportCurrency property.
void	setDateRangeType(DateRangeType value) Sets the value of the dateRangeType property.
void	setEndDate(Date value) Sets the value of the endDate property.
void	setIncludeZeroSalesRows(Boolean value) Sets the value of the includeZeroSalesRows property.
void	setStartDate(Date value) Sets the value of the startDate property.
void	setStatement(Statement value) Sets the value of the statement property.
void	setTimeZoneType(TimeZoneType value) Sets the value of the timeZoneType property.

Methods inherited from class java.lang.Object

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

Field Detail

dimensions

protected List<Dimension> dimensions

adUnitView

protected ReportQueryAdUnitView adUnitView

columns

protected List<Column> columns

dimensionAttributes

protected List<DimensionAttribute> dimensionAttributes

customFieldIds

protected List<Long> customFieldIds

contentMetadataKeyHierarchyCustomTargetingKeyIds

protected List<Long> contentMetadataKeyHierarchyCustomTargetingKeyIds

startDate

protected Date startDate

endDate

protected Date endDate

dateRangeType

protected DateRangeType dateRangeType

statement

protected Statement statement

includeZeroSalesRows

protected Boolean includeZeroSalesRows

adxReportCurrency

protected String adxReportCurrency

timeZoneType

protected TimeZoneType timeZoneType

Constructor Detail

ReportQuery

public ReportQuery()

Method Detail

getDimensions

public List<Dimension> getDimensions()

Gets the value of the dimensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dimensions property.

For example, to add a new item, do as follows:

    getDimensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Dimension

getAdUnitView

public ReportQueryAdUnitView getAdUnitView()

Gets the value of the adUnitView property.

Returns:

possible object is ReportQueryAdUnitView

setAdUnitView

public void setAdUnitView(ReportQueryAdUnitView value)

Sets the value of the adUnitView property.

Parameters:

value - allowed object is ReportQueryAdUnitView

getColumns

public List<Column> getColumns()

Gets the value of the columns property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the columns property.

For example, to add a new item, do as follows:

    getColumns().add(newItem);
 

Objects of the following type(s) are allowed in the list Column

getDimensionAttributes

public List<DimensionAttribute> getDimensionAttributes()

Gets the value of the dimensionAttributes property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dimensionAttributes property.

For example, to add a new item, do as follows:

    getDimensionAttributes().add(newItem);
 

Objects of the following type(s) are allowed in the list DimensionAttribute

getCustomFieldIds

public List<Long> getCustomFieldIds()

Gets the value of the customFieldIds property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the customFieldIds property.

For example, to add a new item, do as follows:

    getCustomFieldIds().add(newItem);
 

Objects of the following type(s) are allowed in the list Long

getContentMetadataKeyHierarchyCustomTargetingKeyIds

public List<Long> getContentMetadataKeyHierarchyCustomTargetingKeyIds()

Gets the value of the contentMetadataKeyHierarchyCustomTargetingKeyIds property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contentMetadataKeyHierarchyCustomTargetingKeyIds property.

For example, to add a new item, do as follows:

    getContentMetadataKeyHierarchyCustomTargetingKeyIds().add(newItem);
 

Objects of the following type(s) are allowed in the list Long

getStartDate

public Date getStartDate()

Gets the value of the startDate property.

Returns:

possible object is Date

setStartDate

public void setStartDate(Date value)

Sets the value of the startDate property.

Parameters:

value - allowed object is Date

getEndDate

public Date getEndDate()

Gets the value of the endDate property.

Returns:

possible object is Date

setEndDate

public void setEndDate(Date value)

Sets the value of the endDate property.

Parameters:

value - allowed object is Date

getDateRangeType

public DateRangeType getDateRangeType()

Gets the value of the dateRangeType property.

Returns:

possible object is DateRangeType

setDateRangeType

public void setDateRangeType(DateRangeType value)

Sets the value of the dateRangeType property.

Parameters:

value - allowed object is DateRangeType

getStatement

public Statement getStatement()

Gets the value of the statement property.

Returns:

possible object is Statement

setStatement

public void setStatement(Statement value)

Sets the value of the statement property.

Parameters:

value - allowed object is Statement

isIncludeZeroSalesRows

public Boolean isIncludeZeroSalesRows()

Gets the value of the includeZeroSalesRows property.

Returns:

possible object is Boolean

setIncludeZeroSalesRows

public void setIncludeZeroSalesRows(Boolean value)

Sets the value of the includeZeroSalesRows property.

Parameters:

value - allowed object is Boolean

getAdxReportCurrency

public String getAdxReportCurrency()

Gets the value of the adxReportCurrency property.

Returns:

possible object is String

setAdxReportCurrency

public void setAdxReportCurrency(String value)

Sets the value of the adxReportCurrency property.

Parameters:

value - allowed object is String

getTimeZoneType

public TimeZoneType getTimeZoneType()

Gets the value of the timeZoneType property.

Returns:

possible object is TimeZoneType

setTimeZoneType

public void setTimeZoneType(TimeZoneType value)

Sets the value of the timeZoneType property.

Parameters:

value - allowed object is TimeZoneType