Metric.php — ShareThis Dashboard for Google Analytics 3.2.0

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

Metric.php

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