DimensionMetadata.php — ShareThis Dashboard for Google Analytics 3.2.0

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

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

DimensionMetadata.php

262 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	* Explains a dimension.
13	*
14	* Generated from protobuf message <code>google.analytics.data.v1beta.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	* The display name of the category that this dimension belongs to. Similar
55	* dimensions and metrics are categorized together.
56	*
57	* Generated from protobuf field <code>string category = 7;</code>
58	*/
59	private $category = '';
60
61	/**
62	* Constructor.
63	*
64	* @param array $data {
65	* Optional. Data for populating the Message object.
66	*
67	* @type string $api_name
68	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
69	* example, `eventName`.
70	* @type string $ui_name
71	* This dimension's name within the Google Analytics user interface. For
72	* example, `Event name`.
73	* @type string $description
74	* Description of how this dimension is used and calculated.
75	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $deprecated_api_names
76	* Still usable but deprecated names for this dimension. If populated, this
77	* dimension is available by either `apiName` or one of `deprecatedApiNames`
78	* for a period of time. After the deprecation period, the dimension will be
79	* available only by `apiName`.
80	* @type bool $custom_definition
81	* True if the dimension is a custom dimension for this property.
82	* @type string $category
83	* The display name of the category that this dimension belongs to. Similar
84	* dimensions and metrics are categorized together.
85	* }
86	*/
87	public function __construct($data = NULL) {
88	\GPBMetadata\Google\Analytics\Data\V1Beta\Data::initOnce();
89	parent::__construct($data);
90	}
91
92	/**
93	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
94	* example, `eventName`.
95	*
96	* Generated from protobuf field <code>string api_name = 1;</code>
97	* @return string
98	*/
99	public function getApiName()
100	{
101	return $this->api_name;
102	}
103
104	/**
105	* This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
106	* example, `eventName`.
107	*
108	* Generated from protobuf field <code>string api_name = 1;</code>
109	* @param string $var
110	* @return $this
111	*/
112	public function setApiName($var)
113	{
114	GPBUtil::checkString($var, True);
115	$this->api_name = $var;
116
117	return $this;
118	}
119
120	/**
121	* This dimension's name within the Google Analytics user interface. For
122	* example, `Event name`.
123	*
124	* Generated from protobuf field <code>string ui_name = 2;</code>
125	* @return string
126	*/
127	public function getUiName()
128	{
129	return $this->ui_name;
130	}
131
132	/**
133	* This dimension's name within the Google Analytics user interface. For
134	* example, `Event name`.
135	*
136	* Generated from protobuf field <code>string ui_name = 2;</code>
137	* @param string $var
138	* @return $this
139	*/
140	public function setUiName($var)
141	{
142	GPBUtil::checkString($var, True);
143	$this->ui_name = $var;
144
145	return $this;
146	}
147
148	/**
149	* Description of how this dimension is used and calculated.
150	*
151	* Generated from protobuf field <code>string description = 3;</code>
152	* @return string
153	*/
154	public function getDescription()
155	{
156	return $this->description;
157	}
158
159	/**
160	* Description of how this dimension is used and calculated.
161	*
162	* Generated from protobuf field <code>string description = 3;</code>
163	* @param string $var
164	* @return $this
165	*/
166	public function setDescription($var)
167	{
168	GPBUtil::checkString($var, True);
169	$this->description = $var;
170
171	return $this;
172	}
173
174	/**
175	* Still usable but deprecated names for this dimension. If populated, this
176	* dimension is available by either `apiName` or one of `deprecatedApiNames`
177	* for a period of time. After the deprecation period, the dimension will be
178	* available only by `apiName`.
179	*
180	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
181	* @return \Google\Protobuf\Internal\RepeatedField
182	*/
183	public function getDeprecatedApiNames()
184	{
185	return $this->deprecated_api_names;
186	}
187
188	/**
189	* Still usable but deprecated names for this dimension. If populated, this
190	* dimension is available by either `apiName` or one of `deprecatedApiNames`
191	* for a period of time. After the deprecation period, the dimension will be
192	* available only by `apiName`.
193	*
194	* Generated from protobuf field <code>repeated string deprecated_api_names = 4;</code>
195	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
196	* @return $this
197	*/
198	public function setDeprecatedApiNames($var)
199	{
200	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
201	$this->deprecated_api_names = $arr;
202
203	return $this;
204	}
205
206	/**
207	* True if the dimension is a custom dimension for this property.
208	*
209	* Generated from protobuf field <code>bool custom_definition = 5;</code>
210	* @return bool
211	*/
212	public function getCustomDefinition()
213	{
214	return $this->custom_definition;
215	}
216
217	/**
218	* True if the dimension is a custom dimension for this property.
219	*
220	* Generated from protobuf field <code>bool custom_definition = 5;</code>
221	* @param bool $var
222	* @return $this
223	*/
224	public function setCustomDefinition($var)
225	{
226	GPBUtil::checkBool($var);
227	$this->custom_definition = $var;
228
229	return $this;
230	}
231
232	/**
233	* The display name of the category that this dimension belongs to. Similar
234	* dimensions and metrics are categorized together.
235	*
236	* Generated from protobuf field <code>string category = 7;</code>
237	* @return string
238	*/
239	public function getCategory()
240	{
241	return $this->category;
242	}
243
244	/**
245	* The display name of the category that this dimension belongs to. Similar
246	* dimensions and metrics are categorized together.
247	*
248	* Generated from protobuf field <code>string category = 7;</code>
249	* @param string $var
250	* @return $this
251	*/
252	public function setCategory($var)
253	{
254	GPBUtil::checkString($var, True);
255	$this->category = $var;
256
257	return $this;
258	}
259
260	}
261
262