com.google.api.ads.admanager.axis.v201905

Class ReportQuery

java.lang.Object

com.google.api.ads.admanager.axis.v201905.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. Only reports with at least one Column are supported.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportQuery()
ReportQuery(Dimension[] dimensions, ReportQueryAdUnitView adUnitView, Column[] columns, DimensionAttribute[] dimensionAttributes, long[] customFieldIds, long[] contentMetadataKeyHierarchyCustomTargetingKeyIds, long[] customDimensionKeyIds, Date startDate, Date endDate, DateRangeType dateRangeType, Statement statement, Boolean includeZeroSalesRows, String adxReportCurrency, TimeZoneType timeZoneType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ReportQueryAdUnitView	getAdUnitView() Gets the adUnitView value for this ReportQuery.
String	getAdxReportCurrency() Gets the adxReportCurrency value for this ReportQuery.
Column[]	getColumns() Gets the columns value for this ReportQuery.
Column	getColumns(int i)
long[]	getContentMetadataKeyHierarchyCustomTargetingKeyIds() Gets the contentMetadataKeyHierarchyCustomTargetingKeyIds value for this ReportQuery.
long	getContentMetadataKeyHierarchyCustomTargetingKeyIds(int i)
long[]	getCustomDimensionKeyIds() Gets the customDimensionKeyIds value for this ReportQuery.
long	getCustomDimensionKeyIds(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)
Dimension[]	getDimensions() Gets the dimensions value for this ReportQuery.
Dimension	getDimensions(int i)
Date	getEndDate() Gets the endDate value for this ReportQuery.
Boolean	getIncludeZeroSalesRows() Gets the includeZeroSalesRows 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.
TimeZoneType	getTimeZoneType() Gets the timeZoneType 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	setAdxReportCurrency(String adxReportCurrency) Sets the adxReportCurrency value for this ReportQuery.
void	setColumns(Column[] columns) Sets the columns value for this ReportQuery.
void	setColumns(int i, Column _value)
void	setContentMetadataKeyHierarchyCustomTargetingKeyIds(int i, long _value)
void	setContentMetadataKeyHierarchyCustomTargetingKeyIds(long[] contentMetadataKeyHierarchyCustomTargetingKeyIds) Sets the contentMetadataKeyHierarchyCustomTargetingKeyIds value for this ReportQuery.
void	setCustomDimensionKeyIds(int i, long _value)
void	setCustomDimensionKeyIds(long[] customDimensionKeyIds) Sets the customDimensionKeyIds value for this ReportQuery.
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	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	setIncludeZeroSalesRows(Boolean includeZeroSalesRows) Sets the includeZeroSalesRows 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	setTimeZoneType(TimeZoneType timeZoneType) Sets the timeZoneType value for this ReportQuery.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportQuery

public ReportQuery()

ReportQuery

public ReportQuery(Dimension[] dimensions,
                   ReportQueryAdUnitView adUnitView,
                   Column[] columns,
                   DimensionAttribute[] dimensionAttributes,
                   long[] customFieldIds,
                   long[] contentMetadataKeyHierarchyCustomTargetingKeyIds,
                   long[] customDimensionKeyIds,
                   Date startDate,
                   Date endDate,
                   DateRangeType dateRangeType,
                   Statement statement,
                   Boolean includeZeroSalesRows,
                   String adxReportCurrency,
                   TimeZoneType timeZoneType)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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. This field is required.

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. This field is required.

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. This field is required.

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. This field is required.

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
CustomFieldEntityType.LINE_ITEM	Dimension.LINE_ITEM_NAME
CustomFieldEntityType.ORDER	Dimension.ORDER_NAME
CustomFieldEntityType.CREATIVE	Dimension.CREATIVE_NAME
CustomFieldEntityType.PRODUCT_TEMPLATE	Dimension.PRODUCT_TEMPLATE_NAME
CustomFieldEntityType.PRODUCT	Dimension.PRODUCT_NAME
CustomFieldEntityType.PROPOSAL	Dimension.PROPOSAL_NAME
CustomFieldEntityType.PROPOSAL_LINE_ITEM	Dimension.PROPOSAL_LINE_ITEM_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
CustomFieldEntityType.LINE_ITEM	Dimension.LINE_ITEM_NAME
CustomFieldEntityType.ORDER	Dimension.ORDER_NAME
CustomFieldEntityType.CREATIVE	Dimension.CREATIVE_NAME
CustomFieldEntityType.PRODUCT_TEMPLATE	Dimension.PRODUCT_TEMPLATE_NAME
CustomFieldEntityType.PRODUCT	Dimension.PRODUCT_NAME
CustomFieldEntityType.PROPOSAL	Dimension.PROPOSAL_NAME
CustomFieldEntityType.PROPOSAL_LINE_ITEM	Dimension.PROPOSAL_LINE_ITEM_NAME

getCustomFieldIds

public long getCustomFieldIds(int i)

setCustomFieldIds

public void setCustomFieldIds(int i,
                              long _value)

getContentMetadataKeyHierarchyCustomTargetingKeyIds

public long[] getContentMetadataKeyHierarchyCustomTargetingKeyIds()

Gets the contentMetadataKeyHierarchyCustomTargetingKeyIds value for this ReportQuery.

Returns:

contentMetadataKeyHierarchyCustomTargetingKeyIds * The list of content metadata hierarchy custom targeting key IDs being requested in this report. Each of these IDs must have been defined in the content metadata key hierarchy. This will include dimensions in the form of CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[id]_ID and CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[id]_VALUE where where ID is the ID of the custom targeting value and VALUE is the name.

To add IDs, you must include Dimension.CONTENT_HIERARCHY in dimensions, and specify a non-empty list of custom targeting key IDs. The order of content hierarchy columns in the report correspond to the place of Dimension.CONTENT_HIERARCHY in dimensions. For example, if dimensions contains the following dimensions in the order: Dimension.ADVERTISER_NAME, Dimension.CONTENT_HIERARCHY and Dimension.COUNTRY_NAME, and contentMetadataKeyHierarchyCustomTargetingKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1001]_VALUE, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1001]_ID, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID

