File "NetworkReportSpecSortCondition.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/AdMob/NetworkReportSpecSortCondition.php
File size: 7.33 KB
MIME-type: text/x-php
Charset: utf-8
<?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\AdMob;
class NetworkReportSpecSortCondition extends \Google\Model
{
/**
* Default value for an unset field. Do not use.
*/
public const DIMENSION_DIMENSION_UNSPECIFIED = 'DIMENSION_UNSPECIFIED';
/**
* A date in the YYYYMMDD format (for example, "20210701"). Requests can
* specify at most one time dimension.
*/
public const DIMENSION_DATE = 'DATE';
/**
* A month in the YYYYMM format (for example, "202107"). Requests can specify
* at most one time dimension.
*/
public const DIMENSION_MONTH = 'MONTH';
/**
* The date of the first day of a week in the YYYYMMDD format (for example,
* "20210701"). Requests can specify at most one time dimension.
*/
public const DIMENSION_WEEK = 'WEEK';
/**
* The unique ID of the ad unit (for example, "ca-app-pub-1234/1234"). If
* AD_UNIT dimension is specified, then APP is included automatically.
*/
public const DIMENSION_AD_UNIT = 'AD_UNIT';
/**
* The unique ID of the mobile application (for example, "ca-app-
* pub-1234~1234").
*/
public const DIMENSION_APP = 'APP';
/**
* Type of the ad (for example, "text" or "image"), an ad delivery dimension.
* **Warning:** The dimension is incompatible with
* [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),
* [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and
* [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.
*/
public const DIMENSION_AD_TYPE = 'AD_TYPE';
/**
* CLDR country code of the place where the ad views/clicks occur (for
* example, "US" or "FR"). This is a geography dimension.
*/
public const DIMENSION_COUNTRY = 'COUNTRY';
/**
* Format of the ad unit (for example, "banner", "native"), an ad delivery
* dimension.
*/
public const DIMENSION_FORMAT = 'FORMAT';
/**
* Mobile OS platform of the app (for example, "Android" or "iOS").
*/
public const DIMENSION_PLATFORM = 'PLATFORM';
/**
* Mobile operating system version, e.g. "iOS 13.5.1".
*/
public const DIMENSION_MOBILE_OS_VERSION = 'MOBILE_OS_VERSION';
/**
* GMA SDK version, e.g. "iOS 7.62.0".
*/
public const DIMENSION_GMA_SDK_VERSION = 'GMA_SDK_VERSION';
/**
* For Android, the app version name can be found in versionName in
* PackageInfo. For iOS, the app version name can be found in
* CFBundleShortVersionString.
*/
public const DIMENSION_APP_VERSION_NAME = 'APP_VERSION_NAME';
/**
* Restriction mode for ads serving (e.g. "Non-personalized ads").
*/
public const DIMENSION_SERVING_RESTRICTION = 'SERVING_RESTRICTION';
/**
* Default value for an unset field. Do not use.
*/
public const METRIC_METRIC_UNSPECIFIED = 'METRIC_UNSPECIFIED';
/**
* The number of ad requests. The value is an integer. **Warning:** The metric
* is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
*/
public const METRIC_AD_REQUESTS = 'AD_REQUESTS';
/**
* The number of times a user clicks an ad. The value is an integer.
*/
public const METRIC_CLICKS = 'CLICKS';
/**
* The estimated earnings of the AdMob publisher. The currency unit (USD, EUR,
* or other) of the earning metrics are determined by the localization setting
* for currency. The amount is in micros. For example, $6.50 would be
* represented as 6500000.
*/
public const METRIC_ESTIMATED_EARNINGS = 'ESTIMATED_EARNINGS';
/**
* The total number of ads shown to users. The value is an integer.
*/
public const METRIC_IMPRESSIONS = 'IMPRESSIONS';
/**
* The ratio of clicks over impressions. The value is a double precision
* (approximate) decimal value.
*/
public const METRIC_IMPRESSION_CTR = 'IMPRESSION_CTR';
/**
* The estimated earnings per thousand ad impressions. The value is in micros.
* For example, $1.03 would be represented as 1030000. Equivalent to eCPM in
* the AdMob UI. **Warning:** The metric is incompatible with
* [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
*/
public const METRIC_IMPRESSION_RPM = 'IMPRESSION_RPM';
/**
* The number of times ads are returned in response to a request. The value is
* an integer.
*/
public const METRIC_MATCHED_REQUESTS = 'MATCHED_REQUESTS';
/**
* The ratio of matched ad requests over the total ad requests. The value is a
* double precision (approximate) decimal value. **Warning:** The metric is
* incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.
*/
public const METRIC_MATCH_RATE = 'MATCH_RATE';
/**
* The ratio of ads that are displayed over ads that are returned, defined as
* impressions / matched requests. The value is a double precision
* (approximate) decimal value.
*/
public const METRIC_SHOW_RATE = 'SHOW_RATE';
/**
* Default value for an unset field. Do not use.
*/
public const ORDER_SORT_ORDER_UNSPECIFIED = 'SORT_ORDER_UNSPECIFIED';
/**
* Sort dimension value or metric value in ascending order.
*/
public const ORDER_ASCENDING = 'ASCENDING';
/**
* Sort dimension value or metric value in descending order.
*/
public const ORDER_DESCENDING = 'DESCENDING';
/**
* Sort by the specified dimension.
*
* @var string
*/
public $dimension;
/**
* Sort by the specified metric.
*
* @var string
*/
public $metric;
/**
* Sorting order of the dimension or metric.
*
* @var string
*/
public $order;
/**
* Sort by the specified dimension.
*
* Accepted values: DIMENSION_UNSPECIFIED, DATE, MONTH, WEEK, AD_UNIT, APP,
* AD_TYPE, COUNTRY, FORMAT, PLATFORM, MOBILE_OS_VERSION, GMA_SDK_VERSION,
* APP_VERSION_NAME, SERVING_RESTRICTION
*
* @param self::DIMENSION_* $dimension
*/
public function setDimension($dimension)
{
$this->dimension = $dimension;
}
/**
* @return self::DIMENSION_*
*/
public function getDimension()
{
return $this->dimension;
}
/**
* Sort by the specified metric.
*
* Accepted values: METRIC_UNSPECIFIED, AD_REQUESTS, CLICKS,
* ESTIMATED_EARNINGS, IMPRESSIONS, IMPRESSION_CTR, IMPRESSION_RPM,
* MATCHED_REQUESTS, MATCH_RATE, SHOW_RATE
*
* @param self::METRIC_* $metric
*/
public function setMetric($metric)
{
$this->metric = $metric;
}
/**
* @return self::METRIC_*
*/
public function getMetric()
{
return $this->metric;
}
/**
* Sorting order of the dimension or metric.
*
* Accepted values: SORT_ORDER_UNSPECIFIED, ASCENDING, DESCENDING
*
* @param self::ORDER_* $order
*/
public function setOrder($order)
{
$this->order = $order;
}
/**
* @return self::ORDER_*
*/
public function getOrder()
{
return $this->order;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NetworkReportSpecSortCondition::class, 'Google_Service_AdMob_NetworkReportSpecSortCondition');