Class: Google::Apis::PlaydeveloperreportingV1alpha1::GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest

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

Overview

Request message for QueryLmkRateMetricSet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest

Returns a new instance of GooglePlayDeveloperReportingV1alpha1QueryLmkRateMetricSetRequest.



1777
1778
1779
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1777

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

Instance Attribute Details

#dimensions ⇒ Array<String>

Optional. Dimensions to slice the metrics by. Supported dimensions: * apiLevel (string): the API level of Android that was running on the user's device, e.g., 26. * versionCode (int64): version of the app that was running on the user's device. * deviceModel (string): unique identifier of the user' s device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * deviceBrand (string): unique identifier of the user's device brand, e.g., google. * deviceType (string): the type (also known as form factor) of the user's device, e.g., PHONE. * countryCode (string): the country or region of the user's device based on their IP address, represented as a 2-letter ISO-3166 code (e.g. US for the United States). * deviceRamBucket (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.) . * deviceSocMake (string): Make of the device's primary system-on-chip, e.g. , Samsung. Reference * deviceSocModel (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". Reference * deviceCpuMake (string): Make of the device's CPU, e.g., Qualcomm. * deviceCpuModel (string): Model of the device's CPU, e.g., "Kryo 240". * deviceGpuMake (string): Make of the device's GPU, e.g., ARM. * deviceGpuModel (string): Model of the device's GPU, e.g., Mali. * deviceGpuVersion (string): Version of the device's GPU, e. g., T750. * deviceVulkanVersion (string): Vulkan version of the device, e.g., "4198400". * deviceGlEsVersion (string): OpenGL ES version of the device, e. g., "196610". * deviceScreenSize (string): Screen size of the device, e.g., NORMAL, LARGE. * deviceScreenDpi (string): Screen density of the device, e.g. , mdpi, hdpi. Corresponds to the JSON property dimensions

Returns:

  • (Array<String>) 


1702
1703
1704
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1702

def dimensions
  @dimensions
end

#filter ⇒ String

Optional. Filters to apply to data. The filtering expression follows AIP-160 standard and supports filtering by equality of all breakdown dimensions. Corresponds to the JSON property filter

Returns:

  • (String) 


1709
1710
1711
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1709

def filter
  @filter
end

#metrics ⇒ Array<String>

Optional. Metrics to aggregate. Supported metrics: * userPerceivedLmkRate (google.type.Decimal): Percentage of distinct users in the aggregation period that experienced at least one LMK while they were actively using your app (a user-perceived LMK). An app is considered to be in active use if it is displaying any activity or executing any foreground service. * userPerceivedLmkRate7dUserWeighted (google.type.Decimal): Rolling average value of userPerceivedLmkRate in the last 7 days. The daily values are weighted by the count of distinct users for the day. * userPerceivedLmkRate28dUserWeighted (google.type.Decimal): Rolling average value of userPerceivedLmkRate in the last 28 days. The daily values are weighted by the count of distinct users for the day. * distinctUsers ( google.type.Decimal): Count of distinct users in the aggregation period that were used as normalization value for the userPerceivedLmkRate metrics. A user is counted in this metric if they used the app in the foreground during the aggregation period. Care must be taken not to aggregate this count further, as it may result in users being counted multiple times. The value is rounded to the nearest multiple of 10, 100, 1,000 or 1,000,000, depending on the magnitude of the value. Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


1731
1732
1733
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1731

def metrics
  @metrics
end

#page_size ⇒ Fixnum

Optional. Maximum size of the returned data. If unspecified, at most 1000 rows will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1738
1739
1740
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1738

def page_size
  @page_size
end

#page_token ⇒ String

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1745
1746
1747
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1745

def page_token
  @page_token
end

#timeline_spec ⇒ Google::Apis::PlaydeveloperreportingV1alpha1::GooglePlayDeveloperReportingV1alpha1TimelineSpec

Specification of the time-related aggregation parameters of a timeline. Timelines have an aggregation period (DAILY, HOURLY, etc) which defines how events are aggregated in metrics. The points in a timeline are defined by the starting DateTime of the aggregation period. The duration is implicit in the AggregationPeriod. Hourly aggregation periods, when supported by a metric set, are always specified in UTC to avoid ambiguities around daylight saving time transitions, where an hour is skipped when adopting DST, and repeated when abandoning DST. For example, the timestamp '2021-11-07 01:00:00 America/ Los_Angeles' is ambiguous since it can correspond to '2021-11-07 08:00:00 UTC' or '2021-11-07 09:00:00 UTC'. Daily aggregation periods require specifying a timezone which will determine the precise instants of the start and the end of the day. Not all metric sets support all timezones, so make sure to check which timezones are supported by the metric set you want to query. Corresponds to the JSON property timelineSpec

Returns:



1762
1763
1764
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1762

def timeline_spec
  @timeline_spec
end

#user_cohort ⇒ String

Optional. User view to select. The output data will correspond to the selected view. Supported values: * OS_PUBLIC To select data from all publicly released Android versions. This is the default. Supports all the above dimensions. * APP_TESTERS To select data from users who have opted in to be testers. Supports all the above dimensions. * OS_BETA To select data from beta android versions only, excluding data from released android versions. Only the following dimensions are supported: * versionCode (int64): version of the app that was running on the user's device. * osBuild (string): OS build of the user's device, e.g., "T1B2.220916.004". Corresponds to the JSON property userCohort

Returns:

  • (String) 


1775
1776
1777
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1775

def user_cohort
  @user_cohort
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/google/apis/playdeveloperreporting_v1alpha1/classes.rb', line 1782

def update!(**args)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @filter = args[:filter] if args.key?(:filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @timeline_spec = args[:timeline_spec] if args.key?(:timeline_spec)
  @user_cohort = args[:user_cohort] if args.key?(:user_cohort)
end