1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/analytics/admin/v1alpha/resources.proto 18 19 package com.google.analytics.admin.v1alpha; 20 21 public interface EnhancedMeasurementSettingsOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.admin.v1alpha.EnhancedMeasurementSettings) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. Resource name of the Enhanced Measurement Settings. 31 * Format: 32 * properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings 33 * Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" 34 * </pre> 35 * 36 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 37 * 38 * @return The name. 39 */ getName()40 java.lang.String getName(); 41 /** 42 * 43 * 44 * <pre> 45 * Output only. Resource name of the Enhanced Measurement Settings. 46 * Format: 47 * properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings 48 * Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" 49 * </pre> 50 * 51 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 52 * 53 * @return The bytes for name. 54 */ getNameBytes()55 com.google.protobuf.ByteString getNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Indicates whether Enhanced Measurement Settings will be used to 62 * automatically measure interactions and content on this web stream. 63 * Changing this value does not affect the settings themselves, but determines 64 * whether they are respected. 65 * </pre> 66 * 67 * <code>bool stream_enabled = 2;</code> 68 * 69 * @return The streamEnabled. 70 */ getStreamEnabled()71 boolean getStreamEnabled(); 72 73 /** 74 * 75 * 76 * <pre> 77 * If enabled, capture scroll events each time a visitor gets to the bottom of 78 * a page. 79 * </pre> 80 * 81 * <code>bool scrolls_enabled = 3;</code> 82 * 83 * @return The scrollsEnabled. 84 */ getScrollsEnabled()85 boolean getScrollsEnabled(); 86 87 /** 88 * 89 * 90 * <pre> 91 * If enabled, capture an outbound click event each time a visitor clicks a 92 * link that leads them away from your domain. 93 * </pre> 94 * 95 * <code>bool outbound_clicks_enabled = 4;</code> 96 * 97 * @return The outboundClicksEnabled. 98 */ getOutboundClicksEnabled()99 boolean getOutboundClicksEnabled(); 100 101 /** 102 * 103 * 104 * <pre> 105 * If enabled, capture a view search results event each time a visitor 106 * performs a search on your site (based on a query parameter). 107 * </pre> 108 * 109 * <code>bool site_search_enabled = 5;</code> 110 * 111 * @return The siteSearchEnabled. 112 */ getSiteSearchEnabled()113 boolean getSiteSearchEnabled(); 114 115 /** 116 * 117 * 118 * <pre> 119 * If enabled, capture video play, progress, and complete events as visitors 120 * view embedded videos on your site. 121 * </pre> 122 * 123 * <code>bool video_engagement_enabled = 6;</code> 124 * 125 * @return The videoEngagementEnabled. 126 */ getVideoEngagementEnabled()127 boolean getVideoEngagementEnabled(); 128 129 /** 130 * 131 * 132 * <pre> 133 * If enabled, capture a file download event each time a link is clicked with 134 * a common document, compressed file, application, video, or audio extension. 135 * </pre> 136 * 137 * <code>bool file_downloads_enabled = 7;</code> 138 * 139 * @return The fileDownloadsEnabled. 140 */ getFileDownloadsEnabled()141 boolean getFileDownloadsEnabled(); 142 143 /** 144 * 145 * 146 * <pre> 147 * If enabled, capture a page view event each time the website changes the 148 * browser history state. 149 * </pre> 150 * 151 * <code>bool page_changes_enabled = 8;</code> 152 * 153 * @return The pageChangesEnabled. 154 */ getPageChangesEnabled()155 boolean getPageChangesEnabled(); 156 157 /** 158 * 159 * 160 * <pre> 161 * If enabled, capture a form interaction event each time a visitor interacts 162 * with a form on your website. 163 * False by default. 164 * </pre> 165 * 166 * <code>bool form_interactions_enabled = 9;</code> 167 * 168 * @return The formInteractionsEnabled. 169 */ getFormInteractionsEnabled()170 boolean getFormInteractionsEnabled(); 171 172 /** 173 * 174 * 175 * <pre> 176 * Required. URL query parameters to interpret as site search parameters. 177 * Max length is 1024 characters. Must not be empty. 178 * </pre> 179 * 180 * <code>string search_query_parameter = 10 [(.google.api.field_behavior) = REQUIRED];</code> 181 * 182 * @return The searchQueryParameter. 183 */ getSearchQueryParameter()184 java.lang.String getSearchQueryParameter(); 185 /** 186 * 187 * 188 * <pre> 189 * Required. URL query parameters to interpret as site search parameters. 190 * Max length is 1024 characters. Must not be empty. 191 * </pre> 192 * 193 * <code>string search_query_parameter = 10 [(.google.api.field_behavior) = REQUIRED];</code> 194 * 195 * @return The bytes for searchQueryParameter. 196 */ getSearchQueryParameterBytes()197 com.google.protobuf.ByteString getSearchQueryParameterBytes(); 198 199 /** 200 * 201 * 202 * <pre> 203 * Additional URL query parameters. 204 * Max length is 1024 characters. 205 * </pre> 206 * 207 * <code>string uri_query_parameter = 11;</code> 208 * 209 * @return The uriQueryParameter. 210 */ getUriQueryParameter()211 java.lang.String getUriQueryParameter(); 212 /** 213 * 214 * 215 * <pre> 216 * Additional URL query parameters. 217 * Max length is 1024 characters. 218 * </pre> 219 * 220 * <code>string uri_query_parameter = 11;</code> 221 * 222 * @return The bytes for uriQueryParameter. 223 */ getUriQueryParameterBytes()224 com.google.protobuf.ByteString getUriQueryParameterBytes(); 225 } 226