gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,71 @@
<?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\AnalyticsData;
class ActiveMetricRestriction extends \Google\Collection
{
protected $collection_key = 'restrictedMetricTypes';
/**
* The name of the restricted metric.
*
* @var string
*/
public $metricName;
/**
* The reason for this metric's restriction.
*
* @var string[]
*/
public $restrictedMetricTypes;
/**
* The name of the restricted metric.
*
* @param string $metricName
*/
public function setMetricName($metricName)
{
$this->metricName = $metricName;
}
/**
* @return string
*/
public function getMetricName()
{
return $this->metricName;
}
/**
* The reason for this metric's restriction.
*
* @param string[] $restrictedMetricTypes
*/
public function setRestrictedMetricTypes($restrictedMetricTypes)
{
$this->restrictedMetricTypes = $restrictedMetricTypes;
}
/**
* @return string[]
*/
public function getRestrictedMetricTypes()
{
return $this->restrictedMetricTypes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActiveMetricRestriction::class, 'Google_Service_AnalyticsData_ActiveMetricRestriction');
@@ -0,0 +1,278 @@
<?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\AnalyticsData;
class AudienceExport extends \Google\Collection
{
/**
* Unspecified state will never be used.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The AudienceExport is currently creating and will be available in the
* future. Creating occurs immediately after the CreateAudienceExport call.
*/
public const STATE_CREATING = 'CREATING';
/**
* The AudienceExport is fully created and ready for querying. An
* AudienceExport is updated to active asynchronously from a request; this
* occurs some time (for example 15 minutes) after the initial create call.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* The AudienceExport failed to be created. It is possible that re-requesting
* this audience export will succeed.
*/
public const STATE_FAILED = 'FAILED';
protected $collection_key = 'dimensions';
/**
* Required. The audience resource name. This resource name identifies the
* audience being listed and is shared between the Analytics Data & Admin
* APIs. Format: `properties/{property}/audiences/{audience}`
*
* @var string
*/
public $audience;
/**
* Output only. The descriptive display name for this audience. For example,
* "Purchasers".
*
* @var string
*/
public $audienceDisplayName;
/**
* Output only. The time when CreateAudienceExport was called and the
* AudienceExport began the `CREATING` state.
*
* @var string
*/
public $beginCreatingTime;
/**
* Output only. The total quota tokens charged during creation of the
* AudienceExport. Because this token count is based on activity from the
* `CREATING` state, this tokens charged will be fixed once an AudienceExport
* enters the `ACTIVE` or `FAILED` states.
*
* @var int
*/
public $creationQuotaTokensCharged;
protected $dimensionsType = V1betaAudienceDimension::class;
protected $dimensionsDataType = 'array';
/**
* Output only. Error message is populated when an audience export fails
* during creation. A common reason for such a failure is quota exhaustion.
*
* @var string
*/
public $errorMessage;
/**
* Output only. Identifier. The audience export resource name assigned during
* creation. This resource name identifies this `AudienceExport`. Format:
* `properties/{property}/audienceExports/{audience_export}`
*
* @var string
*/
public $name;
/**
* Output only. The percentage completed for this audience export ranging
* between 0 to 100.
*
* @var
*/
public $percentageCompleted;
/**
* Output only. The total number of rows in the AudienceExport result.
*
* @var int
*/
public $rowCount;
/**
* Output only. The current state for this AudienceExport.
*
* @var string
*/
public $state;
/**
* Required. The audience resource name. This resource name identifies the
* audience being listed and is shared between the Analytics Data & Admin
* APIs. Format: `properties/{property}/audiences/{audience}`
*
* @param string $audience
*/
public function setAudience($audience)
{
$this->audience = $audience;
}
/**
* @return string
*/
public function getAudience()
{
return $this->audience;
}
/**
* Output only. The descriptive display name for this audience. For example,
* "Purchasers".
*
* @param string $audienceDisplayName
*/
public function setAudienceDisplayName($audienceDisplayName)
{
$this->audienceDisplayName = $audienceDisplayName;
}
/**
* @return string
*/
public function getAudienceDisplayName()
{
return $this->audienceDisplayName;
}
/**
* Output only. The time when CreateAudienceExport was called and the
* AudienceExport began the `CREATING` state.
*
* @param string $beginCreatingTime
*/
public function setBeginCreatingTime($beginCreatingTime)
{
$this->beginCreatingTime = $beginCreatingTime;
}
/**
* @return string
*/
public function getBeginCreatingTime()
{
return $this->beginCreatingTime;
}
/**
* Output only. The total quota tokens charged during creation of the
* AudienceExport. Because this token count is based on activity from the
* `CREATING` state, this tokens charged will be fixed once an AudienceExport
* enters the `ACTIVE` or `FAILED` states.
*
* @param int $creationQuotaTokensCharged
*/
public function setCreationQuotaTokensCharged($creationQuotaTokensCharged)
{
$this->creationQuotaTokensCharged = $creationQuotaTokensCharged;
}
/**
* @return int
*/
public function getCreationQuotaTokensCharged()
{
return $this->creationQuotaTokensCharged;
}
/**
* Required. The dimensions requested and displayed in the query response.
*
* @param V1betaAudienceDimension[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return V1betaAudienceDimension[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* Output only. Error message is populated when an audience export fails
* during creation. A common reason for such a failure is quota exhaustion.
*
* @param string $errorMessage
*/
public function setErrorMessage($errorMessage)
{
$this->errorMessage = $errorMessage;
}
/**
* @return string
*/
public function getErrorMessage()
{
return $this->errorMessage;
}
/**
* Output only. Identifier. The audience export resource name assigned during
* creation. This resource name identifies this `AudienceExport`. Format:
* `properties/{property}/audienceExports/{audience_export}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
public function setPercentageCompleted($percentageCompleted)
{
$this->percentageCompleted = $percentageCompleted;
}
public function getPercentageCompleted()
{
return $this->percentageCompleted;
}
/**
* Output only. The total number of rows in the AudienceExport result.
*
* @param int $rowCount
*/
public function setRowCount($rowCount)
{
$this->rowCount = $rowCount;
}
/**
* @return int
*/
public function getRowCount()
{
return $this->rowCount;
}
/**
* Output only. The current state for this AudienceExport.
*
* Accepted values: STATE_UNSPECIFIED, CREATING, ACTIVE, FAILED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AudienceExport::class, 'Google_Service_AnalyticsData_AudienceExport');
@@ -0,0 +1,25 @@
<?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\AnalyticsData;
class AudienceListMetadata extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AudienceListMetadata::class, 'Google_Service_AnalyticsData_AudienceListMetadata');
@@ -0,0 +1,46 @@
<?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\AnalyticsData;
class BatchRunPivotReportsRequest extends \Google\Collection
{
protected $collection_key = 'requests';
protected $requestsType = RunPivotReportRequest::class;
protected $requestsDataType = 'array';
/**
* Individual requests. Each request has a separate pivot report response.
* Each batch request is allowed up to 5 requests.
*
* @param RunPivotReportRequest[] $requests
*/
public function setRequests($requests)
{
$this->requests = $requests;
}
/**
* @return RunPivotReportRequest[]
*/
public function getRequests()
{
return $this->requests;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRunPivotReportsRequest::class, 'Google_Service_AnalyticsData_BatchRunPivotReportsRequest');
@@ -0,0 +1,71 @@
<?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\AnalyticsData;
class BatchRunPivotReportsResponse extends \Google\Collection
{
protected $collection_key = 'pivotReports';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#batchRunPivotReports". Useful to distinguish
* between response types in JSON.
*
* @var string
*/
public $kind;
protected $pivotReportsType = RunPivotReportResponse::class;
protected $pivotReportsDataType = 'array';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#batchRunPivotReports". Useful to distinguish
* between response types in JSON.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Individual responses. Each response has a separate pivot report request.
*
* @param RunPivotReportResponse[] $pivotReports
*/
public function setPivotReports($pivotReports)
{
$this->pivotReports = $pivotReports;
}
/**
* @return RunPivotReportResponse[]
*/
public function getPivotReports()
{
return $this->pivotReports;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRunPivotReportsResponse::class, 'Google_Service_AnalyticsData_BatchRunPivotReportsResponse');
@@ -0,0 +1,46 @@
<?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\AnalyticsData;
class BatchRunReportsRequest extends \Google\Collection
{
protected $collection_key = 'requests';
protected $requestsType = RunReportRequest::class;
protected $requestsDataType = 'array';
/**
* Individual requests. Each request has a separate report response. Each
* batch request is allowed up to 5 requests.
*
* @param RunReportRequest[] $requests
*/
public function setRequests($requests)
{
$this->requests = $requests;
}
/**
* @return RunReportRequest[]
*/
public function getRequests()
{
return $this->requests;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRunReportsRequest::class, 'Google_Service_AnalyticsData_BatchRunReportsRequest');
@@ -0,0 +1,71 @@
<?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\AnalyticsData;
class BatchRunReportsResponse extends \Google\Collection
{
protected $collection_key = 'reports';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#batchRunReports". Useful to distinguish between
* response types in JSON.
*
* @var string
*/
public $kind;
protected $reportsType = RunReportResponse::class;
protected $reportsDataType = 'array';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#batchRunReports". Useful to distinguish between
* response types in JSON.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Individual responses. Each response has a separate report request.
*
* @param RunReportResponse[] $reports
*/
public function setReports($reports)
{
$this->reports = $reports;
}
/**
* @return RunReportResponse[]
*/
public function getReports()
{
return $this->reports;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRunReportsResponse::class, 'Google_Service_AnalyticsData_BatchRunReportsResponse');
@@ -0,0 +1,62 @@
<?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\AnalyticsData;
class BetweenFilter extends \Google\Model
{
protected $fromValueType = NumericValue::class;
protected $fromValueDataType = '';
protected $toValueType = NumericValue::class;
protected $toValueDataType = '';
/**
* Begins with this number.
*
* @param NumericValue $fromValue
*/
public function setFromValue(NumericValue $fromValue)
{
$this->fromValue = $fromValue;
}
/**
* @return NumericValue
*/
public function getFromValue()
{
return $this->fromValue;
}
/**
* Ends with this number.
*
* @param NumericValue $toValue
*/
public function setToValue(NumericValue $toValue)
{
$this->toValue = $toValue;
}
/**
* @return NumericValue
*/
public function getToValue()
{
return $this->toValue;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BetweenFilter::class, 'Google_Service_AnalyticsData_BetweenFilter');
@@ -0,0 +1,50 @@
<?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\AnalyticsData;
class CaseExpression extends \Google\Model
{
/**
* Name of a dimension. The name must refer back to a name in dimensions field
* of the request.
*
* @var string
*/
public $dimensionName;
/**
* Name of a dimension. The name must refer back to a name in dimensions field
* of the request.
*
* @param string $dimensionName
*/
public function setDimensionName($dimensionName)
{
$this->dimensionName = $dimensionName;
}
/**
* @return string
*/
public function getDimensionName()
{
return $this->dimensionName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CaseExpression::class, 'Google_Service_AnalyticsData_CaseExpression');
@@ -0,0 +1,145 @@
<?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\AnalyticsData;
class CheckCompatibilityRequest extends \Google\Collection
{
/**
* Unspecified compatibility.
*/
public const COMPATIBILITY_FILTER_COMPATIBILITY_UNSPECIFIED = 'COMPATIBILITY_UNSPECIFIED';
/**
* The dimension or metric is compatible. This dimension or metric can be
* successfully added to a report.
*/
public const COMPATIBILITY_FILTER_COMPATIBLE = 'COMPATIBLE';
/**
* The dimension or metric is incompatible. This dimension or metric cannot be
* successfully added to a report.
*/
public const COMPATIBILITY_FILTER_INCOMPATIBLE = 'INCOMPATIBLE';
protected $collection_key = 'metrics';
/**
* Filters the dimensions and metrics in the response to just this
* compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to
* only return compatible dimensions & metrics.
*
* @var string
*/
public $compatibilityFilter;
protected $dimensionFilterType = FilterExpression::class;
protected $dimensionFilterDataType = '';
protected $dimensionsType = Dimension::class;
protected $dimensionsDataType = 'array';
protected $metricFilterType = FilterExpression::class;
protected $metricFilterDataType = '';
protected $metricsType = Metric::class;
protected $metricsDataType = 'array';
/**
* Filters the dimensions and metrics in the response to just this
* compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to
* only return compatible dimensions & metrics.
*
* Accepted values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE
*
* @param self::COMPATIBILITY_FILTER_* $compatibilityFilter
*/
public function setCompatibilityFilter($compatibilityFilter)
{
$this->compatibilityFilter = $compatibilityFilter;
}
/**
* @return self::COMPATIBILITY_FILTER_*
*/
public function getCompatibilityFilter()
{
return $this->compatibilityFilter;
}
/**
* The filter clause of dimensions. `dimensionFilter` should be the same value
* as in your `runReport` request.
*
* @param FilterExpression $dimensionFilter
*/
public function setDimensionFilter(FilterExpression $dimensionFilter)
{
$this->dimensionFilter = $dimensionFilter;
}
/**
* @return FilterExpression
*/
public function getDimensionFilter()
{
return $this->dimensionFilter;
}
/**
* The dimensions in this report. `dimensions` should be the same value as in
* your `runReport` request.
*
* @param Dimension[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return Dimension[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* The filter clause of metrics. `metricFilter` should be the same value as in
* your `runReport` request
*
* @param FilterExpression $metricFilter
*/
public function setMetricFilter(FilterExpression $metricFilter)
{
$this->metricFilter = $metricFilter;
}
/**
* @return FilterExpression
*/
public function getMetricFilter()
{
return $this->metricFilter;
}
/**
* The metrics in this report. `metrics` should be the same value as in your
* `runReport` request.
*
* @param Metric[] $metrics
*/
public function setMetrics($metrics)
{
$this->metrics = $metrics;
}
/**
* @return Metric[]
*/
public function getMetrics()
{
return $this->metrics;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CheckCompatibilityRequest::class, 'Google_Service_AnalyticsData_CheckCompatibilityRequest');
@@ -0,0 +1,63 @@
<?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\AnalyticsData;
class CheckCompatibilityResponse extends \Google\Collection
{
protected $collection_key = 'metricCompatibilities';
protected $dimensionCompatibilitiesType = DimensionCompatibility::class;
protected $dimensionCompatibilitiesDataType = 'array';
protected $metricCompatibilitiesType = MetricCompatibility::class;
protected $metricCompatibilitiesDataType = 'array';
/**
* The compatibility of each dimension.
*
* @param DimensionCompatibility[] $dimensionCompatibilities
*/
public function setDimensionCompatibilities($dimensionCompatibilities)
{
$this->dimensionCompatibilities = $dimensionCompatibilities;
}
/**
* @return DimensionCompatibility[]
*/
public function getDimensionCompatibilities()
{
return $this->dimensionCompatibilities;
}
/**
* The compatibility of each metric.
*
* @param MetricCompatibility[] $metricCompatibilities
*/
public function setMetricCompatibilities($metricCompatibilities)
{
$this->metricCompatibilities = $metricCompatibilities;
}
/**
* @return MetricCompatibility[]
*/
public function getMetricCompatibilities()
{
return $this->metricCompatibilities;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CheckCompatibilityResponse::class, 'Google_Service_AnalyticsData_CheckCompatibilityResponse');
@@ -0,0 +1,109 @@
<?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\AnalyticsData;
class Cohort extends \Google\Model
{
protected $dateRangeType = DateRange::class;
protected $dateRangeDataType = '';
/**
* Dimension used by the cohort. Required and only supports
* `firstSessionDate`.
*
* @var string
*/
public $dimension;
/**
* Assigns a name to this cohort. The dimension `cohort` is valued to this
* name in a report response. If set, cannot begin with `cohort_` or
* `RESERVED_`. If not set, cohorts are named by their zero based index
* `cohort_0`, `cohort_1`, etc.
*
* @var string
*/
public $name;
/**
* The cohort selects users whose first touch date is between start date and
* end date defined in the `dateRange`. This `dateRange` does not specify the
* full date range of event data that is present in a cohort report. In a
* cohort report, this `dateRange` is extended by the granularity and offset
* present in the `cohortsRange`; event data for the extended reporting date
* range is present in a cohort report. In a cohort request, this `dateRange`
* is required and the `dateRanges` in the `RunReportRequest` or
* `RunPivotReportRequest` must be unspecified. This `dateRange` should
* generally be aligned with the cohort's granularity. If `CohortsRange` uses
* daily granularity, this `dateRange` can be a single day. If `CohortsRange`
* uses weekly granularity, this `dateRange` can be aligned to a week
* boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses
* monthly granularity, this `dateRange` can be aligned to a month, starting
* at the first and ending on the last day of the month.
*
* @param DateRange $dateRange
*/
public function setDateRange(DateRange $dateRange)
{
$this->dateRange = $dateRange;
}
/**
* @return DateRange
*/
public function getDateRange()
{
return $this->dateRange;
}
/**
* Dimension used by the cohort. Required and only supports
* `firstSessionDate`.
*
* @param string $dimension
*/
public function setDimension($dimension)
{
$this->dimension = $dimension;
}
/**
* @return string
*/
public function getDimension()
{
return $this->dimension;
}
/**
* Assigns a name to this cohort. The dimension `cohort` is valued to this
* name in a report response. If set, cannot begin with `cohort_` or
* `RESERVED_`. If not set, cohorts are named by their zero based index
* `cohort_0`, `cohort_1`, etc.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Cohort::class, 'Google_Service_AnalyticsData_Cohort');
@@ -0,0 +1,50 @@
<?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\AnalyticsData;
class CohortReportSettings extends \Google\Model
{
/**
* If true, accumulates the result from first touch day to the end day. Not
* supported in `RunReportRequest`.
*
* @var bool
*/
public $accumulate;
/**
* If true, accumulates the result from first touch day to the end day. Not
* supported in `RunReportRequest`.
*
* @param bool $accumulate
*/
public function setAccumulate($accumulate)
{
$this->accumulate = $accumulate;
}
/**
* @return bool
*/
public function getAccumulate()
{
return $this->accumulate;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CohortReportSettings::class, 'Google_Service_AnalyticsData_CohortReportSettings');
@@ -0,0 +1,84 @@
<?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\AnalyticsData;
class CohortSpec extends \Google\Collection
{
protected $collection_key = 'cohorts';
protected $cohortReportSettingsType = CohortReportSettings::class;
protected $cohortReportSettingsDataType = '';
protected $cohortsType = Cohort::class;
protected $cohortsDataType = 'array';
protected $cohortsRangeType = CohortsRange::class;
protected $cohortsRangeDataType = '';
/**
* Optional settings for a cohort report.
*
* @param CohortReportSettings $cohortReportSettings
*/
public function setCohortReportSettings(CohortReportSettings $cohortReportSettings)
{
$this->cohortReportSettings = $cohortReportSettings;
}
/**
* @return CohortReportSettings
*/
public function getCohortReportSettings()
{
return $this->cohortReportSettings;
}
/**
* Defines the selection criteria to group users into cohorts. Most cohort
* reports define only a single cohort. If multiple cohorts are specified,
* each cohort can be recognized in the report by their name.
*
* @param Cohort[] $cohorts
*/
public function setCohorts($cohorts)
{
$this->cohorts = $cohorts;
}
/**
* @return Cohort[]
*/
public function getCohorts()
{
return $this->cohorts;
}
/**
* Cohort reports follow cohorts over an extended reporting date range. This
* range specifies an offset duration to follow the cohorts over.
*
* @param CohortsRange $cohortsRange
*/
public function setCohortsRange(CohortsRange $cohortsRange)
{
$this->cohortsRange = $cohortsRange;
}
/**
* @return CohortsRange
*/
public function getCohortsRange()
{
return $this->cohortsRange;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CohortSpec::class, 'Google_Service_AnalyticsData_CohortSpec');
@@ -0,0 +1,148 @@
<?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\AnalyticsData;
class CohortsRange extends \Google\Model
{
/**
* Should never be specified.
*/
public const GRANULARITY_GRANULARITY_UNSPECIFIED = 'GRANULARITY_UNSPECIFIED';
/**
* Daily granularity. Commonly used if the cohort's `dateRange` is a single
* day and the request contains `cohortNthDay`.
*/
public const GRANULARITY_DAILY = 'DAILY';
/**
* Weekly granularity. Commonly used if the cohort's `dateRange` is a week in
* duration (starting on Sunday and ending on Saturday) and the request
* contains `cohortNthWeek`.
*/
public const GRANULARITY_WEEKLY = 'WEEKLY';
/**
* Monthly granularity. Commonly used if the cohort's `dateRange` is a month
* in duration and the request contains `cohortNthMonth`.
*/
public const GRANULARITY_MONTHLY = 'MONTHLY';
/**
* Required. `endOffset` specifies the end date of the extended reporting date
* range for a cohort report. `endOffset` can be any positive integer but is
* commonly set to 5 to 10 so that reports contain data on the cohort for the
* next several granularity time periods. If `granularity` is `DAILY`, the
* `endDate` of the extended reporting date range is `endDate` of the cohort
* plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the
* extended reporting date range is `endDate` of the cohort plus `endOffset *
* 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended
* reporting date range is `endDate` of the cohort plus `endOffset * 30` days.
*
* @var int
*/
public $endOffset;
/**
* Required. The granularity used to interpret the `startOffset` and
* `endOffset` for the extended reporting date range for a cohort report.
*
* @var string
*/
public $granularity;
/**
* `startOffset` specifies the start date of the extended reporting date range
* for a cohort report. `startOffset` is commonly set to 0 so that reports
* contain data from the acquisition of the cohort forward. If `granularity`
* is `DAILY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset` days. If `granularity` is
* `WEEKLY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is
* `MONTHLY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset * 30` days.
*
* @var int
*/
public $startOffset;
/**
* Required. `endOffset` specifies the end date of the extended reporting date
* range for a cohort report. `endOffset` can be any positive integer but is
* commonly set to 5 to 10 so that reports contain data on the cohort for the
* next several granularity time periods. If `granularity` is `DAILY`, the
* `endDate` of the extended reporting date range is `endDate` of the cohort
* plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the
* extended reporting date range is `endDate` of the cohort plus `endOffset *
* 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended
* reporting date range is `endDate` of the cohort plus `endOffset * 30` days.
*
* @param int $endOffset
*/
public function setEndOffset($endOffset)
{
$this->endOffset = $endOffset;
}
/**
* @return int
*/
public function getEndOffset()
{
return $this->endOffset;
}
/**
* Required. The granularity used to interpret the `startOffset` and
* `endOffset` for the extended reporting date range for a cohort report.
*
* Accepted values: GRANULARITY_UNSPECIFIED, DAILY, WEEKLY, MONTHLY
*
* @param self::GRANULARITY_* $granularity
*/
public function setGranularity($granularity)
{
$this->granularity = $granularity;
}
/**
* @return self::GRANULARITY_*
*/
public function getGranularity()
{
return $this->granularity;
}
/**
* `startOffset` specifies the start date of the extended reporting date range
* for a cohort report. `startOffset` is commonly set to 0 so that reports
* contain data from the acquisition of the cohort forward. If `granularity`
* is `DAILY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset` days. If `granularity` is
* `WEEKLY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is
* `MONTHLY`, the `startDate` of the extended reporting date range is
* `startDate` of the cohort plus `startOffset * 30` days.
*
* @param int $startOffset
*/
public function setStartOffset($startOffset)
{
$this->startOffset = $startOffset;
}
/**
* @return int
*/
public function getStartOffset()
{
return $this->startOffset;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CohortsRange::class, 'Google_Service_AnalyticsData_CohortsRange');
@@ -0,0 +1,94 @@
<?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\AnalyticsData;
class Comparison extends \Google\Model
{
/**
* A saved comparison identified by the comparison's resource name. For
* example, 'comparisons/1234'.
*
* @var string
*/
public $comparison;
protected $dimensionFilterType = FilterExpression::class;
protected $dimensionFilterDataType = '';
/**
* Each comparison produces separate rows in the response. In the response,
* this comparison is identified by this name. If name is unspecified, we will
* use the saved comparisons display name.
*
* @var string
*/
public $name;
/**
* A saved comparison identified by the comparison's resource name. For
* example, 'comparisons/1234'.
*
* @param string $comparison
*/
public function setComparison($comparison)
{
$this->comparison = $comparison;
}
/**
* @return string
*/
public function getComparison()
{
return $this->comparison;
}
/**
* A basic comparison.
*
* @param FilterExpression $dimensionFilter
*/
public function setDimensionFilter(FilterExpression $dimensionFilter)
{
$this->dimensionFilter = $dimensionFilter;
}
/**
* @return FilterExpression
*/
public function getDimensionFilter()
{
return $this->dimensionFilter;
}
/**
* Each comparison produces separate rows in the response. In the response,
* this comparison is identified by this name. If name is unspecified, we will
* use the saved comparisons display name.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Comparison::class, 'Google_Service_AnalyticsData_Comparison');
@@ -0,0 +1,94 @@
<?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\AnalyticsData;
class ComparisonMetadata extends \Google\Model
{
/**
* This comparison's resource name. Useable in [Comparison](#Comparison)'s
* `comparison` field. For example, 'comparisons/1234'.
*
* @var string
*/
public $apiName;
/**
* This comparison's description.
*
* @var string
*/
public $description;
/**
* This comparison's name within the Google Analytics user interface.
*
* @var string
*/
public $uiName;
/**
* This comparison's resource name. Useable in [Comparison](#Comparison)'s
* `comparison` field. For example, 'comparisons/1234'.
*
* @param string $apiName
*/
public function setApiName($apiName)
{
$this->apiName = $apiName;
}
/**
* @return string
*/
public function getApiName()
{
return $this->apiName;
}
/**
* This comparison's description.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* This comparison's name within the Google Analytics user interface.
*
* @param string $uiName
*/
public function setUiName($uiName)
{
$this->uiName = $uiName;
}
/**
* @return string
*/
public function getUiName()
{
return $this->uiName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ComparisonMetadata::class, 'Google_Service_AnalyticsData_ComparisonMetadata');
@@ -0,0 +1,81 @@
<?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\AnalyticsData;
class ConcatenateExpression extends \Google\Collection
{
protected $collection_key = 'dimensionNames';
/**
* The delimiter placed between dimension names. Delimiters are often single
* characters such as "|" or "," but can be longer strings. If a dimension
* value contains the delimiter, both will be present in response with no
* distinction. For example if dimension 1 value = "US,FR", dimension 2 value
* = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
*
* @var string
*/
public $delimiter;
/**
* Names of dimensions. The names must refer back to names in the dimensions
* field of the request.
*
* @var string[]
*/
public $dimensionNames;
/**
* The delimiter placed between dimension names. Delimiters are often single
* characters such as "|" or "," but can be longer strings. If a dimension
* value contains the delimiter, both will be present in response with no
* distinction. For example if dimension 1 value = "US,FR", dimension 2 value
* = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
*
* @param string $delimiter
*/
public function setDelimiter($delimiter)
{
$this->delimiter = $delimiter;
}
/**
* @return string
*/
public function getDelimiter()
{
return $this->delimiter;
}
/**
* Names of dimensions. The names must refer back to names in the dimensions
* field of the request.
*
* @param string[] $dimensionNames
*/
public function setDimensionNames($dimensionNames)
{
$this->dimensionNames = $dimensionNames;
}
/**
* @return string[]
*/
public function getDimensionNames()
{
return $this->dimensionNames;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ConcatenateExpression::class, 'Google_Service_AnalyticsData_ConcatenateExpression');
@@ -0,0 +1,110 @@
<?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\AnalyticsData;
class DateRange extends \Google\Model
{
/**
* The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be
* before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
* accepted, and in that case, the date is inferred based on the property's
* reporting time zone.
*
* @var string
*/
public $endDate;
/**
* Assigns a name to this date range. The dimension `dateRange` is valued to
* this name in a report response. If set, cannot begin with `date_range_` or
* `RESERVED_`. If not set, date ranges are named by their zero based index in
* the request: `date_range_0`, `date_range_1`, etc.
*
* @var string
*/
public $name;
/**
* The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
* be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
* accepted, and in that case, the date is inferred based on the property's
* reporting time zone.
*
* @var string
*/
public $startDate;
/**
* The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be
* before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
* accepted, and in that case, the date is inferred based on the property's
* reporting time zone.
*
* @param string $endDate
*/
public function setEndDate($endDate)
{
$this->endDate = $endDate;
}
/**
* @return string
*/
public function getEndDate()
{
return $this->endDate;
}
/**
* Assigns a name to this date range. The dimension `dateRange` is valued to
* this name in a report response. If set, cannot begin with `date_range_` or
* `RESERVED_`. If not set, date ranges are named by their zero based index in
* the request: `date_range_0`, `date_range_1`, etc.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
* be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
* accepted, and in that case, the date is inferred based on the property's
* reporting time zone.
*
* @param string $startDate
*/
public function setStartDate($startDate)
{
$this->startDate = $startDate;
}
/**
* @return string
*/
public function getStartDate()
{
return $this->startDate;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DateRange::class, 'Google_Service_AnalyticsData_DateRange');
@@ -0,0 +1,97 @@
<?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\AnalyticsData;
class Dimension extends \Google\Model
{
protected $dimensionExpressionType = DimensionExpression::class;
protected $dimensionExpressionDataType = '';
/**
* The name of the dimension. See the [API Dimensions](https://developers.goog
* le.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the
* list of dimension names supported by core reporting methods such as
* `runReport` and `batchRunReports`. See [Realtime Dimensions](https://develo
* pers.google.com/analytics/devguides/reporting/data/v1/realtime-api-
* schema#dimensions) for the list of dimension names supported by the
* `runRealtimeReport` method. See [Funnel Dimensions](https://developers.goog
* le.com/analytics/devguides/reporting/data/v1/exploration-api-
* schema#dimensions) for the list of dimension names supported by the
* `runFunnelReport` method. If `dimensionExpression` is specified, `name` can
* be any string that you would like within the allowed character set. For
* example if a `dimensionExpression` concatenates `country` and `city`, you
* could call that dimension `countryAndCity`. Dimension names that you choose
* must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are
* referenced by `name` in `dimensionFilter`, `orderBys`,
* `dimensionExpression`, and `pivots`.
*
* @var string
*/
public $name;
/**
* One dimension can be the result of an expression of multiple dimensions.
* For example, dimension "country, city": concatenate(country, ", ", city).
*
* @param DimensionExpression $dimensionExpression
*/
public function setDimensionExpression(DimensionExpression $dimensionExpression)
{
$this->dimensionExpression = $dimensionExpression;
}
/**
* @return DimensionExpression
*/
public function getDimensionExpression()
{
return $this->dimensionExpression;
}
/**
* The name of the dimension. See the [API Dimensions](https://developers.goog
* le.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the
* list of dimension names supported by core reporting methods such as
* `runReport` and `batchRunReports`. See [Realtime Dimensions](https://develo
* pers.google.com/analytics/devguides/reporting/data/v1/realtime-api-
* schema#dimensions) for the list of dimension names supported by the
* `runRealtimeReport` method. See [Funnel Dimensions](https://developers.goog
* le.com/analytics/devguides/reporting/data/v1/exploration-api-
* schema#dimensions) for the list of dimension names supported by the
* `runFunnelReport` method. If `dimensionExpression` is specified, `name` can
* be any string that you would like within the allowed character set. For
* example if a `dimensionExpression` concatenates `country` and `city`, you
* could call that dimension `countryAndCity`. Dimension names that you choose
* must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are
* referenced by `name` in `dimensionFilter`, `orderBys`,
* `dimensionExpression`, and `pivots`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Dimension::class, 'Google_Service_AnalyticsData_Dimension');
@@ -0,0 +1,86 @@
<?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\AnalyticsData;
class DimensionCompatibility extends \Google\Model
{
/**
* Unspecified compatibility.
*/
public const COMPATIBILITY_COMPATIBILITY_UNSPECIFIED = 'COMPATIBILITY_UNSPECIFIED';
/**
* The dimension or metric is compatible. This dimension or metric can be
* successfully added to a report.
*/
public const COMPATIBILITY_COMPATIBLE = 'COMPATIBLE';
/**
* The dimension or metric is incompatible. This dimension or metric cannot be
* successfully added to a report.
*/
public const COMPATIBILITY_INCOMPATIBLE = 'INCOMPATIBLE';
/**
* The compatibility of this dimension. If the compatibility is COMPATIBLE,
* this dimension can be successfully added to the report.
*
* @var string
*/
public $compatibility;
protected $dimensionMetadataType = DimensionMetadata::class;
protected $dimensionMetadataDataType = '';
/**
* The compatibility of this dimension. If the compatibility is COMPATIBLE,
* this dimension can be successfully added to the report.
*
* Accepted values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE
*
* @param self::COMPATIBILITY_* $compatibility
*/
public function setCompatibility($compatibility)
{
$this->compatibility = $compatibility;
}
/**
* @return self::COMPATIBILITY_*
*/
public function getCompatibility()
{
return $this->compatibility;
}
/**
* The dimension metadata contains the API name for this compatibility
* information. The dimension metadata also contains other helpful information
* like the UI name and description.
*
* @param DimensionMetadata $dimensionMetadata
*/
public function setDimensionMetadata(DimensionMetadata $dimensionMetadata)
{
$this->dimensionMetadata = $dimensionMetadata;
}
/**
* @return DimensionMetadata
*/
public function getDimensionMetadata()
{
return $this->dimensionMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionCompatibility::class, 'Google_Service_AnalyticsData_DimensionCompatibility');
@@ -0,0 +1,81 @@
<?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\AnalyticsData;
class DimensionExpression extends \Google\Model
{
protected $concatenateType = ConcatenateExpression::class;
protected $concatenateDataType = '';
protected $lowerCaseType = CaseExpression::class;
protected $lowerCaseDataType = '';
protected $upperCaseType = CaseExpression::class;
protected $upperCaseDataType = '';
/**
* Used to combine dimension values to a single dimension. For example,
* dimension "country, city": concatenate(country, ", ", city).
*
* @param ConcatenateExpression $concatenate
*/
public function setConcatenate(ConcatenateExpression $concatenate)
{
$this->concatenate = $concatenate;
}
/**
* @return ConcatenateExpression
*/
public function getConcatenate()
{
return $this->concatenate;
}
/**
* Used to convert a dimension value to lower case.
*
* @param CaseExpression $lowerCase
*/
public function setLowerCase(CaseExpression $lowerCase)
{
$this->lowerCase = $lowerCase;
}
/**
* @return CaseExpression
*/
public function getLowerCase()
{
return $this->lowerCase;
}
/**
* Used to convert a dimension value to upper case.
*
* @param CaseExpression $upperCase
*/
public function setUpperCase(CaseExpression $upperCase)
{
$this->upperCase = $upperCase;
}
/**
* @return CaseExpression
*/
public function getUpperCase()
{
return $this->upperCase;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionExpression::class, 'Google_Service_AnalyticsData_DimensionExpression');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class DimensionHeader extends \Google\Model
{
/**
* The dimension's name.
*
* @var string
*/
public $name;
/**
* The dimension's name.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionHeader::class, 'Google_Service_AnalyticsData_DimensionHeader');
@@ -0,0 +1,179 @@
<?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\AnalyticsData;
class DimensionMetadata extends \Google\Collection
{
protected $collection_key = 'deprecatedApiNames';
/**
* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
* example, `eventName`.
*
* @var string
*/
public $apiName;
/**
* The display name of the category that this dimension belongs to. Similar
* dimensions and metrics are categorized together.
*
* @var string
*/
public $category;
/**
* True if the dimension is custom to this property. This includes user,
* event, & item scoped custom dimensions; to learn more about custom
* dimensions, see https://support.google.com/analytics/answer/14240153. This
* also include custom channel groups; to learn more about custom channel
* groups, see https://support.google.com/analytics/answer/13051316.
*
* @var bool
*/
public $customDefinition;
/**
* Still usable but deprecated names for this dimension. If populated, this
* dimension is available by either `apiName` or one of `deprecatedApiNames`
* for a period of time. After the deprecation period, the dimension will be
* available only by `apiName`.
*
* @var string[]
*/
public $deprecatedApiNames;
/**
* Description of how this dimension is used and calculated.
*
* @var string
*/
public $description;
/**
* This dimension's name within the Google Analytics user interface. For
* example, `Event name`.
*
* @var string
*/
public $uiName;
/**
* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
* example, `eventName`.
*
* @param string $apiName
*/
public function setApiName($apiName)
{
$this->apiName = $apiName;
}
/**
* @return string
*/
public function getApiName()
{
return $this->apiName;
}
/**
* The display name of the category that this dimension belongs to. Similar
* dimensions and metrics are categorized together.
*
* @param string $category
*/
public function setCategory($category)
{
$this->category = $category;
}
/**
* @return string
*/
public function getCategory()
{
return $this->category;
}
/**
* True if the dimension is custom to this property. This includes user,
* event, & item scoped custom dimensions; to learn more about custom
* dimensions, see https://support.google.com/analytics/answer/14240153. This
* also include custom channel groups; to learn more about custom channel
* groups, see https://support.google.com/analytics/answer/13051316.
*
* @param bool $customDefinition
*/
public function setCustomDefinition($customDefinition)
{
$this->customDefinition = $customDefinition;
}
/**
* @return bool
*/
public function getCustomDefinition()
{
return $this->customDefinition;
}
/**
* Still usable but deprecated names for this dimension. If populated, this
* dimension is available by either `apiName` or one of `deprecatedApiNames`
* for a period of time. After the deprecation period, the dimension will be
* available only by `apiName`.
*
* @param string[] $deprecatedApiNames
*/
public function setDeprecatedApiNames($deprecatedApiNames)
{
$this->deprecatedApiNames = $deprecatedApiNames;
}
/**
* @return string[]
*/
public function getDeprecatedApiNames()
{
return $this->deprecatedApiNames;
}
/**
* Description of how this dimension is used and calculated.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* This dimension's name within the Google Analytics user interface. For
* example, `Event name`.
*
* @param string $uiName
*/
public function setUiName($uiName)
{
$this->uiName = $uiName;
}
/**
* @return string
*/
public function getUiName()
{
return $this->uiName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionMetadata::class, 'Google_Service_AnalyticsData_DimensionMetadata');
@@ -0,0 +1,94 @@
<?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\AnalyticsData;
class DimensionOrderBy extends \Google\Model
{
/**
* Unspecified.
*/
public const ORDER_TYPE_ORDER_TYPE_UNSPECIFIED = 'ORDER_TYPE_UNSPECIFIED';
/**
* Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b"
* < "z".
*/
public const ORDER_TYPE_ALPHANUMERIC = 'ALPHANUMERIC';
/**
* Case insensitive alphanumeric sort by lower case Unicode code point. For
* example, "2" < "A" < "b" < "X" < "z".
*/
public const ORDER_TYPE_CASE_INSENSITIVE_ALPHANUMERIC = 'CASE_INSENSITIVE_ALPHANUMERIC';
/**
* Dimension values are converted to numbers before sorting. For example in
* NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" < "25". Non-
* numeric dimension values all have equal ordering value below all numeric
* values.
*/
public const ORDER_TYPE_NUMERIC = 'NUMERIC';
/**
* A dimension name in the request to order by.
*
* @var string
*/
public $dimensionName;
/**
* Controls the rule for dimension value ordering.
*
* @var string
*/
public $orderType;
/**
* A dimension name in the request to order by.
*
* @param string $dimensionName
*/
public function setDimensionName($dimensionName)
{
$this->dimensionName = $dimensionName;
}
/**
* @return string
*/
public function getDimensionName()
{
return $this->dimensionName;
}
/**
* Controls the rule for dimension value ordering.
*
* Accepted values: ORDER_TYPE_UNSPECIFIED, ALPHANUMERIC,
* CASE_INSENSITIVE_ALPHANUMERIC, NUMERIC
*
* @param self::ORDER_TYPE_* $orderType
*/
public function setOrderType($orderType)
{
$this->orderType = $orderType;
}
/**
* @return self::ORDER_TYPE_*
*/
public function getOrderType()
{
return $this->orderType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionOrderBy::class, 'Google_Service_AnalyticsData_DimensionOrderBy');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class DimensionValue extends \Google\Model
{
/**
* Value as a string if the dimension type is a string.
*
* @var string
*/
public $value;
/**
* Value as a string if the dimension type is a string.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DimensionValue::class, 'Google_Service_AnalyticsData_DimensionValue');
@@ -0,0 +1,25 @@
<?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\AnalyticsData;
class EmptyFilter extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EmptyFilter::class, 'Google_Service_AnalyticsData_EmptyFilter');
@@ -0,0 +1,144 @@
<?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\AnalyticsData;
class Filter extends \Google\Model
{
protected $betweenFilterType = BetweenFilter::class;
protected $betweenFilterDataType = '';
protected $emptyFilterType = EmptyFilter::class;
protected $emptyFilterDataType = '';
/**
* The dimension name or metric name. In most methods, dimensions & metrics
* can be used for the first time in this field. However in a
* RunPivotReportRequest, this field must be additionally specified by name in
* the RunPivotReportRequest's dimensions or metrics.
*
* @var string
*/
public $fieldName;
protected $inListFilterType = InListFilter::class;
protected $inListFilterDataType = '';
protected $numericFilterType = NumericFilter::class;
protected $numericFilterDataType = '';
protected $stringFilterType = StringFilter::class;
protected $stringFilterDataType = '';
/**
* A filter for two values.
*
* @param BetweenFilter $betweenFilter
*/
public function setBetweenFilter(BetweenFilter $betweenFilter)
{
$this->betweenFilter = $betweenFilter;
}
/**
* @return BetweenFilter
*/
public function getBetweenFilter()
{
return $this->betweenFilter;
}
/**
* A filter for empty values such as "(not set)" and "" values.
*
* @param EmptyFilter $emptyFilter
*/
public function setEmptyFilter(EmptyFilter $emptyFilter)
{
$this->emptyFilter = $emptyFilter;
}
/**
* @return EmptyFilter
*/
public function getEmptyFilter()
{
return $this->emptyFilter;
}
/**
* The dimension name or metric name. In most methods, dimensions & metrics
* can be used for the first time in this field. However in a
* RunPivotReportRequest, this field must be additionally specified by name in
* the RunPivotReportRequest's dimensions or metrics.
*
* @param string $fieldName
*/
public function setFieldName($fieldName)
{
$this->fieldName = $fieldName;
}
/**
* @return string
*/
public function getFieldName()
{
return $this->fieldName;
}
/**
* A filter for in list values.
*
* @param InListFilter $inListFilter
*/
public function setInListFilter(InListFilter $inListFilter)
{
$this->inListFilter = $inListFilter;
}
/**
* @return InListFilter
*/
public function getInListFilter()
{
return $this->inListFilter;
}
/**
* A filter for numeric or date values.
*
* @param NumericFilter $numericFilter
*/
public function setNumericFilter(NumericFilter $numericFilter)
{
$this->numericFilter = $numericFilter;
}
/**
* @return NumericFilter
*/
public function getNumericFilter()
{
return $this->numericFilter;
}
/**
* Strings related filter.
*
* @param StringFilter $stringFilter
*/
public function setStringFilter(StringFilter $stringFilter)
{
$this->stringFilter = $stringFilter;
}
/**
* @return StringFilter
*/
public function getStringFilter()
{
return $this->stringFilter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Filter::class, 'Google_Service_AnalyticsData_Filter');
@@ -0,0 +1,99 @@
<?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\AnalyticsData;
class FilterExpression extends \Google\Model
{
protected $andGroupType = FilterExpressionList::class;
protected $andGroupDataType = '';
protected $filterType = Filter::class;
protected $filterDataType = '';
protected $notExpressionType = FilterExpression::class;
protected $notExpressionDataType = '';
protected $orGroupType = FilterExpressionList::class;
protected $orGroupDataType = '';
/**
* The FilterExpressions in and_group have an AND relationship.
*
* @param FilterExpressionList $andGroup
*/
public function setAndGroup(FilterExpressionList $andGroup)
{
$this->andGroup = $andGroup;
}
/**
* @return FilterExpressionList
*/
public function getAndGroup()
{
return $this->andGroup;
}
/**
* A primitive filter. In the same FilterExpression, all of the filter's field
* names need to be either all dimensions or all metrics.
*
* @param Filter $filter
*/
public function setFilter(Filter $filter)
{
$this->filter = $filter;
}
/**
* @return Filter
*/
public function getFilter()
{
return $this->filter;
}
/**
* The FilterExpression is NOT of not_expression.
*
* @param FilterExpression $notExpression
*/
public function setNotExpression(FilterExpression $notExpression)
{
$this->notExpression = $notExpression;
}
/**
* @return FilterExpression
*/
public function getNotExpression()
{
return $this->notExpression;
}
/**
* The FilterExpressions in or_group have an OR relationship.
*
* @param FilterExpressionList $orGroup
*/
public function setOrGroup(FilterExpressionList $orGroup)
{
$this->orGroup = $orGroup;
}
/**
* @return FilterExpressionList
*/
public function getOrGroup()
{
return $this->orGroup;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FilterExpression::class, 'Google_Service_AnalyticsData_FilterExpression');
@@ -0,0 +1,45 @@
<?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\AnalyticsData;
class FilterExpressionList extends \Google\Collection
{
protected $collection_key = 'expressions';
protected $expressionsType = FilterExpression::class;
protected $expressionsDataType = 'array';
/**
* A list of filter expressions.
*
* @param FilterExpression[] $expressions
*/
public function setExpressions($expressions)
{
$this->expressions = $expressions;
}
/**
* @return FilterExpression[]
*/
public function getExpressions()
{
return $this->expressions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FilterExpressionList::class, 'Google_Service_AnalyticsData_FilterExpressionList');
@@ -0,0 +1,71 @@
<?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\AnalyticsData;
class InListFilter extends \Google\Collection
{
protected $collection_key = 'values';
/**
* If true, the string value is case sensitive.
*
* @var bool
*/
public $caseSensitive;
/**
* The list of string values. Must be non-empty.
*
* @var string[]
*/
public $values;
/**
* If true, the string value is case sensitive.
*
* @param bool $caseSensitive
*/
public function setCaseSensitive($caseSensitive)
{
$this->caseSensitive = $caseSensitive;
}
/**
* @return bool
*/
public function getCaseSensitive()
{
return $this->caseSensitive;
}
/**
* The list of string values. Must be non-empty.
*
* @param string[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return string[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InListFilter::class, 'Google_Service_AnalyticsData_InListFilter');
@@ -0,0 +1,69 @@
<?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\AnalyticsData;
class ListAudienceExportsResponse extends \Google\Collection
{
protected $collection_key = 'audienceExports';
protected $audienceExportsType = AudienceExport::class;
protected $audienceExportsDataType = 'array';
/**
* A token, which can be sent as `page_token` to retrieve the next page. If
* this field is omitted, there are no subsequent pages.
*
* @var string
*/
public $nextPageToken;
/**
* Each audience export for a property.
*
* @param AudienceExport[] $audienceExports
*/
public function setAudienceExports($audienceExports)
{
$this->audienceExports = $audienceExports;
}
/**
* @return AudienceExport[]
*/
public function getAudienceExports()
{
return $this->audienceExports;
}
/**
* A token, which can be sent as `page_token` to retrieve the next page. If
* this field is omitted, there are no subsequent pages.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListAudienceExportsResponse::class, 'Google_Service_AnalyticsData_ListAudienceExportsResponse');
@@ -0,0 +1,103 @@
<?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\AnalyticsData;
class Metadata extends \Google\Collection
{
protected $collection_key = 'metrics';
protected $comparisonsType = ComparisonMetadata::class;
protected $comparisonsDataType = 'array';
protected $dimensionsType = DimensionMetadata::class;
protected $dimensionsDataType = 'array';
protected $metricsType = MetricMetadata::class;
protected $metricsDataType = 'array';
/**
* Resource name of this metadata.
*
* @var string
*/
public $name;
/**
* The comparison descriptions.
*
* @param ComparisonMetadata[] $comparisons
*/
public function setComparisons($comparisons)
{
$this->comparisons = $comparisons;
}
/**
* @return ComparisonMetadata[]
*/
public function getComparisons()
{
return $this->comparisons;
}
/**
* The dimension descriptions.
*
* @param DimensionMetadata[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return DimensionMetadata[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* The metric descriptions.
*
* @param MetricMetadata[] $metrics
*/
public function setMetrics($metrics)
{
$this->metrics = $metrics;
}
/**
* @return MetricMetadata[]
*/
public function getMetrics()
{
return $this->metrics;
}
/**
* Resource name of this metadata.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Metadata::class, 'Google_Service_AnalyticsData_Metadata');
@@ -0,0 +1,124 @@
<?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\AnalyticsData;
class Metric extends \Google\Model
{
/**
* A mathematical expression for derived metrics. For example, the metric
* Event count per user is `eventCount/totalUsers`.
*
* @var string
*/
public $expression;
/**
* Indicates if a metric is invisible in the report response. If a metric is
* invisible, the metric will not produce a column in the response, but can be
* used in `metricFilter`, `orderBys`, or a metric `expression`.
*
* @var bool
*/
public $invisible;
/**
* The name of the metric. See the [API Metrics](https://developers.google.com
* /analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of
* metric names supported by core reporting methods such as `runReport` and
* `batchRunReports`. See [Realtime Metrics](https://developers.google.com/ana
* lytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the
* list of metric names supported by the `runRealtimeReport` method. See
* [Funnel Metrics](https://developers.google.com/analytics/devguides/reportin
* g/data/v1/exploration-api-schema#metrics) for the list of metric names
* supported by the `runFunnelReport` method. If `expression` is specified,
* `name` can be any string that you would like within the allowed character
* set. For example if `expression` is `screenPageViews/sessions`, you could
* call that metric's name = `viewsPerSession`. Metric names that you choose
* must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced
* by `name` in `metricFilter`, `orderBys`, and metric `expression`.
*
* @var string
*/
public $name;
/**
* A mathematical expression for derived metrics. For example, the metric
* Event count per user is `eventCount/totalUsers`.
*
* @param string $expression
*/
public function setExpression($expression)
{
$this->expression = $expression;
}
/**
* @return string
*/
public function getExpression()
{
return $this->expression;
}
/**
* Indicates if a metric is invisible in the report response. If a metric is
* invisible, the metric will not produce a column in the response, but can be
* used in `metricFilter`, `orderBys`, or a metric `expression`.
*
* @param bool $invisible
*/
public function setInvisible($invisible)
{
$this->invisible = $invisible;
}
/**
* @return bool
*/
public function getInvisible()
{
return $this->invisible;
}
/**
* The name of the metric. See the [API Metrics](https://developers.google.com
* /analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of
* metric names supported by core reporting methods such as `runReport` and
* `batchRunReports`. See [Realtime Metrics](https://developers.google.com/ana
* lytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the
* list of metric names supported by the `runRealtimeReport` method. See
* [Funnel Metrics](https://developers.google.com/analytics/devguides/reportin
* g/data/v1/exploration-api-schema#metrics) for the list of metric names
* supported by the `runFunnelReport` method. If `expression` is specified,
* `name` can be any string that you would like within the allowed character
* set. For example if `expression` is `screenPageViews/sessions`, you could
* call that metric's name = `viewsPerSession`. Metric names that you choose
* must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced
* by `name` in `metricFilter`, `orderBys`, and metric `expression`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Metric::class, 'Google_Service_AnalyticsData_Metric');
@@ -0,0 +1,86 @@
<?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\AnalyticsData;
class MetricCompatibility extends \Google\Model
{
/**
* Unspecified compatibility.
*/
public const COMPATIBILITY_COMPATIBILITY_UNSPECIFIED = 'COMPATIBILITY_UNSPECIFIED';
/**
* The dimension or metric is compatible. This dimension or metric can be
* successfully added to a report.
*/
public const COMPATIBILITY_COMPATIBLE = 'COMPATIBLE';
/**
* The dimension or metric is incompatible. This dimension or metric cannot be
* successfully added to a report.
*/
public const COMPATIBILITY_INCOMPATIBLE = 'INCOMPATIBLE';
/**
* The compatibility of this metric. If the compatibility is COMPATIBLE, this
* metric can be successfully added to the report.
*
* @var string
*/
public $compatibility;
protected $metricMetadataType = MetricMetadata::class;
protected $metricMetadataDataType = '';
/**
* The compatibility of this metric. If the compatibility is COMPATIBLE, this
* metric can be successfully added to the report.
*
* Accepted values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE
*
* @param self::COMPATIBILITY_* $compatibility
*/
public function setCompatibility($compatibility)
{
$this->compatibility = $compatibility;
}
/**
* @return self::COMPATIBILITY_*
*/
public function getCompatibility()
{
return $this->compatibility;
}
/**
* The metric metadata contains the API name for this compatibility
* information. The metric metadata also contains other helpful information
* like the UI name and description.
*
* @param MetricMetadata $metricMetadata
*/
public function setMetricMetadata(MetricMetadata $metricMetadata)
{
$this->metricMetadata = $metricMetadata;
}
/**
* @return MetricMetadata
*/
public function getMetricMetadata()
{
return $this->metricMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetricCompatibility::class, 'Google_Service_AnalyticsData_MetricCompatibility');
@@ -0,0 +1,126 @@
<?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\AnalyticsData;
class MetricHeader extends \Google\Model
{
/**
* Unspecified type.
*/
public const TYPE_METRIC_TYPE_UNSPECIFIED = 'METRIC_TYPE_UNSPECIFIED';
/**
* Integer type.
*/
public const TYPE_TYPE_INTEGER = 'TYPE_INTEGER';
/**
* Floating point type.
*/
public const TYPE_TYPE_FLOAT = 'TYPE_FLOAT';
/**
* A duration of seconds; a special floating point type.
*/
public const TYPE_TYPE_SECONDS = 'TYPE_SECONDS';
/**
* A duration in milliseconds; a special floating point type.
*/
public const TYPE_TYPE_MILLISECONDS = 'TYPE_MILLISECONDS';
/**
* A duration in minutes; a special floating point type.
*/
public const TYPE_TYPE_MINUTES = 'TYPE_MINUTES';
/**
* A duration in hours; a special floating point type.
*/
public const TYPE_TYPE_HOURS = 'TYPE_HOURS';
/**
* A custom metric of standard type; a special floating point type.
*/
public const TYPE_TYPE_STANDARD = 'TYPE_STANDARD';
/**
* An amount of money; a special floating point type.
*/
public const TYPE_TYPE_CURRENCY = 'TYPE_CURRENCY';
/**
* A length in feet; a special floating point type.
*/
public const TYPE_TYPE_FEET = 'TYPE_FEET';
/**
* A length in miles; a special floating point type.
*/
public const TYPE_TYPE_MILES = 'TYPE_MILES';
/**
* A length in meters; a special floating point type.
*/
public const TYPE_TYPE_METERS = 'TYPE_METERS';
/**
* A length in kilometers; a special floating point type.
*/
public const TYPE_TYPE_KILOMETERS = 'TYPE_KILOMETERS';
/**
* The metric's name.
*
* @var string
*/
public $name;
/**
* The metric's data type.
*
* @var string
*/
public $type;
/**
* The metric's name.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The metric's data type.
*
* Accepted values: METRIC_TYPE_UNSPECIFIED, TYPE_INTEGER, TYPE_FLOAT,
* TYPE_SECONDS, TYPE_MILLISECONDS, TYPE_MINUTES, TYPE_HOURS, TYPE_STANDARD,
* TYPE_CURRENCY, TYPE_FEET, TYPE_MILES, TYPE_METERS, TYPE_KILOMETERS
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetricHeader::class, 'Google_Service_AnalyticsData_MetricHeader');
@@ -0,0 +1,309 @@
<?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\AnalyticsData;
class MetricMetadata extends \Google\Collection
{
/**
* Unspecified type.
*/
public const TYPE_METRIC_TYPE_UNSPECIFIED = 'METRIC_TYPE_UNSPECIFIED';
/**
* Integer type.
*/
public const TYPE_TYPE_INTEGER = 'TYPE_INTEGER';
/**
* Floating point type.
*/
public const TYPE_TYPE_FLOAT = 'TYPE_FLOAT';
/**
* A duration of seconds; a special floating point type.
*/
public const TYPE_TYPE_SECONDS = 'TYPE_SECONDS';
/**
* A duration in milliseconds; a special floating point type.
*/
public const TYPE_TYPE_MILLISECONDS = 'TYPE_MILLISECONDS';
/**
* A duration in minutes; a special floating point type.
*/
public const TYPE_TYPE_MINUTES = 'TYPE_MINUTES';
/**
* A duration in hours; a special floating point type.
*/
public const TYPE_TYPE_HOURS = 'TYPE_HOURS';
/**
* A custom metric of standard type; a special floating point type.
*/
public const TYPE_TYPE_STANDARD = 'TYPE_STANDARD';
/**
* An amount of money; a special floating point type.
*/
public const TYPE_TYPE_CURRENCY = 'TYPE_CURRENCY';
/**
* A length in feet; a special floating point type.
*/
public const TYPE_TYPE_FEET = 'TYPE_FEET';
/**
* A length in miles; a special floating point type.
*/
public const TYPE_TYPE_MILES = 'TYPE_MILES';
/**
* A length in meters; a special floating point type.
*/
public const TYPE_TYPE_METERS = 'TYPE_METERS';
/**
* A length in kilometers; a special floating point type.
*/
public const TYPE_TYPE_KILOMETERS = 'TYPE_KILOMETERS';
protected $collection_key = 'deprecatedApiNames';
/**
* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
* `eventCount`.
*
* @var string
*/
public $apiName;
/**
* If reasons are specified, your access is blocked to this metric for this
* property. API requests from you to this property for this metric will
* succeed; however, the report will contain only zeros for this metric. API
* requests with metric filters on blocked metrics will fail. If reasons are
* empty, you have access to this metric. To learn more, see [Access and data-
* restriction
* management](https://support.google.com/analytics/answer/10851388).
*
* @var string[]
*/
public $blockedReasons;
/**
* The display name of the category that this metrics belongs to. Similar
* dimensions and metrics are categorized together.
*
* @var string
*/
public $category;
/**
* True if the metric is a custom metric for this property.
*
* @var bool
*/
public $customDefinition;
/**
* Still usable but deprecated names for this metric. If populated, this
* metric is available by either `apiName` or one of `deprecatedApiNames` for
* a period of time. After the deprecation period, the metric will be
* available only by `apiName`.
*
* @var string[]
*/
public $deprecatedApiNames;
/**
* Description of how this metric is used and calculated.
*
* @var string
*/
public $description;
/**
* The mathematical expression for this derived metric. Can be used in
* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
* are not expressions, and for non-expressions, this field is empty.
*
* @var string
*/
public $expression;
/**
* The type of this metric.
*
* @var string
*/
public $type;
/**
* This metric's name within the Google Analytics user interface. For example,
* `Event count`.
*
* @var string
*/
public $uiName;
/**
* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
* `eventCount`.
*
* @param string $apiName
*/
public function setApiName($apiName)
{
$this->apiName = $apiName;
}
/**
* @return string
*/
public function getApiName()
{
return $this->apiName;
}
/**
* If reasons are specified, your access is blocked to this metric for this
* property. API requests from you to this property for this metric will
* succeed; however, the report will contain only zeros for this metric. API
* requests with metric filters on blocked metrics will fail. If reasons are
* empty, you have access to this metric. To learn more, see [Access and data-
* restriction
* management](https://support.google.com/analytics/answer/10851388).
*
* @param string[] $blockedReasons
*/
public function setBlockedReasons($blockedReasons)
{
$this->blockedReasons = $blockedReasons;
}
/**
* @return string[]
*/
public function getBlockedReasons()
{
return $this->blockedReasons;
}
/**
* The display name of the category that this metrics belongs to. Similar
* dimensions and metrics are categorized together.
*
* @param string $category
*/
public function setCategory($category)
{
$this->category = $category;
}
/**
* @return string
*/
public function getCategory()
{
return $this->category;
}
/**
* True if the metric is a custom metric for this property.
*
* @param bool $customDefinition
*/
public function setCustomDefinition($customDefinition)
{
$this->customDefinition = $customDefinition;
}
/**
* @return bool
*/
public function getCustomDefinition()
{
return $this->customDefinition;
}
/**
* Still usable but deprecated names for this metric. If populated, this
* metric is available by either `apiName` or one of `deprecatedApiNames` for
* a period of time. After the deprecation period, the metric will be
* available only by `apiName`.
*
* @param string[] $deprecatedApiNames
*/
public function setDeprecatedApiNames($deprecatedApiNames)
{
$this->deprecatedApiNames = $deprecatedApiNames;
}
/**
* @return string[]
*/
public function getDeprecatedApiNames()
{
return $this->deprecatedApiNames;
}
/**
* Description of how this metric is used and calculated.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* The mathematical expression for this derived metric. Can be used in
* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
* are not expressions, and for non-expressions, this field is empty.
*
* @param string $expression
*/
public function setExpression($expression)
{
$this->expression = $expression;
}
/**
* @return string
*/
public function getExpression()
{
return $this->expression;
}
/**
* The type of this metric.
*
* Accepted values: METRIC_TYPE_UNSPECIFIED, TYPE_INTEGER, TYPE_FLOAT,
* TYPE_SECONDS, TYPE_MILLISECONDS, TYPE_MINUTES, TYPE_HOURS, TYPE_STANDARD,
* TYPE_CURRENCY, TYPE_FEET, TYPE_MILES, TYPE_METERS, TYPE_KILOMETERS
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
/**
* This metric's name within the Google Analytics user interface. For example,
* `Event count`.
*
* @param string $uiName
*/
public function setUiName($uiName)
{
$this->uiName = $uiName;
}
/**
* @return string
*/
public function getUiName()
{
return $this->uiName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetricMetadata::class, 'Google_Service_AnalyticsData_MetricMetadata');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class MetricOrderBy extends \Google\Model
{
/**
* A metric name in the request to order by.
*
* @var string
*/
public $metricName;
/**
* A metric name in the request to order by.
*
* @param string $metricName
*/
public function setMetricName($metricName)
{
$this->metricName = $metricName;
}
/**
* @return string
*/
public function getMetricName()
{
return $this->metricName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetricOrderBy::class, 'Google_Service_AnalyticsData_MetricOrderBy');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class MetricValue extends \Google\Model
{
/**
* Measurement value. See MetricHeader for type.
*
* @var string
*/
public $value;
/**
* Measurement value. See MetricHeader for type.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetricValue::class, 'Google_Service_AnalyticsData_MetricValue');
@@ -0,0 +1,122 @@
<?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\AnalyticsData;
class MinuteRange extends \Google\Model
{
/**
* The inclusive end minute for the query as a number of minutes before now.
* Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
* specifies the report should include event data from prior to 15 minutes
* ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
* properties can request any minute in the last 30 minutes of event data
* (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
* minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
*
* @var int
*/
public $endMinutesAgo;
/**
* Assigns a name to this minute range. The dimension `dateRange` is valued to
* this name in a report response. If set, cannot begin with `date_range_` or
* `RESERVED_`. If not set, minute ranges are named by their zero based index
* in the request: `date_range_0`, `date_range_1`, etc.
*
* @var string
*/
public $name;
/**
* The inclusive start minute for the query as a number of minutes before now.
* For example, `"startMinutesAgo": 29` specifies the report should include
* event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
* If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
* properties can request up to the last 30 minutes of event data
* (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
* the last 60 minutes of event data (`startMinutesAgo <= 59`).
*
* @var int
*/
public $startMinutesAgo;
/**
* The inclusive end minute for the query as a number of minutes before now.
* Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
* specifies the report should include event data from prior to 15 minutes
* ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
* properties can request any minute in the last 30 minutes of event data
* (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
* minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
*
* @param int $endMinutesAgo
*/
public function setEndMinutesAgo($endMinutesAgo)
{
$this->endMinutesAgo = $endMinutesAgo;
}
/**
* @return int
*/
public function getEndMinutesAgo()
{
return $this->endMinutesAgo;
}
/**
* Assigns a name to this minute range. The dimension `dateRange` is valued to
* this name in a report response. If set, cannot begin with `date_range_` or
* `RESERVED_`. If not set, minute ranges are named by their zero based index
* in the request: `date_range_0`, `date_range_1`, etc.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The inclusive start minute for the query as a number of minutes before now.
* For example, `"startMinutesAgo": 29` specifies the report should include
* event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
* If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
* properties can request up to the last 30 minutes of event data
* (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
* the last 60 minutes of event data (`startMinutesAgo <= 59`).
*
* @param int $startMinutesAgo
*/
public function setStartMinutesAgo($startMinutesAgo)
{
$this->startMinutesAgo = $startMinutesAgo;
}
/**
* @return int
*/
public function getStartMinutesAgo()
{
return $this->startMinutesAgo;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MinuteRange::class, 'Google_Service_AnalyticsData_MinuteRange');
@@ -0,0 +1,93 @@
<?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\AnalyticsData;
class NumericFilter extends \Google\Model
{
/**
* Unspecified.
*/
public const OPERATION_OPERATION_UNSPECIFIED = 'OPERATION_UNSPECIFIED';
/**
* Equal
*/
public const OPERATION_EQUAL = 'EQUAL';
/**
* Less than
*/
public const OPERATION_LESS_THAN = 'LESS_THAN';
/**
* Less than or equal
*/
public const OPERATION_LESS_THAN_OR_EQUAL = 'LESS_THAN_OR_EQUAL';
/**
* Greater than
*/
public const OPERATION_GREATER_THAN = 'GREATER_THAN';
/**
* Greater than or equal
*/
public const OPERATION_GREATER_THAN_OR_EQUAL = 'GREATER_THAN_OR_EQUAL';
/**
* The operation type for this filter.
*
* @var string
*/
public $operation;
protected $valueType = NumericValue::class;
protected $valueDataType = '';
/**
* The operation type for this filter.
*
* Accepted values: OPERATION_UNSPECIFIED, EQUAL, LESS_THAN,
* LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL
*
* @param self::OPERATION_* $operation
*/
public function setOperation($operation)
{
$this->operation = $operation;
}
/**
* @return self::OPERATION_*
*/
public function getOperation()
{
return $this->operation;
}
/**
* A numeric value or a date value.
*
* @param NumericValue $value
*/
public function setValue(NumericValue $value)
{
$this->value = $value;
}
/**
* @return NumericValue
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NumericFilter::class, 'Google_Service_AnalyticsData_NumericFilter');
@@ -0,0 +1,62 @@
<?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\AnalyticsData;
class NumericValue extends \Google\Model
{
/**
* Double value
*
* @var
*/
public $doubleValue;
/**
* Integer value
*
* @var string
*/
public $int64Value;
public function setDoubleValue($doubleValue)
{
$this->doubleValue = $doubleValue;
}
public function getDoubleValue()
{
return $this->doubleValue;
}
/**
* Integer value
*
* @param string $int64Value
*/
public function setInt64Value($int64Value)
{
$this->int64Value = $int64Value;
}
/**
* @return string
*/
public function getInt64Value()
{
return $this->int64Value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NumericValue::class, 'Google_Service_AnalyticsData_NumericValue');
@@ -0,0 +1,158 @@
<?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\AnalyticsData;
class Operation extends \Google\Model
{
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @var bool
*/
public $done;
protected $errorType = Status::class;
protected $errorDataType = '';
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @var array[]
*/
public $metadata;
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @var string
*/
public $name;
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @var array[]
*/
public $response;
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @param bool $done
*/
public function setDone($done)
{
$this->done = $done;
}
/**
* @return bool
*/
public function getDone()
{
return $this->done;
}
/**
* The error result of the operation in case of failure or cancellation.
*
* @param Status $error
*/
public function setError(Status $error)
{
$this->error = $error;
}
/**
* @return Status
*/
public function getError()
{
return $this->error;
}
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @param array[] $response
*/
public function setResponse($response)
{
$this->response = $response;
}
/**
* @return array[]
*/
public function getResponse()
{
return $this->response;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Operation::class, 'Google_Service_AnalyticsData_Operation');
@@ -0,0 +1,102 @@
<?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\AnalyticsData;
class OrderBy extends \Google\Model
{
/**
* If true, sorts by descending order.
*
* @var bool
*/
public $desc;
protected $dimensionType = DimensionOrderBy::class;
protected $dimensionDataType = '';
protected $metricType = MetricOrderBy::class;
protected $metricDataType = '';
protected $pivotType = PivotOrderBy::class;
protected $pivotDataType = '';
/**
* If true, sorts by descending order.
*
* @param bool $desc
*/
public function setDesc($desc)
{
$this->desc = $desc;
}
/**
* @return bool
*/
public function getDesc()
{
return $this->desc;
}
/**
* Sorts results by a dimension's values.
*
* @param DimensionOrderBy $dimension
*/
public function setDimension(DimensionOrderBy $dimension)
{
$this->dimension = $dimension;
}
/**
* @return DimensionOrderBy
*/
public function getDimension()
{
return $this->dimension;
}
/**
* Sorts results by a metric's values.
*
* @param MetricOrderBy $metric
*/
public function setMetric(MetricOrderBy $metric)
{
$this->metric = $metric;
}
/**
* @return MetricOrderBy
*/
public function getMetric()
{
return $this->metric;
}
/**
* Sorts results by a metric's values within a pivot column group.
*
* @param PivotOrderBy $pivot
*/
public function setPivot(PivotOrderBy $pivot)
{
$this->pivot = $pivot;
}
/**
* @return PivotOrderBy
*/
public function getPivot()
{
return $this->pivot;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OrderBy::class, 'Google_Service_AnalyticsData_OrderBy');
@@ -0,0 +1,155 @@
<?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\AnalyticsData;
class Pivot extends \Google\Collection
{
protected $collection_key = 'orderBys';
/**
* Dimension names for visible columns in the report response. Including
* "dateRange" produces a date range column; for each row in the response,
* dimension values in the date range column will indicate the corresponding
* date range from the request.
*
* @var string[]
*/
public $fieldNames;
/**
* The number of unique combinations of dimension values to return in this
* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
* single pivot requests. The product of the `limit` for each `pivot` in a
* `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot
* request with `limit: 1000` in each pivot will fail because the product is
* `1,000,000`.
*
* @var string
*/
public $limit;
/**
* Aggregate the metrics by dimensions in this pivot using the specified
* metric_aggregations.
*
* @var string[]
*/
public $metricAggregations;
/**
* The row count of the start row. The first row is counted as row 0.
*
* @var string
*/
public $offset;
protected $orderBysType = OrderBy::class;
protected $orderBysDataType = 'array';
/**
* Dimension names for visible columns in the report response. Including
* "dateRange" produces a date range column; for each row in the response,
* dimension values in the date range column will indicate the corresponding
* date range from the request.
*
* @param string[] $fieldNames
*/
public function setFieldNames($fieldNames)
{
$this->fieldNames = $fieldNames;
}
/**
* @return string[]
*/
public function getFieldNames()
{
return $this->fieldNames;
}
/**
* The number of unique combinations of dimension values to return in this
* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
* single pivot requests. The product of the `limit` for each `pivot` in a
* `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot
* request with `limit: 1000` in each pivot will fail because the product is
* `1,000,000`.
*
* @param string $limit
*/
public function setLimit($limit)
{
$this->limit = $limit;
}
/**
* @return string
*/
public function getLimit()
{
return $this->limit;
}
/**
* Aggregate the metrics by dimensions in this pivot using the specified
* metric_aggregations.
*
* @param string[] $metricAggregations
*/
public function setMetricAggregations($metricAggregations)
{
$this->metricAggregations = $metricAggregations;
}
/**
* @return string[]
*/
public function getMetricAggregations()
{
return $this->metricAggregations;
}
/**
* The row count of the start row. The first row is counted as row 0.
*
* @param string $offset
*/
public function setOffset($offset)
{
$this->offset = $offset;
}
/**
* @return string
*/
public function getOffset()
{
return $this->offset;
}
/**
* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
* Dimensions specified in these OrderBys must be a subset of
* Pivot.field_names.
*
* @param OrderBy[] $orderBys
*/
public function setOrderBys($orderBys)
{
$this->orderBys = $orderBys;
}
/**
* @return OrderBy[]
*/
public function getOrderBys()
{
return $this->orderBys;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Pivot::class, 'Google_Service_AnalyticsData_Pivot');
@@ -0,0 +1,45 @@
<?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\AnalyticsData;
class PivotDimensionHeader extends \Google\Collection
{
protected $collection_key = 'dimensionValues';
protected $dimensionValuesType = DimensionValue::class;
protected $dimensionValuesDataType = 'array';
/**
* Values of multiple dimensions in a pivot.
*
* @param DimensionValue[] $dimensionValues
*/
public function setDimensionValues($dimensionValues)
{
$this->dimensionValues = $dimensionValues;
}
/**
* @return DimensionValue[]
*/
public function getDimensionValues()
{
return $this->dimensionValues;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivotDimensionHeader::class, 'Google_Service_AnalyticsData_PivotDimensionHeader');
@@ -0,0 +1,72 @@
<?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\AnalyticsData;
class PivotHeader extends \Google\Collection
{
protected $collection_key = 'pivotDimensionHeaders';
protected $pivotDimensionHeadersType = PivotDimensionHeader::class;
protected $pivotDimensionHeadersDataType = 'array';
/**
* The cardinality of the pivot. The total number of rows for this pivot's
* fields regardless of how the parameters `offset` and `limit` are specified
* in the request.
*
* @var int
*/
public $rowCount;
/**
* The size is the same as the cardinality of the corresponding dimension
* combinations.
*
* @param PivotDimensionHeader[] $pivotDimensionHeaders
*/
public function setPivotDimensionHeaders($pivotDimensionHeaders)
{
$this->pivotDimensionHeaders = $pivotDimensionHeaders;
}
/**
* @return PivotDimensionHeader[]
*/
public function getPivotDimensionHeaders()
{
return $this->pivotDimensionHeaders;
}
/**
* The cardinality of the pivot. The total number of rows for this pivot's
* fields regardless of how the parameters `offset` and `limit` are specified
* in the request.
*
* @param int $rowCount
*/
public function setRowCount($rowCount)
{
$this->rowCount = $rowCount;
}
/**
* @return int
*/
public function getRowCount()
{
return $this->rowCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivotHeader::class, 'Google_Service_AnalyticsData_PivotHeader');
@@ -0,0 +1,72 @@
<?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\AnalyticsData;
class PivotOrderBy extends \Google\Collection
{
protected $collection_key = 'pivotSelections';
/**
* In the response to order by, order rows by this column. Must be a metric
* name from the request.
*
* @var string
*/
public $metricName;
protected $pivotSelectionsType = PivotSelection::class;
protected $pivotSelectionsDataType = 'array';
/**
* In the response to order by, order rows by this column. Must be a metric
* name from the request.
*
* @param string $metricName
*/
public function setMetricName($metricName)
{
$this->metricName = $metricName;
}
/**
* @return string
*/
public function getMetricName()
{
return $this->metricName;
}
/**
* Used to select a dimension name and value pivot. If multiple pivot
* selections are given, the sort occurs on rows where all pivot selection
* dimension name and value pairs match the row's dimension name and value
* pair.
*
* @param PivotSelection[] $pivotSelections
*/
public function setPivotSelections($pivotSelections)
{
$this->pivotSelections = $pivotSelections;
}
/**
* @return PivotSelection[]
*/
public function getPivotSelections()
{
return $this->pivotSelections;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivotOrderBy::class, 'Google_Service_AnalyticsData_PivotOrderBy');
@@ -0,0 +1,70 @@
<?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\AnalyticsData;
class PivotSelection extends \Google\Model
{
/**
* Must be a dimension name from the request.
*
* @var string
*/
public $dimensionName;
/**
* Order by only when the named dimension is this value.
*
* @var string
*/
public $dimensionValue;
/**
* Must be a dimension name from the request.
*
* @param string $dimensionName
*/
public function setDimensionName($dimensionName)
{
$this->dimensionName = $dimensionName;
}
/**
* @return string
*/
public function getDimensionName()
{
return $this->dimensionName;
}
/**
* Order by only when the named dimension is this value.
*
* @param string $dimensionValue
*/
public function setDimensionValue($dimensionValue)
{
$this->dimensionValue = $dimensionValue;
}
/**
* @return string
*/
public function getDimensionValue()
{
return $this->dimensionValue;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivotSelection::class, 'Google_Service_AnalyticsData_PivotSelection');
@@ -0,0 +1,150 @@
<?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\AnalyticsData;
class PropertyQuota extends \Google\Model
{
protected $concurrentRequestsType = QuotaStatus::class;
protected $concurrentRequestsDataType = '';
protected $potentiallyThresholdedRequestsPerHourType = QuotaStatus::class;
protected $potentiallyThresholdedRequestsPerHourDataType = '';
protected $serverErrorsPerProjectPerHourType = QuotaStatus::class;
protected $serverErrorsPerProjectPerHourDataType = '';
protected $tokensPerDayType = QuotaStatus::class;
protected $tokensPerDayDataType = '';
protected $tokensPerHourType = QuotaStatus::class;
protected $tokensPerHourDataType = '';
protected $tokensPerProjectPerHourType = QuotaStatus::class;
protected $tokensPerProjectPerHourDataType = '';
/**
* Standard Analytics Properties can send up to 10 concurrent requests;
* Analytics 360 Properties can use up to 50 concurrent requests.
*
* @param QuotaStatus $concurrentRequests
*/
public function setConcurrentRequests(QuotaStatus $concurrentRequests)
{
$this->concurrentRequests = $concurrentRequests;
}
/**
* @return QuotaStatus
*/
public function getConcurrentRequests()
{
return $this->concurrentRequests;
}
/**
* Analytics Properties can send up to 120 requests with potentially
* thresholded dimensions per hour. In a batch request, each report request is
* individually counted for this quota if the request contains potentially
* thresholded dimensions.
*
* @param QuotaStatus $potentiallyThresholdedRequestsPerHour
*/
public function setPotentiallyThresholdedRequestsPerHour(QuotaStatus $potentiallyThresholdedRequestsPerHour)
{
$this->potentiallyThresholdedRequestsPerHour = $potentiallyThresholdedRequestsPerHour;
}
/**
* @return QuotaStatus
*/
public function getPotentiallyThresholdedRequestsPerHour()
{
return $this->potentiallyThresholdedRequestsPerHour;
}
/**
* Standard Analytics Properties and cloud project pairs can have up to 10
* server errors per hour; Analytics 360 Properties and cloud project pairs
* can have up to 50 server errors per hour.
*
* @param QuotaStatus $serverErrorsPerProjectPerHour
*/
public function setServerErrorsPerProjectPerHour(QuotaStatus $serverErrorsPerProjectPerHour)
{
$this->serverErrorsPerProjectPerHour = $serverErrorsPerProjectPerHour;
}
/**
* @return QuotaStatus
*/
public function getServerErrorsPerProjectPerHour()
{
return $this->serverErrorsPerProjectPerHour;
}
/**
* Standard Analytics Properties can use up to 200,000 tokens per day;
* Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
* consume fewer than 10 tokens.
*
* @param QuotaStatus $tokensPerDay
*/
public function setTokensPerDay(QuotaStatus $tokensPerDay)
{
$this->tokensPerDay = $tokensPerDay;
}
/**
* @return QuotaStatus
*/
public function getTokensPerDay()
{
return $this->tokensPerDay;
}
/**
* Standard Analytics Properties can use up to 40,000 tokens per hour;
* Analytics 360 Properties can use 400,000 tokens per hour. An API request
* consumes a single number of tokens, and that number is deducted from all of
* the hourly, daily, and per project hourly quotas.
*
* @param QuotaStatus $tokensPerHour
*/
public function setTokensPerHour(QuotaStatus $tokensPerHour)
{
$this->tokensPerHour = $tokensPerHour;
}
/**
* @return QuotaStatus
*/
public function getTokensPerHour()
{
return $this->tokensPerHour;
}
/**
* Analytics Properties can use up to 35% of their tokens per project per
* hour. This amounts to standard Analytics Properties can use up to 14,000
* tokens per project per hour, and Analytics 360 Properties can use 140,000
* tokens per project per hour. An API request consumes a single number of
* tokens, and that number is deducted from all of the hourly, daily, and per
* project hourly quotas.
*
* @param QuotaStatus $tokensPerProjectPerHour
*/
public function setTokensPerProjectPerHour(QuotaStatus $tokensPerProjectPerHour)
{
$this->tokensPerProjectPerHour = $tokensPerProjectPerHour;
}
/**
* @return QuotaStatus
*/
public function getTokensPerProjectPerHour()
{
return $this->tokensPerProjectPerHour;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PropertyQuota::class, 'Google_Service_AnalyticsData_PropertyQuota');
@@ -0,0 +1,94 @@
<?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\AnalyticsData;
class QueryAudienceExportRequest extends \Google\Model
{
/**
* Optional. The number of rows to return. If unspecified, 10,000 rows are
* returned. The API returns a maximum of 250,000 rows per request, no matter
* how many you ask for. `limit` must be positive. The API can also return
* fewer rows than the requested `limit`, if there aren't as many dimension
* values as the `limit`. To learn more about this pagination parameter, see [
* Pagination](https://developers.google.com/analytics/devguides/reporting/dat
* a/v1/basics#pagination).
*
* @var string
*/
public $limit;
/**
* Optional. The row count of the start row. The first row is counted as row
* 0. When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
* second request sets offset to the `limit` of the first request; the second
* request returns the second `limit` of rows. To learn more about this
* pagination parameter, see [Pagination](https://developers.google.com/analyt
* ics/devguides/reporting/data/v1/basics#pagination).
*
* @var string
*/
public $offset;
/**
* Optional. The number of rows to return. If unspecified, 10,000 rows are
* returned. The API returns a maximum of 250,000 rows per request, no matter
* how many you ask for. `limit` must be positive. The API can also return
* fewer rows than the requested `limit`, if there aren't as many dimension
* values as the `limit`. To learn more about this pagination parameter, see [
* Pagination](https://developers.google.com/analytics/devguides/reporting/dat
* a/v1/basics#pagination).
*
* @param string $limit
*/
public function setLimit($limit)
{
$this->limit = $limit;
}
/**
* @return string
*/
public function getLimit()
{
return $this->limit;
}
/**
* Optional. The row count of the start row. The first row is counted as row
* 0. When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
* second request sets offset to the `limit` of the first request; the second
* request returns the second `limit` of rows. To learn more about this
* pagination parameter, see [Pagination](https://developers.google.com/analyt
* ics/devguides/reporting/data/v1/basics#pagination).
*
* @param string $offset
*/
public function setOffset($offset)
{
$this->offset = $offset;
}
/**
* @return string
*/
public function getOffset()
{
return $this->offset;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(QueryAudienceExportRequest::class, 'Google_Service_AnalyticsData_QueryAudienceExportRequest');
@@ -0,0 +1,100 @@
<?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\AnalyticsData;
class QueryAudienceExportResponse extends \Google\Collection
{
protected $collection_key = 'audienceRows';
protected $audienceExportType = AudienceExport::class;
protected $audienceExportDataType = '';
protected $audienceRowsType = V1betaAudienceRow::class;
protected $audienceRowsDataType = 'array';
/**
* The total number of rows in the AudienceExport result. `rowCount` is
* independent of the number of rows returned in the response, the `limit`
* request parameter, and the `offset` request parameter. For example if a
* query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows. To learn more
* about this pagination parameter, see [Pagination](https://developers.google
* .com/analytics/devguides/reporting/data/v1/basics#pagination).
*
* @var int
*/
public $rowCount;
/**
* Configuration data about AudienceExport being queried. Returned to help
* interpret the audience rows in this response. For example, the dimensions
* in this AudienceExport correspond to the columns in the AudienceRows.
*
* @param AudienceExport $audienceExport
*/
public function setAudienceExport(AudienceExport $audienceExport)
{
$this->audienceExport = $audienceExport;
}
/**
* @return AudienceExport
*/
public function getAudienceExport()
{
return $this->audienceExport;
}
/**
* Rows for each user in an audience export. The number of rows in this
* response will be less than or equal to request's page size.
*
* @param V1betaAudienceRow[] $audienceRows
*/
public function setAudienceRows($audienceRows)
{
$this->audienceRows = $audienceRows;
}
/**
* @return V1betaAudienceRow[]
*/
public function getAudienceRows()
{
return $this->audienceRows;
}
/**
* The total number of rows in the AudienceExport result. `rowCount` is
* independent of the number of rows returned in the response, the `limit`
* request parameter, and the `offset` request parameter. For example if a
* query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows. To learn more
* about this pagination parameter, see [Pagination](https://developers.google
* .com/analytics/devguides/reporting/data/v1/basics#pagination).
*
* @param int $rowCount
*/
public function setRowCount($rowCount)
{
$this->rowCount = $rowCount;
}
/**
* @return int
*/
public function getRowCount()
{
return $this->rowCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(QueryAudienceExportResponse::class, 'Google_Service_AnalyticsData_QueryAudienceExportResponse');
@@ -0,0 +1,70 @@
<?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\AnalyticsData;
class QuotaStatus extends \Google\Model
{
/**
* Quota consumed by this request.
*
* @var int
*/
public $consumed;
/**
* Quota remaining after this request.
*
* @var int
*/
public $remaining;
/**
* Quota consumed by this request.
*
* @param int $consumed
*/
public function setConsumed($consumed)
{
$this->consumed = $consumed;
}
/**
* @return int
*/
public function getConsumed()
{
return $this->consumed;
}
/**
* Quota remaining after this request.
*
* @param int $remaining
*/
public function setRemaining($remaining)
{
$this->remaining = $remaining;
}
/**
* @return int
*/
public function getRemaining()
{
return $this->remaining;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(QuotaStatus::class, 'Google_Service_AnalyticsData_QuotaStatus');
@@ -0,0 +1,220 @@
<?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\AnalyticsData\Resource;
use Google\Service\AnalyticsData\BatchRunPivotReportsRequest;
use Google\Service\AnalyticsData\BatchRunPivotReportsResponse;
use Google\Service\AnalyticsData\BatchRunReportsRequest;
use Google\Service\AnalyticsData\BatchRunReportsResponse;
use Google\Service\AnalyticsData\CheckCompatibilityRequest;
use Google\Service\AnalyticsData\CheckCompatibilityResponse;
use Google\Service\AnalyticsData\Metadata;
use Google\Service\AnalyticsData\RunPivotReportRequest;
use Google\Service\AnalyticsData\RunPivotReportResponse;
use Google\Service\AnalyticsData\RunRealtimeReportRequest;
use Google\Service\AnalyticsData\RunRealtimeReportResponse;
use Google\Service\AnalyticsData\RunReportRequest;
use Google\Service\AnalyticsData\RunReportResponse;
/**
* The "properties" collection of methods.
* Typical usage is:
* <code>
* $analyticsdataService = new Google\Service\AnalyticsData(...);
* $properties = $analyticsdataService->properties;
* </code>
*/
class Properties extends \Google\Service\Resource
{
/**
* Returns multiple pivot reports in a batch. All reports must be for the same
* Google Analytics property. (properties.batchRunPivotReports)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. Specified in the URL path and not the body. To learn more, see
* [where to find your Property ID](https://developers.google.com/analytics/devg
* uides/reporting/data/v1/property-id). This property must be specified for the
* batch. The property within RunPivotReportRequest may either be unspecified or
* consistent with this property. Example: properties/1234
* @param BatchRunPivotReportsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchRunPivotReportsResponse
* @throws \Google\Service\Exception
*/
public function batchRunPivotReports($property, BatchRunPivotReportsRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchRunPivotReports', [$params], BatchRunPivotReportsResponse::class);
}
/**
* Returns multiple reports in a batch. All reports must be for the same Google
* Analytics property. (properties.batchRunReports)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. Specified in the URL path and not the body. To learn more, see
* [where to find your Property ID](https://developers.google.com/analytics/devg
* uides/reporting/data/v1/property-id). This property must be specified for the
* batch. The property within RunReportRequest may either be unspecified or
* consistent with this property. Example: properties/1234
* @param BatchRunReportsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchRunReportsResponse
* @throws \Google\Service\Exception
*/
public function batchRunReports($property, BatchRunReportsRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchRunReports', [$params], BatchRunReportsResponse::class);
}
/**
* This compatibility method lists dimensions and metrics that can be added to a
* report request and maintain compatibility. This method fails if the request's
* dimensions and metrics are incompatible. In Google Analytics, reports fail if
* they request incompatible dimensions and/or metrics; in that case, you will
* need to remove dimensions and/or metrics from the incompatible report until
* the report is compatible. The Realtime and Core reports have different
* compatibility rules. This method checks compatibility for Core reports.
* (properties.checkCompatibility)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. To learn more, see [where to find your Property ID](https://deve
* lopers.google.com/analytics/devguides/reporting/data/v1/property-id).
* `property` should be the same value as in your `runReport` request. Example:
* properties/1234
* @param CheckCompatibilityRequest $postBody
* @param array $optParams Optional parameters.
* @return CheckCompatibilityResponse
* @throws \Google\Service\Exception
*/
public function checkCompatibility($property, CheckCompatibilityRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('checkCompatibility', [$params], CheckCompatibilityResponse::class);
}
/**
* Returns metadata for dimensions and metrics available in reporting methods.
* Used to explore the dimensions and metrics. In this method, a Google
* Analytics property identifier is specified in the request, and the metadata
* response includes Custom dimensions and metrics as well as Universal
* metadata. For example if a custom metric with parameter name
* `levels_unlocked` is registered to a property, the Metadata response will
* contain `customEvent:levels_unlocked`. Universal metadata are dimensions and
* metrics applicable to any property such as `country` and `totalUsers`.
* (properties.getMetadata)
*
* @param string $name Required. The resource name of the metadata to retrieve.
* This name field is specified in the URL path and not URL parameters. Property
* is a numeric Google Analytics property identifier. To learn more, see [where
* to find your Property ID](https://developers.google.com/analytics/devguides/r
* eporting/data/v1/property-id). Example: properties/1234/metadata Set the
* Property ID to 0 for dimensions and metrics common to all properties. In this
* special mode, this method will not return custom dimensions and metrics.
* @param array $optParams Optional parameters.
* @return Metadata
* @throws \Google\Service\Exception
*/
public function getMetadata($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getMetadata', [$params], Metadata::class);
}
/**
* Returns a customized pivot report of your Google Analytics event data. Pivot
* reports are more advanced and expressive formats than regular reports. In a
* pivot report, dimensions are only visible if they are included in a pivot.
* Multiple pivots can be specified to further dissect your data.
* (properties.runPivotReport)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. Specified in the URL path and not the body. To learn more, see
* [where to find your Property ID](https://developers.google.com/analytics/devg
* uides/reporting/data/v1/property-id). Within a batch request, this property
* should either be unspecified or consistent with the batch-level property.
* Example: properties/1234
* @param RunPivotReportRequest $postBody
* @param array $optParams Optional parameters.
* @return RunPivotReportResponse
* @throws \Google\Service\Exception
*/
public function runPivotReport($property, RunPivotReportRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('runPivotReport', [$params], RunPivotReportResponse::class);
}
/**
* Returns a customized report of realtime event data for your property. Events
* appear in realtime reports seconds after they have been sent to the Google
* Analytics. Realtime reports show events and usage data for the periods of
* time ranging from the present moment to 30 minutes ago (up to 60 minutes for
* Google Analytics 360 properties). For a guide to constructing realtime
* requests & understanding responses, see [Creating a Realtime Report](https://
* developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
* (properties.runRealtimeReport)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. Specified in the URL path and not the body. To learn more, see
* [where to find your Property ID](https://developers.google.com/analytics/devg
* uides/reporting/data/v1/property-id). Example: properties/1234
* @param RunRealtimeReportRequest $postBody
* @param array $optParams Optional parameters.
* @return RunRealtimeReportResponse
* @throws \Google\Service\Exception
*/
public function runRealtimeReport($property, RunRealtimeReportRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('runRealtimeReport', [$params], RunRealtimeReportResponse::class);
}
/**
* Returns a customized report of your Google Analytics event data. Reports
* contain statistics derived from data collected by the Google Analytics
* tracking code. The data returned from the API is as a table with columns for
* the requested dimensions and metrics. Metrics are individual measurements of
* user activity on your property, such as active users or event count.
* Dimensions break down metrics across some common criteria, such as country or
* event name. For a guide to constructing requests & understanding responses,
* see [Creating a Report](https://developers.google.com/analytics/devguides/rep
* orting/data/v1/basics). (properties.runReport)
*
* @param string $property A Google Analytics property identifier whose events
* are tracked. Specified in the URL path and not the body. To learn more, see
* [where to find your Property ID](https://developers.google.com/analytics/devg
* uides/reporting/data/v1/property-id). Within a batch request, this property
* should either be unspecified or consistent with the batch-level property.
* Example: properties/1234
* @param RunReportRequest $postBody
* @param array $optParams Optional parameters.
* @return RunReportResponse
* @throws \Google\Service\Exception
*/
public function runReport($property, RunReportRequest $postBody, $optParams = [])
{
$params = ['property' => $property, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('runReport', [$params], RunReportResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Properties::class, 'Google_Service_AnalyticsData_Resource_Properties');
@@ -0,0 +1,159 @@
<?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\AnalyticsData\Resource;
use Google\Service\AnalyticsData\AudienceExport;
use Google\Service\AnalyticsData\ListAudienceExportsResponse;
use Google\Service\AnalyticsData\Operation;
use Google\Service\AnalyticsData\QueryAudienceExportRequest;
use Google\Service\AnalyticsData\QueryAudienceExportResponse;
/**
* The "audienceExports" collection of methods.
* Typical usage is:
* <code>
* $analyticsdataService = new Google\Service\AnalyticsData(...);
* $audienceExports = $analyticsdataService->properties_audienceExports;
* </code>
*/
class PropertiesAudienceExports extends \Google\Service\Resource
{
/**
* Creates an audience export for later retrieval. This method quickly returns
* the audience export's resource name and initiates a long running asynchronous
* request to form an audience export. To export the users in an audience
* export, first create the audience export through this method and then send
* the audience resource name to the `QueryAudienceExport` method. See [Creating
* an Audience Export](https://developers.google.com/analytics/devguides/reporti
* ng/data/v1/audience-list-basics) for an introduction to Audience Exports with
* examples. An audience export is a snapshot of the users currently in the
* audience at the time of audience export creation. Creating audience exports
* for one audience on different days will return different results as users
* enter and exit the audience. Audiences in Google Analytics 4 allow you to
* segment your users in the ways that are important to your business. To learn
* more, see https://support.google.com/analytics/answer/9267572. Audience
* exports contain the users in each audience. Audience Export APIs have some
* methods at alpha and other methods at beta stability. The intention is to
* advance methods to beta stability after some feedback and adoption. To give
* your feedback on this API, complete the [Google Analytics Audience Export API
* Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. (audienceExports.create)
*
* @param string $parent Required. The parent resource where this audience
* export will be created. Format: `properties/{property}`
* @param AudienceExport $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, AudienceExport $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Gets configuration metadata about a specific audience export. This method can
* be used to understand an audience export after it has been created. See
* [Creating an Audience Export](https://developers.google.com/analytics/devguid
* es/reporting/data/v1/audience-list-basics) for an introduction to Audience
* Exports with examples. Audience Export APIs have some methods at alpha and
* other methods at beta stability. The intention is to advance methods to beta
* stability after some feedback and adoption. To give your feedback on this
* API, complete the [Google Analytics Audience Export API
* Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. (audienceExports.get)
*
* @param string $name Required. The audience export resource name. Format:
* `properties/{property}/audienceExports/{audience_export}`
* @param array $optParams Optional parameters.
* @return AudienceExport
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], AudienceExport::class);
}
/**
* Lists all audience exports for a property. This method can be used for you to
* find and reuse existing audience exports rather than creating unnecessary new
* audience exports. The same audience can have multiple audience exports that
* represent the export of users that were in an audience on different days. See
* [Creating an Audience Export](https://developers.google.com/analytics/devguid
* es/reporting/data/v1/audience-list-basics) for an introduction to Audience
* Exports with examples. Audience Export APIs have some methods at alpha and
* other methods at beta stability. The intention is to advance methods to beta
* stability after some feedback and adoption. To give your feedback on this
* API, complete the [Google Analytics Audience Export API
* Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* (audienceExports.listPropertiesAudienceExports)
*
* @param string $parent Required. All audience exports for this property will
* be listed in the response. Format: `properties/{property}`
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. The maximum number of audience exports to
* return. The service may return fewer than this value. If unspecified, at most
* 200 audience exports will be returned. The maximum value is 1000 (higher
* values will be coerced to the maximum).
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListAudienceExports` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAudienceExports` must
* match the call that provided the page token.
* @return ListAudienceExportsResponse
* @throws \Google\Service\Exception
*/
public function listPropertiesAudienceExports($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAudienceExportsResponse::class);
}
/**
* Retrieves an audience export of users. After creating an audience, the users
* are not immediately available for exporting. First, a request to
* `CreateAudienceExport` is necessary to create an audience export of users,
* and then second, this method is used to retrieve the users in the audience
* export. See [Creating an Audience Export](https://developers.google.com/analy
* tics/devguides/reporting/data/v1/audience-list-basics) for an introduction to
* Audience Exports with examples. Audiences in Google Analytics 4 allow you to
* segment your users in the ways that are important to your business. To learn
* more, see https://support.google.com/analytics/answer/9267572. Audience
* Export APIs have some methods at alpha and other methods at beta stability.
* The intention is to advance methods to beta stability after some feedback and
* adoption. To give your feedback on this API, complete the [Google Analytics
* Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* (audienceExports.query)
*
* @param string $name Required. The name of the audience export to retrieve
* users from. Format: `properties/{property}/audienceExports/{audience_export}`
* @param QueryAudienceExportRequest $postBody
* @param array $optParams Optional parameters.
* @return QueryAudienceExportResponse
* @throws \Google\Service\Exception
*/
public function query($name, QueryAudienceExportRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('query', [$params], QueryAudienceExportResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PropertiesAudienceExports::class, 'Google_Service_AnalyticsData_Resource_PropertiesAudienceExports');
@@ -0,0 +1,229 @@
<?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\AnalyticsData;
class ResponseMetaData extends \Google\Collection
{
protected $collection_key = 'samplingMetadatas';
/**
* 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.
*
* @var string
*/
public $currencyCode;
/**
* If true, indicates some buckets of dimension combinations are rolled into
* "(other)" row. This can happen for high cardinality reports. The metadata
* parameter dataLossFromOtherRow is populated based on the aggregated data
* table used in the report. The parameter will be accurately populated
* regardless of the filters and limits in the report. For example, the
* (other) row could be dropped from the report because the request contains a
* filter on sessionSource = google. This parameter will still be populated if
* data loss from other row was present in the input aggregate data used to
* generate this report. To learn more, see [About the (other) row and data
* sampling](https://support.google.com/analytics/answer/13208658#reports).
*
* @var bool
*/
public $dataLossFromOtherRow;
/**
* If empty reason is specified, the report is empty for this reason.
*
* @var string
*/
public $emptyReason;
protected $samplingMetadatasType = SamplingMetadata::class;
protected $samplingMetadatasDataType = 'array';
protected $schemaRestrictionResponseType = SchemaRestrictionResponse::class;
protected $schemaRestrictionResponseDataType = '';
/**
* If `subjectToThresholding` is true, this report is subject to thresholding
* and only returns data that meets the minimum aggregation thresholds. It is
* possible for a request to be subject to thresholding thresholding and no
* data is absent from the report, and this happens when all data is above the
* thresholds. To learn more, see [Data
* thresholds](https://support.google.com/analytics/answer/9383630).
*
* @var bool
*/
public $subjectToThresholding;
/**
* 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".
*
* @var string
*/
public $timeZone;
/**
* 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.
*
* @param string $currencyCode
*/
public function setCurrencyCode($currencyCode)
{
$this->currencyCode = $currencyCode;
}
/**
* @return string
*/
public function getCurrencyCode()
{
return $this->currencyCode;
}
/**
* If true, indicates some buckets of dimension combinations are rolled into
* "(other)" row. This can happen for high cardinality reports. The metadata
* parameter dataLossFromOtherRow is populated based on the aggregated data
* table used in the report. The parameter will be accurately populated
* regardless of the filters and limits in the report. For example, the
* (other) row could be dropped from the report because the request contains a
* filter on sessionSource = google. This parameter will still be populated if
* data loss from other row was present in the input aggregate data used to
* generate this report. To learn more, see [About the (other) row and data
* sampling](https://support.google.com/analytics/answer/13208658#reports).
*
* @param bool $dataLossFromOtherRow
*/
public function setDataLossFromOtherRow($dataLossFromOtherRow)
{
$this->dataLossFromOtherRow = $dataLossFromOtherRow;
}
/**
* @return bool
*/
public function getDataLossFromOtherRow()
{
return $this->dataLossFromOtherRow;
}
/**
* If empty reason is specified, the report is empty for this reason.
*
* @param string $emptyReason
*/
public function setEmptyReason($emptyReason)
{
$this->emptyReason = $emptyReason;
}
/**
* @return string
*/
public function getEmptyReason()
{
return $this->emptyReason;
}
/**
* If this report results is
* [sampled](https://support.google.com/analytics/answer/13331292), this
* describes the percentage of events used in this report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
* were specified in the request. However if the results are not sampled, this
* field will not be defined.
*
* @param SamplingMetadata[] $samplingMetadatas
*/
public function setSamplingMetadatas($samplingMetadatas)
{
$this->samplingMetadatas = $samplingMetadatas;
}
/**
* @return SamplingMetadata[]
*/
public function getSamplingMetadatas()
{
return $this->samplingMetadatas;
}
/**
* Describes the schema restrictions actively enforced in creating this
* report. To learn more, see [Access and data-restriction
* management](https://support.google.com/analytics/answer/10851388).
*
* @param SchemaRestrictionResponse $schemaRestrictionResponse
*/
public function setSchemaRestrictionResponse(SchemaRestrictionResponse $schemaRestrictionResponse)
{
$this->schemaRestrictionResponse = $schemaRestrictionResponse;
}
/**
* @return SchemaRestrictionResponse
*/
public function getSchemaRestrictionResponse()
{
return $this->schemaRestrictionResponse;
}
/**
* If `subjectToThresholding` is true, this report is subject to thresholding
* and only returns data that meets the minimum aggregation thresholds. It is
* possible for a request to be subject to thresholding thresholding and no
* data is absent from the report, and this happens when all data is above the
* thresholds. To learn more, see [Data
* thresholds](https://support.google.com/analytics/answer/9383630).
*
* @param bool $subjectToThresholding
*/
public function setSubjectToThresholding($subjectToThresholding)
{
$this->subjectToThresholding = $subjectToThresholding;
}
/**
* @return bool
*/
public function getSubjectToThresholding()
{
return $this->subjectToThresholding;
}
/**
* 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".
*
* @param string $timeZone
*/
public function setTimeZone($timeZone)
{
$this->timeZone = $timeZone;
}
/**
* @return string
*/
public function getTimeZone()
{
return $this->timeZone;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ResponseMetaData::class, 'Google_Service_AnalyticsData_ResponseMetaData');
@@ -0,0 +1,64 @@
<?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\AnalyticsData;
class Row extends \Google\Collection
{
protected $collection_key = 'metricValues';
protected $dimensionValuesType = DimensionValue::class;
protected $dimensionValuesDataType = 'array';
protected $metricValuesType = MetricValue::class;
protected $metricValuesDataType = 'array';
/**
* List of requested dimension values. In a PivotReport, dimension_values are
* only listed for dimensions included in a pivot.
*
* @param DimensionValue[] $dimensionValues
*/
public function setDimensionValues($dimensionValues)
{
$this->dimensionValues = $dimensionValues;
}
/**
* @return DimensionValue[]
*/
public function getDimensionValues()
{
return $this->dimensionValues;
}
/**
* List of requested visible metric values.
*
* @param MetricValue[] $metricValues
*/
public function setMetricValues($metricValues)
{
$this->metricValues = $metricValues;
}
/**
* @return MetricValue[]
*/
public function getMetricValues()
{
return $this->metricValues;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Row::class, 'Google_Service_AnalyticsData_Row');
@@ -0,0 +1,301 @@
<?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\AnalyticsData;
class RunPivotReportRequest extends \Google\Collection
{
protected $collection_key = 'pivots';
protected $cohortSpecType = CohortSpec::class;
protected $cohortSpecDataType = '';
protected $comparisonsType = Comparison::class;
protected $comparisonsDataType = 'array';
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the
* field is empty, the report uses the property's default currency.
*
* @var string
*/
public $currencyCode;
protected $dateRangesType = DateRange::class;
protected $dateRangesDataType = 'array';
protected $dimensionFilterType = FilterExpression::class;
protected $dimensionFilterDataType = '';
protected $dimensionsType = Dimension::class;
protected $dimensionsDataType = 'array';
/**
* If false or unspecified, each row with all metrics equal to 0 will not be
* returned. If true, these rows will be returned if they are not separately
* removed by a filter. Regardless of this `keep_empty_rows` setting, only
* data recorded by the Google Analytics property can be displayed in a
* report. For example if a property never logs a `purchase` event, then a
* query for the `eventName` dimension and `eventCount` metric will not have a
* row eventName: "purchase" and eventCount: 0.
*
* @var bool
*/
public $keepEmptyRows;
protected $metricFilterType = FilterExpression::class;
protected $metricFilterDataType = '';
protected $metricsType = Metric::class;
protected $metricsDataType = 'array';
protected $pivotsType = Pivot::class;
protected $pivotsDataType = 'array';
/**
* A Google Analytics property identifier whose events are tracked. Specified
* in the URL path and not the body. To learn more, see [where to find your
* Property ID](https://developers.google.com/analytics/devguides/reporting/da
* ta/v1/property-id). Within a batch request, this property should either be
* unspecified or consistent with the batch-level property. Example:
* properties/1234
*
* @var string
*/
public $property;
/**
* Toggles whether to return the current state of this Google Analytics
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* @var bool
*/
public $returnPropertyQuota;
/**
* Cohort group associated with this request. If there is a cohort group in
* the request the 'cohort' dimension must be present.
*
* @param CohortSpec $cohortSpec
*/
public function setCohortSpec(CohortSpec $cohortSpec)
{
$this->cohortSpec = $cohortSpec;
}
/**
* @return CohortSpec
*/
public function getCohortSpec()
{
return $this->cohortSpec;
}
/**
* Optional. The configuration of comparisons requested and displayed. The
* request requires both a comparisons field and a comparisons dimension to
* receive a comparison column in the response.
*
* @param Comparison[] $comparisons
*/
public function setComparisons($comparisons)
{
$this->comparisons = $comparisons;
}
/**
* @return Comparison[]
*/
public function getComparisons()
{
return $this->comparisons;
}
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the
* field is empty, the report uses the property's default currency.
*
* @param string $currencyCode
*/
public function setCurrencyCode($currencyCode)
{
$this->currencyCode = $currencyCode;
}
/**
* @return string
*/
public function getCurrencyCode()
{
return $this->currencyCode;
}
/**
* The date range to retrieve event data for the report. If multiple date
* ranges are specified, event data from each date range is used in the
* report. A special dimension with field name "dateRange" can be included in
* a Pivot's field names; if included, the report compares between date
* ranges. In a cohort request, this `dateRanges` must be unspecified.
*
* @param DateRange[] $dateRanges
*/
public function setDateRanges($dateRanges)
{
$this->dateRanges = $dateRanges;
}
/**
* @return DateRange[]
*/
public function getDateRanges()
{
return $this->dateRanges;
}
/**
* The filter clause of dimensions. Dimensions must be requested to be used in
* this filter. Metrics cannot be used in this filter.
*
* @param FilterExpression $dimensionFilter
*/
public function setDimensionFilter(FilterExpression $dimensionFilter)
{
$this->dimensionFilter = $dimensionFilter;
}
/**
* @return FilterExpression
*/
public function getDimensionFilter()
{
return $this->dimensionFilter;
}
/**
* The dimensions requested. All defined dimensions must be used by one of the
* following: dimension_expression, dimension_filter, pivots, order_bys.
*
* @param Dimension[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return Dimension[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* If false or unspecified, each row with all metrics equal to 0 will not be
* returned. If true, these rows will be returned if they are not separately
* removed by a filter. Regardless of this `keep_empty_rows` setting, only
* data recorded by the Google Analytics property can be displayed in a
* report. For example if a property never logs a `purchase` event, then a
* query for the `eventName` dimension and `eventCount` metric will not have a
* row eventName: "purchase" and eventCount: 0.
*
* @param bool $keepEmptyRows
*/
public function setKeepEmptyRows($keepEmptyRows)
{
$this->keepEmptyRows = $keepEmptyRows;
}
/**
* @return bool
*/
public function getKeepEmptyRows()
{
return $this->keepEmptyRows;
}
/**
* The filter clause of metrics. Applied at post aggregation phase, similar to
* SQL having-clause. Metrics must be requested to be used in this filter.
* Dimensions cannot be used in this filter.
*
* @param FilterExpression $metricFilter
*/
public function setMetricFilter(FilterExpression $metricFilter)
{
$this->metricFilter = $metricFilter;
}
/**
* @return FilterExpression
*/
public function getMetricFilter()
{
return $this->metricFilter;
}
/**
* The metrics requested, at least one metric needs to be specified. All
* defined metrics must be used by one of the following: metric_expression,
* metric_filter, order_bys.
*
* @param Metric[] $metrics
*/
public function setMetrics($metrics)
{
$this->metrics = $metrics;
}
/**
* @return Metric[]
*/
public function getMetrics()
{
return $this->metrics;
}
/**
* Describes the visual format of the report's dimensions in columns or rows.
* The union of the fieldNames (dimension names) in all pivots must be a
* subset of dimension names defined in Dimensions. No two pivots can share a
* dimension. A dimension is only visible if it appears in a pivot.
*
* @param Pivot[] $pivots
*/
public function setPivots($pivots)
{
$this->pivots = $pivots;
}
/**
* @return Pivot[]
*/
public function getPivots()
{
return $this->pivots;
}
/**
* A Google Analytics property identifier whose events are tracked. Specified
* in the URL path and not the body. To learn more, see [where to find your
* Property ID](https://developers.google.com/analytics/devguides/reporting/da
* ta/v1/property-id). Within a batch request, this property should either be
* unspecified or consistent with the batch-level property. Example:
* properties/1234
*
* @param string $property
*/
public function setProperty($property)
{
$this->property = $property;
}
/**
* @return string
*/
public function getProperty()
{
return $this->property;
}
/**
* Toggles whether to return the current state of this Google Analytics
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* @param bool $returnPropertyQuota
*/
public function setReturnPropertyQuota($returnPropertyQuota)
{
$this->returnPropertyQuota = $returnPropertyQuota;
}
/**
* @return bool
*/
public function getReturnPropertyQuota()
{
return $this->returnPropertyQuota;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunPivotReportRequest::class, 'Google_Service_AnalyticsData_RunPivotReportRequest');
@@ -0,0 +1,192 @@
<?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\AnalyticsData;
class RunPivotReportResponse extends \Google\Collection
{
protected $collection_key = 'rows';
protected $aggregatesType = Row::class;
protected $aggregatesDataType = 'array';
protected $dimensionHeadersType = DimensionHeader::class;
protected $dimensionHeadersDataType = 'array';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runPivotReport". Useful to distinguish between
* response types in JSON.
*
* @var string
*/
public $kind;
protected $metadataType = ResponseMetaData::class;
protected $metadataDataType = '';
protected $metricHeadersType = MetricHeader::class;
protected $metricHeadersDataType = 'array';
protected $pivotHeadersType = PivotHeader::class;
protected $pivotHeadersDataType = 'array';
protected $propertyQuotaType = PropertyQuota::class;
protected $propertyQuotaDataType = '';
protected $rowsType = Row::class;
protected $rowsDataType = 'array';
/**
* Aggregation of metric values. Can be totals, minimums, or maximums. The
* returned aggregations are controlled by the metric_aggregations in the
* pivot. The type of aggregation returned in each row is shown by the
* dimension_values which are set to "RESERVED_".
*
* @param Row[] $aggregates
*/
public function setAggregates($aggregates)
{
$this->aggregates = $aggregates;
}
/**
* @return Row[]
*/
public function getAggregates()
{
return $this->aggregates;
}
/**
* Describes dimension columns. The number of DimensionHeaders and ordering of
* DimensionHeaders matches the dimensions present in rows.
*
* @param DimensionHeader[] $dimensionHeaders
*/
public function setDimensionHeaders($dimensionHeaders)
{
$this->dimensionHeaders = $dimensionHeaders;
}
/**
* @return DimensionHeader[]
*/
public function getDimensionHeaders()
{
return $this->dimensionHeaders;
}
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runPivotReport". Useful to distinguish between
* response types in JSON.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* Metadata for the report.
*
* @param ResponseMetaData $metadata
*/
public function setMetadata(ResponseMetaData $metadata)
{
$this->metadata = $metadata;
}
/**
* @return ResponseMetaData
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* Describes metric columns. The number of MetricHeaders and ordering of
* MetricHeaders matches the metrics present in rows.
*
* @param MetricHeader[] $metricHeaders
*/
public function setMetricHeaders($metricHeaders)
{
$this->metricHeaders = $metricHeaders;
}
/**
* @return MetricHeader[]
*/
public function getMetricHeaders()
{
return $this->metricHeaders;
}
/**
* Summarizes the columns and rows created by a pivot. Each pivot in the
* request produces one header in the response. If we have a request like
* this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames":
* "eventName" }] We will have the following `pivotHeaders` in the response:
* "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value":
* "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ {
* "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{
* "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues":
* [{ "value": "scroll" }] }] }]
*
* @param PivotHeader[] $pivotHeaders
*/
public function setPivotHeaders($pivotHeaders)
{
$this->pivotHeaders = $pivotHeaders;
}
/**
* @return PivotHeader[]
*/
public function getPivotHeaders()
{
return $this->pivotHeaders;
}
/**
* This Google Analytics property's quota state including this request.
*
* @param PropertyQuota $propertyQuota
*/
public function setPropertyQuota(PropertyQuota $propertyQuota)
{
$this->propertyQuota = $propertyQuota;
}
/**
* @return PropertyQuota
*/
public function getPropertyQuota()
{
return $this->propertyQuota;
}
/**
* Rows of dimension value combinations and metric values in the report.
*
* @param Row[] $rows
*/
public function setRows($rows)
{
$this->rows = $rows;
}
/**
* @return Row[]
*/
public function getRows()
{
return $this->rows;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunPivotReportResponse::class, 'Google_Service_AnalyticsData_RunPivotReportResponse');
@@ -0,0 +1,224 @@
<?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\AnalyticsData;
class RunRealtimeReportRequest extends \Google\Collection
{
protected $collection_key = 'orderBys';
protected $dimensionFilterType = FilterExpression::class;
protected $dimensionFilterDataType = '';
protected $dimensionsType = Dimension::class;
protected $dimensionsDataType = 'array';
/**
* The number of rows to return. If unspecified, 10,000 rows are returned. The
* API returns a maximum of 250,000 rows per request, no matter how many you
* ask for. `limit` must be positive. The API can also return fewer rows than
* the requested `limit`, if there aren't as many dimension values as the
* `limit`. For instance, there are fewer than 300 possible values for the
* dimension `country`, so when reporting on only `country`, you can't get
* more than 300 rows, even if you set `limit` to a higher value.
*
* @var string
*/
public $limit;
/**
* Aggregation of metrics. Aggregated metric values will be shown in rows
* where the dimension_values are set to "RESERVED_(MetricAggregation)".
*
* @var string[]
*/
public $metricAggregations;
protected $metricFilterType = FilterExpression::class;
protected $metricFilterDataType = '';
protected $metricsType = Metric::class;
protected $metricsDataType = 'array';
protected $minuteRangesType = MinuteRange::class;
protected $minuteRangesDataType = 'array';
protected $orderBysType = OrderBy::class;
protected $orderBysDataType = 'array';
/**
* Toggles whether to return the current state of this Google Analytics
* property's Realtime quota. Quota is returned in
* [PropertyQuota](#PropertyQuota).
*
* @var bool
*/
public $returnPropertyQuota;
/**
* The filter clause of dimensions. Metrics cannot be used in this filter.
*
* @param FilterExpression $dimensionFilter
*/
public function setDimensionFilter(FilterExpression $dimensionFilter)
{
$this->dimensionFilter = $dimensionFilter;
}
/**
* @return FilterExpression
*/
public function getDimensionFilter()
{
return $this->dimensionFilter;
}
/**
* The dimensions requested and displayed.
*
* @param Dimension[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return Dimension[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* The number of rows to return. If unspecified, 10,000 rows are returned. The
* API returns a maximum of 250,000 rows per request, no matter how many you
* ask for. `limit` must be positive. The API can also return fewer rows than
* the requested `limit`, if there aren't as many dimension values as the
* `limit`. For instance, there are fewer than 300 possible values for the
* dimension `country`, so when reporting on only `country`, you can't get
* more than 300 rows, even if you set `limit` to a higher value.
*
* @param string $limit
*/
public function setLimit($limit)
{
$this->limit = $limit;
}
/**
* @return string
*/
public function getLimit()
{
return $this->limit;
}
/**
* Aggregation of metrics. Aggregated metric values will be shown in rows
* where the dimension_values are set to "RESERVED_(MetricAggregation)".
*
* @param string[] $metricAggregations
*/
public function setMetricAggregations($metricAggregations)
{
$this->metricAggregations = $metricAggregations;
}
/**
* @return string[]
*/
public function getMetricAggregations()
{
return $this->metricAggregations;
}
/**
* The filter clause of metrics. Applied at post aggregation phase, similar to
* SQL having-clause. Dimensions cannot be used in this filter.
*
* @param FilterExpression $metricFilter
*/
public function setMetricFilter(FilterExpression $metricFilter)
{
$this->metricFilter = $metricFilter;
}
/**
* @return FilterExpression
*/
public function getMetricFilter()
{
return $this->metricFilter;
}
/**
* The metrics requested and displayed.
*
* @param Metric[] $metrics
*/
public function setMetrics($metrics)
{
$this->metrics = $metrics;
}
/**
* @return Metric[]
*/
public function getMetrics()
{
return $this->metrics;
}
/**
* The minute ranges of event data to read. If unspecified, one minute range
* for the last 30 minutes will be used. If multiple minute ranges are
* requested, each response row will contain a zero based minute range index.
* If two minute ranges overlap, the event data for the overlapping minutes is
* included in the response rows for both minute ranges.
*
* @param MinuteRange[] $minuteRanges
*/
public function setMinuteRanges($minuteRanges)
{
$this->minuteRanges = $minuteRanges;
}
/**
* @return MinuteRange[]
*/
public function getMinuteRanges()
{
return $this->minuteRanges;
}
/**
* Specifies how rows are ordered in the response.
*
* @param OrderBy[] $orderBys
*/
public function setOrderBys($orderBys)
{
$this->orderBys = $orderBys;
}
/**
* @return OrderBy[]
*/
public function getOrderBys()
{
return $this->orderBys;
}
/**
* Toggles whether to return the current state of this Google Analytics
* property's Realtime quota. Quota is returned in
* [PropertyQuota](#PropertyQuota).
*
* @param bool $returnPropertyQuota
*/
public function setReturnPropertyQuota($returnPropertyQuota)
{
$this->returnPropertyQuota = $returnPropertyQuota;
}
/**
* @return bool
*/
public function getReturnPropertyQuota()
{
return $this->returnPropertyQuota;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunRealtimeReportRequest::class, 'Google_Service_AnalyticsData_RunRealtimeReportRequest');
@@ -0,0 +1,212 @@
<?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\AnalyticsData;
class RunRealtimeReportResponse extends \Google\Collection
{
protected $collection_key = 'totals';
protected $dimensionHeadersType = DimensionHeader::class;
protected $dimensionHeadersDataType = 'array';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runRealtimeReport". Useful to distinguish
* between response types in JSON.
*
* @var string
*/
public $kind;
protected $maximumsType = Row::class;
protected $maximumsDataType = 'array';
protected $metricHeadersType = MetricHeader::class;
protected $metricHeadersDataType = 'array';
protected $minimumsType = Row::class;
protected $minimumsDataType = 'array';
protected $propertyQuotaType = PropertyQuota::class;
protected $propertyQuotaDataType = '';
/**
* The total number of rows in the query result. `rowCount` is independent of
* the number of rows returned in the response and the `limit` request
* parameter. For example if a query returns 175 rows and includes `limit` of
* 50 in the API request, the response will contain `rowCount` of 175 but only
* 50 rows.
*
* @var int
*/
public $rowCount;
protected $rowsType = Row::class;
protected $rowsDataType = 'array';
protected $totalsType = Row::class;
protected $totalsDataType = 'array';
/**
* Describes dimension columns. The number of DimensionHeaders and ordering of
* DimensionHeaders matches the dimensions present in rows.
*
* @param DimensionHeader[] $dimensionHeaders
*/
public function setDimensionHeaders($dimensionHeaders)
{
$this->dimensionHeaders = $dimensionHeaders;
}
/**
* @return DimensionHeader[]
*/
public function getDimensionHeaders()
{
return $this->dimensionHeaders;
}
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runRealtimeReport". Useful to distinguish
* between response types in JSON.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* If requested, the maximum values of metrics.
*
* @param Row[] $maximums
*/
public function setMaximums($maximums)
{
$this->maximums = $maximums;
}
/**
* @return Row[]
*/
public function getMaximums()
{
return $this->maximums;
}
/**
* Describes metric columns. The number of MetricHeaders and ordering of
* MetricHeaders matches the metrics present in rows.
*
* @param MetricHeader[] $metricHeaders
*/
public function setMetricHeaders($metricHeaders)
{
$this->metricHeaders = $metricHeaders;
}
/**
* @return MetricHeader[]
*/
public function getMetricHeaders()
{
return $this->metricHeaders;
}
/**
* If requested, the minimum values of metrics.
*
* @param Row[] $minimums
*/
public function setMinimums($minimums)
{
$this->minimums = $minimums;
}
/**
* @return Row[]
*/
public function getMinimums()
{
return $this->minimums;
}
/**
* This Google Analytics property's Realtime quota state including this
* request.
*
* @param PropertyQuota $propertyQuota
*/
public function setPropertyQuota(PropertyQuota $propertyQuota)
{
$this->propertyQuota = $propertyQuota;
}
/**
* @return PropertyQuota
*/
public function getPropertyQuota()
{
return $this->propertyQuota;
}
/**
* The total number of rows in the query result. `rowCount` is independent of
* the number of rows returned in the response and the `limit` request
* parameter. For example if a query returns 175 rows and includes `limit` of
* 50 in the API request, the response will contain `rowCount` of 175 but only
* 50 rows.
*
* @param int $rowCount
*/
public function setRowCount($rowCount)
{
$this->rowCount = $rowCount;
}
/**
* @return int
*/
public function getRowCount()
{
return $this->rowCount;
}
/**
* Rows of dimension value combinations and metric values in the report.
*
* @param Row[] $rows
*/
public function setRows($rows)
{
$this->rows = $rows;
}
/**
* @return Row[]
*/
public function getRows()
{
return $this->rows;
}
/**
* If requested, the totaled values of metrics.
*
* @param Row[] $totals
*/
public function setTotals($totals)
{
$this->totals = $totals;
}
/**
* @return Row[]
*/
public function getTotals()
{
return $this->totals;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunRealtimeReportResponse::class, 'Google_Service_AnalyticsData_RunRealtimeReportResponse');
@@ -0,0 +1,398 @@
<?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\AnalyticsData;
class RunReportRequest extends \Google\Collection
{
protected $collection_key = 'orderBys';
protected $cohortSpecType = CohortSpec::class;
protected $cohortSpecDataType = '';
protected $comparisonsType = Comparison::class;
protected $comparisonsDataType = 'array';
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the
* field is empty, the report uses the property's default currency.
*
* @var string
*/
public $currencyCode;
protected $dateRangesType = DateRange::class;
protected $dateRangesDataType = 'array';
protected $dimensionFilterType = FilterExpression::class;
protected $dimensionFilterDataType = '';
protected $dimensionsType = Dimension::class;
protected $dimensionsDataType = 'array';
/**
* If false or unspecified, each row with all metrics equal to 0 will not be
* returned. If true, these rows will be returned if they are not separately
* removed by a filter. Regardless of this `keep_empty_rows` setting, only
* data recorded by the Google Analytics property can be displayed in a
* report. For example if a property never logs a `purchase` event, then a
* query for the `eventName` dimension and `eventCount` metric will not have a
* row eventName: "purchase" and eventCount: 0.
*
* @var bool
*/
public $keepEmptyRows;
/**
* The number of rows to return. If unspecified, 10,000 rows are returned. The
* API returns a maximum of 250,000 rows per request, no matter how many you
* ask for. `limit` must be positive. The API can also return fewer rows than
* the requested `limit`, if there aren't as many dimension values as the
* `limit`. For instance, there are fewer than 300 possible values for the
* dimension `country`, so when reporting on only `country`, you can't get
* more than 300 rows, even if you set `limit` to a higher value. To learn
* more about this pagination parameter, see [Pagination](https://developers.g
* oogle.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
* @var string
*/
public $limit;
/**
* Aggregation of metrics. Aggregated metric values will be shown in rows
* where the dimension_values are set to "RESERVED_(MetricAggregation)".
* Aggregates including both comparisons and multiple date ranges will be
* aggregated based on the date ranges.
*
* @var string[]
*/
public $metricAggregations;
protected $metricFilterType = FilterExpression::class;
protected $metricFilterDataType = '';
protected $metricsType = Metric::class;
protected $metricsDataType = 'array';
/**
* The row count of the start row. The first row is counted as row 0. When
* paging, the first request does not specify offset; or equivalently, sets
* offset to 0; the first request returns the first `limit` of rows. The
* second request sets offset to the `limit` of the first request; the second
* request returns the second `limit` of rows. To learn more about this
* pagination parameter, see [Pagination](https://developers.google.com/analyt
* ics/devguides/reporting/data/v1/basics#pagination).
*
* @var string
*/
public $offset;
protected $orderBysType = OrderBy::class;
protected $orderBysDataType = 'array';
/**
* A Google Analytics property identifier whose events are tracked. Specified
* in the URL path and not the body. To learn more, see [where to find your
* Property ID](https://developers.google.com/analytics/devguides/reporting/da
* ta/v1/property-id). Within a batch request, this property should either be
* unspecified or consistent with the batch-level property. Example:
* properties/1234
*
* @var string
*/
public $property;
/**
* Toggles whether to return the current state of this Google Analytics
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* @var bool
*/
public $returnPropertyQuota;
/**
* Cohort group associated with this request. If there is a cohort group in
* the request the 'cohort' dimension must be present.
*
* @param CohortSpec $cohortSpec
*/
public function setCohortSpec(CohortSpec $cohortSpec)
{
$this->cohortSpec = $cohortSpec;
}
/**
* @return CohortSpec
*/
public function getCohortSpec()
{
return $this->cohortSpec;
}
/**
* Optional. The configuration of comparisons requested and displayed. The
* request only requires a comparisons field in order to receive a comparison
* column in the response.
*
* @param Comparison[] $comparisons
*/
public function setComparisons($comparisons)
{
$this->comparisons = $comparisons;
}
/**
* @return Comparison[]
*/
public function getComparisons()
{
return $this->comparisons;
}
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the
* field is empty, the report uses the property's default currency.
*
* @param string $currencyCode
*/
public function setCurrencyCode($currencyCode)
{
$this->currencyCode = $currencyCode;
}
/**
* @return string
*/
public function getCurrencyCode()
{
return $this->currencyCode;
}
/**
* Date ranges of data to read. If multiple date ranges are requested, each
* response row will contain a zero based date range index. If two date ranges
* overlap, the event data for the overlapping days is included in the
* response rows for both date ranges. In a cohort request, this `dateRanges`
* must be unspecified.
*
* @param DateRange[] $dateRanges
*/
public function setDateRanges($dateRanges)
{
$this->dateRanges = $dateRanges;
}
/**
* @return DateRange[]
*/
public function getDateRanges()
{
return $this->dateRanges;
}
/**
* Dimension filters let you ask for only specific dimension values in the
* report. To learn more, see [Fundamentals of Dimension Filters](https://deve
* lopers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_fi
* lters) for examples. Metrics cannot be used in this filter.
*
* @param FilterExpression $dimensionFilter
*/
public function setDimensionFilter(FilterExpression $dimensionFilter)
{
$this->dimensionFilter = $dimensionFilter;
}
/**
* @return FilterExpression
*/
public function getDimensionFilter()
{
return $this->dimensionFilter;
}
/**
* The dimensions requested and displayed.
*
* @param Dimension[] $dimensions
*/
public function setDimensions($dimensions)
{
$this->dimensions = $dimensions;
}
/**
* @return Dimension[]
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* If false or unspecified, each row with all metrics equal to 0 will not be
* returned. If true, these rows will be returned if they are not separately
* removed by a filter. Regardless of this `keep_empty_rows` setting, only
* data recorded by the Google Analytics property can be displayed in a
* report. For example if a property never logs a `purchase` event, then a
* query for the `eventName` dimension and `eventCount` metric will not have a
* row eventName: "purchase" and eventCount: 0.
*
* @param bool $keepEmptyRows
*/
public function setKeepEmptyRows($keepEmptyRows)
{
$this->keepEmptyRows = $keepEmptyRows;
}
/**
* @return bool
*/
public function getKeepEmptyRows()
{
return $this->keepEmptyRows;
}
/**
* The number of rows to return. If unspecified, 10,000 rows are returned. The
* API returns a maximum of 250,000 rows per request, no matter how many you
* ask for. `limit` must be positive. The API can also return fewer rows than
* the requested `limit`, if there aren't as many dimension values as the
* `limit`. For instance, there are fewer than 300 possible values for the
* dimension `country`, so when reporting on only `country`, you can't get
* more than 300 rows, even if you set `limit` to a higher value. To learn
* more about this pagination parameter, see [Pagination](https://developers.g
* oogle.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
* @param string $limit
*/
public function setLimit($limit)
{
$this->limit = $limit;
}
/**
* @return string
*/
public function getLimit()
{
return $this->limit;
}
/**
* Aggregation of metrics. Aggregated metric values will be shown in rows
* where the dimension_values are set to "RESERVED_(MetricAggregation)".
* Aggregates including both comparisons and multiple date ranges will be
* aggregated based on the date ranges.
*
* @param string[] $metricAggregations
*/
public function setMetricAggregations($metricAggregations)
{
$this->metricAggregations = $metricAggregations;
}
/**
* @return string[]
*/
public function getMetricAggregations()
{
return $this->metricAggregations;
}
/**
* The filter clause of metrics. Applied after aggregating the report's rows,
* similar to SQL having-clause. Dimensions cannot be used in this filter.
*
* @param FilterExpression $metricFilter
*/
public function setMetricFilter(FilterExpression $metricFilter)
{
$this->metricFilter = $metricFilter;
}
/**
* @return FilterExpression
*/
public function getMetricFilter()
{
return $this->metricFilter;
}
/**
* The metrics requested and displayed.
*
* @param Metric[] $metrics
*/
public function setMetrics($metrics)
{
$this->metrics = $metrics;
}
/**
* @return Metric[]
*/
public function getMetrics()
{
return $this->metrics;
}
/**
* The row count of the start row. The first row is counted as row 0. When
* paging, the first request does not specify offset; or equivalently, sets
* offset to 0; the first request returns the first `limit` of rows. The
* second request sets offset to the `limit` of the first request; the second
* request returns the second `limit` of rows. To learn more about this
* pagination parameter, see [Pagination](https://developers.google.com/analyt
* ics/devguides/reporting/data/v1/basics#pagination).
*
* @param string $offset
*/
public function setOffset($offset)
{
$this->offset = $offset;
}
/**
* @return string
*/
public function getOffset()
{
return $this->offset;
}
/**
* Specifies how rows are ordered in the response. Requests including both
* comparisons and multiple date ranges will have order bys applied on the
* comparisons.
*
* @param OrderBy[] $orderBys
*/
public function setOrderBys($orderBys)
{
$this->orderBys = $orderBys;
}
/**
* @return OrderBy[]
*/
public function getOrderBys()
{
return $this->orderBys;
}
/**
* A Google Analytics property identifier whose events are tracked. Specified
* in the URL path and not the body. To learn more, see [where to find your
* Property ID](https://developers.google.com/analytics/devguides/reporting/da
* ta/v1/property-id). Within a batch request, this property should either be
* unspecified or consistent with the batch-level property. Example:
* properties/1234
*
* @param string $property
*/
public function setProperty($property)
{
$this->property = $property;
}
/**
* @return string
*/
public function getProperty()
{
return $this->property;
}
/**
* Toggles whether to return the current state of this Google Analytics
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* @param bool $returnPropertyQuota
*/
public function setReturnPropertyQuota($returnPropertyQuota)
{
$this->returnPropertyQuota = $returnPropertyQuota;
}
/**
* @return bool
*/
public function getReturnPropertyQuota()
{
return $this->returnPropertyQuota;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunReportRequest::class, 'Google_Service_AnalyticsData_RunReportRequest');
@@ -0,0 +1,233 @@
<?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\AnalyticsData;
class RunReportResponse extends \Google\Collection
{
protected $collection_key = 'totals';
protected $dimensionHeadersType = DimensionHeader::class;
protected $dimensionHeadersDataType = 'array';
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runReport". Useful to distinguish between
* response types in JSON.
*
* @var string
*/
public $kind;
protected $maximumsType = Row::class;
protected $maximumsDataType = 'array';
protected $metadataType = ResponseMetaData::class;
protected $metadataDataType = '';
protected $metricHeadersType = MetricHeader::class;
protected $metricHeadersDataType = 'array';
protected $minimumsType = Row::class;
protected $minimumsDataType = 'array';
protected $propertyQuotaType = PropertyQuota::class;
protected $propertyQuotaDataType = '';
/**
* The total number of rows in the query result. `rowCount` is independent of
* the number of rows returned in the response, the `limit` request parameter,
* and the `offset` request parameter. For example if a query returns 175 rows
* and includes `limit` of 50 in the API request, the response will contain
* `rowCount` of 175 but only 50 rows. To learn more about this pagination
* parameter, see [Pagination](https://developers.google.com/analytics/devguid
* es/reporting/data/v1/basics#pagination).
*
* @var int
*/
public $rowCount;
protected $rowsType = Row::class;
protected $rowsDataType = 'array';
protected $totalsType = Row::class;
protected $totalsDataType = 'array';
/**
* Describes dimension columns. The number of DimensionHeaders and ordering of
* DimensionHeaders matches the dimensions present in rows.
*
* @param DimensionHeader[] $dimensionHeaders
*/
public function setDimensionHeaders($dimensionHeaders)
{
$this->dimensionHeaders = $dimensionHeaders;
}
/**
* @return DimensionHeader[]
*/
public function getDimensionHeaders()
{
return $this->dimensionHeaders;
}
/**
* Identifies what kind of resource this message is. This `kind` is always the
* fixed string "analyticsData#runReport". Useful to distinguish between
* response types in JSON.
*
* @param string $kind
*/
public function setKind($kind)
{
$this->kind = $kind;
}
/**
* @return string
*/
public function getKind()
{
return $this->kind;
}
/**
* If requested, the maximum values of metrics.
*
* @param Row[] $maximums
*/
public function setMaximums($maximums)
{
$this->maximums = $maximums;
}
/**
* @return Row[]
*/
public function getMaximums()
{
return $this->maximums;
}
/**
* Metadata for the report.
*
* @param ResponseMetaData $metadata
*/
public function setMetadata(ResponseMetaData $metadata)
{
$this->metadata = $metadata;
}
/**
* @return ResponseMetaData
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* Describes metric columns. The number of MetricHeaders and ordering of
* MetricHeaders matches the metrics present in rows.
*
* @param MetricHeader[] $metricHeaders
*/
public function setMetricHeaders($metricHeaders)
{
$this->metricHeaders = $metricHeaders;
}
/**
* @return MetricHeader[]
*/
public function getMetricHeaders()
{
return $this->metricHeaders;
}
/**
* If requested, the minimum values of metrics.
*
* @param Row[] $minimums
*/
public function setMinimums($minimums)
{
$this->minimums = $minimums;
}
/**
* @return Row[]
*/
public function getMinimums()
{
return $this->minimums;
}
/**
* This Google Analytics property's quota state including this request.
*
* @param PropertyQuota $propertyQuota
*/
public function setPropertyQuota(PropertyQuota $propertyQuota)
{
$this->propertyQuota = $propertyQuota;
}
/**
* @return PropertyQuota
*/
public function getPropertyQuota()
{
return $this->propertyQuota;
}
/**
* The total number of rows in the query result. `rowCount` is independent of
* the number of rows returned in the response, the `limit` request parameter,
* and the `offset` request parameter. For example if a query returns 175 rows
* and includes `limit` of 50 in the API request, the response will contain
* `rowCount` of 175 but only 50 rows. To learn more about this pagination
* parameter, see [Pagination](https://developers.google.com/analytics/devguid
* es/reporting/data/v1/basics#pagination).
*
* @param int $rowCount
*/
public function setRowCount($rowCount)
{
$this->rowCount = $rowCount;
}
/**
* @return int
*/
public function getRowCount()
{
return $this->rowCount;
}
/**
* Rows of dimension value combinations and metric values in the report.
*
* @param Row[] $rows
*/
public function setRows($rows)
{
$this->rows = $rows;
}
/**
* @return Row[]
*/
public function getRows()
{
return $this->rows;
}
/**
* If requested, the totaled values of metrics.
*
* @param Row[] $totals
*/
public function setTotals($totals)
{
$this->totals = $totals;
}
/**
* @return Row[]
*/
public function getTotals()
{
return $this->totals;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunReportResponse::class, 'Google_Service_AnalyticsData_RunReportResponse');
@@ -0,0 +1,82 @@
<?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\AnalyticsData;
class SamplingMetadata extends \Google\Model
{
/**
* The total number of events read in this sampled report for a date range.
* This is the size of the subset this property's data that was analyzed in
* this report.
*
* @var string
*/
public $samplesReadCount;
/**
* The total number of events present in this property's data that could have
* been analyzed in this report for a date range. Sampling uncovers the
* meaningful information about the larger data set, and this is the size of
* the larger data set. To calculate the percentage of available data that was
* used in this report, compute `samplesReadCount/samplingSpaceSize`.
*
* @var string
*/
public $samplingSpaceSize;
/**
* The total number of events read in this sampled report for a date range.
* This is the size of the subset this property's data that was analyzed in
* this report.
*
* @param string $samplesReadCount
*/
public function setSamplesReadCount($samplesReadCount)
{
$this->samplesReadCount = $samplesReadCount;
}
/**
* @return string
*/
public function getSamplesReadCount()
{
return $this->samplesReadCount;
}
/**
* The total number of events present in this property's data that could have
* been analyzed in this report for a date range. Sampling uncovers the
* meaningful information about the larger data set, and this is the size of
* the larger data set. To calculate the percentage of available data that was
* used in this report, compute `samplesReadCount/samplingSpaceSize`.
*
* @param string $samplingSpaceSize
*/
public function setSamplingSpaceSize($samplingSpaceSize)
{
$this->samplingSpaceSize = $samplingSpaceSize;
}
/**
* @return string
*/
public function getSamplingSpaceSize()
{
return $this->samplingSpaceSize;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SamplingMetadata::class, 'Google_Service_AnalyticsData_SamplingMetadata');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class SchemaRestrictionResponse extends \Google\Collection
{
protected $collection_key = 'activeMetricRestrictions';
protected $activeMetricRestrictionsType = ActiveMetricRestriction::class;
protected $activeMetricRestrictionsDataType = 'array';
/**
* All restrictions actively enforced in creating the report. For example,
* `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However,
* this active response restriction is only populated if the user's custom
* role disallows access to `REVENUE_DATA`.
*
* @param ActiveMetricRestriction[] $activeMetricRestrictions
*/
public function setActiveMetricRestrictions($activeMetricRestrictions)
{
$this->activeMetricRestrictions = $activeMetricRestrictions;
}
/**
* @return ActiveMetricRestriction[]
*/
public function getActiveMetricRestrictions()
{
return $this->activeMetricRestrictions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SchemaRestrictionResponse::class, 'Google_Service_AnalyticsData_SchemaRestrictionResponse');
@@ -0,0 +1,99 @@
<?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\AnalyticsData;
class Status extends \Google\Collection
{
protected $collection_key = 'details';
/**
* The status code, which should be an enum value of google.rpc.Code.
*
* @var int
*/
public $code;
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*
* @var array[]
*/
public $details;
/**
* A developer-facing error message, which should be in English. Any user-
* facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*
* @var string
*/
public $message;
/**
* The status code, which should be an enum value of google.rpc.Code.
*
* @param int $code
*/
public function setCode($code)
{
$this->code = $code;
}
/**
* @return int
*/
public function getCode()
{
return $this->code;
}
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*
* @param array[] $details
*/
public function setDetails($details)
{
$this->details = $details;
}
/**
* @return array[]
*/
public function getDetails()
{
return $this->details;
}
/**
* A developer-facing error message, which should be in English. Any user-
* facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*
* @param string $message
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Status::class, 'Google_Service_AnalyticsData_Status');
@@ -0,0 +1,123 @@
<?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\AnalyticsData;
class StringFilter extends \Google\Model
{
/**
* Unspecified
*/
public const MATCH_TYPE_MATCH_TYPE_UNSPECIFIED = 'MATCH_TYPE_UNSPECIFIED';
/**
* Exact match of the string value.
*/
public const MATCH_TYPE_EXACT = 'EXACT';
/**
* Begins with the string value.
*/
public const MATCH_TYPE_BEGINS_WITH = 'BEGINS_WITH';
/**
* Ends with the string value.
*/
public const MATCH_TYPE_ENDS_WITH = 'ENDS_WITH';
/**
* Contains the string value.
*/
public const MATCH_TYPE_CONTAINS = 'CONTAINS';
/**
* Full match for the regular expression with the string value.
*/
public const MATCH_TYPE_FULL_REGEXP = 'FULL_REGEXP';
/**
* Partial match for the regular expression with the string value.
*/
public const MATCH_TYPE_PARTIAL_REGEXP = 'PARTIAL_REGEXP';
/**
* If true, the string value is case sensitive.
*
* @var bool
*/
public $caseSensitive;
/**
* The match type for this filter.
*
* @var string
*/
public $matchType;
/**
* The string value used for the matching.
*
* @var string
*/
public $value;
/**
* If true, the string value is case sensitive.
*
* @param bool $caseSensitive
*/
public function setCaseSensitive($caseSensitive)
{
$this->caseSensitive = $caseSensitive;
}
/**
* @return bool
*/
public function getCaseSensitive()
{
return $this->caseSensitive;
}
/**
* The match type for this filter.
*
* Accepted values: MATCH_TYPE_UNSPECIFIED, EXACT, BEGINS_WITH, ENDS_WITH,
* CONTAINS, FULL_REGEXP, PARTIAL_REGEXP
*
* @param self::MATCH_TYPE_* $matchType
*/
public function setMatchType($matchType)
{
$this->matchType = $matchType;
}
/**
* @return self::MATCH_TYPE_*
*/
public function getMatchType()
{
return $this->matchType;
}
/**
* The string value used for the matching.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(StringFilter::class, 'Google_Service_AnalyticsData_StringFilter');
@@ -0,0 +1,52 @@
<?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\AnalyticsData;
class V1betaAudienceDimension extends \Google\Model
{
/**
* Optional. The API name of the dimension. See the [API Dimensions](https://d
* evelopers.google.com/analytics/devguides/reporting/data/v1/audience-list-
* api-schema#dimensions) for the list of dimension names.
*
* @var string
*/
public $dimensionName;
/**
* Optional. The API name of the dimension. See the [API Dimensions](https://d
* evelopers.google.com/analytics/devguides/reporting/data/v1/audience-list-
* api-schema#dimensions) for the list of dimension names.
*
* @param string $dimensionName
*/
public function setDimensionName($dimensionName)
{
$this->dimensionName = $dimensionName;
}
/**
* @return string
*/
public function getDimensionName()
{
return $this->dimensionName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(V1betaAudienceDimension::class, 'Google_Service_AnalyticsData_V1betaAudienceDimension');
@@ -0,0 +1,48 @@
<?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\AnalyticsData;
class V1betaAudienceDimensionValue extends \Google\Model
{
/**
* Value as a string if the dimension type is a string.
*
* @var string
*/
public $value;
/**
* Value as a string if the dimension type is a string.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(V1betaAudienceDimensionValue::class, 'Google_Service_AnalyticsData_V1betaAudienceDimensionValue');
@@ -0,0 +1,46 @@
<?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\AnalyticsData;
class V1betaAudienceRow extends \Google\Collection
{
protected $collection_key = 'dimensionValues';
protected $dimensionValuesType = V1betaAudienceDimensionValue::class;
protected $dimensionValuesDataType = 'array';
/**
* Each dimension value attribute for an audience user. One dimension value
* will be added for each dimension column requested.
*
* @param V1betaAudienceDimensionValue[] $dimensionValues
*/
public function setDimensionValues($dimensionValues)
{
$this->dimensionValues = $dimensionValues;
}
/**
* @return V1betaAudienceDimensionValue[]
*/
public function getDimensionValues()
{
return $this->dimensionValues;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(V1betaAudienceRow::class, 'Google_Service_AnalyticsData_V1betaAudienceRow');