class Google::Apis::AdmobV1beta::NetworkReportSpec
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;
Attributes
Specification of a single date range. Both dates are inclusive. Corresponds to the JSON property `dateRange` @return [Google::Apis::AdmobV1beta::DateRange]
Describes which report rows to match based on their dimension values. Corresponds to the JSON property `dimensionFilters` @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecDimensionFilter>]
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` @return [Array<String>]
Localization settings for reports, such as currency and language. It affects how metrics are calculated. Corresponds to the JSON property `localizationSettings` @return [Google::Apis::AdmobV1beta::LocalizationSettings]
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` @return [Fixnum]
List of metrics of the report. A report must specify at least one metric. Corresponds to the JSON property `metrics` @return [Array<String>]
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` @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecSortCondition>]
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` @return [String]
Public Class Methods
# File lib/google/apis/admob_v1beta/classes.rb, line 727 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/admob_v1beta/classes.rb, line 732 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