Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / analytics_v3.management.goals.html
blob: ff0e1e275c51a21be7883042358b115defa741e4 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<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">
78 <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
79<p class="firstline">Lists goals to which the user has access.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
83 <pre>Lists goals to which the user has access.
84
85Args:
86 accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
87 webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]88 profileId: string, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. (required)
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]89 max_results: integer, The maximum number of goals to include in this response.
90 start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
91
92Returns:
93 An object of the form:
94
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]95 { # 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]96 "username": "A String", # Email ID of the authenticated user
97 "kind": "analytics#goals", # Collection type.
98 "items": [ # A list of goals.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]99 { # JSON template for Analytics goal resource.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]100 "kind": "analytics#goal", # Resource type for an Analytics goal.
101 "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
102 "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
103 "comparisonValue": "A String", # Value used for this comparison.
104 },
105 "name": "A String", # Goal name.
106 "created": "A String", # Time this goal was created.
107 "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
108 "url": "A String", # URL for this goal.
109 "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
110 "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
111 "steps": [ # List of steps configured for this goal funnel.
112 {
113 "url": "A String", # URL for this step.
114 "name": "A String", # Step name.
115 "number": 42, # Step number.
116 },
117 ],
118 "firstStepRequired": True or False, # Determines if the first step in this goal is required.
119 },
120 "updated": "A String", # Time this goal was last modified.
121 "value": 3.14, # Goal value.
122 "visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.
123 "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
124 "comparisonValue": "A String", # Value used for this comparison.
125 },
126 "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
127 "eventDetails": { # Details for the goal of the type EVENT.
128 "eventConditions": [ # List of event conditions.
129 {
130 "type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
131 "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
132 "expression": "A String", # Expression used for this match.
133 "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
134 "comparisonValue": "A String", # Value used for this comparison.
135 },
136 ],
137 "useEventValue": True or False, # Determines if the event value should be used as the value for this goal.
138 },
139 "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
140 "active": True or False, # Determines whether this goal is active.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]141 "profileId": "A String", # View (Profile) ID to which this goal belongs.
142 "parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
143 "href": "A String", # Link to the view (profile) to which this goal belongs.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]144 "type": "analytics#profile", # Value is "analytics#profile".
145 },
146 "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
147 "id": "A String", # Goal ID.
148 "selfLink": "A String", # Link for this goal.
149 "accountId": "A String", # Account ID to which this goal belongs.
150 },
151 ],
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]152 "itemsPerPage": 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]153 "previousLink": "A String", # Link to previous page for this goal collection.
154 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
155 "nextLink": "A String", # Link to next page for this goal collection.
156 "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
157 }</pre>
158</div>
159
160</body></html>