CustomDimension.php — ShareThis Dashboard for Google Analytics 3.2.2

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsAdmin / src / V1alpha / CustomDimension.php

googleanalytics / lib / analytics-admin / vendor / google / cloud / AnalyticsAdmin / src / V1alpha Last commit date

CustomDimension.php

290 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/analytics/admin/v1alpha/resources.proto
4
5	namespace Google\Analytics\Admin\V1alpha;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* A definition for a CustomDimension.
13	*
14	* Generated from protobuf message <code>google.analytics.admin.v1alpha.CustomDimension</code>
15	*/
16	class CustomDimension extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* Output only. Resource name for this CustomDimension resource.
20	* Format: properties/{property}/customDimensions/{customDimension}
21	*
22	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
23	*/
24	private $name = '';
25	/**
26	* Required. Immutable. Tagging parameter name for this custom dimension.
27	* If this is a user-scoped dimension, then this is the user property name.
28	* If this is an event-scoped dimension, then this is the event parameter
29	* name.
30	* May only contain alphanumeric and underscore characters, starting with a
31	* letter. Max length of 24 characters for user-scoped dimensions, 40
32	* characters for event-scoped dimensions.
33	*
34	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
35	*/
36	private $parameter_name = '';
37	/**
38	* Required. Display name for this custom dimension as shown in the Analytics UI.
39	* Max length of 82 characters, alphanumeric plus space and underscore
40	* starting with a letter. Legacy system-generated display names may contain
41	* square brackets, but updates to this field will never permit square
42	* brackets.
43	*
44	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
45	*/
46	private $display_name = '';
47	/**
48	* Optional. Description for this custom dimension. Max length of 150 characters.
49	*
50	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
51	*/
52	private $description = '';
53	/**
54	* Required. Immutable. The scope of this dimension.
55	*
56	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
57	*/
58	private $scope = 0;
59	/**
60	* Optional. If set to true, sets this dimension as NPA and excludes it from ads
61	* personalization.
62	* This is currently only supported by user-scoped custom dimensions.
63	*
64	* Generated from protobuf field <code>bool disallow_ads_personalization = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
65	*/
66	private $disallow_ads_personalization = false;
67
68	/**
69	* Constructor.
70	*
71	* @param array $data {
72	* Optional. Data for populating the Message object.
73	*
74	* @type string $name
75	* Output only. Resource name for this CustomDimension resource.
76	* Format: properties/{property}/customDimensions/{customDimension}
77	* @type string $parameter_name
78	* Required. Immutable. Tagging parameter name for this custom dimension.
79	* If this is a user-scoped dimension, then this is the user property name.
80	* If this is an event-scoped dimension, then this is the event parameter
81	* name.
82	* May only contain alphanumeric and underscore characters, starting with a
83	* letter. Max length of 24 characters for user-scoped dimensions, 40
84	* characters for event-scoped dimensions.
85	* @type string $display_name
86	* Required. Display name for this custom dimension as shown in the Analytics UI.
87	* Max length of 82 characters, alphanumeric plus space and underscore
88	* starting with a letter. Legacy system-generated display names may contain
89	* square brackets, but updates to this field will never permit square
90	* brackets.
91	* @type string $description
92	* Optional. Description for this custom dimension. Max length of 150 characters.
93	* @type int $scope
94	* Required. Immutable. The scope of this dimension.
95	* @type bool $disallow_ads_personalization
96	* Optional. If set to true, sets this dimension as NPA and excludes it from ads
97	* personalization.
98	* This is currently only supported by user-scoped custom dimensions.
99	* }
100	*/
101	public function __construct($data = NULL) {
102	\GPBMetadata\Google\Analytics\Admin\V1Alpha\Resources::initOnce();
103	parent::__construct($data);
104	}
105
106	/**
107	* Output only. Resource name for this CustomDimension resource.
108	* Format: properties/{property}/customDimensions/{customDimension}
109	*
110	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
111	* @return string
112	*/
113	public function getName()
114	{
115	return $this->name;
116	}
117
118	/**
119	* Output only. Resource name for this CustomDimension resource.
120	* Format: properties/{property}/customDimensions/{customDimension}
121	*
122	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
123	* @param string $var
124	* @return $this
125	*/
126	public function setName($var)
127	{
128	GPBUtil::checkString($var, True);
129	$this->name = $var;
130
131	return $this;
132	}
133
134	/**
135	* Required. Immutable. Tagging parameter name for this custom dimension.
136	* If this is a user-scoped dimension, then this is the user property name.
137	* If this is an event-scoped dimension, then this is the event parameter
138	* name.
139	* May only contain alphanumeric and underscore characters, starting with a
140	* letter. Max length of 24 characters for user-scoped dimensions, 40
141	* characters for event-scoped dimensions.
142	*
143	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
144	* @return string
145	*/
146	public function getParameterName()
147	{
148	return $this->parameter_name;
149	}
150
151	/**
152	* Required. Immutable. Tagging parameter name for this custom dimension.
153	* If this is a user-scoped dimension, then this is the user property name.
154	* If this is an event-scoped dimension, then this is the event parameter
155	* name.
156	* May only contain alphanumeric and underscore characters, starting with a
157	* letter. Max length of 24 characters for user-scoped dimensions, 40
158	* characters for event-scoped dimensions.
159	*
160	* Generated from protobuf field <code>string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
161	* @param string $var
162	* @return $this
163	*/
164	public function setParameterName($var)
165	{
166	GPBUtil::checkString($var, True);
167	$this->parameter_name = $var;
168
169	return $this;
170	}
171
172	/**
173	* Required. Display name for this custom dimension as shown in the Analytics UI.
174	* Max length of 82 characters, alphanumeric plus space and underscore
175	* starting with a letter. Legacy system-generated display names may contain
176	* square brackets, but updates to this field will never permit square
177	* brackets.
178	*
179	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
180	* @return string
181	*/
182	public function getDisplayName()
183	{
184	return $this->display_name;
185	}
186
187	/**
188	* Required. Display name for this custom dimension as shown in the Analytics UI.
189	* Max length of 82 characters, alphanumeric plus space and underscore
190	* starting with a letter. Legacy system-generated display names may contain
191	* square brackets, but updates to this field will never permit square
192	* brackets.
193	*
194	* Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
195	* @param string $var
196	* @return $this
197	*/
198	public function setDisplayName($var)
199	{
200	GPBUtil::checkString($var, True);
201	$this->display_name = $var;
202
203	return $this;
204	}
205
206	/**
207	* Optional. Description for this custom dimension. Max length of 150 characters.
208	*
209	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
210	* @return string
211	*/
212	public function getDescription()
213	{
214	return $this->description;
215	}
216
217	/**
218	* Optional. Description for this custom dimension. Max length of 150 characters.
219	*
220	* Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
221	* @param string $var
222	* @return $this
223	*/
224	public function setDescription($var)
225	{
226	GPBUtil::checkString($var, True);
227	$this->description = $var;
228
229	return $this;
230	}
231
232	/**
233	* Required. Immutable. The scope of this dimension.
234	*
235	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
236	* @return int
237	*/
238	public function getScope()
239	{
240	return $this->scope;
241	}
242
243	/**
244	* Required. Immutable. The scope of this dimension.
245	*
246	* Generated from protobuf field <code>.google.analytics.admin.v1alpha.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];</code>
247	* @param int $var
248	* @return $this
249	*/
250	public function setScope($var)
251	{
252	GPBUtil::checkEnum($var, \Google\Analytics\Admin\V1alpha\CustomDimension\DimensionScope::class);
253	$this->scope = $var;
254
255	return $this;
256	}
257
258	/**
259	* Optional. If set to true, sets this dimension as NPA and excludes it from ads
260	* personalization.
261	* This is currently only supported by user-scoped custom dimensions.
262	*
263	* Generated from protobuf field <code>bool disallow_ads_personalization = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
264	* @return bool
265	*/
266	public function getDisallowAdsPersonalization()
267	{
268	return $this->disallow_ads_personalization;
269	}
270
271	/**
272	* Optional. If set to true, sets this dimension as NPA and excludes it from ads
273	* personalization.
274	* This is currently only supported by user-scoped custom dimensions.
275	*
276	* Generated from protobuf field <code>bool disallow_ads_personalization = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
277	* @param bool $var
278	* @return $this
279	*/
280	public function setDisallowAdsPersonalization($var)
281	{
282	GPBUtil::checkBool($var);
283	$this->disallow_ads_personalization = $var;
284
285	return $this;
286	}
287
288	}
289
290