blob: 5302c43ed659fb09f05d4cffd44c95510a46c2eb [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.
112 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
113 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
114 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
115}
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # A conversion event in a Google Analytics property.
126 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
127 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
128 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
129 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
130}</pre>
131</div>
132
133<div class="method">
134 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
135 <pre>Deletes a conversion event in a property.
136
137Args:
138 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)
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # 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 `{}`.
148}</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(name, x__xgafv=None)</code>
153 <pre>Retrieve a single conversion event.
154
155Args:
156 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)
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # A conversion event in a Google Analytics property.
166 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
167 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
168 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
169 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
170}</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
175 <pre>Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
176
177Args:
178 parent: string, Required. The resource name of the parent property. Example: &#x27;properties/123&#x27; (required)
179 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)
180 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.
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # Response message for ListConversionEvents RPC.
190 &quot;conversionEvents&quot;: [ # The requested conversion events
191 { # A conversion event in a Google Analytics property.
192 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this conversion event was created in the property.
193 &quot;eventName&quot;: &quot;A String&quot;, # Immutable. The event name for this conversion event. Examples: &#x27;click&#x27;, &#x27;purchase&#x27;
194 &quot;isDeletable&quot;: True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
195 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
196 },
197 ],
198 &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.
199}</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
204 <pre>Retrieves the next page of results.
205
206Args:
207 previous_request: The request for the previous page. (required)
208 previous_response: The response from the request for the previous page. (required)
209
210Returns:
211 A request object that you can call &#x27;execute()&#x27; on to request the next
212 page. Returns None if there are no more items in the collection.
213 </pre>
214</div>
215
216</body></html>