CustomMetric.php — ShareThis Dashboard for Google Analytics trunk

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsAdmin / src / V1alpha / CustomMetric.php

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

CustomMetric.php

320 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/analytics/admin/v1alpha/resources.proto
4
5	namespace Google\Analytics\Admin\V1alpha;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* A definition for a custom metric.
13	*
14	* Generated from protobuf message <code>google.analytics.admin.v1alpha.CustomMetric</code>
15	*/
16	class CustomMetric extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* Output only. Resource name for this CustomMetric resource.
20	* Format: properties/{property}/customMetrics/{customMetric}
21	*
22	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
23	*/
24	private $name = '';
25	/**
26	* Required. Immutable. Tagging name for this custom metric.
27	* If this is an event-scoped metric, then this is the event parameter
28	* name.
29	* May only contain alphanumeric and underscore charactes, starting with a
30	* letter. Max length of 40 characters for event-scoped metrics.
31	*
32	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
33	*/
34	private $parameter_name = '';
35	/**
36	* Required. Display name for this custom metric as shown in the Analytics UI.
37	* Max length of 82 characters, alphanumeric plus space and underscore
38	* starting with a letter. Legacy system-generated display names may contain
39	* square brackets, but updates to this field will never permit square
40	* brackets.
41	*
42	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
43	*/
44	private $display_name = '';
45	/**
46	* Optional. Description for this custom dimension.
47	* Max length of 150 characters.
48	*
49	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
50	*/
51	private $description = '';
52	/**
53	* Required. The type for the custom metric's value.
54	*
55	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];</code>
56	*/
57	private $measurement_unit = 0;
58	/**
59	* Required. Immutable. The scope of this custom metric.
60	*
61	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
62	*/
63	private $scope = 0;
64	/**
65	* Optional. Types of restricted data that this metric may contain. Required for metrics
66	* with CURRENCY measurement unit. Must be empty for metrics with a
67	* non-CURRENCY measurement unit.
68	*
69	* Generated from protobuf field <code>repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
70	*/
71	private $restricted_metric_type;
72
73	/**
74	* Constructor.
75	*
76	* @param array $data {
77	* Optional. Data for populating the Message object.
78	*
79	* @type string $name
80	* Output only. Resource name for this CustomMetric resource.
81	* Format: properties/{property}/customMetrics/{customMetric}
82	* @type string $parameter_name
83	* Required. Immutable. Tagging name for this custom metric.
84	* If this is an event-scoped metric, then this is the event parameter
85	* name.
86	* May only contain alphanumeric and underscore charactes, starting with a
87	* letter. Max length of 40 characters for event-scoped metrics.
88	* @type string $display_name
89	* Required. Display name for this custom metric as shown in the Analytics UI.
90	* Max length of 82 characters, alphanumeric plus space and underscore
91	* starting with a letter. Legacy system-generated display names may contain
92	* square brackets, but updates to this field will never permit square
93	* brackets.
94	* @type string $description
95	* Optional. Description for this custom dimension.
96	* Max length of 150 characters.
97	* @type int $measurement_unit
98	* Required. The type for the custom metric's value.
99	* @type int $scope
100	* Required. Immutable. The scope of this custom metric.
101	* @type int[]\|\Google\Protobuf\Internal\RepeatedField $restricted_metric_type
102	* Optional. Types of restricted data that this metric may contain. Required for metrics
103	* with CURRENCY measurement unit. Must be empty for metrics with a
104	* non-CURRENCY measurement unit.
105	* }
106	*/
107	public function __construct($data = NULL) {
108	\GPBMetadata\Google\Analytics\Admin\V1Alpha\Resources::initOnce();
109	parent::__construct($data);
110	}
111
112	/**
113	* Output only. Resource name for this CustomMetric resource.
114	* Format: properties/{property}/customMetrics/{customMetric}
115	*
116	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
117	* @return string
118	*/
119	public function getName()
120	{
121	return $this->name;
122	}
123
124	/**
125	* Output only. Resource name for this CustomMetric resource.
126	* Format: properties/{property}/customMetrics/{customMetric}
127	*
128	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
129	* @param string $var
130	* @return $this
131	*/
132	public function setName($var)
133	{
134	GPBUtil::checkString($var, True);
135	$this->name = $var;
136
137	return $this;
138	}
139
140	/**
141	* Required. Immutable. Tagging name for this custom metric.
142	* If this is an event-scoped metric, then this is the event parameter
143	* name.
144	* May only contain alphanumeric and underscore charactes, starting with a
145	* letter. Max length of 40 characters for event-scoped metrics.
146	*
147	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
148	* @return string
149	*/
150	public function getParameterName()
151	{
152	return $this->parameter_name;
153	}
154
155	/**
156	* Required. Immutable. Tagging name for this custom metric.
157	* If this is an event-scoped metric, then this is the event parameter
158	* name.
159	* May only contain alphanumeric and underscore charactes, starting with a
160	* letter. Max length of 40 characters for event-scoped metrics.
161	*
162	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
163	* @param string $var
164	* @return $this
165	*/
166	public function setParameterName($var)
167	{
168	GPBUtil::checkString($var, True);
169	$this->parameter_name = $var;
170
171	return $this;
172	}
173
174	/**
175	* Required. Display name for this custom metric as shown in the Analytics UI.
176	* Max length of 82 characters, alphanumeric plus space and underscore
177	* starting with a letter. Legacy system-generated display names may contain
178	* square brackets, but updates to this field will never permit square
179	* brackets.
180	*
181	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
182	* @return string
183	*/
184	public function getDisplayName()
185	{
186	return $this->display_name;
187	}
188
189	/**
190	* Required. Display name for this custom metric as shown in the Analytics UI.
191	* Max length of 82 characters, alphanumeric plus space and underscore
192	* starting with a letter. Legacy system-generated display names may contain
193	* square brackets, but updates to this field will never permit square
194	* brackets.
195	*
196	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
197	* @param string $var
198	* @return $this
199	*/
200	public function setDisplayName($var)
201	{
202	GPBUtil::checkString($var, True);
203	$this->display_name = $var;
204
205	return $this;
206	}
207
208	/**
209	* Optional. Description for this custom dimension.
210	* Max length of 150 characters.
211	*
212	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
213	* @return string
214	*/
215	public function getDescription()
216	{
217	return $this->description;
218	}
219
220	/**
221	* Optional. Description for this custom dimension.
222	* Max length of 150 characters.
223	*
224	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
225	* @param string $var
226	* @return $this
227	*/
228	public function setDescription($var)
229	{
230	GPBUtil::checkString($var, True);
231	$this->description = $var;
232
233	return $this;
234	}
235
236	/**
237	* Required. The type for the custom metric's value.
238	*
239	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];</code>
240	* @return int
241	*/
242	public function getMeasurementUnit()
243	{
244	return $this->measurement_unit;
245	}
246
247	/**
248	* Required. The type for the custom metric's value.
249	*
250	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];</code>
251	* @param int $var
252	* @return $this
253	*/
254	public function setMeasurementUnit($var)
255	{
256	GPBUtil::checkEnum($var, \Google\Analytics\Admin\V1alpha\CustomMetric\MeasurementUnit::class);
257	$this->measurement_unit = $var;
258
259	return $this;
260	}
261
262	/**
263	* Required. Immutable. The scope of this custom metric.
264	*
265	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
266	* @return int
267	*/
268	public function getScope()
269	{
270	return $this->scope;
271	}
272
273	/**
274	* Required. Immutable. The scope of this custom metric.
275	*
276	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
277	* @param int $var
278	* @return $this
279	*/
280	public function setScope($var)
281	{
282	GPBUtil::checkEnum($var, \Google\Analytics\Admin\V1alpha\CustomMetric\MetricScope::class);
283	$this->scope = $var;
284
285	return $this;
286	}
287
288	/**
289	* Optional. Types of restricted data that this metric may contain. Required for metrics
290	* with CURRENCY measurement unit. Must be empty for metrics with a
291	* non-CURRENCY measurement unit.
292	*
293	* Generated from protobuf field <code>repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
294	* @return \Google\Protobuf\Internal\RepeatedField
295	*/
296	public function getRestrictedMetricType()
297	{
298	return $this->restricted_metric_type;
299	}
300
301	/**
302	* Optional. Types of restricted data that this metric may contain. Required for metrics
303	* with CURRENCY measurement unit. Must be empty for metrics with a
304	* non-CURRENCY measurement unit.
305	*
306	* Generated from protobuf field <code>repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
307	* @param int[]\|\Google\Protobuf\Internal\RepeatedField $var
308	* @return $this
309	*/
310	public function setRestrictedMetricType($var)
311	{
312	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Analytics\Admin\V1alpha\CustomMetric\RestrictedMetricType::class);
313	$this->restricted_metric_type = $arr;
314
315	return $this;
316	}
317
318	}
319
320