Class: Google::Apis::AnalyticsdataV1beta::ResponseMetaData

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

Overview

Response's metadata carrying additional information about the report content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ResponseMetaData

Returns a new instance of ResponseMetaData.



1516
1517
1518
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1516

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

Instance Attribute Details

#currency_code ⇒ String

The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/ 9796179. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


1475
1476
1477
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1475

def currency_code
  @currency_code
end

#data_loss_from_other_row ⇒ Boolean Also known as: data_loss_from_other_row?

If true, indicates some buckets of dimension combinations are rolled into "( other)" row. This can happen for high cardinality reports. Corresponds to the JSON property dataLossFromOtherRow

Returns:

  • (Boolean) 


1481
1482
1483
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1481

def data_loss_from_other_row
  @data_loss_from_other_row
end

#empty_reason ⇒ String

If empty reason is specified, the report is empty for this reason. Corresponds to the JSON property emptyReason

Returns:

  • (String) 


1487
1488
1489
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1487

def empty_reason
  @empty_reason
end

#schema_restriction_response ⇒ Google::Apis::AnalyticsdataV1beta::SchemaRestrictionResponse

The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management. Corresponds to the JSON property schemaRestrictionResponse

Returns:



1494
1495
1496
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1494

def schema_restriction_response
  @schema_restriction_response
end

#subject_to_thresholding ⇒ Boolean Also known as: subject_to_thresholding?

If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see Data thresholds and About Demographics and Interests. Corresponds to the JSON property subjectToThresholding

Returns:

  • (Boolean) 


1505
1506
1507
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1505

def subject_to_thresholding
  @subject_to_thresholding
end

#time_zone ⇒ String

The property's current timezone. Intended to be used to interpret time-based dimensions like hour and minute. 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) 


1514
1515
1516
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1514

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1521

def update!(**args)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row)
  @empty_reason = args[:empty_reason] if args.key?(:empty_reason)
  @schema_restriction_response = args[:schema_restriction_response] if args.key?(:schema_restriction_response)
  @subject_to_thresholding = args[:subject_to_thresholding] if args.key?(:subject_to_thresholding)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end