Class: Google::Apis::AdmobV1::MediationReportSpec
- Inherits:
-
Object
- Object
- Google::Apis::AdmobV1::MediationReportSpec
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/admob_v1/classes.rb,
generated/google/apis/admob_v1/representations.rb,
generated/google/apis/admob_v1/representations.rb
Overview
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;
Instance Attribute Summary collapse
-
#date_range ⇒ Google::Apis::AdmobV1::DateRange
Specification of a single date range.
-
#dimension_filters ⇒ Array<Google::Apis::AdmobV1::MediationReportSpecDimensionFilter>
Describes which report rows to match based on their dimension values.
-
#dimensions ⇒ Array<String>
List of dimensions of the report.
-
#localization_settings ⇒ Google::Apis::AdmobV1::LocalizationSettings
Localization settings for reports, such as currency and language.
-
#max_report_rows ⇒ Fixnum
Maximum number of report data rows to return.
-
#metrics ⇒ Array<String>
List of metrics of the report.
-
#sort_conditions ⇒ Array<Google::Apis::AdmobV1::MediationReportSpecSortCondition>
Describes the sorting of report rows.
-
#time_zone ⇒ String
A report time zone.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MediationReportSpec
constructor
A new instance of MediationReportSpec.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MediationReportSpec
Returns a new instance of MediationReportSpec.
481 482 483 |
# File 'generated/google/apis/admob_v1/classes.rb', line 481 def initialize(**args) update!(**args) end |
Instance Attribute Details
#date_range ⇒ Google::Apis::AdmobV1::DateRange
Specification of a single date range. Both dates are inclusive.
Corresponds to the JSON property dateRange
432 433 434 |
# File 'generated/google/apis/admob_v1/classes.rb', line 432 def date_range @date_range end |
#dimension_filters ⇒ Array<Google::Apis::AdmobV1::MediationReportSpecDimensionFilter>
Describes which report rows to match based on their dimension values.
Corresponds to the JSON property dimensionFilters
437 438 439 |
# File 'generated/google/apis/admob_v1/classes.rb', line 437 def dimension_filters @dimension_filters end |
#dimensions ⇒ Array<String>
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.
Corresponds to the JSON property dimensions
444 445 446 |
# File 'generated/google/apis/admob_v1/classes.rb', line 444 def dimensions @dimensions end |
#localization_settings ⇒ Google::Apis::AdmobV1::LocalizationSettings
Localization settings for reports, such as currency and language. It affects
how metrics are calculated.
Corresponds to the JSON property localizationSettings
450 451 452 |
# File 'generated/google/apis/admob_v1/classes.rb', line 450 def localization_settings @localization_settings end |
#max_report_rows ⇒ Fixnum
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. Any other values are treated as 100000.
Corresponds to the JSON property maxReportRows
457 458 459 |
# File 'generated/google/apis/admob_v1/classes.rb', line 457 def max_report_rows @max_report_rows end |
#metrics ⇒ Array<String>
List of metrics of the report. A report must specify at least one metric.
Corresponds to the JSON property metrics
462 463 464 |
# File 'generated/google/apis/admob_v1/classes.rb', line 462 def metrics @metrics end |
#sort_conditions ⇒ Array<Google::Apis::AdmobV1::MediationReportSpecSortCondition>
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.
Corresponds to the JSON property sortConditions
470 471 472 |
# File 'generated/google/apis/admob_v1/classes.rb', line 470 def sort_conditions @sort_conditions end |
#time_zone ⇒ String
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.
Corresponds to the JSON property timeZone
479 480 481 |
# File 'generated/google/apis/admob_v1/classes.rb', line 479 def time_zone @time_zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
486 487 488 489 490 491 492 493 494 495 |
# File 'generated/google/apis/admob_v1/classes.rb', line 486 def update!(**args) @date_range = args[:date_range] if args.key?(:date_range) @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) @dimensions = args[:dimensions] if args.key?(:dimensions) @localization_settings = args[:localization_settings] if args.key?(:localization_settings) @max_report_rows = args[:max_report_rows] if args.key?(:max_report_rows) @metrics = args[:metrics] if args.key?(:metrics) @sort_conditions = args[:sort_conditions] if args.key?(:sort_conditions) @time_zone = args[:time_zone] if args.key?(:time_zone) end |