Class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaRunAccessReportRequest

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

Overview

The request for a Data Access Record Report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1betaRunAccessReportRequest

Returns a new instance of GoogleAnalyticsAdminV1betaRunAccessReportRequest.



2005
2006
2007
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 2005

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

Instance Attribute Details

#date_ranges ⇒ Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDateRange>

Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. Corresponds to the JSON property dateRanges

Returns:



1935
1936
1937
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1935

def date_ranges
  @date_ranges
end

#dimension_filter ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression

Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. Corresponds to the JSON property dimensionFilter

Returns:



1941
1942
1943
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1941

def dimension_filter
  @dimension_filter
end

#dimensions ⇒ Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessDimension>

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. Corresponds to the JSON property dimensions

Returns:



1947
1948
1949
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1947

def dimensions
  @dimensions
end

#limit ⇒ Fixnum

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive. The API may return fewer rows than the requested limit, if there aren't as many remaining rows as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


1960
1961
1962
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1960

def limit
  @limit
end

#metric_filter ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessFilterExpression

Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. Corresponds to the JSON property metricFilter

Returns:



1966
1967
1968
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1966

def metric_filter
  @metric_filter
end

#metrics ⇒ Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessMetric>

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. Corresponds to the JSON property metrics

Returns:



1972
1973
1974
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1972

def metrics
  @metrics
end

#offset ⇒ Fixnum

The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries. To learn more about this pagination parameter, see Pagination. Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


1981
1982
1983
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1981

def offset
  @offset
end

#order_bys ⇒ Array<Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccessOrderBy>

Specifies how rows are ordered in the response. Corresponds to the JSON property orderBys

Returns:



1986
1987
1988
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1986

def order_bys
  @order_bys
end

#return_entity_quota ⇒ Boolean Also known as: return_entity_quota?

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false. Corresponds to the JSON property returnEntityQuota

Returns:

  • (Boolean) 


1993
1994
1995
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1993

def return_entity_quota
  @return_entity_quota
end

#time_zone ⇒ String

This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database ( https://www.iana.org/time-zones); for example "America/New_York" or "Asia/ Tokyo". Corresponds to the JSON property timeZone

Returns:

  • (String) 


2003
2004
2005
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 2003

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 2010

def update!(**args)
  @date_ranges = args[:date_ranges] if args.key?(:date_ranges)
  @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_filter = args[:metric_filter] if args.key?(:metric_filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @offset = args[:offset] if args.key?(:offset)
  @order_bys = args[:order_bys] if args.key?(:order_bys)
  @return_entity_quota = args[:return_entity_quota] if args.key?(:return_entity_quota)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end