Pivot.php — ShareThis Dashboard for Google Analytics 3.2.2

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsData / src / V1alpha / Pivot.php

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsData / src / V1alpha Last commit date

CohortsRange 3 years ago DimensionExpression 3 years ago Filter 3 years ago Gapic 3 years ago OrderBy 3 years ago resources 3 years ago AlphaAnalyticsDataClient.php 3 years ago AlphaAnalyticsDataGrpcClient.php 3 years ago BatchRunPivotReportsRequest.php 3 years ago BatchRunPivotReportsResponse.php 3 years ago BatchRunReportsRequest.php 3 years ago BatchRunReportsResponse.php 3 years ago Cohort.php 3 years ago CohortReportSettings.php 3 years ago CohortSpec.php 3 years ago CohortsRange.php 3 years ago DateRange.php 3 years ago Dimension.php 3 years ago DimensionExpression.php 3 years ago DimensionHeader.php 3 years ago DimensionMetadata.php 3 years ago DimensionValue.php 3 years ago Entity.php 3 years ago Filter.php 3 years ago FilterExpression.php 3 years ago FilterExpressionList.php 3 years ago GetMetadataRequest.php 3 years ago Metadata.php 3 years ago Metric.php 3 years ago MetricAggregation.php 3 years ago MetricHeader.php 3 years ago MetricMetadata.php 3 years ago MetricType.php 3 years ago MetricValue.php 3 years ago NumericValue.php 3 years ago OrderBy.php 3 years ago Pivot.php 3 years ago PivotDimensionHeader.php 3 years ago PivotHeader.php 3 years ago PropertyQuota.php 3 years ago QuotaStatus.php 3 years ago ResponseMetaData.php 3 years ago Row.php 3 years ago RunPivotReportRequest.php 3 years ago RunPivotReportResponse.php 3 years ago RunRealtimeReportRequest.php 3 years ago RunRealtimeReportResponse.php 3 years ago RunReportRequest.php 3 years ago RunReportResponse.php 3 years ago gapic_metadata.json 3 years ago

Pivot.php

