<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\Playdeveloperreporting;

class GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest extends \Google\Collection
{
  /**
   * Unspecified User cohort. This will automatically choose the default value.
   */
  public const USER_COHORT_USER_COHORT_UNSPECIFIED = 'USER_COHORT_UNSPECIFIED';
  /**
   * This is default view. Contains data from public released android versions
   * only.
   */
  public const USER_COHORT_OS_PUBLIC = 'OS_PUBLIC';
  /**
   * This is the view with just android beta data excluding released OS version
   * data.
   */
  public const USER_COHORT_OS_BETA = 'OS_BETA';
  /**
   * This is the view with data only from users who have opted in to be testers
   * for a given app, excluding OS beta data.
   */
  public const USER_COHORT_APP_TESTERS = 'APP_TESTERS';
  protected $collection_key = 'metrics';
  /**
   * 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](htt
   * ps://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) *
   * `deviceSocModel` (string): Model of the device's primary system-on-chip,
   * e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/an
   * droid/os/Build#SOC_MODEL) * `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.
   *
   * @var string[]
   */
  public $dimensions;
  /**
   * Optional. Filters to apply to data. The filtering expression follows
   * [AIP-160](https://google.aip.dev/160) standard and supports filtering by
   * equality of all breakdown dimensions.
   *
   * @var string
   */
  public $filter;
  /**
   * 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.
   *
   * @var string[]
   */
  public $metrics;
  /**
   * 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.
   *
   * @var int
   */
  public $pageSize;
  /**
   * 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.
   *
   * @var string
   */
  public $pageToken;
  protected $timelineSpecType = GooglePlayDeveloperReportingV1beta1TimelineSpec::class;
  protected $timelineSpecDataType = '';
  /**
   * 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".
   *
   * @var string
   */
  public $userCohort;

  /**
   * 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](htt
   * ps://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) *
   * `deviceSocModel` (string): Model of the device's primary system-on-chip,
   * e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/an
   * droid/os/Build#SOC_MODEL) * `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.
   *
   * @param string[] $dimensions
   */
  public function setDimensions($dimensions)
  {
    $this->dimensions = $dimensions;
  }
  /**
   * @return string[]
   */
  public function getDimensions()
  {
    return $this->dimensions;
  }
  /**
   * Optional. Filters to apply to data. The filtering expression follows
   * [AIP-160](https://google.aip.dev/160) standard and supports filtering by
   * equality of all breakdown dimensions.
   *
   * @param string $filter
   */
  public function setFilter($filter)
  {
    $this->filter = $filter;
  }
  /**
   * @return string
   */
  public function getFilter()
  {
    return $this->filter;
  }
  /**
   * 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.
   *
   * @param string[] $metrics
   */
  public function setMetrics($metrics)
  {
    $this->metrics = $metrics;
  }
  /**
   * @return string[]
   */
  public function getMetrics()
  {
    return $this->metrics;
  }
  /**
   * 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.
   *
   * @param int $pageSize
   */
  public function setPageSize($pageSize)
  {
    $this->pageSize = $pageSize;
  }
  /**
   * @return int
   */
  public function getPageSize()
  {
    return $this->pageSize;
  }
  /**
   * 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.
   *
   * @param string $pageToken
   */
  public function setPageToken($pageToken)
  {
    $this->pageToken = $pageToken;
  }
  /**
   * @return string
   */
  public function getPageToken()
  {
    return $this->pageToken;
  }
  /**
   * Optional. Specification of the timeline aggregation parameters. **Supported
   * aggregation periods:** * DAILY: metrics are aggregated in calendar date
   * intervals. Due to historical constraints, the default and only supported
   * timezone is `America/Los_Angeles`.
   *
   * @param GooglePlayDeveloperReportingV1beta1TimelineSpec $timelineSpec
   */
  public function setTimelineSpec(GooglePlayDeveloperReportingV1beta1TimelineSpec $timelineSpec)
  {
    $this->timelineSpec = $timelineSpec;
  }
  /**
   * @return GooglePlayDeveloperReportingV1beta1TimelineSpec
   */
  public function getTimelineSpec()
  {
    return $this->timelineSpec;
  }
  /**
   * 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".
   *
   * Accepted values: USER_COHORT_UNSPECIFIED, OS_PUBLIC, OS_BETA, APP_TESTERS
   *
   * @param self::USER_COHORT_* $userCohort
   */
  public function setUserCohort($userCohort)
  {
    $this->userCohort = $userCohort;
  }
  /**
   * @return self::USER_COHORT_*
   */
  public function getUserCohort()
  {
    return $this->userCohort;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest::class, 'Google_Service_Playdeveloperreporting_GooglePlayDeveloperReportingV1beta1QueryLmkRateMetricSetRequest');
