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.



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

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) 


1465
1466
1467
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1465

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) 


1471
1472
1473
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1471

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) 


1477
1478
1479
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1477

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:



1484
1485
1486
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1484

def schema_restriction_response
  @schema_restriction_response
end

#thresholding_applied ⇒ Boolean Also known as: thresholding_applied?

If thresholdingApplied is true, this report has thresholding applied and only returns data that meets the minimum aggregation thresholds. This boolean only indicates if thresholding was applied. It is possible for thresholding to be applied 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 thresholdingApplied

Returns:

  • (Boolean) 


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

def thresholding_applied
  @thresholding_applied
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) 


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

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1511

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)
  @thresholding_applied = args[:thresholding_applied] if args.key?(:thresholding_applied)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end