240 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/analytics/data/v1alpha/data.proto
4
5	namespace Google\Analytics\Data\V1alpha;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* Describes the visible dimension columns and rows in the report response.
13	*
14	* Generated from protobuf message <code>google.analytics.data.v1alpha.Pivot</code>
15	*/
16	class Pivot extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* Dimension names for visible columns in the report response. Including
20	* "dateRange" produces a date range column; for each row in the response,
21	* dimension values in the date range column will indicate the corresponding
22	* date range from the request.
23	*
24	* Generated from protobuf field <code>repeated string field_names = 1;</code>
25	*/
26	private $field_names;
27	/**
28	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
29	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
30	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
31	* Dimensions specified in these OrderBys must be a subset of
32	* Pivot.field_names.
33	*
34	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy order_bys = 2;</code>
35	*/
36	private $order_bys;
37	/**
38	* The row count of the start row. The first row is counted as row 0.
39	*
40	* Generated from protobuf field <code>int64 offset = 3;</code>
41	*/
42	private $offset = 0;
43	/**
44	* The number of rows to return in this pivot. If unspecified, 10 rows are
45	* returned. If -1, all rows are returned.
46	*
47	* Generated from protobuf field <code>int64 limit = 4;</code>
48	*/
49	private $limit = 0;
50	/**
51	* Aggregate the metrics by dimensions in this pivot using the specified
52	* metric_aggregations.
53	*
54	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 5;</code>
55	*/
56	private $metric_aggregations;
57
58	/**
59	* Constructor.
60	*
61	* @param array $data {
62	* Optional. Data for populating the Message object.
63	*
64	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $field_names
65	* Dimension names for visible columns in the report response. Including
66	* "dateRange" produces a date range column; for each row in the response,
67	* dimension values in the date range column will indicate the corresponding
68	* date range from the request.
69	* @type \Google\Analytics\Data\V1alpha\OrderBy[]\|\Google\Protobuf\Internal\RepeatedField $order_bys
70	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
71	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
72	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
73	* Dimensions specified in these OrderBys must be a subset of
74	* Pivot.field_names.
75	* @type int\|string $offset
76	* The row count of the start row. The first row is counted as row 0.
77	* @type int\|string $limit
78	* The number of rows to return in this pivot. If unspecified, 10 rows are
79	* returned. If -1, all rows are returned.
80	* @type int[]\|\Google\Protobuf\Internal\RepeatedField $metric_aggregations
81	* Aggregate the metrics by dimensions in this pivot using the specified
82	* metric_aggregations.
83	* }
84	*/
85	public function __construct($data = NULL) {
86	\GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
87	parent::__construct($data);
88	}
89
90	/**
91	* Dimension names for visible columns in the report response. Including
92	* "dateRange" produces a date range column; for each row in the response,
93	* dimension values in the date range column will indicate the corresponding
94	* date range from the request.
95	*
96	* Generated from protobuf field <code>repeated string field_names = 1;</code>
97	* @return \Google\Protobuf\Internal\RepeatedField
98	*/
99	public function getFieldNames()
100	{
101	return $this->field_names;
102	}
103
104	/**
105	* Dimension names for visible columns in the report response. Including
106	* "dateRange" produces a date range column; for each row in the response,
107	* dimension values in the date range column will indicate the corresponding
108	* date range from the request.
109	*
110	* Generated from protobuf field <code>repeated string field_names = 1;</code>
111	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
112	* @return $this
113	*/
114	public function setFieldNames($var)
115	{
116	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
117	$this->field_names = $arr;
118
119	return $this;
120	}
121
122	/**
123	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
124	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
125	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
126	* Dimensions specified in these OrderBys must be a subset of
127	* Pivot.field_names.
128	*
129	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy order_bys = 2;</code>
130	* @return \Google\Protobuf\Internal\RepeatedField
131	*/
132	public function getOrderBys()
133	{
134	return $this->order_bys;
135	}
136
137	/**
138	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
139	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
140	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
141	* Dimensions specified in these OrderBys must be a subset of
142	* Pivot.field_names.
143	*
144	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.OrderBy order_bys = 2;</code>
145	* @param \Google\Analytics\Data\V1alpha\OrderBy[]\|\Google\Protobuf\Internal\RepeatedField $var
146	* @return $this
147	*/
148	public function setOrderBys($var)
149	{
150	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1alpha\OrderBy::class);
151	$this->order_bys = $arr;
152
153	return $this;
154	}
155
156	/**
157	* The row count of the start row. The first row is counted as row 0.
158	*
159	* Generated from protobuf field <code>int64 offset = 3;</code>
160	* @return int\|string
161	*/
162	public function getOffset()
163	{
164	return $this->offset;
165	}
166
167	/**
168	* The row count of the start row. The first row is counted as row 0.
169	*
170	* Generated from protobuf field <code>int64 offset = 3;</code>
171	* @param int\|string $var
172	* @return $this
173	*/
174	public function setOffset($var)
175	{
176	GPBUtil::checkInt64($var);
177	$this->offset = $var;
178
179	return $this;
180	}
181
182	/**
183	* The number of rows to return in this pivot. If unspecified, 10 rows are
184	* returned. If -1, all rows are returned.
185	*
186	* Generated from protobuf field <code>int64 limit = 4;</code>
187	* @return int\|string
188	*/
189	public function getLimit()
190	{
191	return $this->limit;
192	}
193
194	/**
195	* The number of rows to return in this pivot. If unspecified, 10 rows are
196	* returned. If -1, all rows are returned.
197	*
198	* Generated from protobuf field <code>int64 limit = 4;</code>
199	* @param int\|string $var
200	* @return $this
201	*/
202	public function setLimit($var)
203	{
204	GPBUtil::checkInt64($var);
205	$this->limit = $var;
206
207	return $this;
208	}
209
210	/**
211	* Aggregate the metrics by dimensions in this pivot using the specified
212	* metric_aggregations.
213	*
214	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 5;</code>
215	* @return \Google\Protobuf\Internal\RepeatedField
216	*/
217	public function getMetricAggregations()
218	{
219	return $this->metric_aggregations;
220	}
221
222	/**
223	* Aggregate the metrics by dimensions in this pivot using the specified
224	* metric_aggregations.
225	*
226	* Generated from protobuf field <code>repeated .google.analytics.data.v1alpha.MetricAggregation metric_aggregations = 5;</code>
227	* @param int[]\|\Google\Protobuf\Internal\RepeatedField $var
228	* @return $this
229	*/
230	public function setMetricAggregations($var)
231	{
232	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Analytics\Data\V1alpha\MetricAggregation::class);
233	$this->metric_aggregations = $arr;
234
235	return $this;
236	}
237
238	}
239
240