blob: f5c32938a99e8ed75d2a16760f8a146fd431e3f6 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.goals.html">goals</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040081 <code><a href="#get">get(accountId, webPropertyId, profileId, goalId)</a></code></p>
82<p class="firstline">Gets a goal to which the user has access.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Create a new goal.</p>
86<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080087 <code><a href="#list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<p class="firstline">Lists goals to which the user has access.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#patch">patch(accountId, webPropertyId, profileId, goalId, body=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070091<p class="firstline">Updates an existing goal. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#update">update(accountId, webPropertyId, profileId, goalId, body=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070094<p class="firstline">Updates an existing goal.</p>
John Asmuth614db982014-04-24 15:46:26 -040095<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400102 <code class="details" id="get">get(accountId, webPropertyId, profileId, goalId)</code>
103 <pre>Gets a goal to which the user has access.
104
105Args:
106 accountId: string, Account ID to retrieve the goal for. (required)
107 webPropertyId: string, Web property ID to retrieve the goal for. (required)
108 profileId: string, View (Profile) ID to retrieve the goal for. (required)
109 goalId: string, Goal ID to retrieve the goal for. (required)
110
111Returns:
112 An object of the form:
113
114 { # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800115 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
116 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
117 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800118 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800119 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
120 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800121 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
122 &quot;eventConditions&quot;: [ # List of event conditions.
123 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800124 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
125 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800126 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800127 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
128 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
129 },
130 ],
131 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
132 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800133 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800134 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800135 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800136 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800137 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800138 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
139 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
140 {
141 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
142 &quot;number&quot;: 42, # Step number.
143 &quot;name&quot;: &quot;A String&quot;, # Step name.
144 },
145 ],
146 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
147 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
148 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
149 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
150 },
151 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
152 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
153 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
154 },
155 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800156 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800157 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
158 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
159 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
160 },
161 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
162 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
163 &quot;name&quot;: &quot;A String&quot;, # Goal name.
164 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800165 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400166</div>
167
168<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700169 <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400170 <pre>Create a new goal.
171
172Args:
173 accountId: string, Account ID to create the goal for. (required)
174 webPropertyId: string, Web property ID to create the goal for. (required)
175 profileId: string, View (Profile) ID to create the goal for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700176 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400177 The object takes the form of:
178
179{ # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800180 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
181 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
182 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800183 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800184 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
185 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800186 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
187 &quot;eventConditions&quot;: [ # List of event conditions.
188 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800189 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
190 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800191 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800192 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
193 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
194 },
195 ],
196 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
197 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800198 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800199 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800200 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800201 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800202 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800203 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
204 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
205 {
206 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
207 &quot;number&quot;: 42, # Step number.
208 &quot;name&quot;: &quot;A String&quot;, # Step name.
209 },
210 ],
211 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
212 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
213 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
214 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
215 },
216 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
217 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
218 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
219 },
220 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800221 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800222 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
223 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
224 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
225 },
226 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
227 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
228 &quot;name&quot;: &quot;A String&quot;, # Goal name.
229 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800230 }
John Asmuth614db982014-04-24 15:46:26 -0400231
232
233Returns:
234 An object of the form:
235
236 { # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800237 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
238 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
239 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800240 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800241 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
242 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800243 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
244 &quot;eventConditions&quot;: [ # List of event conditions.
245 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
247 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800248 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800249 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
250 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
251 },
252 ],
253 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
254 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800255 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800256 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800257 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800258 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800259 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800260 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
261 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
262 {
263 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
264 &quot;number&quot;: 42, # Step number.
265 &quot;name&quot;: &quot;A String&quot;, # Step name.
266 },
267 ],
268 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
269 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
270 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
271 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
272 },
273 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
274 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
275 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
276 },
277 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800278 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800279 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
280 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
281 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
282 },
283 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
284 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
285 &quot;name&quot;: &quot;A String&quot;, # Goal name.
286 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800287 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400288</div>
289
290<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800291 <code class="details" id="list">list(accountId, webPropertyId, profileId, start_index=None, max_results=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400292 <pre>Lists goals to which the user has access.
293
294Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or &#x27;~all&#x27;, which refers to all the accounts that user has access to. (required)
296 webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or &#x27;~all&#x27;, which refers to all the web properties that user has access to. (required)
297 profileId: string, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or &#x27;~all&#x27;, which refers to all the views (profiles) that user has access to. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700298 start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800299 max_results: integer, The maximum number of goals to include in this response.
John Asmuth614db982014-04-24 15:46:26 -0400300
301Returns:
302 An object of the form:
303
304 { # A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800305 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &quot;items&quot;: [ # A list of goals.
John Asmuth614db982014-04-24 15:46:26 -0400307 { # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800308 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
309 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
310 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800311 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800312 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
313 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800314 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
315 &quot;eventConditions&quot;: [ # List of event conditions.
316 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800317 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
318 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800319 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800320 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
321 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
322 },
323 ],
324 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
325 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800326 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800327 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800328 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800329 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800330 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800331 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
332 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
333 {
334 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
335 &quot;number&quot;: 42, # Step number.
336 &quot;name&quot;: &quot;A String&quot;, # Step name.
337 },
338 ],
339 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
340 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
341 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
342 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
343 },
344 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
345 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
346 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
347 },
348 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800349 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800350 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
351 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
352 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
353 },
354 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
355 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
356 &quot;name&quot;: &quot;A String&quot;, # Goal name.
357 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700358 },
John Asmuth614db982014-04-24 15:46:26 -0400359 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800360 &quot;itemsPerPage&quot;: 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800361 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this goal collection.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800362 &quot;kind&quot;: &quot;analytics#goals&quot;, # Collection type.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800363 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this goal collection.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800364 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of resources in the result.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800365 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
John Asmuth614db982014-04-24 15:46:26 -0400366 }</pre>
367</div>
368
369<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700370 <code class="details" id="patch">patch(accountId, webPropertyId, profileId, goalId, body=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700371 <pre>Updates an existing goal. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400372
373Args:
374 accountId: string, Account ID to update the goal. (required)
375 webPropertyId: string, Web property ID to update the goal. (required)
376 profileId: string, View (Profile) ID to update the goal. (required)
377 goalId: string, Index of the goal to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700378 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400379 The object takes the form of:
380
381{ # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800382 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
383 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
384 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800385 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800386 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
387 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800388 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
389 &quot;eventConditions&quot;: [ # List of event conditions.
390 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800391 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
392 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800393 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800394 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
395 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
396 },
397 ],
398 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
399 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800400 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800401 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800402 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800403 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800404 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800405 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
406 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
407 {
408 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
409 &quot;number&quot;: 42, # Step number.
410 &quot;name&quot;: &quot;A String&quot;, # Step name.
411 },
412 ],
413 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
414 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
415 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
416 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
417 },
418 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
419 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
420 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
421 },
422 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800423 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800424 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
425 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
426 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
427 },
428 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
429 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
430 &quot;name&quot;: &quot;A String&quot;, # Goal name.
431 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800432 }
John Asmuth614db982014-04-24 15:46:26 -0400433
434
435Returns:
436 An object of the form:
437
438 { # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800439 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
440 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
441 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800442 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800443 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
444 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800445 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
446 &quot;eventConditions&quot;: [ # List of event conditions.
447 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800448 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
449 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800450 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800451 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
452 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
453 },
454 ],
455 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
456 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800457 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800458 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800459 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800460 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800461 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800462 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
463 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
464 {
465 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
466 &quot;number&quot;: 42, # Step number.
467 &quot;name&quot;: &quot;A String&quot;, # Step name.
468 },
469 ],
470 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
471 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
472 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
473 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
474 },
475 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
476 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
477 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
478 },
479 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800480 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800481 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
482 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
483 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
484 },
485 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
486 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
487 &quot;name&quot;: &quot;A String&quot;, # Goal name.
488 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800489 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400490</div>
491
492<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700493 <code class="details" id="update">update(accountId, webPropertyId, profileId, goalId, body=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700494 <pre>Updates an existing goal.
John Asmuth614db982014-04-24 15:46:26 -0400495
496Args:
497 accountId: string, Account ID to update the goal. (required)
498 webPropertyId: string, Web property ID to update the goal. (required)
499 profileId: string, View (Profile) ID to update the goal. (required)
500 goalId: string, Index of the goal to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700501 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400502 The object takes the form of:
503
504{ # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800505 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
506 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
507 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800508 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800509 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
510 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800511 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
512 &quot;eventConditions&quot;: [ # List of event conditions.
513 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800514 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
515 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800516 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800517 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
518 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
519 },
520 ],
521 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
522 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800523 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800524 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800525 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800526 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800527 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800528 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
529 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
530 {
531 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
532 &quot;number&quot;: 42, # Step number.
533 &quot;name&quot;: &quot;A String&quot;, # Step name.
534 },
535 ],
536 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
537 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
538 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
539 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
540 },
541 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
542 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
543 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
544 },
545 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800546 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800547 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
548 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
549 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
550 },
551 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
552 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
553 &quot;name&quot;: &quot;A String&quot;, # Goal name.
554 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800555 }
John Asmuth614db982014-04-24 15:46:26 -0400556
557
558Returns:
559 An object of the form:
560
561 { # JSON template for Analytics goal resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800562 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this goal.
563 &quot;id&quot;: &quot;A String&quot;, # Goal ID.
564 &quot;updated&quot;: &quot;A String&quot;, # Time this goal was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800565 &quot;kind&quot;: &quot;analytics#goal&quot;, # Resource type for an Analytics goal.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800566 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
567 &quot;active&quot;: True or False, # Determines whether this goal is active.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800568 &quot;eventDetails&quot;: { # Details for the goal of the type EVENT.
569 &quot;eventConditions&quot;: [ # List of event conditions.
570 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800571 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
572 &quot;matchType&quot;: &quot;A String&quot;, # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800573 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800574 &quot;expression&quot;: &quot;A String&quot;, # Expression used for this match.
575 &quot;type&quot;: &quot;A String&quot;, # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
576 },
577 ],
578 &quot;useEventValue&quot;: True or False, # Determines if the event value should be used as the value for this goal.
579 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800580 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800581 &quot;visitNumPagesDetails&quot;: { # Details for the goal of the type VISIT_NUM_PAGES.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800582 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800583 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800584 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800585 &quot;urlDestinationDetails&quot;: { # Details for the goal of the type URL_DESTINATION.
586 &quot;steps&quot;: [ # List of steps configured for this goal funnel.
587 {
588 &quot;url&quot;: &quot;A String&quot;, # URL for this step.
589 &quot;number&quot;: 42, # Step number.
590 &quot;name&quot;: &quot;A String&quot;, # Step name.
591 },
592 ],
593 &quot;matchType&quot;: &quot;A String&quot;, # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
594 &quot;firstStepRequired&quot;: True or False, # Determines if the first step in this goal is required.
595 &quot;url&quot;: &quot;A String&quot;, # URL for this goal.
596 &quot;caseSensitive&quot;: True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
597 },
598 &quot;parentLink&quot;: { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
599 &quot;type&quot;: &quot;analytics#profile&quot;, # Value is &quot;analytics#profile&quot;.
600 &quot;href&quot;: &quot;A String&quot;, # Link to the view (profile) to which this goal belongs.
601 },
602 &quot;internalWebPropertyId&quot;: &quot;A String&quot;, # Internal ID for the web property to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800603 &quot;value&quot;: 3.14, # Goal value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800604 &quot;visitTimeOnSiteDetails&quot;: { # Details for the goal of the type VISIT_TIME_ON_SITE.
605 &quot;comparisonValue&quot;: &quot;A String&quot;, # Value used for this comparison.
606 &quot;comparisonType&quot;: &quot;A String&quot;, # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
607 },
608 &quot;type&quot;: &quot;A String&quot;, # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
609 &quot;created&quot;: &quot;A String&quot;, # Time this goal was created.
610 &quot;name&quot;: &quot;A String&quot;, # Goal name.
611 &quot;profileId&quot;: &quot;A String&quot;, # View (Profile) ID to which this goal belongs.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800612 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400613</div>
614
615</body></html>