setContentMetadataKeyHierarchyCustomTargetingKeyIds

public void setContentMetadataKeyHierarchyCustomTargetingKeyIds(long[] contentMetadataKeyHierarchyCustomTargetingKeyIds)

Sets the contentMetadataKeyHierarchyCustomTargetingKeyIds value for this ReportQuery.

Parameters:

contentMetadataKeyHierarchyCustomTargetingKeyIds - * The list of content metadata hierarchy custom targeting key IDs being requested in this report. Each of these IDs must have been defined in the content metadata key hierarchy. This will include dimensions in the form of CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[id]_ID and CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[id]_VALUE where where ID is the ID of the custom targeting value and VALUE is the name.

To add IDs, you must include Dimension.CONTENT_HIERARCHY in dimensions, and specify a non-empty list of custom targeting key IDs. The order of content hierarchy columns in the report correspond to the place of Dimension.CONTENT_HIERARCHY in dimensions. For example, if dimensions contains the following dimensions in the order: Dimension.ADVERTISER_NAME, Dimension.CONTENT_HIERARCHY and Dimension.COUNTRY_NAME, and contentMetadataKeyHierarchyCustomTargetingKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1001]_VALUE, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1001]_ID, Dimension.CONTENT_HIERARCHY_CUSTOM_TARGETING_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID

getContentMetadataKeyHierarchyCustomTargetingKeyIds

public long getContentMetadataKeyHierarchyCustomTargetingKeyIds(int i)

setContentMetadataKeyHierarchyCustomTargetingKeyIds

public void setContentMetadataKeyHierarchyCustomTargetingKeyIds(int i,
                                                                long _value)

getCustomDimensionKeyIds

public long[] getCustomDimensionKeyIds()

Gets the customDimensionKeyIds value for this ReportQuery.

Returns:

