Pivot.php — ShareThis Dashboard for Google Analytics 3.2.2

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

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

Pivot.php

256 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/analytics/data/v1beta/data.proto
4
5	namespace Google\Analytics\Data\V1beta;
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.v1beta.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.v1beta.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 unique combinations of dimension values to return in this
45	* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
46	* single pivot requests.
47	* The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
48	* must not exceed 100,000. For example, a two pivot request with `limit:
49	* 1000` in each pivot will fail because the product is `1,000,000`.
50	*
51	* Generated from protobuf field <code>int64 limit = 4;</code>
52	*/
53	private $limit = 0;
54	/**
55	* Aggregate the metrics by dimensions in this pivot using the specified
56	* metric_aggregations.
57	*
58	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code>
59	*/
60	private $metric_aggregations;
61
62	/**
63	* Constructor.
64	*
65	* @param array $data {
66	* Optional. Data for populating the Message object.
67	*
68	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $field_names
69	* Dimension names for visible columns in the report response. Including
70	* "dateRange" produces a date range column; for each row in the response,
71	* dimension values in the date range column will indicate the corresponding
72	* date range from the request.
73	* @type \Google\Analytics\Data\V1beta\OrderBy[]\|\Google\Protobuf\Internal\RepeatedField $order_bys
74	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
75	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
76	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
77	* Dimensions specified in these OrderBys must be a subset of
78	* Pivot.field_names.
79	* @type int\|string $offset
80	* The row count of the start row. The first row is counted as row 0.
81	* @type int\|string $limit
82	* The number of unique combinations of dimension values to return in this
83	* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
84	* single pivot requests.
85	* The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
86	* must not exceed 100,000. For example, a two pivot request with `limit:
87	* 1000` in each pivot will fail because the product is `1,000,000`.
88	* @type int[]\|\Google\Protobuf\Internal\RepeatedField $metric_aggregations
89	* Aggregate the metrics by dimensions in this pivot using the specified
90	* metric_aggregations.
91	* }
92	*/
93	public function __construct($data = NULL) {
94	\GPBMetadata\Google\Analytics\Data\V1Beta\Data::initOnce();
95	parent::__construct($data);
96	}
97
98	/**
99	* Dimension names for visible columns in the report response. Including
100	* "dateRange" produces a date range column; for each row in the response,
101	* dimension values in the date range column will indicate the corresponding
102	* date range from the request.
103	*
104	* Generated from protobuf field <code>repeated string field_names = 1;</code>
105	* @return \Google\Protobuf\Internal\RepeatedField
106	*/
107	public function getFieldNames()
108	{
109	return $this->field_names;
110	}
111
112	/**
113	* Dimension names for visible columns in the report response. Including
114	* "dateRange" produces a date range column; for each row in the response,
115	* dimension values in the date range column will indicate the corresponding
116	* date range from the request.
117	*
118	* Generated from protobuf field <code>repeated string field_names = 1;</code>
119	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
120	* @return $this
121	*/
122	public function setFieldNames($var)
123	{
124	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
125	$this->field_names = $arr;
126
127	return $this;
128	}
129
130	/**
131	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
132	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
133	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
134	* Dimensions specified in these OrderBys must be a subset of
135	* Pivot.field_names.
136	*
137	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code>
138	* @return \Google\Protobuf\Internal\RepeatedField
139	*/
140	public function getOrderBys()
141	{
142	return $this->order_bys;
143	}
144
145	/**
146	* Specifies how dimensions are ordered in the pivot. In the first Pivot, the
147	* OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
148	* Pivots, the OrderBys determine only PivotDimensionHeader ordering.
149	* Dimensions specified in these OrderBys must be a subset of
150	* Pivot.field_names.
151	*
152	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code>
153	* @param \Google\Analytics\Data\V1beta\OrderBy[]\|\Google\Protobuf\Internal\RepeatedField $var
154	* @return $this
155	*/
156	public function setOrderBys($var)
157	{
158	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Data\V1beta\OrderBy::class);
159	$this->order_bys = $arr;
160
161	return $this;
162	}
163
164	/**
165	* The row count of the start row. The first row is counted as row 0.
166	*
167	* Generated from protobuf field <code>int64 offset = 3;</code>
168	* @return int\|string
169	*/
170	public function getOffset()
171	{
172	return $this->offset;
173	}
174
175	/**
176	* The row count of the start row. The first row is counted as row 0.
177	*
178	* Generated from protobuf field <code>int64 offset = 3;</code>
179	* @param int\|string $var
180	* @return $this
181	*/
182	public function setOffset($var)
183	{
184	GPBUtil::checkInt64($var);
185	$this->offset = $var;
186
187	return $this;
188	}
189
190	/**
191	* The number of unique combinations of dimension values to return in this
192	* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
193	* single pivot requests.
194	* The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
195	* must not exceed 100,000. For example, a two pivot request with `limit:
196	* 1000` in each pivot will fail because the product is `1,000,000`.
197	*
198	* Generated from protobuf field <code>int64 limit = 4;</code>
199	* @return int\|string
200	*/
201	public function getLimit()
202	{
203	return $this->limit;
204	}
205
206	/**
207	* The number of unique combinations of dimension values to return in this
208	* pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
209	* single pivot requests.
210	* The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
211	* must not exceed 100,000. For example, a two pivot request with `limit:
212	* 1000` in each pivot will fail because the product is `1,000,000`.
213	*
214	* Generated from protobuf field <code>int64 limit = 4;</code>
215	* @param int\|string $var
216	* @return $this
217	*/
218	public function setLimit($var)
219	{
220	GPBUtil::checkInt64($var);
221	$this->limit = $var;
222
223	return $this;
224	}
225
226	/**
227	* Aggregate the metrics by dimensions in this pivot using the specified
228	* metric_aggregations.
229	*
230	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code>
231	* @return \Google\Protobuf\Internal\RepeatedField
232	*/
233	public function getMetricAggregations()
234	{
235	return $this->metric_aggregations;
236	}
237
238	/**
239	* Aggregate the metrics by dimensions in this pivot using the specified
240	* metric_aggregations.
241	*
242	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code>
243	* @param int[]\|\Google\Protobuf\Internal\RepeatedField $var
244	* @return $this
245	*/
246	public function setMetricAggregations($var)
247	{
248	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Analytics\Data\V1beta\MetricAggregation::class);
249	$this->metric_aggregations = $arr;
250
251	return $this;
252	}
253
254	}
255
256