EnhancedMeasurementSettings.php — ShareThis Dashboard for Google Analytics trunk

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

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

EnhancedMeasurementSettings.php

503 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	* Singleton resource under a WebDataStream, configuring measurement of
13	* additional site interactions and content.
14	*
15	* Generated from protobuf message <code>google.analytics.admin.v1alpha.EnhancedMeasurementSettings</code>
16	*/
17	class EnhancedMeasurementSettings extends \Google\Protobuf\Internal\Message
18	{
19	/**
20	* Output only. Resource name of this Data Stream.
21	* Format:
22	* properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
23	* Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
24	*
25	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
26	*/
27	private $name = '';
28	/**
29	* Indicates whether Enhanced Measurement Settings will be used to
30	* automatically measure interactions and content on this web stream.
31	* Changing this value does not affect the settings themselves, but determines
32	* whether they are respected.
33	*
34	* Generated from protobuf field <code>bool stream_enabled = 2;</code>
35	*/
36	private $stream_enabled = false;
37	/**
38	* Output only. If enabled, capture a page view event each time a page loads or the
39	* website changes the browser history state.
40	*
41	* Generated from protobuf field <code>bool page_views_enabled = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
42	*/
43	private $page_views_enabled = false;
44	/**
45	* If enabled, capture scroll events each time a visitor gets to the bottom of
46	* a page.
47	*
48	* Generated from protobuf field <code>bool scrolls_enabled = 4;</code>
49	*/
50	private $scrolls_enabled = false;
51	/**
52	* If enabled, capture an outbound click event each time a visitor clicks a
53	* link that leads them away from your domain.
54	*
55	* Generated from protobuf field <code>bool outbound_clicks_enabled = 5;</code>
56	*/
57	private $outbound_clicks_enabled = false;
58	/**
59	* If enabled, capture a view search results event each time a visitor
60	* performs a search on your site (based on a query parameter).
61	*
62	* Generated from protobuf field <code>bool site_search_enabled = 7;</code>
63	*/
64	private $site_search_enabled = false;
65	/**
66	* If enabled, capture video play, progress, and complete events as visitors
67	* view embedded videos on your site.
68	*
69	* Generated from protobuf field <code>bool video_engagement_enabled = 9;</code>
70	*/
71	private $video_engagement_enabled = false;
72	/**
73	* If enabled, capture a file download event each time a link is clicked with
74	* a common document, compressed file, application, video, or audio extension.
75	*
76	* Generated from protobuf field <code>bool file_downloads_enabled = 10;</code>
77	*/
78	private $file_downloads_enabled = false;
79	/**
80	* Output only. If enabled, capture a page view event each time a page loads.
81	*
82	* Generated from protobuf field <code>bool page_loads_enabled = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
83	*/
84	private $page_loads_enabled = false;
85	/**
86	* If enabled, capture a page view event each time the website changes the
87	* browser history state.
88	*
89	* Generated from protobuf field <code>bool page_changes_enabled = 13;</code>
90	*/
91	private $page_changes_enabled = false;
92	/**
93	* Required. URL query parameters to interpret as site search parameters.
94	* Max length is 1024 characters. Must not be empty.
95	*
96	* Generated from protobuf field <code>string search_query_parameter = 16 [(.google.api.field_behavior) = REQUIRED];</code>
97	*/
98	private $search_query_parameter = '';
99	/**
100	* Additional URL query parameters.
101	* Max length is 1024 characters.
102	*
103	* Generated from protobuf field <code>string uri_query_parameter = 17;</code>
104	*/
105	private $uri_query_parameter = '';
106
107	/**
108	* Constructor.
109	*
110	* @param array $data {
111	* Optional. Data for populating the Message object.
112	*
113	* @type string $name
114	* Output only. Resource name of this Data Stream.
115	* Format:
116	* properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
117	* Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
118	* @type bool $stream_enabled
119	* Indicates whether Enhanced Measurement Settings will be used to
120	* automatically measure interactions and content on this web stream.
121	* Changing this value does not affect the settings themselves, but determines
122	* whether they are respected.
123	* @type bool $page_views_enabled
124	* Output only. If enabled, capture a page view event each time a page loads or the
125	* website changes the browser history state.
126	* @type bool $scrolls_enabled
127	* If enabled, capture scroll events each time a visitor gets to the bottom of
128	* a page.
129	* @type bool $outbound_clicks_enabled
130	* If enabled, capture an outbound click event each time a visitor clicks a
131	* link that leads them away from your domain.
132	* @type bool $site_search_enabled
133	* If enabled, capture a view search results event each time a visitor
134	* performs a search on your site (based on a query parameter).
135	* @type bool $video_engagement_enabled
136	* If enabled, capture video play, progress, and complete events as visitors
137	* view embedded videos on your site.
138	* @type bool $file_downloads_enabled
139	* If enabled, capture a file download event each time a link is clicked with
140	* a common document, compressed file, application, video, or audio extension.
141	* @type bool $page_loads_enabled
142	* Output only. If enabled, capture a page view event each time a page loads.
143	* @type bool $page_changes_enabled
144	* If enabled, capture a page view event each time the website changes the
145	* browser history state.
146	* @type string $search_query_parameter
147	* Required. URL query parameters to interpret as site search parameters.
148	* Max length is 1024 characters. Must not be empty.
149	* @type string $uri_query_parameter
150	* Additional URL query parameters.
151	* Max length is 1024 characters.
152	* }
153	*/
154	public function __construct($data = NULL) {
155	\GPBMetadata\Google\Analytics\Admin\V1Alpha\Resources::initOnce();
156	parent::__construct($data);
157	}
158
159	/**
160	* Output only. Resource name of this Data Stream.
161	* Format:
162	* properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
163	* Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
164	*
165	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
166	* @return string
167	*/
168	public function getName()
169	{
170	return $this->name;
171	}
172
173	/**
174	* Output only. Resource name of this Data Stream.
175	* Format:
176	* properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
177	* Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
178	*
179	* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
180	* @param string $var
181	* @return $this
182	*/
183	public function setName($var)
184	{
185	GPBUtil::checkString($var, True);
186	$this->name = $var;
187
188	return $this;
189	}
190
191	/**
192	* Indicates whether Enhanced Measurement Settings will be used to
193	* automatically measure interactions and content on this web stream.
194	* Changing this value does not affect the settings themselves, but determines
195	* whether they are respected.
196	*
197	* Generated from protobuf field <code>bool stream_enabled = 2;</code>
198	* @return bool
199	*/
200	public function getStreamEnabled()
201	{
202	return $this->stream_enabled;
203	}
204
205	/**
206	* Indicates whether Enhanced Measurement Settings will be used to
207	* automatically measure interactions and content on this web stream.
208	* Changing this value does not affect the settings themselves, but determines
209	* whether they are respected.
210	*
211	* Generated from protobuf field <code>bool stream_enabled = 2;</code>
212	* @param bool $var
213	* @return $this
214	*/
215	public function setStreamEnabled($var)
216	{
217	GPBUtil::checkBool($var);
218	$this->stream_enabled = $var;
219
220	return $this;
221	}
222
223	/**
224	* Output only. If enabled, capture a page view event each time a page loads or the
225	* website changes the browser history state.
226	*
227	* Generated from protobuf field <code>bool page_views_enabled = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
228	* @return bool
229	*/
230	public function getPageViewsEnabled()
231	{
232	return $this->page_views_enabled;
233	}
234
235	/**
236	* Output only. If enabled, capture a page view event each time a page loads or the
237	* website changes the browser history state.
238	*
239	* Generated from protobuf field <code>bool page_views_enabled = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
240	* @param bool $var
241	* @return $this
242	*/
243	public function setPageViewsEnabled($var)
244	{
245	GPBUtil::checkBool($var);
246	$this->page_views_enabled = $var;
247
248	return $this;
249	}
250
251	/**
252	* If enabled, capture scroll events each time a visitor gets to the bottom of
253	* a page.
254	*
255	* Generated from protobuf field <code>bool scrolls_enabled = 4;</code>
256	* @return bool
257	*/
258	public function getScrollsEnabled()
259	{
260	return $this->scrolls_enabled;
261	}
262
263	/**
264	* If enabled, capture scroll events each time a visitor gets to the bottom of
265	* a page.
266	*
267	* Generated from protobuf field <code>bool scrolls_enabled = 4;</code>
268	* @param bool $var
269	* @return $this
270	*/
271	public function setScrollsEnabled($var)
272	{
273	GPBUtil::checkBool($var);
274	$this->scrolls_enabled = $var;
275
276	return $this;
277	}
278
279	/**
280	* If enabled, capture an outbound click event each time a visitor clicks a
281	* link that leads them away from your domain.
282	*
283	* Generated from protobuf field <code>bool outbound_clicks_enabled = 5;</code>
284	* @return bool
285	*/
286	public function getOutboundClicksEnabled()
287	{
288	return $this->outbound_clicks_enabled;
289	}
290
291	/**
292	* If enabled, capture an outbound click event each time a visitor clicks a
293	* link that leads them away from your domain.
294	*
295	* Generated from protobuf field <code>bool outbound_clicks_enabled = 5;</code>
296	* @param bool $var
297	* @return $this
298	*/
299	public function setOutboundClicksEnabled($var)
300	{
301	GPBUtil::checkBool($var);
302	$this->outbound_clicks_enabled = $var;
303
304	return $this;
305	}
306
307	/**
308	* If enabled, capture a view search results event each time a visitor
309	* performs a search on your site (based on a query parameter).
310	*
311	* Generated from protobuf field <code>bool site_search_enabled = 7;</code>
312	* @return bool
313	*/
314	public function getSiteSearchEnabled()
315	{
316	return $this->site_search_enabled;
317	}
318
319	/**
320	* If enabled, capture a view search results event each time a visitor
321	* performs a search on your site (based on a query parameter).
322	*
323	* Generated from protobuf field <code>bool site_search_enabled = 7;</code>
324	* @param bool $var
325	* @return $this
326	*/
327	public function setSiteSearchEnabled($var)
328	{
329	GPBUtil::checkBool($var);
330	$this->site_search_enabled = $var;
331
332	return $this;
333	}
334
335	/**
336	* If enabled, capture video play, progress, and complete events as visitors
337	* view embedded videos on your site.
338	*
339	* Generated from protobuf field <code>bool video_engagement_enabled = 9;</code>
340	* @return bool
341	*/
342	public function getVideoEngagementEnabled()
343	{
344	return $this->video_engagement_enabled;
345	}
346
347	/**
348	* If enabled, capture video play, progress, and complete events as visitors
349	* view embedded videos on your site.
350	*
351	* Generated from protobuf field <code>bool video_engagement_enabled = 9;</code>
352	* @param bool $var
353	* @return $this
354	*/
355	public function setVideoEngagementEnabled($var)
356	{
357	GPBUtil::checkBool($var);
358	$this->video_engagement_enabled = $var;
359
360	return $this;
361	}
362
363	/**
364	* If enabled, capture a file download event each time a link is clicked with
365	* a common document, compressed file, application, video, or audio extension.
366	*
367	* Generated from protobuf field <code>bool file_downloads_enabled = 10;</code>
368	* @return bool
369	*/
370	public function getFileDownloadsEnabled()
371	{
372	return $this->file_downloads_enabled;
373	}
374
375	/**
376	* If enabled, capture a file download event each time a link is clicked with
377	* a common document, compressed file, application, video, or audio extension.
378	*
379	* Generated from protobuf field <code>bool file_downloads_enabled = 10;</code>
380	* @param bool $var
381	* @return $this
382	*/
383	public function setFileDownloadsEnabled($var)
384	{
385	GPBUtil::checkBool($var);
386	$this->file_downloads_enabled = $var;
387
388	return $this;
389	}
390
391	/**
392	* Output only. If enabled, capture a page view event each time a page loads.
393	*
394	* Generated from protobuf field <code>bool page_loads_enabled = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
395	* @return bool
396	*/
397	public function getPageLoadsEnabled()
398	{
399	return $this->page_loads_enabled;
400	}
401
402	/**
403	* Output only. If enabled, capture a page view event each time a page loads.
404	*
405	* Generated from protobuf field <code>bool page_loads_enabled = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
406	* @param bool $var
407	* @return $this
408	*/
409	public function setPageLoadsEnabled($var)
410	{
411	GPBUtil::checkBool($var);
412	$this->page_loads_enabled = $var;
413
414	return $this;
415	}
416
417	/**
418	* If enabled, capture a page view event each time the website changes the
419	* browser history state.
420	*
421	* Generated from protobuf field <code>bool page_changes_enabled = 13;</code>
422	* @return bool
423	*/
424	public function getPageChangesEnabled()
425	{
426	return $this->page_changes_enabled;
427	}
428
429	/**
430	* If enabled, capture a page view event each time the website changes the
431	* browser history state.
432	*
433	* Generated from protobuf field <code>bool page_changes_enabled = 13;</code>
434	* @param bool $var
435	* @return $this
436	*/
437	public function setPageChangesEnabled($var)
438	{
439	GPBUtil::checkBool($var);
440	$this->page_changes_enabled = $var;
441
442	return $this;
443	}
444
445	/**
446	* Required. URL query parameters to interpret as site search parameters.
447	* Max length is 1024 characters. Must not be empty.
448	*
449	* Generated from protobuf field <code>string search_query_parameter = 16 [(.google.api.field_behavior) = REQUIRED];</code>
450	* @return string
451	*/
452	public function getSearchQueryParameter()
453	{
454	return $this->search_query_parameter;
455	}
456
457	/**
458	* Required. URL query parameters to interpret as site search parameters.
459	* Max length is 1024 characters. Must not be empty.
460	*
461	* Generated from protobuf field <code>string search_query_parameter = 16 [(.google.api.field_behavior) = REQUIRED];</code>
462	* @param string $var
463	* @return $this
464	*/
465	public function setSearchQueryParameter($var)
466	{
467	GPBUtil::checkString($var, True);
468	$this->search_query_parameter = $var;
469
470	return $this;
471	}
472
473	/**
474	* Additional URL query parameters.
475	* Max length is 1024 characters.
476	*
477	* Generated from protobuf field <code>string uri_query_parameter = 17;</code>
478	* @return string
479	*/
480	public function getUriQueryParameter()
481	{
482	return $this->uri_query_parameter;
483	}
484
485	/**
486	* Additional URL query parameters.
487	* Max length is 1024 characters.
488	*
489	* Generated from protobuf field <code>string uri_query_parameter = 17;</code>
490	* @param string $var
491	* @return $this
492	*/
493	public function setUriQueryParameter($var)
494	{
495	GPBUtil::checkString($var, True);
496	$this->uri_query_parameter = $var;
497
498	return $this;
499	}
500
501	}
502
503