Debian Codegraph @

docs/dyn/analyticsadmin_v1beta.properties.keyEvents.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_v1beta.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1beta.properties.html">properties</a> . <a href="analyticsadmin_v1beta.properties.keyEvents.html">keyEvents</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 Key Event.</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 Key Event.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieve a single Key Event.</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">Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.</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 Key Event.</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 Key Event.
107
108 Args:
109 parent: string, Required. The resource name of the parent property where this Key Event will be created. Format: properties/123 (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A key event in a Google Analytics property.
114 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
115 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
116 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
117 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
118 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
119 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
120 },
121 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
122 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
123 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
124 }
125
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # A key event in a Google Analytics property.
135 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
136 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
137 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
138 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
139 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
140 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
141 },
142 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
143 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
144 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
145 }</pre>
146 </div>
147
148 <div class="method">
149 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
150 <pre>Deletes a Key Event.
151
152 Args:
153 name: string, Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: &quot;properties/123/keyEvents/456&quot; (required)
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159 Returns:
160 An object of the form:
161
162 { # 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); }
163 }</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="get">get(name, x__xgafv=None)</code>
168 <pre>Retrieve a single Key Event.
169
170 Args:
171 name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: &quot;properties/123/keyEvents/456&quot; (required)
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176
177 Returns:
178 An object of the form:
179
180 { # A key event in a Google Analytics property.
181 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
182 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
183 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
184 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
185 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
186 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
187 },
188 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
189 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
190 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
191 }</pre>
192 </div>
193
194 <div class="method">
195 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
196 <pre>Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
197
198 Args:
199 parent: string, Required. The resource name of the parent property. Example: &#x27;properties/123&#x27; (required)
200 pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
201 pageToken: string, Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.
202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
206
207 Returns:
208 An object of the form:
209
210 { # Response message for ListKeyEvents RPC.
211 &quot;keyEvents&quot;: [ # The requested Key Events
212 { # A key event in a Google Analytics property.
213 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
214 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
215 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
216 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
217 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
218 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
219 },
220 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
221 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
222 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
223 },
224 ],
225 &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.
226 }</pre>
227 </div>
228
229 <div class="method">
230 <code class="details" id="list_next">list_next()</code>
231 <pre>Retrieves the next page of results.
232
233 Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237 Returns:
238 A request object that you can call &#x27;execute()&#x27; on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241 </div>
242
243 <div class="method">
244 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
245 <pre>Updates a Key Event.
246
247 Args:
248 name: string, Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} (required)
249 body: object, The request body.
250 The object takes the form of:
251
252 { # A key event in a Google Analytics property.
253 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
254 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
255 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
256 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
257 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
258 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
259 },
260 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
261 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
262 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
263 }
264
265 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &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.
266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271 Returns:
272 An object of the form:
273
274 { # A key event in a Google Analytics property.
275 &quot;countingMethod&quot;: &quot;A String&quot;, # Required. The method by which Key Events will be counted across multiple events within a session.
276 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this key event was created in the property.
277 &quot;custom&quot;: True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
278 &quot;defaultValue&quot;: { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
279 &quot;currencyCode&quot;: &quot;A String&quot;, # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
280 &quot;numericValue&quot;: 3.14, # Required. This will be used to populate the &quot;value&quot; parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
281 },
282 &quot;deletable&quot;: True or False, # Output only. If set to true, this event can be deleted.
283 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this key event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
284 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
285 }</pre>
286 </div>
287
288 </body></html>