blob: e8b5759ac7c01966728d3d2eb3ba22ac1b26a11a [file] [log] [blame]
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.conversionEvents.html">conversionEvents</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 conversion event with the specified attributes.</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 conversion event in a property.</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 conversion 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 conversion events in the specified parent property. Returns an empty list if no conversion events are found.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Creates a conversion event with the specified attributes.
104
105Args:
106 parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
107 body: object, The request body.
108 The object takes the form of:
109
110{ # A conversion event in a Google Analytics property.
111 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700112 &quot;custom&quot;: True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700113 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
114 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
115 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
116}
117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
126 { # A conversion event in a Google Analytics property.
127 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700128 &quot;custom&quot;: True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700129 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
130 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
131 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
132}</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
137 <pre>Deletes a conversion event in a property.
138
139Args:
140 name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: &quot;properties/123/conversionEvents/456&quot; (required)
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
150}</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="get">get(name, x__xgafv=None)</code>
155 <pre>Retrieve a single conversion event.
156
157Args:
158 name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: &quot;properties/123/conversionEvents/456&quot; (required)
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # A conversion event in a Google Analytics property.
168 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700169 &quot;custom&quot;: True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700170 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
171 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
172 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
173}</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
178 <pre>Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
179
180Args:
181 parent: string, Required. The resource name of the parent property. Example: &#x27;properties/123&#x27; (required)
182 pageSize: integer, 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)
183 pageToken: string, A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189Returns:
190 An object of the form:
191
192 { # Response message for ListConversionEvents RPC.
193 &quot;conversionEvents&quot;: [ # The requested conversion events
194 { # A conversion event in a Google Analytics property.
195 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700196 &quot;custom&quot;: True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700197 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
198 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
199 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
200 },
201 ],
202 &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.
203}</pre>
204</div>
205
206<div class="method">
207 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
208 <pre>Retrieves the next page of results.
209
210Args:
211 previous_request: The request for the previous page. (required)
212 previous_response: The response from the request for the previous page. (required)
213
214Returns:
215 A request object that you can call &#x27;execute()&#x27; on to request the next
216 page. Returns None if there are no more items in the collection.
217 </pre>
218</div>
219
220</body></html>