customDimensionKeyIds * The list of custom dimension custom targeting key IDs being requested in this report. This will include dimensions in the form of TOP_LEVEL_DIMENSION_KEY[id]_ID and TOP_LEVEL_DIMENSION_KEY[id]_VALUE where ID is the ID of the custom targeting value and VALUE is the name.

To add IDs, you must include Dimension.CUSTOM_DIMENSION in dimensions, and specify a non-empty list of custom targeting key IDs. The order of cusotm dimension columns in the report correspond to the place of Dimension.CUSTOM_DIMENSION in dimensions. For example, if dimensions contains the following dimensions in the order: Dimension.ADVERTISER_NAME, Dimension.CUSTOM_DIMENSION and Dimension.COUNTRY_NAME, and #customCriteriaCustomTargetingKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_VALUE, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID.

setCustomDimensionKeyIds

public void setCustomDimensionKeyIds(long[] customDimensionKeyIds)

Sets the customDimensionKeyIds value for this ReportQuery.

Parameters:

customDimensionKeyIds - * The list of custom dimension custom targeting key IDs being requested in this report. This will include dimensions in the form of TOP_LEVEL_DIMENSION_KEY[id]_ID and TOP_LEVEL_DIMENSION_KEY[id]_VALUE where ID is the ID of the custom targeting value and VALUE is the name.

To add IDs, you must include Dimension.CUSTOM_DIMENSION in dimensions, and specify a non-empty list of custom targeting key IDs. The order of cusotm dimension columns in the report correspond to the place of Dimension.CUSTOM_DIMENSION in dimensions. For example, if dimensions contains the following dimensions in the order: Dimension.ADVERTISER_NAME, Dimension.CUSTOM_DIMENSION and Dimension.COUNTRY_NAME, and #customCriteriaCustomTargetingKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_VALUE, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID.

getCustomDimensionKeyIds

public long getCustomDimensionKeyIds(int i)

setCustomDimensionKeyIds

public void setCustomDimensionKeyIds(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.

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. 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. 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.

getIncludeZeroSalesRows

public Boolean getIncludeZeroSalesRows()

Gets the includeZeroSalesRows value for this ReportQuery.

Returns:

includeZeroSalesRows * Whether report includes rows with all zero metric values. This field is only eligible for sales reports. This field is optional and defaults to false.

setIncludeZeroSalesRows

public void setIncludeZeroSalesRows(Boolean includeZeroSalesRows)

Sets the includeZeroSalesRows value for this ReportQuery.

Parameters:

includeZeroSalesRows - * Whether report includes rows with all zero metric values. This field is only eligible for sales reports. This field is optional and defaults to false.

getAdxReportCurrency

public String getAdxReportCurrency()

Gets the adxReportCurrency value for this ReportQuery.

Returns:

adxReportCurrency * The currency for Ad Exchange revenue metrics. This field is only valid for Ad Exchange metrics, and an exception will be thrown if this field is used with non-Ad Exchange metrics. Defaults to the network currency if left null. The supported currency codes can be found in this Help Center article.

setAdxReportCurrency

public void setAdxReportCurrency(String adxReportCurrency)

Sets the adxReportCurrency value for this ReportQuery.

Parameters:

adxReportCurrency - * The currency for Ad Exchange revenue metrics. This field is only valid for Ad Exchange metrics, and an exception will be thrown if this field is used with non-Ad Exchange metrics. Defaults to the network currency if left null. The supported currency codes can be found in this Help Center article.

getTimeZoneType

public TimeZoneType getTimeZoneType()

Gets the timeZoneType value for this ReportQuery.

Returns:

timeZoneType * Gets the TimeZoneType for this report, which determines the time zone used for the report's date range. Defaults to TimeZoneType.PUBLISHER.

setTimeZoneType

public void setTimeZoneType(TimeZoneType timeZoneType)

Sets the timeZoneType value for this ReportQuery.

Parameters:

timeZoneType - * Gets the TimeZoneType for this report, which determines the time zone used for the report's date range. Defaults to TimeZoneType.PUBLISHER.

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