diff --git a/api_names_out.yaml b/api_names_out.yaml index 264ffca22..e5364d34d 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -6967,6 +6967,34 @@ "/analyticsdata:v1alpha/RunPivotReportResponse/propertyQuota": property_quota "/analyticsdata:v1alpha/RunPivotReportResponse/rows": rows "/analyticsdata:v1alpha/RunPivotReportResponse/rows/row": row +"/analyticsdata:v1alpha/RunRealtimeReportRequest": run_realtime_report_request +"/analyticsdata:v1alpha/RunRealtimeReportRequest/dimensionFilter": dimension_filter +"/analyticsdata:v1alpha/RunRealtimeReportRequest/dimensions": dimensions +"/analyticsdata:v1alpha/RunRealtimeReportRequest/dimensions/dimension": dimension +"/analyticsdata:v1alpha/RunRealtimeReportRequest/limit": limit +"/analyticsdata:v1alpha/RunRealtimeReportRequest/metricAggregations": metric_aggregations +"/analyticsdata:v1alpha/RunRealtimeReportRequest/metricAggregations/metric_aggregation": metric_aggregation +"/analyticsdata:v1alpha/RunRealtimeReportRequest/metricFilter": metric_filter +"/analyticsdata:v1alpha/RunRealtimeReportRequest/metrics": metrics +"/analyticsdata:v1alpha/RunRealtimeReportRequest/metrics/metric": metric +"/analyticsdata:v1alpha/RunRealtimeReportRequest/orderBys": order_bys +"/analyticsdata:v1alpha/RunRealtimeReportRequest/orderBys/order_by": order_by +"/analyticsdata:v1alpha/RunRealtimeReportRequest/returnPropertyQuota": return_property_quota +"/analyticsdata:v1alpha/RunRealtimeReportResponse": run_realtime_report_response +"/analyticsdata:v1alpha/RunRealtimeReportResponse/dimensionHeaders": dimension_headers +"/analyticsdata:v1alpha/RunRealtimeReportResponse/dimensionHeaders/dimension_header": dimension_header +"/analyticsdata:v1alpha/RunRealtimeReportResponse/maximums": maximums +"/analyticsdata:v1alpha/RunRealtimeReportResponse/maximums/maximum": maximum +"/analyticsdata:v1alpha/RunRealtimeReportResponse/metricHeaders": metric_headers +"/analyticsdata:v1alpha/RunRealtimeReportResponse/metricHeaders/metric_header": metric_header +"/analyticsdata:v1alpha/RunRealtimeReportResponse/minimums": minimums +"/analyticsdata:v1alpha/RunRealtimeReportResponse/minimums/minimum": minimum +"/analyticsdata:v1alpha/RunRealtimeReportResponse/propertyQuota": property_quota +"/analyticsdata:v1alpha/RunRealtimeReportResponse/rowCount": row_count +"/analyticsdata:v1alpha/RunRealtimeReportResponse/rows": rows +"/analyticsdata:v1alpha/RunRealtimeReportResponse/rows/row": row +"/analyticsdata:v1alpha/RunRealtimeReportResponse/totals": totals +"/analyticsdata:v1alpha/RunRealtimeReportResponse/totals/total": total "/analyticsdata:v1alpha/RunReportRequest": run_report_request "/analyticsdata:v1alpha/RunReportRequest/cohortSpec": cohort_spec "/analyticsdata:v1alpha/RunReportRequest/currencyCode": currency_code @@ -7016,6 +7044,8 @@ "/analyticsdata:v1alpha/analyticsdata.batchRunReports": batch_run_reports "/analyticsdata:v1alpha/analyticsdata.properties.getMetadata": get_property_metadata "/analyticsdata:v1alpha/analyticsdata.properties.getMetadata/name": name +"/analyticsdata:v1alpha/analyticsdata.properties.runRealtimeReport": run_property_realtime_report +"/analyticsdata:v1alpha/analyticsdata.properties.runRealtimeReport/property": property "/analyticsdata:v1alpha/analyticsdata.runPivotReport": run_pivot_report "/analyticsdata:v1alpha/analyticsdata.runReport": run_report "/analyticsdata:v1alpha/fields": fields diff --git a/generated/google/apis/analyticsdata_v1alpha.rb b/generated/google/apis/analyticsdata_v1alpha.rb index 05970e531..36adb884d 100644 --- a/generated/google/apis/analyticsdata_v1alpha.rb +++ b/generated/google/apis/analyticsdata_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/analytics/trusted-testing/analytics-data/ module AnalyticsdataV1alpha VERSION = 'V1alpha' - REVISION = '20201023' + REVISION = '20201030' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' diff --git a/generated/google/apis/analyticsdata_v1alpha/classes.rb b/generated/google/apis/analyticsdata_v1alpha/classes.rb index 8eec634e2..87703bccc 100644 --- a/generated/google/apis/analyticsdata_v1alpha/classes.rb +++ b/generated/google/apis/analyticsdata_v1alpha/classes.rb @@ -571,7 +571,10 @@ module Google # @return [Google::Apis::AnalyticsdataV1alpha::InListFilter] attr_accessor :in_list_filter - # A filter for null values. + # A filter for null values. If True, a null dimension value is matched by this + # filter. Null filter is commonly used inside a NOT filter expression. For + # example, a NOT expression of a null filter removes rows when a dimension is + # null. # Corresponds to the JSON property `nullFilter` # @return [Boolean] attr_accessor :null_filter @@ -1213,11 +1216,12 @@ module Google end end - # Report data for each row. For example if RunReportRequest contains: ```none - # dimensions ` name: "eventName" ` dimensions ` name: "countryId" ` metrics ` - # name: "eventCount" ` ``` One row with 'in_app_purchase' as the eventName, 'us' - # as the countryId, and 15 as the eventCount, would be: ```none dimension_values - # ` name: 'in_app_purchase' name: 'us' ` metric_values ` int64_value: 15 ` ``` + # Report data for each row. For example if RunReportRequest contains: ```none " + # dimensions": [ ` "name": "eventName" `, ` "name": "countryId" ` ], "metrics": [ + # ` "name": "eventCount" ` ] ``` One row with 'in_app_purchase' as the + # eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none " + # dimensionValues": [ ` "value": "in_app_purchase" `, ` "value": "JP" ` ], " + # metricValues": [ ` "value": "15" ` ] ``` class Row include Google::Apis::Core::Hashable @@ -1409,6 +1413,141 @@ module Google end end + # The request to generate a realtime report. + class RunRealtimeReportRequest + include Google::Apis::Core::Hashable + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `dimensionFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :dimension_filter + + # The dimensions requested and displayed. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The number of rows to return. If unspecified, 10 rows are returned. If -1, all + # rows are returned. + # Corresponds to the JSON property `limit` + # @return [Fixnum] + attr_accessor :limit + + # Aggregation of metrics. Aggregated metric values will be shown in rows where + # the dimension_values are set to "RESERVED_(MetricAggregation)". + # Corresponds to the JSON property `metricAggregations` + # @return [Array] + attr_accessor :metric_aggregations + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `metricFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :metric_filter + + # The metrics requested and displayed. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Specifies how rows are ordered in the response. + # Corresponds to the JSON property `orderBys` + # @return [Array] + attr_accessor :order_bys + + # Toggles whether to return the current state of this Analytics Property's + # Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). + # Corresponds to the JSON property `returnPropertyQuota` + # @return [Boolean] + attr_accessor :return_property_quota + alias_method :return_property_quota?, :return_property_quota + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @limit = args[:limit] if args.key?(:limit) + @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations) + @metric_filter = args[:metric_filter] if args.key?(:metric_filter) + @metrics = args[:metrics] if args.key?(:metrics) + @order_bys = args[:order_bys] if args.key?(:order_bys) + @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota) + end + end + + # The response realtime report table corresponding to a request. + class RunRealtimeReportResponse + include Google::Apis::Core::Hashable + + # Describes dimension columns. The number of DimensionHeaders and ordering of + # DimensionHeaders matches the dimensions present in rows. + # Corresponds to the JSON property `dimensionHeaders` + # @return [Array] + attr_accessor :dimension_headers + + # If requested, the maximum values of metrics. + # Corresponds to the JSON property `maximums` + # @return [Array] + attr_accessor :maximums + + # Describes metric columns. The number of MetricHeaders and ordering of + # MetricHeaders matches the metrics present in rows. + # Corresponds to the JSON property `metricHeaders` + # @return [Array] + attr_accessor :metric_headers + + # If requested, the minimum values of metrics. + # Corresponds to the JSON property `minimums` + # @return [Array] + attr_accessor :minimums + + # Current state of all quotas for this Analytics Property. If any quota for a + # property is exhausted, all requests to that property will return Resource + # Exhausted errors. + # Corresponds to the JSON property `propertyQuota` + # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota] + attr_accessor :property_quota + + # The total number of rows in the query result, regardless of the number of rows + # returned in the response. For example if a query returns 175 rows and includes + # limit = 50 in the API request, the response will contain row_count = 175 but + # only 50 rows. + # Corresponds to the JSON property `rowCount` + # @return [Fixnum] + attr_accessor :row_count + + # Rows of dimension value combinations and metric values in the report. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # If requested, the totaled values of metrics. + # Corresponds to the JSON property `totals` + # @return [Array] + attr_accessor :totals + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers) + @maximums = args[:maximums] if args.key?(:maximums) + @metric_headers = args[:metric_headers] if args.key?(:metric_headers) + @minimums = args[:minimums] if args.key?(:minimums) + @property_quota = args[:property_quota] if args.key?(:property_quota) + @row_count = args[:row_count] if args.key?(:row_count) + @rows = args[:rows] if args.key?(:rows) + @totals = args[:totals] if args.key?(:totals) + end + end + # The request to generate a report. class RunReportRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/analyticsdata_v1alpha/representations.rb b/generated/google/apis/analyticsdata_v1alpha/representations.rb index be4cccc0b..46cf0b2c1 100644 --- a/generated/google/apis/analyticsdata_v1alpha/representations.rb +++ b/generated/google/apis/analyticsdata_v1alpha/representations.rb @@ -280,6 +280,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RunRealtimeReportRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RunRealtimeReportResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RunReportRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -732,6 +744,46 @@ module Google end end + class RunRealtimeReportRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1alpha::Dimension, decorator: Google::Apis::AnalyticsdataV1alpha::Dimension::Representation + + property :limit, :numeric_string => true, as: 'limit' + collection :metric_aggregations, as: 'metricAggregations' + property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1alpha::Metric, decorator: Google::Apis::AnalyticsdataV1alpha::Metric::Representation + + collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsdataV1alpha::OrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::OrderBy::Representation + + property :return_property_quota, as: 'returnPropertyQuota' + end + end + + class RunRealtimeReportResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_headers, as: 'dimensionHeaders', class: Google::Apis::AnalyticsdataV1alpha::DimensionHeader, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionHeader::Representation + + collection :maximums, as: 'maximums', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + collection :metric_headers, as: 'metricHeaders', class: Google::Apis::AnalyticsdataV1alpha::MetricHeader, decorator: Google::Apis::AnalyticsdataV1alpha::MetricHeader::Representation + + collection :minimums, as: 'minimums', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + property :property_quota, as: 'propertyQuota', class: Google::Apis::AnalyticsdataV1alpha::PropertyQuota, decorator: Google::Apis::AnalyticsdataV1alpha::PropertyQuota::Representation + + property :row_count, as: 'rowCount' + collection :rows, as: 'rows', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + collection :totals, as: 'totals', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + end + end + class RunReportRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/analyticsdata_v1alpha/service.rb b/generated/google/apis/analyticsdata_v1alpha/service.rb index 2ce8540c9..b2b448d00 100644 --- a/generated/google/apis/analyticsdata_v1alpha/service.rb +++ b/generated/google/apis/analyticsdata_v1alpha/service.rb @@ -88,6 +88,44 @@ module Google execute_or_queue_command(command, &block) end + # The Google Analytics Realtime API returns a customized report of realtime + # event data for your property. These reports show events and usage from the + # last 30 minutes. + # @param [String] property + # A Google Analytics GA4 property identifier whose events are tracked. Specified + # in the URL path and not the body. To learn more, see [where to find your + # Property ID](https://developers.google.com/analytics/trusted-testing/analytics- + # data/property-id). Example: properties/1234 + # @param [Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportRequest] run_realtime_report_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_property_realtime_report(property, run_realtime_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha/{+property}:runRealtimeReport', options) + command.request_representation = Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportRequest::Representation + command.request_object = run_realtime_report_request_object + command.response_representation = Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportResponse::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::RunRealtimeReportResponse + command.params['property'] = property unless property.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Returns multiple pivot reports in a batch. All reports must be for the same # Entity. # @param [Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsRequest] batch_run_pivot_reports_request_object diff --git a/generated/google/apis/analyticsdata_v1alpha/synth.metadata b/generated/google/apis/analyticsdata_v1alpha/synth.metadata index 4325a4869..eea78d816 100644 --- a/generated/google/apis/analyticsdata_v1alpha/synth.metadata +++ b/generated/google/apis/analyticsdata_v1alpha/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "f7fd8441cea0c111e25170a6e4ea5676fdd23164" + "sha": "d99b4075b0c4b6f712495b22315268d5f28038c0" } } ]