Metric.php — ShareThis Dashboard for Google Analytics 3.2.3

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

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

Metric.php

186 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	* The quantitative measurements of a report. For example, the metric
13	* `eventCount` is the total number of events. Requests are allowed up to 10
14	* metrics.
15	*
16	* Generated from protobuf message <code>google.analytics.data.v1beta.Metric</code>
17	*/
18	class Metric extends \Google\Protobuf\Internal\Message
19	{
20	/**
21	* The name of the metric. See the [API
22	* Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
23	* for the list of metric names.
24	* If `expression` is specified, `name` can be any string that you would like
25	* within the allowed character set. For example if `expression` is
26	* `screenPageViews/sessions`, you could call that metric's name =
27	* `viewsPerSession`. Metric names that you choose must match the regular
28	* expression `^[a-zA-Z0-9_]$`.
29	* Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
30	* `expression`.
31	*
32	* Generated from protobuf field <code>string name = 1;</code>
33	*/
34	private $name = '';
35	/**
36	* A mathematical expression for derived metrics. For example, the metric
37	* Event count per user is `eventCount/totalUsers`.
38	*
39	* Generated from protobuf field <code>string expression = 2;</code>
40	*/
41	private $expression = '';
42	/**
43	* Indicates if a metric is invisible in the report response. If a metric is
44	* invisible, the metric will not produce a column in the response, but can be
45	* used in `metricFilter`, `orderBys`, or a metric `expression`.
46	*
47	* Generated from protobuf field <code>bool invisible = 3;</code>
48	*/
49	private $invisible = false;
50
51	/**
52	* Constructor.
53	*
54	* @param array $data {
55	* Optional. Data for populating the Message object.
56	*
57	* @type string $name
58	* The name of the metric. See the [API
59	* Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
60	* for the list of metric names.
61	* If `expression` is specified, `name` can be any string that you would like
62	* within the allowed character set. For example if `expression` is
63	* `screenPageViews/sessions`, you could call that metric's name =
64	* `viewsPerSession`. Metric names that you choose must match the regular
65	* expression `^[a-zA-Z0-9_]$`.
66	* Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
67	* `expression`.
68	* @type string $expression
69	* A mathematical expression for derived metrics. For example, the metric
70	* Event count per user is `eventCount/totalUsers`.
71	* @type bool $invisible
72	* Indicates if a metric is invisible in the report response. If a metric is
73	* invisible, the metric will not produce a column in the response, but can be
74	* used in `metricFilter`, `orderBys`, or a metric `expression`.
75	* }
76	*/
77	public function __construct($data = NULL) {
78	\GPBMetadata\Google\Analytics\Data\V1Beta\Data::initOnce();
79	parent::__construct($data);
80	}
81
82	/**
83	* The name of the metric. See the [API
84	* Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
85	* for the list of metric names.
86	* If `expression` is specified, `name` can be any string that you would like
87	* within the allowed character set. For example if `expression` is
88	* `screenPageViews/sessions`, you could call that metric's name =
89	* `viewsPerSession`. Metric names that you choose must match the regular
90	* expression `^[a-zA-Z0-9_]$`.
91	* Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
92	* `expression`.
93	*
94	* Generated from protobuf field <code>string name = 1;</code>
95	* @return string
96	*/
97	public function getName()
98	{
99	return $this->name;
100	}
101
102	/**
103	* The name of the metric. See the [API
104	* Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
105	* for the list of metric names.
106	* If `expression` is specified, `name` can be any string that you would like
107	* within the allowed character set. For example if `expression` is
108	* `screenPageViews/sessions`, you could call that metric's name =
109	* `viewsPerSession`. Metric names that you choose must match the regular
110	* expression `^[a-zA-Z0-9_]$`.
111	* Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
112	* `expression`.
113	*
114	* Generated from protobuf field <code>string name = 1;</code>
115	* @param string $var
116	* @return $this
117	*/
118	public function setName($var)
119	{
120	GPBUtil::checkString($var, True);
121	$this->name = $var;
122
123	return $this;
124	}
125
126	/**
127	* A mathematical expression for derived metrics. For example, the metric
128	* Event count per user is `eventCount/totalUsers`.
129	*
130	* Generated from protobuf field <code>string expression = 2;</code>
131	* @return string
132	*/
133	public function getExpression()
134	{
135	return $this->expression;
136	}
137
138	/**
139	* A mathematical expression for derived metrics. For example, the metric
140	* Event count per user is `eventCount/totalUsers`.
141	*
142	* Generated from protobuf field <code>string expression = 2;</code>
143	* @param string $var
144	* @return $this
145	*/
146	public function setExpression($var)
147	{
148	GPBUtil::checkString($var, True);
149	$this->expression = $var;
150
151	return $this;
152	}
153
154	/**
155	* Indicates if a metric is invisible in the report response. If a metric is
156	* invisible, the metric will not produce a column in the response, but can be
157	* used in `metricFilter`, `orderBys`, or a metric `expression`.
158	*
159	* Generated from protobuf field <code>bool invisible = 3;</code>
160	* @return bool
161	*/
162	public function getInvisible()
163	{
164	return $this->invisible;
165	}
166
167	/**
168	* Indicates if a metric is invisible in the report response. If a metric is
169	* invisible, the metric will not produce a column in the response, but can be
170	* used in `metricFilter`, `orderBys`, or a metric `expression`.
171	*
172	* Generated from protobuf field <code>bool invisible = 3;</code>
173	* @param bool $var
174	* @return $this
175	*/
176	public function setInvisible($var)
177	{
178	GPBUtil::checkBool($var);
179	$this->invisible = $var;
180
181	return $this;
182	}
183
184	}
185
186