com.google.api.services.dfareporting.model

Class Report.FloodlightCriteria

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Report.FloodlightCriteria

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Report

public static final class Report.FloodlightCriteria
extends com.google.api.client.json.GenericJson

The report criteria for a report of type "FLOODLIGHT".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Report.FloodlightCriteria.ReportProperties The properties of the report.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FloodlightCriteria()

Method Summary

Modifier and Type	Method and Description
Report.FloodlightCriteria	clone()
List<DimensionValue>	getCustomRichMediaEvents() The list of custom rich media events to include.
DateRange	getDateRange() The date range this report should be run for.
List<DimensionValue>	getDimensionFilters() The list of filters on which dimensions are filtered.
List<SortedDimension>	getDimensions() The list of dimensions the report should include.
DimensionValue	getFloodlightConfigId() The floodlight ID for which to show data in this report.
List<String>	getMetricNames() The list of names of metrics the report should include.
Report.FloodlightCriteria.ReportProperties	getReportProperties() The properties of the report.
Report.FloodlightCriteria	set(String fieldName, Object value)
Report.FloodlightCriteria	setCustomRichMediaEvents(List<DimensionValue> customRichMediaEvents) The list of custom rich media events to include.
Report.FloodlightCriteria	setDateRange(DateRange dateRange) The date range this report should be run for.
Report.FloodlightCriteria	setDimensionFilters(List<DimensionValue> dimensionFilters) The list of filters on which dimensions are filtered.
Report.FloodlightCriteria	setDimensions(List<SortedDimension> dimensions) The list of dimensions the report should include.
Report.FloodlightCriteria	setFloodlightConfigId(DimensionValue floodlightConfigId) The floodlight ID for which to show data in this report.
Report.FloodlightCriteria	setMetricNames(List<String> metricNames) The list of names of metrics the report should include.
Report.FloodlightCriteria	setReportProperties(Report.FloodlightCriteria.ReportProperties reportProperties) The properties of the report.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

FloodlightCriteria

public FloodlightCriteria()

Method Detail

getCustomRichMediaEvents

public List<DimensionValue> getCustomRichMediaEvents()

The list of custom rich media events to include.

Returns:

value or null for none

setCustomRichMediaEvents

public Report.FloodlightCriteria setCustomRichMediaEvents(List<DimensionValue> customRichMediaEvents)

The list of custom rich media events to include.

Parameters:

customRichMediaEvents - customRichMediaEvents or null for none

getDateRange

public DateRange getDateRange()

The date range this report should be run for.

Returns:

value or null for none

setDateRange

public Report.FloodlightCriteria setDateRange(DateRange dateRange)

The date range this report should be run for.

Parameters:

dateRange - dateRange or null for none

getDimensionFilters

public List<DimensionValue> getDimensionFilters()

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

Returns:

value or null for none

setDimensionFilters

public Report.FloodlightCriteria setDimensionFilters(List<DimensionValue> dimensionFilters)

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.

Parameters:

dimensionFilters - dimensionFilters or null for none

getDimensions

public List<SortedDimension> getDimensions()

The list of dimensions the report should include.

Returns:

value or null for none

setDimensions

public Report.FloodlightCriteria setDimensions(List<SortedDimension> dimensions)

The list of dimensions the report should include.

Parameters:

dimensions - dimensions or null for none

getFloodlightConfigId

public DimensionValue getFloodlightConfigId()

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

Returns:

value or null for none

setFloodlightConfigId

public Report.FloodlightCriteria setFloodlightConfigId(DimensionValue floodlightConfigId)

The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.

Parameters:

floodlightConfigId - floodlightConfigId or null for none

getMetricNames

public List<String> getMetricNames()

The list of names of metrics the report should include.

Returns:

value or null for none

setMetricNames

public Report.FloodlightCriteria setMetricNames(List<String> metricNames)

The list of names of metrics the report should include.

Parameters:

metricNames - metricNames or null for none

getReportProperties

public Report.FloodlightCriteria.ReportProperties getReportProperties()

The properties of the report.

Returns:

value or null for none

setReportProperties

public Report.FloodlightCriteria setReportProperties(Report.FloodlightCriteria.ReportProperties reportProperties)

The properties of the report.

Parameters:

reportProperties - reportProperties or null for none

set

public Report.FloodlightCriteria set(String fieldName,
                                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Report.FloodlightCriteria clone()

Overrides:

clone in class com.google.api.client.json.GenericJson