com.google.api.ads.admanager.jaxws.v202311.ReportQuery Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202311;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
/**
*
* A {@code ReportQuery} object allows you to specify the selection criteria for
* generating a report. Only reports with at least one {@link 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/v202311}Dimension" maxOccurs="unbounded" minOccurs="0"/>
* <element name="adUnitView" type="{https://www.google.com/apis/ads/publisher/v202311}ReportQuery.AdUnitView" minOccurs="0"/>
* <element name="columns" type="{https://www.google.com/apis/ads/publisher/v202311}Column" maxOccurs="unbounded" minOccurs="0"/>
* <element name="dimensionAttributes" type="{https://www.google.com/apis/ads/publisher/v202311}DimensionAttribute" maxOccurs="unbounded" minOccurs="0"/>
* <element name="customFieldIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
* <element name="cmsMetadataKeyIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
* <element name="customDimensionKeyIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
* <element name="startDate" type="{https://www.google.com/apis/ads/publisher/v202311}Date" minOccurs="0"/>
* <element name="endDate" type="{https://www.google.com/apis/ads/publisher/v202311}Date" minOccurs="0"/>
* <element name="dateRangeType" type="{https://www.google.com/apis/ads/publisher/v202311}DateRangeType" minOccurs="0"/>
* <element name="statement" type="{https://www.google.com/apis/ads/publisher/v202311}Statement" minOccurs="0"/>
* <element name="reportCurrency" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="timeZoneType" type="{https://www.google.com/apis/ads/publisher/v202311}TimeZoneType" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ReportQuery", propOrder = {
"dimensions",
"adUnitView",
"columns",
"dimensionAttributes",
"customFieldIds",
"cmsMetadataKeyIds",
"customDimensionKeyIds",
"startDate",
"endDate",
"dateRangeType",
"statement",
"reportCurrency",
"timeZoneType"
})
public class ReportQuery {
@XmlSchemaType(name = "string")
protected List dimensions;
@XmlSchemaType(name = "string")
protected ReportQueryAdUnitView adUnitView;
@XmlSchemaType(name = "string")
protected List columns;
@XmlSchemaType(name = "string")
protected List dimensionAttributes;
@XmlElement(type = Long.class)
protected List customFieldIds;
@XmlElement(type = Long.class)
protected List cmsMetadataKeyIds;
@XmlElement(type = Long.class)
protected List customDimensionKeyIds;
protected Date startDate;
protected Date endDate;
@XmlSchemaType(name = "string")
protected DateRangeType dateRangeType;
protected Statement statement;
protected String reportCurrency;
@XmlSchemaType(name = "string")
protected TimeZoneType timeZoneType;
/**
* 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
* {@link Dimension }
*
*
*/
public List getDimensions() {
if (dimensions == null) {
dimensions = new ArrayList();
}
return this.dimensions;
}
/**
* Gets the value of the adUnitView property.
*
* @return
* possible object is
* {@link ReportQueryAdUnitView }
*
*/
public ReportQueryAdUnitView getAdUnitView() {
return adUnitView;
}
/**
* Sets the value of the adUnitView property.
*
* @param value
* allowed object is
* {@link ReportQueryAdUnitView }
*
*/
public void setAdUnitView(ReportQueryAdUnitView value) {
this.adUnitView = value;
}
/**
* 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
* {@link Column }
*
*
*/
public List getColumns() {
if (columns == null) {
columns = new ArrayList();
}
return this.columns;
}
/**
* 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
* {@link DimensionAttribute }
*
*
*/
public List getDimensionAttributes() {
if (dimensionAttributes == null) {
dimensionAttributes = new ArrayList();
}
return this.dimensionAttributes;
}
/**
* 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
* {@link Long }
*
*
*/
public List getCustomFieldIds() {
if (customFieldIds == null) {
customFieldIds = new ArrayList();
}
return this.customFieldIds;
}
/**
* Gets the value of the cmsMetadataKeyIds 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 cmsMetadataKeyIds property.
*
*
* For example, to add a new item, do as follows:
*
* getCmsMetadataKeyIds().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Long }
*
*
*/
public List getCmsMetadataKeyIds() {
if (cmsMetadataKeyIds == null) {
cmsMetadataKeyIds = new ArrayList();
}
return this.cmsMetadataKeyIds;
}
/**
* Gets the value of the customDimensionKeyIds 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 customDimensionKeyIds property.
*
*
* For example, to add a new item, do as follows:
*
* getCustomDimensionKeyIds().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Long }
*
*
*/
public List getCustomDimensionKeyIds() {
if (customDimensionKeyIds == null) {
customDimensionKeyIds = new ArrayList();
}
return this.customDimensionKeyIds;
}
/**
* Gets the value of the startDate property.
*
* @return
* possible object is
* {@link Date }
*
*/
public Date getStartDate() {
return startDate;
}
/**
* Sets the value of the startDate property.
*
* @param value
* allowed object is
* {@link Date }
*
*/
public void setStartDate(Date value) {
this.startDate = value;
}
/**
* Gets the value of the endDate property.
*
* @return
* possible object is
* {@link Date }
*
*/
public Date getEndDate() {
return endDate;
}
/**
* Sets the value of the endDate property.
*
* @param value
* allowed object is
* {@link Date }
*
*/
public void setEndDate(Date value) {
this.endDate = value;
}
/**
* Gets the value of the dateRangeType property.
*
* @return
* possible object is
* {@link DateRangeType }
*
*/
public DateRangeType getDateRangeType() {
return dateRangeType;
}
/**
* Sets the value of the dateRangeType property.
*
* @param value
* allowed object is
* {@link DateRangeType }
*
*/
public void setDateRangeType(DateRangeType value) {
this.dateRangeType = value;
}
/**
* Gets the value of the statement property.
*
* @return
* possible object is
* {@link Statement }
*
*/
public Statement getStatement() {
return statement;
}
/**
* Sets the value of the statement property.
*
* @param value
* allowed object is
* {@link Statement }
*
*/
public void setStatement(Statement value) {
this.statement = value;
}
/**
* Gets the value of the reportCurrency property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getReportCurrency() {
return reportCurrency;
}
/**
* Sets the value of the reportCurrency property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setReportCurrency(String value) {
this.reportCurrency = value;
}
/**
* Gets the value of the timeZoneType property.
*
* @return
* possible object is
* {@link TimeZoneType }
*
*/
public TimeZoneType getTimeZoneType() {
return timeZoneType;
}
/**
* Sets the value of the timeZoneType property.
*
* @param value
* allowed object is
* {@link TimeZoneType }
*
*/
public void setTimeZoneType(TimeZoneType value) {
this.timeZoneType = value;
}
}