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.



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

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

Instance Attribute Details

#currency_codeString

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_rowBoolean 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_reasonString

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_responseGoogle::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



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

def schema_restriction_response
  @schema_restriction_response
end

#time_zoneString

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)


1492
1493
1494
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1492

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1499
1500
1501
1502
1503
1504
1505
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1499

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