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