DimensionMetadata.php — ShareThis Dashboard for Google Analytics 3.2.3

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

DimensionMetadata.php

224 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 dimension.
13	*
14	* Generated from protobuf message <code>google.analytics.data.v1alpha.DimensionMetadata</code>
15	*/
16	class DimensionMetadata extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
20	* example, `eventName`.
21	*
22	* Generated from protobuf field <code>string api_name = 1;</code>
23	*/
24	private $api_name = '';
25	/**
26	* This dimension's name within the Google Analytics user interface. For
27	* example, `Event name`.
28	*
29	* Generated from protobuf field <code>string ui_name = 2;</code>
30	*/
31	private $ui_name = '';
32	/**
33	* Description of how this dimension 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 dimension. If populated, this
40	* dimension is available by either `apiName` or one of `deprecatedApiNames`
41	* for a period of time. After the deprecation period, the dimension 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	* True if the dimension is a custom dimension for this property.
49	*
50	* Generated from protobuf field <code>bool custom_definition = 5;</code>
51	*/
52	private $custom_definition = false;
53
54	/**
55	* Constructor.
56	*
57	* @param array $data {
58	* Optional. Data for populating the Message object.
59	*
60	* @type string $api_name
61	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
62	* example, `eventName`.
63	* @type string $ui_name
64	* This dimension's name within the Google Analytics user interface. For
65	* example, `Event name`.
66	* @type string $description
67	* Description of how this dimension is used and calculated.
68	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $deprecated_api_names
69	* Still usable but deprecated names for this dimension. If populated, this
70	* dimension is available by either `apiName` or one of `deprecatedApiNames`
71	* for a period of time. After the deprecation period, the dimension will be
72	* available only by `apiName`.
73	* @type bool $custom_definition
74	* True if the dimension is a custom dimension for this property.
75	* }
76	*/
77	public function __construct($data = NULL) {
78	\GPBMetadata\Google\Analytics\Data\V1Alpha\Data::initOnce();
79	parent::__construct($data);
80	}
81
82	/**
83	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
84	* example, `eventName`.
85	*
86	* Generated from protobuf field <code>string api_name = 1;</code>
87	* @return string
88	*/
89	public function getApiName()
90	{
91	return $this->api_name;
92	}
93
94	/**
95	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
96	* example, `eventName`.
97	*
98	* Generated from protobuf field <code>string api_name = 1;</code>
99	* @param string $var
100	* @return $this
101	*/
102	public function setApiName($var)
103	{
104	GPBUtil::checkString($var, True);
105	$this->api_name = $var;
106
107	return $this;
108	}
109
110	/**
111	* This dimension's name within the Google Analytics user interface. For
112	* example, `Event name`.
113	*
114	* Generated from protobuf field <code>string ui_name = 2;</code>
115	* @return string
116	*/
117	public function getUiName()
118	{
119	return $this->ui_name;
120	}
121
122	/**
123	* This dimension's name within the Google Analytics user interface. For
124	* example, `Event name`.
125	*
126	* Generated from protobuf field <code>string ui_name = 2;</code>
127	* @param string $var
128	* @return $this
129	*/
130	public function setUiName($var)
131	{
132	GPBUtil::checkString($var, True);
133	$this->ui_name = $var;
134
135	return $this;
136	}
137
138	/**
139	* Description of how this dimension is used and calculated.
140	*
141	* Generated from protobuf field <code>string description = 3;</code>
142	* @return string
143	*/
144	public function getDescription()
145	{
146	return $this->description;
147	}
148
149	/**
150	* Description of how this dimension is used and calculated.
151	*
152	* Generated from protobuf field <code>string description = 3;</code>
153	* @param string $var
154	* @return $this
155	*/
156	public function setDescription($var)
157	{
158	GPBUtil::checkString($var, True);
159	$this->description = $var;
160
161	return $this;
162	}
163
164	/**
165	* Still usable but deprecated names for this dimension. If populated, this
166	* dimension is available by either `apiName` or one of `deprecatedApiNames`
167	* for a period of time. After the deprecation period, the dimension will be
168	* available only by `apiName`.
169	*
170	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
171	* @return \Google\Protobuf\Internal\RepeatedField
172	*/
173	public function getDeprecatedApiNames()
174	{
175	return $this->deprecated_api_names;
176	}
177
178	/**
179	* Still usable but deprecated names for this dimension. If populated, this
180	* dimension is available by either `apiName` or one of `deprecatedApiNames`
181	* for a period of time. After the deprecation period, the dimension will be
182	* available only by `apiName`.
183	*
184	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
185	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
186	* @return $this
187	*/
188	public function setDeprecatedApiNames($var)
189	{
190	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
191	$this->deprecated_api_names = $arr;
192
193	return $this;
194	}
195
196	/**
197	* True if the dimension is a custom dimension for this property.
198	*
199	* Generated from protobuf field <code>bool custom_definition = 5;</code>
200	* @return bool
201	*/
202	public function getCustomDefinition()
203	{
204	return $this->custom_definition;
205	}
206
207	/**
208	* True if the dimension is a custom dimension for this property.
209	*
210	* Generated from protobuf field <code>bool custom_definition = 5;</code>
211	* @param bool $var
212	* @return $this
213	*/
214	public function setCustomDefinition($var)
215	{
216	GPBUtil::checkBool($var);
217	$this->custom_definition = $var;
218
219	return $this;
220	}
221
222	}
223
224