Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.subpropertyEventFilters.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.subpropertyEventFilters.html">subpropertyEventFilters</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a subproperty Event Filter.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a subproperty event filter.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lookup for a single subproperty Event Filter.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">List all subproperty Event Filters on a property.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a subproperty Event Filter.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
106 <pre>Creates a subproperty Event Filter.
107
108 Args:
109 parent: string, Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123 (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A resource message representing a Google Analytics subproperty event filter.
114 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
115 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
116 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
117 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
118 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
119 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
120 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
121 &quot;nullFilter&quot;: True or False, # A filter for null values.
122 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
123 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
124 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
125 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
126 },
127 },
128 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
129 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
130 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
131 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
132 ],
133 },
134 },
135 },
136 ],
137 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145 Returns:
146 An object of the form:
147
148 { # A resource message representing a Google Analytics subproperty event filter.
149 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
150 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
151 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
152 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
153 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
154 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
155 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
156 &quot;nullFilter&quot;: True or False, # A filter for null values.
157 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
158 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
159 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
160 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
161 },
162 },
163 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
164 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
165 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
166 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
167 ],
168 },
169 },
170 },
171 ],
172 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
173 }</pre>
174 </div>
175
176 <div class="method">
177 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
178 <pre>Deletes a subproperty event filter.
179
180 Args:
181 name: string, Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 (required)
182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187 Returns:
188 An object of the form:
189
190 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
191 }</pre>
192 </div>
193
194 <div class="method">
195 <code class="details" id="get">get(name, x__xgafv=None)</code>
196 <pre>Lookup for a single subproperty Event Filter.
197
198 Args:
199 name: string, Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 (required)
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205 Returns:
206 An object of the form:
207
208 { # A resource message representing a Google Analytics subproperty event filter.
209 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
210 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
211 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
212 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
213 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
214 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
215 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
216 &quot;nullFilter&quot;: True or False, # A filter for null values.
217 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
218 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
219 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
220 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
221 },
222 },
223 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
224 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
225 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
226 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
227 ],
228 },
229 },
230 },
231 ],
232 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
233 }</pre>
234 </div>
235
236 <div class="method">
237 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
238 <pre>List all subproperty Event Filters on a property.
239
240 Args:
241 parent: string, Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123 (required)
242 pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
243 pageToken: string, Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token.
244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
248
249 Returns:
250 An object of the form:
251
252 { # Response message for ListSubpropertyEventFilter RPC.
253 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
254 &quot;subpropertyEventFilters&quot;: [ # List of subproperty event filters.
255 { # A resource message representing a Google Analytics subproperty event filter.
256 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
257 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
258 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
259 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
260 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
261 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
262 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
263 &quot;nullFilter&quot;: True or False, # A filter for null values.
264 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
265 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
266 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
267 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
268 },
269 },
270 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
271 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
272 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
273 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
274 ],
275 },
276 },
277 },
278 ],
279 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
280 },
281 ],
282 }</pre>
283 </div>
284
285 <div class="method">
286 <code class="details" id="list_next">list_next()</code>
287 <pre>Retrieves the next page of results.
288
289 Args:
290 previous_request: The request for the previous page. (required)
291 previous_response: The response from the request for the previous page. (required)
292
293 Returns:
294 A request object that you can call &#x27;execute()&#x27; on to request the next
295 page. Returns None if there are no more items in the collection.
296 </pre>
297 </div>
298
299 <div class="method">
300 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
301 <pre>Updates a subproperty Event Filter.
302
303 Args:
304 name: string, Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678 (required)
305 body: object, The request body.
306 The object takes the form of:
307
308 { # A resource message representing a Google Analytics subproperty event filter.
309 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
310 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
311 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
312 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
313 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
314 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
315 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
316 &quot;nullFilter&quot;: True or False, # A filter for null values.
317 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
318 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
319 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
320 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
321 },
322 },
323 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
324 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
325 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
326 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
327 ],
328 },
329 },
330 },
331 ],
332 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
333 }
334
335 updateMask: string, Required. The list of fields to update. Field names must be in snake case (for example, &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
336 x__xgafv: string, V1 error format.
337 Allowed values
338 1 - v1 error format
339 2 - v2 error format
340
341 Returns:
342 An object of the form:
343
344 { # A resource message representing a Google Analytics subproperty event filter.
345 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
346 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
347 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
348 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
349 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
350 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
351 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
352 &quot;nullFilter&quot;: True or False, # A filter for null values.
353 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
354 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
355 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
356 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
357 },
358 },
359 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
360 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
361 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
362 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
363 ],
364 },
365 },
366 },
367 ],
368 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
369 }</pre>
370 </div>
371
372 </body></html>