Class: Google::Apis::AnalyticsreportingV4::ReportRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb

Overview

The main request class which specifies the Reporting API request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReportRequest

Returns a new instance of ReportRequest.


501
502
503
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 501

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cohort_groupGoogle::Apis::AnalyticsreportingV4::CohortGroup

Defines a cohort group. For example: "cohortGroup": "cohorts": [ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": "startDate": "2015-08-01", "endDate": "2015-08-01" , "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": "startDate": "2015-07-01", "endDate": "2015-07-01" ] Corresponds to the JSON property cohortGroup


361
362
363
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 361

def cohort_group
  @cohort_group
end

#date_rangesArray<Google::Apis::AnalyticsreportingV4::DateRange>

Date ranges in the request. The request can have a maximum of 2 date ranges. The response will contain a set of metric values for each combination of the dimensions for each date range in the request. So, if there are two date ranges, there will be two set of metric values, one for the original date range and one for the second date range. The reportRequest.dateRanges field should not be specified for cohorts or Lifetime value requests. If a date range is not provided, the default date range is (startDate: current date - 7 days, endDate: current date - 1 day). Every ReportRequest within a batchGet method must contain the same dateRanges definition. Corresponds to the JSON property dateRanges


418
419
420
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 418

def date_ranges
  @date_ranges
end

#dimension_filter_clausesArray<Google::Apis::AnalyticsreportingV4::DimensionFilterClause>

The dimension filter clauses for filtering Dimension Values. They are logically combined with the AND operator. Note that filtering occurs before any dimensions are aggregated, so that the returned metrics represent the total for only the relevant dimensions. Corresponds to the JSON property dimensionFilterClauses


398
399
400
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 398

def dimension_filter_clauses
  @dimension_filter_clauses
end

#dimensionsArray<Google::Apis::AnalyticsreportingV4::Dimension>

The dimensions requested. Requests can have a total of 7 dimensions. Corresponds to the JSON property dimensions


367
368
369
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 367

def dimensions
  @dimensions
end

#filters_expressionString

Dimension or metric filters that restrict the data returned for your request. To use the filtersExpression, supply a dimension or metric on which to filter, followed by the filter expression. For example, the following expression selects ga:browser dimension which starts with Firefox; ga:browser=~^Firefox. For more information on dimensions and metric filters, see Filters reference. Corresponds to the JSON property filtersExpression

Returns:

  • (String)

476
477
478
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 476

def filters_expression
  @filters_expression
end

#hide_totalsBoolean Also known as: hide_totals?

If set to true, hides the total of all metrics for all the matching rows, for every date range. The default false and will return the totals. Corresponds to the JSON property hideTotals

Returns:

  • (Boolean)

381
382
383
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 381

def hide_totals
  @hide_totals
end

#hide_value_rangesBoolean Also known as: hide_value_ranges?

If set to true, hides the minimum and maximum across all matching rows. The default is false and the value ranges are returned. Corresponds to the JSON property hideValueRanges

Returns:

  • (Boolean)

482
483
484
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 482

def hide_value_ranges
  @hide_value_ranges
end

#include_empty_rowsBoolean Also known as: include_empty_rows?

If set to false, the response does not include rows if all the retrieved metrics are equal to zero. The default is false which will exclude these rows. Corresponds to the JSON property includeEmptyRows

Returns:

  • (Boolean)

389
390
391
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 389

def include_empty_rows
  @include_empty_rows
end

#metric_filter_clausesArray<Google::Apis::AnalyticsreportingV4::MetricFilterClause>

The metric filter clauses. They are logically combined with the AND operator. Metric filters look at only the first date range and not the comparing date range. Note that filtering on metrics occurs after the metrics are aggregated. Corresponds to the JSON property metricFilterClauses


375
376
377
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 375

def metric_filter_clauses
  @metric_filter_clauses
end

#metricsArray<Google::Apis::AnalyticsreportingV4::Metric>

The metrics requested. Requests must specify at least one metric. Requests can have a total of 10 metrics. Corresponds to the JSON property metrics


445
446
447
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 445

def metrics
  @metrics
end

#order_bysArray<Google::Apis::AnalyticsreportingV4::OrderBy>

Sort order on output rows. To compare two rows, the elements of the following are applied in order until a difference is found. All date ranges in the output get the same row order. Corresponds to the JSON property orderBys


464
465
466
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 464

def order_bys
  @order_bys
end

#page_sizeFixnum

Page size is for paging and specifies the maximum number of returned rows. Page size should be >= 0. A query returns the default of 1,000 rows. The Analytics Core Reporting API returns a maximum of 10,000 rows per request, no matter how many you ask for. It can also return fewer rows than requested, if there aren't as many dimension segments as you expect. For instance, there are fewer than 300 possible values for ga:country, so when segmenting only by country, you can't get more than 300 rows, even if you set pageSize to a higher value. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum)

457
458
459
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 457

def page_size
  @page_size
end

#page_tokenString

A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the GetReports request. Corresponds to the JSON property pageToken

Returns:

  • (String)

499
500
501
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 499

def page_token
  @page_token
end

#pivotsArray<Google::Apis::AnalyticsreportingV4::Pivot>

The pivot definitions. Requests can have a maximum of 2 pivots. Corresponds to the JSON property pivots


403
404
405
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 403

def pivots
  @pivots
end

#sampling_levelString

The desired report sample size. If the the samplingLevel field is unspecified the DEFAULT sampling level is used. Every ReportRequest within a batchGet method must contain the same samplingLevel definition. See developer guide for details. Corresponds to the JSON property samplingLevel

Returns:

  • (String)

438
439
440
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 438

def sampling_level
  @sampling_level
end

#segmentsArray<Google::Apis::AnalyticsreportingV4::Segment>

Segment the data returned for the request. A segment definition helps look at a subset of the segment request. A request can contain up to four segments. Every ReportRequest within a batchGet method must contain the same segments definition. Requests with segments must have the ga:segment dimension. Corresponds to the JSON property segments


427
428
429
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 427

def segments
  @segments
end

#view_idString

The Analytics view ID from which to retrieve data. Every ReportRequest within a batchGet method must contain the same viewId. Corresponds to the JSON property viewId

Returns:

  • (String)

491
492
493
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 491

def view_id
  @view_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 506

def update!(**args)
  @cohort_group = args[:cohort_group] if args.key?(:cohort_group)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @metric_filter_clauses = args[:metric_filter_clauses] if args.key?(:metric_filter_clauses)
  @hide_totals = args[:hide_totals] if args.key?(:hide_totals)
  @include_empty_rows = args[:include_empty_rows] if args.key?(:include_empty_rows)
  @dimension_filter_clauses = args[:dimension_filter_clauses] if args.key?(:dimension_filter_clauses)
  @pivots = args[:pivots] if args.key?(:pivots)
  @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
  @segments = args[:segments] if args.key?(:segments)
  @sampling_level = args[:sampling_level] if args.key?(:sampling_level)
  @metrics = args[:metrics] if args.key?(:metrics)
  @page_size = args[:page_size] if args.key?(:page_size)
  @order_bys = args[:order_bys] if args.key?(:order_bys)
  @filters_expression = args[:filters_expression] if args.key?(:filters_expression)
  @hide_value_ranges = args[:hide_value_ranges] if args.key?(:hide_value_ranges)
  @view_id = args[:view_id] if args.key?(:view_id)
  @page_token = args[:page_token] if args.key?(:page_token)
end