Viewing file:  RunPivotReportRequest.php (20.94 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/analytics/data/v1beta/analytics_data_api.proto
namespace Google\Analytics\Data\V1beta;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* The request to generate a pivot report.
*
* Generated from protobuf message <code>google.analytics.data.v1beta.RunPivotReportRequest</code>
*/
class RunPivotReportRequest extends \Google\Protobuf\Internal\Message
{
/**
* A Google Analytics GA4 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/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
* Example: properties/1234
*
* Generated from protobuf field <code>string property = 1;</code>
*/
private $property = '';
/**
* The dimensions requested. All defined dimensions must be used by one of the
* following: dimension_expression, dimension_filter, pivots, order_bys.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Dimension dimensions = 2;</code>
*/
private $dimensions;
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Metric metrics = 3;</code>
*/
private $metrics;
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;</code>
*/
private $date_ranges;
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Pivot pivots = 5;</code>
*/
private $pivots;
/**
* The filter clause of dimensions. Dimensions must be requested to be used in
* this filter. Metrics cannot be used in this filter.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;</code>
*/
private $dimension_filter = null;
/**
* 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.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression metric_filter = 7;</code>
*/
private $metric_filter = null;
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY".
* If the field is empty, the report uses the property's default currency.
*
* Generated from protobuf field <code>string currency_code = 8;</code>
*/
private $currency_code = '';
/**
* Cohort group associated with this request. If there is a cohort group
* in the request the 'cohort' dimension must be present.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;</code>
*/
private $cohort_spec = null;
/**
* 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.
*
* Generated from protobuf field <code>bool keep_empty_rows = 10;</code>
*/
private $keep_empty_rows = false;
/**
* Toggles whether to return the current state of this Analytics Property's
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* Generated from protobuf field <code>bool return_property_quota = 11;</code>
*/
private $return_property_quota = false;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $property
* A Google Analytics GA4 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/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
* Example: properties/1234
* @type array<\Google\Analytics\Data\V1beta\Dimension>|\Google\Protobuf\Internal\RepeatedField $dimensions
* The dimensions requested. All defined dimensions must be used by one of the
* following: dimension_expression, dimension_filter, pivots, order_bys.
* @type array<\Google\Analytics\Data\V1beta\Metric>|\Google\Protobuf\Internal\RepeatedField $metrics
* 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.
* @type array<\Google\Analytics\Data\V1beta\DateRange>|\Google\Protobuf\Internal\RepeatedField $date_ranges
* 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.
* @type array<\Google\Analytics\Data\V1beta\Pivot>|\Google\Protobuf\Internal\RepeatedField $pivots
* 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.
* @type \Google\Analytics\Data\V1beta\FilterExpression $dimension_filter
* The filter clause of dimensions. Dimensions must be requested to be used in
* this filter. Metrics cannot be used in this filter.
* @type \Google\Analytics\Data\V1beta\FilterExpression $metric_filter
* 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.
* @type string $currency_code
* A currency code in ISO4217 format, such as "AED", "USD", "JPY".
* If the field is empty, the report uses the property's default currency.
* @type \Google\Analytics\Data\V1beta\CohortSpec $cohort_spec
* Cohort group associated with this request. If there is a cohort group
* in the request the 'cohort' dimension must be present.
* @type bool $keep_empty_rows
* 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.
* @type bool $return_property_quota
* Toggles whether to return the current state of this Analytics Property's
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Analytics\Data\V1Beta\AnalyticsDataApi::initOnce();
parent::__construct($data);
}
/**
* A Google Analytics GA4 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/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
* Example: properties/1234
*
* Generated from protobuf field <code>string property = 1;</code>
* @return string
*/
public function getProperty()
{
return $this->property;
}
/**
* A Google Analytics GA4 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/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
* Example: properties/1234
*
* Generated from protobuf field <code>string property = 1;</code>
* @param string $var
* @return $this
*/
public function setProperty($var)
{
GPBUtil::checkString($var, True);
$this->property = $var;
return $this;
}
/**
* The dimensions requested. All defined dimensions must be used by one of the
* following: dimension_expression, dimension_filter, pivots, order_bys.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Dimension dimensions = 2;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getDimensions()
{
return $this->dimensions;
}
/**
* The dimensions requested. All defined dimensions must be used by one of the
* following: dimension_expression, dimension_filter, pivots, order_bys.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Dimension dimensions = 2;</code>
* @param array<\Google\Analytics\Data\V1beta\Dimension>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setDimensions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1beta\Dimension::class);
$this->dimensions = $arr;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Metric metrics = 3;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getMetrics()
{
return $this->metrics;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Metric metrics = 3;</code>
* @param array<\Google\Analytics\Data\V1beta\Metric>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setMetrics($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1beta\Metric::class);
$this->metrics = $arr;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getDateRanges()
{
return $this->date_ranges;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.DateRange date_ranges = 4;</code>
* @param array<\Google\Analytics\Data\V1beta\DateRange>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setDateRanges($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1beta\DateRange::class);
$this->date_ranges = $arr;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Pivot pivots = 5;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getPivots()
{
return $this->pivots;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.Pivot pivots = 5;</code>
* @param array<\Google\Analytics\Data\V1beta\Pivot>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setPivots($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1beta\Pivot::class);
$this->pivots = $arr;
return $this;
}
/**
* The filter clause of dimensions. Dimensions must be requested to be used in
* this filter. Metrics cannot be used in this filter.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;</code>
* @return \Google\Analytics\Data\V1beta\FilterExpression|null
*/
public function getDimensionFilter()
{
return $this->dimension_filter;
}
public function hasDimensionFilter()
{
return isset($this->dimension_filter);
}
public function clearDimensionFilter()
{
unset($this->dimension_filter);
}
/**
* The filter clause of dimensions. Dimensions must be requested to be used in
* this filter. Metrics cannot be used in this filter.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression dimension_filter = 6;</code>
* @param \Google\Analytics\Data\V1beta\FilterExpression $var
* @return $this
*/
public function setDimensionFilter($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1beta\FilterExpression::class);
$this->dimension_filter = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression metric_filter = 7;</code>
* @return \Google\Analytics\Data\V1beta\FilterExpression|null
*/
public function getMetricFilter()
{
return $this->metric_filter;
}
public function hasMetricFilter()
{
return isset($this->metric_filter);
}
public function clearMetricFilter()
{
unset($this->metric_filter);
}
/**
* 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.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.FilterExpression metric_filter = 7;</code>
* @param \Google\Analytics\Data\V1beta\FilterExpression $var
* @return $this
*/
public function setMetricFilter($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1beta\FilterExpression::class);
$this->metric_filter = $var;
return $this;
}
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY".
* If the field is empty, the report uses the property's default currency.
*
* Generated from protobuf field <code>string currency_code = 8;</code>
* @return string
*/
public function getCurrencyCode()
{
return $this->currency_code;
}
/**
* A currency code in ISO4217 format, such as "AED", "USD", "JPY".
* If the field is empty, the report uses the property's default currency.
*
* Generated from protobuf field <code>string currency_code = 8;</code>
* @param string $var
* @return $this
*/
public function setCurrencyCode($var)
{
GPBUtil::checkString($var, True);
$this->currency_code = $var;
return $this;
}
/**
* Cohort group associated with this request. If there is a cohort group
* in the request the 'cohort' dimension must be present.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;</code>
* @return \Google\Analytics\Data\V1beta\CohortSpec|null
*/
public function getCohortSpec()
{
return $this->cohort_spec;
}
public function hasCohortSpec()
{
return isset($this->cohort_spec);
}
public function clearCohortSpec()
{
unset($this->cohort_spec);
}
/**
* Cohort group associated with this request. If there is a cohort group
* in the request the 'cohort' dimension must be present.
*
* Generated from protobuf field <code>.google.analytics.data.v1beta.CohortSpec cohort_spec = 9;</code>
* @param \Google\Analytics\Data\V1beta\CohortSpec $var
* @return $this
*/
public function setCohortSpec($var)
{
GPBUtil::checkMessage($var, \Google\Analytics\Data\V1beta\CohortSpec::class);
$this->cohort_spec = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>bool keep_empty_rows = 10;</code>
* @return bool
*/
public function getKeepEmptyRows()
{
return $this->keep_empty_rows;
}
/**
* 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.
*
* Generated from protobuf field <code>bool keep_empty_rows = 10;</code>
* @param bool $var
* @return $this
*/
public function setKeepEmptyRows($var)
{
GPBUtil::checkBool($var);
$this->keep_empty_rows = $var;
return $this;
}
/**
* Toggles whether to return the current state of this Analytics Property's
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* Generated from protobuf field <code>bool return_property_quota = 11;</code>
* @return bool
*/
public function getReturnPropertyQuota()
{
return $this->return_property_quota;
}
/**
* Toggles whether to return the current state of this Analytics Property's
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
* Generated from protobuf field <code>bool return_property_quota = 11;</code>
* @param bool $var
* @return $this
*/
public function setReturnPropertyQuota($var)
{
GPBUtil::checkBool($var);
$this->return_property_quota = $var;
return $this;
}
}
|