Class: Google::Apis::AdmobV1::NetworkReportSpec
- Inherits:
-
Object
- Object
- Google::Apis::AdmobV1::NetworkReportSpec
- 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 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': 2018, 'month': 9, 'day': 1
, 'end_date': 'year': 2018, '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 >= '2018-09-
01' AND DATE <= '2018-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::AdmobV1::DateRange
Specification of a single date range.
-
#dimension_filters ⇒ Array<Google::Apis::AdmobV1::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::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::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.
513 514 515 |
# File 'generated/google/apis/admob_v1/classes.rb', line 513 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
466 467 468 |
# File 'generated/google/apis/admob_v1/classes.rb', line 466 def date_range @date_range end |
#dimension_filters ⇒ Array<Google::Apis::AdmobV1::NetworkReportSpecDimensionFilter>
Describes which report rows to match based on their dimension values.
Corresponds to the JSON property dimensionFilters
471 472 473 |
# File 'generated/google/apis/admob_v1/classes.rb', line 471 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
478 479 480 |
# File 'generated/google/apis/admob_v1/classes.rb', line 478 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
484 485 486 |
# File 'generated/google/apis/admob_v1/classes.rb', line 484 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
491 492 493 |
# File 'generated/google/apis/admob_v1/classes.rb', line 491 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
496 497 498 |
# File 'generated/google/apis/admob_v1/classes.rb', line 496 def metrics @metrics end |
#sort_conditions ⇒ Array<Google::Apis::AdmobV1::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
503 504 505 |
# File 'generated/google/apis/admob_v1/classes.rb', line 503 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
511 512 513 |
# File 'generated/google/apis/admob_v1/classes.rb', line 511 def time_zone @time_zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
518 519 520 521 522 523 524 525 526 527 |
# File 'generated/google/apis/admob_v1/classes.rb', line 518 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 |