MetricMetadata.php — ShareThis Dashboard for Google Analytics 3.2.0

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsData / src / V1alpha / MetricMetadata.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

MetricMetadata.php

300 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	* Explains a metric.
13	*
14	* Generated from protobuf message <code>google.analytics.data.v1alpha.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.v1alpha.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	/**
69	* Constructor.
70	*
71	* @param array $data {
72	* Optional. Data for populating the Message object.
73	*
74	* @type string $api_name
75	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
76	* `eventCount`.
77	* @type string $ui_name
78	* This metric's name within the Google Analytics user interface. For example,
79	* `Event count`.
80	* @type string $description
81	* Description of how this metric is used and calculated.
82	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $deprecated_api_names
83	* Still usable but deprecated names for this metric. If populated, this
84	* metric is available by either `apiName` or one of `deprecatedApiNames`
85	* for a period of time. After the deprecation period, the metric will be
86	* available only by `apiName`.
87	* @type int $type
88	* The type of this metric.
89	* @type string $expression
90	* The mathematical expression for this derived metric. Can be used in
91	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
92	* are not expressions, and for non-expressions, this field is empty.
93	* @type bool $custom_definition
94	* True if the metric is a custom metric for this property.
95	* }
96	*/
97	public function __construct($data = NULL) {
98	\GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
99	parent::__construct($data);
100	}
101
102	/**
103	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
104	* `eventCount`.
105	*
106	* Generated from protobuf field <code>string api_name = 1;</code>
107	* @return string
108	*/
109	public function getApiName()
110	{
111	return $this->api_name;
112	}
113
114	/**
115	* A metric name. Useable in [Metric](#Metric)'s `name`. For example,
116	* `eventCount`.
117	*
118	* Generated from protobuf field <code>string api_name = 1;</code>
119	* @param string $var
120	* @return $this
121	*/
122	public function setApiName($var)
123	{
124	GPBUtil::checkString($var, True);
125	$this->api_name = $var;
126
127	return $this;
128	}
129
130	/**
131	* This metric's name within the Google Analytics user interface. For example,
132	* `Event count`.
133	*
134	* Generated from protobuf field <code>string ui_name = 2;</code>
135	* @return string
136	*/
137	public function getUiName()
138	{
139	return $this->ui_name;
140	}
141
142	/**
143	* This metric's name within the Google Analytics user interface. For example,
144	* `Event count`.
145	*
146	* Generated from protobuf field <code>string ui_name = 2;</code>
147	* @param string $var
148	* @return $this
149	*/
150	public function setUiName($var)
151	{
152	GPBUtil::checkString($var, True);
153	$this->ui_name = $var;
154
155	return $this;
156	}
157
158	/**
159	* Description of how this metric is used and calculated.
160	*
161	* Generated from protobuf field <code>string description = 3;</code>
162	* @return string
163	*/
164	public function getDescription()
165	{
166	return $this->description;
167	}
168
169	/**
170	* Description of how this metric is used and calculated.
171	*
172	* Generated from protobuf field <code>string description = 3;</code>
173	* @param string $var
174	* @return $this
175	*/
176	public function setDescription($var)
177	{
178	GPBUtil::checkString($var, True);
179	$this->description = $var;
180
181	return $this;
182	}
183
184	/**
185	* Still usable but deprecated names for this metric. If populated, this
186	* metric is available by either `apiName` or one of `deprecatedApiNames`
187	* for a period of time. After the deprecation period, the metric will be
188	* available only by `apiName`.
189	*
190	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
191	* @return \Google\Protobuf\Internal\RepeatedField
192	*/
193	public function getDeprecatedApiNames()
194	{
195	return $this->deprecated_api_names;
196	}
197
198	/**
199	* Still usable but deprecated names for this metric. If populated, this
200	* metric is available by either `apiName` or one of `deprecatedApiNames`
201	* for a period of time. After the deprecation period, the metric will be
202	* available only by `apiName`.
203	*
204	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
205	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
206	* @return $this
207	*/
208	public function setDeprecatedApiNames($var)
209	{
210	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
211	$this->deprecated_api_names = $arr;
212
213	return $this;
214	}
215
216	/**
217	* The type of this metric.
218	*
219	* Generated from protobuf field <code>.google.analytics.data.v1alpha.MetricType type = 5;</code>
220	* @return int
221	*/
222	public function getType()
223	{
224	return $this->type;
225	}
226
227	/**
228	* The type of this metric.
229	*
230	* Generated from protobuf field <code>.google.analytics.data.v1alpha.MetricType type = 5;</code>
231	* @param int $var
232	* @return $this
233	*/
234	public function setType($var)
235	{
236	GPBUtil::checkEnum($var, \Google\Analytics\Data\V1alpha\MetricType::class);
237	$this->type = $var;
238
239	return $this;
240	}
241
242	/**
243	* The mathematical expression for this derived metric. Can be used in
244	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
245	* are not expressions, and for non-expressions, this field is empty.
246	*
247	* Generated from protobuf field <code>string expression = 6;</code>
248	* @return string
249	*/
250	public function getExpression()
251	{
252	return $this->expression;
253	}
254
255	/**
256	* The mathematical expression for this derived metric. Can be used in
257	* [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
258	* are not expressions, and for non-expressions, this field is empty.
259	*
260	* Generated from protobuf field <code>string expression = 6;</code>
261	* @param string $var
262	* @return $this
263	*/
264	public function setExpression($var)
265	{
266	GPBUtil::checkString($var, True);
267	$this->expression = $var;
268
269	return $this;
270	}
271
272	/**
273	* True if the metric is a custom metric for this property.
274	*
275	* Generated from protobuf field <code>bool custom_definition = 7;</code>
276	* @return bool
277	*/
278	public function getCustomDefinition()
279	{
280	return $this->custom_definition;
281	}
282
283	/**
284	* True if the metric is a custom metric for this property.
285	*
286	* Generated from protobuf field <code>bool custom_definition = 7;</code>
287	* @param bool $var
288	* @return $this
289	*/
290	public function setCustomDefinition($var)
291	{
292	GPBUtil::checkBool($var);
293	$this->custom_definition = $var;
294
295	return $this;
296	}
297
298	}
299
300