MediationReportSpec (AdMob API v1-rev20201110-1.30.10)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.admob.v1.model.MediationReportSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class MediationReportSpec
extends GenericJson
```
The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 30} }, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "metrics": ["OBSERVED_ECPM"], "dimension_filters": [ { "dimension": "COUNTRY", "matches_any": {"values": [{"value": "US", "value": "CN"}]} } ], "sort_conditions": [ {"dimension":"APP", order: "ASCENDING"} ], "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the AdMob API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  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

MediationReportSpec()

Constructors
Constructor and Description
`MediationReportSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MediationReportSpec`	`clone()`
`DateRange`	`getDateRange()` The date range for which the report is generated.
`List<MediationReportSpecDimensionFilter>`	`getDimensionFilters()` Describes which report rows to match based on their dimension values.
`List<String>`	`getDimensions()` List of dimensions of the report.
`LocalizationSettings`	`getLocalizationSettings()` Localization settings of the report.
`Integer`	`getMaxReportRows()` Maximum number of report data rows to return.
`List<String>`	`getMetrics()` List of metrics of the report.
`List<MediationReportSpecSortCondition>`	`getSortConditions()` Describes the sorting of report rows.
`String`	`getTimeZone()` A report time zone.
`MediationReportSpec`	`set(String fieldName, Object value)`
`MediationReportSpec`	`setDateRange(DateRange dateRange)` The date range for which the report is generated.
`MediationReportSpec`	`setDimensionFilters(List<MediationReportSpecDimensionFilter> dimensionFilters)` Describes which report rows to match based on their dimension values.
`MediationReportSpec`	`setDimensions(List<String> dimensions)` List of dimensions of the report.
`MediationReportSpec`	`setLocalizationSettings(LocalizationSettings localizationSettings)` Localization settings of the report.
`MediationReportSpec`	`setMaxReportRows(Integer maxReportRows)` Maximum number of report data rows to return.
`MediationReportSpec`	`setMetrics(List<String> metrics)` List of metrics of the report.
`MediationReportSpec`	`setSortConditions(List<MediationReportSpecSortCondition> sortConditions)` Describes the sorting of report rows.
`MediationReportSpec`	`setTimeZone(String timeZone)` A report time zone.

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
  - MediationReportSpec
```
public MediationReportSpec()
```
- Method Detail
  - getDateRange
```
public DateRange getDateRange()
```
    The date range for which the report is generated.
    
    Returns:
    
    value or null for none
  - setDateRange
```
public MediationReportSpec setDateRange(DateRange dateRange)
```
    The date range for which the report is generated.
    
    Parameters:
    
    dateRange - dateRange or null for none
  - getDimensionFilters
```
public List<MediationReportSpecDimensionFilter> getDimensionFilters()
```
    Describes which report rows to match based on their dimension values.
    
    Returns:
    
    value or null for none
  - setDimensionFilters
```
public MediationReportSpec setDimensionFilters(List<MediationReportSpecDimensionFilter> dimensionFilters)
```
    Describes which report rows to match based on their dimension values.
    
    Parameters:
    
    dimensionFilters - dimensionFilters or null for none
  - getDimensions
```
public List<String> getDimensions()
```
    List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public MediationReportSpec setDimensions(List<String> dimensions)
```
    List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getLocalizationSettings
```
public LocalizationSettings getLocalizationSettings()
```
    Localization settings of the report.
    
    Returns:
    
    value or null for none
  - setLocalizationSettings
```
public MediationReportSpec setLocalizationSettings(LocalizationSettings localizationSettings)
```
    Localization settings of the report.
    
    Parameters:
    
    localizationSettings - localizationSettings or null for none
  - getMaxReportRows
```
public Integer getMaxReportRows()
```
    Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Values larger than 100000 return an error.
    
    Returns:
    
    value or null for none
  - setMaxReportRows
```
public MediationReportSpec setMaxReportRows(Integer maxReportRows)
```
    Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Values larger than 100000 return an error.
    
    Parameters:
    
    maxReportRows - maxReportRows or null for none
  - getMetrics
```
public List<String> getMetrics()
```
    List of metrics of the report. A report must specify at least one metric.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public MediationReportSpec setMetrics(List<String> metrics)
```
    List of metrics of the report. A report must specify at least one metric.
    
    Parameters:
    
    metrics - metrics or null for none
  - getSortConditions
```
public List<MediationReportSpecSortCondition> getSortConditions()
```
    Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined.
    
    Returns:
    
    value or null for none
  - setSortConditions
```
public MediationReportSpec setSortConditions(List<MediationReportSpecSortCondition> sortConditions)
```
    Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined.
    
    Parameters:
    
    sortConditions - sortConditions or null for none
  - getTimeZone
```
public String getTimeZone()
```
    A report time zone. Accepts an IANA TZ name values, such as "America/Los_Angeles." If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The "America/Los_Angeles" is the only supported value at the moment.
    
    Returns:
    
    value or null for none
  - setTimeZone
```
public MediationReportSpec setTimeZone(String timeZone)
```
    A report time zone. Accepts an IANA TZ name values, such as "America/Los_Angeles." If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The "America/Los_Angeles" is the only supported value at the moment.
    
    Parameters:
    
    timeZone - timeZone or null for none
  - set
```
public MediationReportSpec set(String fieldName,
                               Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public MediationReportSpec clone()
```
    Overrides:
    
    clone in class GenericJson

Class MediationReportSpec

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

MediationReportSpec

Method Detail

getDateRange

setDateRange

getDimensionFilters

setDimensionFilters

getDimensions

setDimensions

getLocalizationSettings

setLocalizationSettings

getMaxReportRows

setMaxReportRows

getMetrics

setMetrics

getSortConditions

setSortConditions

getTimeZone

setTimeZone

set

clone