MetricMetadata.php — ShareThis Dashboard for Google Analytics 3.2.0

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

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

MetricMetadata.php

396 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	* Explains a metric.
13	*
14	* Generated from protobuf message <code>google.analytics.data.v1beta.MetricMetadata</code>
15	*/
16	class MetricMetadata extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
20	* `eventCount`.
21	*
22	* Generated from protobuf field <code>string api_name = 1;</code>
23	*/
24	private $api_name = '';
25	/**
26	* This metric's name within the Google Analytics user interface. For example,
27	* `Event count`.
28	*
29	* Generated from protobuf field <code>string ui_name = 2;</code>
30	*/
31	private $ui_name = '';
32	/**
33	* Description of how this metric is used and calculated.
34	*
35	* Generated from protobuf field <code>string description = 3;</code>
36	*/
37	private $description = '';
38	/**
39	* Still usable but deprecated names for this metric. If populated, this
40	* metric is available by either `apiName` or one of `deprecatedApiNames`
41	* for a period of time. After the deprecation period, the metric will be
42	* available only by `apiName`.
43	*
44	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
45	*/
46	private $deprecated_api_names;
47	/**
48	* The type of this metric.
49	*
50	* Generated from protobuf field <code>.google.analytics.data.v1beta.MetricType type = 5;</code>
51	*/
52	private $type = 0;
53	/**
54	* The mathematical expression for this derived metric. Can be used in
55	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
56	* are not expressions, and for non-expressions, this field is empty.
57	*
58	* Generated from protobuf field <code>string expression = 6;</code>
59	*/
60	private $expression = '';
61	/**
62	* True if the metric is a custom metric for this property.
63	*
64	* Generated from protobuf field <code>bool custom_definition = 7;</code>
65	*/
66	private $custom_definition = false;
67	/**
68	* If reasons are specified, your access is blocked to this metric for this
69	* property. API requests from you to this property for this metric will
70	* succeed; however, the report will contain only zeros for this metric. API
71	* requests with metric filters on blocked metrics will fail. If reasons are
72	* empty, you have access to this metric.
73	* To learn more, see [Access and data-restriction
74	* management](https://support.google.com/analytics/answer/10851388).
75	*
76	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;</code>
77	*/
78	private $blocked_reasons;
79	/**
80	* The display name of the category that this metrics belongs to. Similar
81	* dimensions and metrics are categorized together.
82	*
83	* Generated from protobuf field <code>string category = 10;</code>
84	*/
85	private $category = '';
86
87	/**
88	* Constructor.
89	*
90	* @param array $data {
91	* Optional. Data for populating the Message object.
92	*
93	* @type string $api_name
94	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
95	* `eventCount`.
96	* @type string $ui_name
97	* This metric's name within the Google Analytics user interface. For example,
98	* `Event count`.
99	* @type string $description
100	* Description of how this metric is used and calculated.
101	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $deprecated_api_names
102	* Still usable but deprecated names for this metric. If populated, this
103	* metric is available by either `apiName` or one of `deprecatedApiNames`
104	* for a period of time. After the deprecation period, the metric will be
105	* available only by `apiName`.
106	* @type int $type
107	* The type of this metric.
108	* @type string $expression
109	* The mathematical expression for this derived metric. Can be used in
110	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
111	* are not expressions, and for non-expressions, this field is empty.
112	* @type bool $custom_definition
113	* True if the metric is a custom metric for this property.
114	* @type int[]\|\Google\Protobuf\Internal\RepeatedField $blocked_reasons
115	* If reasons are specified, your access is blocked to this metric for this
116	* property. API requests from you to this property for this metric will
117	* succeed; however, the report will contain only zeros for this metric. API
118	* requests with metric filters on blocked metrics will fail. If reasons are
119	* empty, you have access to this metric.
120	* To learn more, see [Access and data-restriction
121	* management](https://support.google.com/analytics/answer/10851388).
122	* @type string $category
123	* The display name of the category that this metrics belongs to. Similar
124	* dimensions and metrics are categorized together.
125	* }
126	*/
127	public function __construct($data = NULL) {
128	\GPBMetadata\Google\Analytics\Data\V1Beta\Data::initOnce();
129	parent::__construct($data);
130	}
131
132	/**
133	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
134	* `eventCount`.
135	*
136	* Generated from protobuf field <code>string api_name = 1;</code>
137	* @return string
138	*/
139	public function getApiName()
140	{
141	return $this->api_name;
142	}
143
144	/**
145	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
146	* `eventCount`.
147	*
148	* Generated from protobuf field <code>string api_name = 1;</code>
149	* @param string $var
150	* @return $this
151	*/
152	public function setApiName($var)
153	{
154	GPBUtil::checkString($var, True);
155	$this->api_name = $var;
156
157	return $this;
158	}
159
160	/**
161	* This metric's name within the Google Analytics user interface. For example,
162	* `Event count`.
163	*
164	* Generated from protobuf field <code>string ui_name = 2;</code>
165	* @return string
166	*/
167	public function getUiName()
168	{
169	return $this->ui_name;
170	}
171
172	/**
173	* This metric's name within the Google Analytics user interface. For example,
174	* `Event count`.
175	*
176	* Generated from protobuf field <code>string ui_name = 2;</code>
177	* @param string $var
178	* @return $this
179	*/
180	public function setUiName($var)
181	{
182	GPBUtil::checkString($var, True);
183	$this->ui_name = $var;
184
185	return $this;
186	}
187
188	/**
189	* Description of how this metric is used and calculated.
190	*
191	* Generated from protobuf field <code>string description = 3;</code>
192	* @return string
193	*/
194	public function getDescription()
195	{
196	return $this->description;
197	}
198
199	/**
200	* Description of how this metric is used and calculated.
201	*
202	* Generated from protobuf field <code>string description = 3;</code>
203	* @param string $var
204	* @return $this
205	*/
206	public function setDescription($var)
207	{
208	GPBUtil::checkString($var, True);
209	$this->description = $var;
210
211	return $this;
212	}
213
214	/**
215	* Still usable but deprecated names for this metric. If populated, this
216	* metric is available by either `apiName` or one of `deprecatedApiNames`
217	* for a period of time. After the deprecation period, the metric will be
218	* available only by `apiName`.
219	*
220	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
221	* @return \Google\Protobuf\Internal\RepeatedField
222	*/
223	public function getDeprecatedApiNames()
224	{
225	return $this->deprecated_api_names;
226	}
227
228	/**
229	* Still usable but deprecated names for this metric. If populated, this
230	* metric is available by either `apiName` or one of `deprecatedApiNames`
231	* for a period of time. After the deprecation period, the metric will be
232	* available only by `apiName`.
233	*
234	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
235	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
236	* @return $this
237	*/
238	public function setDeprecatedApiNames($var)
239	{
240	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
241	$this->deprecated_api_names = $arr;
242
243	return $this;
244	}
245
246	/**
247	* The type of this metric.
248	*
249	* Generated from protobuf field <code>.google.analytics.data.v1beta.MetricType type = 5;</code>
250	* @return int
251	*/
252	public function getType()
253	{
254	return $this->type;
255	}
256
257	/**
258	* The type of this metric.
259	*
260	* Generated from protobuf field <code>.google.analytics.data.v1beta.MetricType type = 5;</code>
261	* @param int $var
262	* @return $this
263	*/
264	public function setType($var)
265	{
266	GPBUtil::checkEnum($var, \Google\Analytics\Data\V1beta\MetricType::class);
267	$this->type = $var;
268
269	return $this;
270	}
271
272	/**
273	* The mathematical expression for this derived metric. Can be used in
274	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
275	* are not expressions, and for non-expressions, this field is empty.
276	*
277	* Generated from protobuf field <code>string expression = 6;</code>
278	* @return string
279	*/
280	public function getExpression()
281	{
282	return $this->expression;
283	}
284
285	/**
286	* The mathematical expression for this derived metric. Can be used in
287	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
288	* are not expressions, and for non-expressions, this field is empty.
289	*
290	* Generated from protobuf field <code>string expression = 6;</code>
291	* @param string $var
292	* @return $this
293	*/
294	public function setExpression($var)
295	{
296	GPBUtil::checkString($var, True);
297	$this->expression = $var;
298
299	return $this;
300	}
301
302	/**
303	* True if the metric is a custom metric for this property.
304	*
305	* Generated from protobuf field <code>bool custom_definition = 7;</code>
306	* @return bool
307	*/
308	public function getCustomDefinition()
309	{
310	return $this->custom_definition;
311	}
312
313	/**
314	* True if the metric is a custom metric for this property.
315	*
316	* Generated from protobuf field <code>bool custom_definition = 7;</code>
317	* @param bool $var
318	* @return $this
319	*/
320	public function setCustomDefinition($var)
321	{
322	GPBUtil::checkBool($var);
323	$this->custom_definition = $var;
324
325	return $this;
326	}
327
328	/**
329	* If reasons are specified, your access is blocked to this metric for this
330	* property. API requests from you to this property for this metric will
331	* succeed; however, the report will contain only zeros for this metric. API
332	* requests with metric filters on blocked metrics will fail. If reasons are
333	* empty, you have access to this metric.
334	* To learn more, see [Access and data-restriction
335	* management](https://support.google.com/analytics/answer/10851388).
336	*
337	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;</code>
338	* @return \Google\Protobuf\Internal\RepeatedField
339	*/
340	public function getBlockedReasons()
341	{
342	return $this->blocked_reasons;
343	}
344
345	/**
346	* If reasons are specified, your access is blocked to this metric for this
347	* property. API requests from you to this property for this metric will
348	* succeed; however, the report will contain only zeros for this metric. API
349	* requests with metric filters on blocked metrics will fail. If reasons are
350	* empty, you have access to this metric.
351	* To learn more, see [Access and data-restriction
352	* management](https://support.google.com/analytics/answer/10851388).
353	*
354	* Generated from protobuf field <code>repeated .google.analytics.data.v1beta.MetricMetadata.BlockedReason blocked_reasons = 8;</code>
355	* @param int[]\|\Google\Protobuf\Internal\RepeatedField $var
356	* @return $this
357	*/
358	public function setBlockedReasons($var)
359	{
360	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Analytics\Data\V1beta\MetricMetadata\BlockedReason::class);
361	$this->blocked_reasons = $arr;
362
363	return $this;
364	}
365
366	/**
367	* The display name of the category that this metrics belongs to. Similar
368	* dimensions and metrics are categorized together.
369	*
370	* Generated from protobuf field <code>string category = 10;</code>
371	* @return string
372	*/
373	public function getCategory()
374	{
375	return $this->category;
376	}
377
378	/**
379	* The display name of the category that this metrics belongs to. Similar
380	* dimensions and metrics are categorized together.
381	*
382	* Generated from protobuf field <code>string category = 10;</code>
383	* @param string $var
384	* @return $this
385	*/
386	public function setCategory($var)
387	{
388	GPBUtil::checkString($var, True);
389	$this->category = $var;
390
391	return $this;
392	}
393
394	}
395
396