Class: Google::Apis::AdmobV1beta::NetworkReportSpec
- Inherits:
-
Object
- Object
- Google::Apis::AdmobV1beta::NetworkReportSpec
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/admob_v1beta/classes.rb,
lib/google/apis/admob_v1beta/representations.rb,
lib/google/apis/admob_v1beta/representations.rb
Overview
The specification for generating an AdMob Network report. For example, the
specification to get clicks and estimated earnings for only the 'US' and 'CN'
countries can look like the following example: 'date_range':
'start_date':
'year': 2021, 'month': 9, 'day': 1
, 'end_date': 'year': 2021, 'month': 9, '
day': 30
, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', '
ESTIMATED_EARNINGS'], 'dimension_filters': [
'dimension': 'COUNTRY', '
matches_any': 'values': [
'value': 'US', 'value': 'CN']
], '
sort_conditions': [
'dimension':'APP', order: 'ASCENDING',
'metric':'CLICKS'
, order: 'DESCENDING'], '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 DATE, APP,
COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2021-09-
01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP,
COUNTRY ORDER BY APP ASC, CLICKS DESC;
Instance Attribute Summary collapse
-
#date_range ⇒ Google::Apis::AdmobV1beta::DateRange
Specification of a single date range.
-
#dimension_filters ⇒ Array<Google::Apis::AdmobV1beta::NetworkReportSpecDimensionFilter>
Describes which report rows to match based on their dimension values.
-
#dimensions ⇒ Array<String>
List of dimensions of the report.
-
#localization_settings ⇒ Google::Apis::AdmobV1beta::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::AdmobV1beta::NetworkReportSpecSortCondition>
Describes the sorting of report rows.
-
#time_zone ⇒ String
A report time zone.
Instance Method Summary collapse
-
#initialize(**args) ⇒ NetworkReportSpec
constructor
A new instance of NetworkReportSpec.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ NetworkReportSpec
Returns a new instance of NetworkReportSpec.
1517 1518 1519 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1517 def initialize(**args) update!(**args) end |
Instance Attribute Details
#date_range ⇒ Google::Apis::AdmobV1beta::DateRange
Specification of a single date range. Both dates are inclusive.
Corresponds to the JSON property dateRange
1470 1471 1472 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1470 def date_range @date_range end |
#dimension_filters ⇒ Array<Google::Apis::AdmobV1beta::NetworkReportSpecDimensionFilter>
Describes which report rows to match based on their dimension values.
Corresponds to the JSON property dimensionFilters
1475 1476 1477 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1475 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
1482 1483 1484 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1482 def dimensions @dimensions end |
#localization_settings ⇒ Google::Apis::AdmobV1beta::LocalizationSettings
Localization settings for reports, such as currency and language. It affects
how metrics are calculated.
Corresponds to the JSON property localizationSettings
1488 1489 1490 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1488 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. Values larger than 100000 return an error.
Corresponds to the JSON property maxReportRows
1495 1496 1497 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1495 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
1500 1501 1502 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1500 def metrics @metrics end |
#sort_conditions ⇒ Array<Google::Apis::AdmobV1beta::NetworkReportSpecSortCondition>
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
1507 1508 1509 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1507 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
1515 1516 1517 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1515 def time_zone @time_zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 |
# File 'lib/google/apis/admob_v1beta/classes.rb', line 1522 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 |