Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / analytics_v3.management.profiles.html
blob: e5afffa154576a484d78c6dcce4a68e70881f3d5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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.profiles.html">profiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(accountId, webPropertyId, profileId)</a></code></p>
79<p class="firstline">Deletes a view (profile).</p>
80<p class="toc_element">
81 <code><a href="#get">get(accountId, webPropertyId, profileId)</a></code></p>
82<p class="firstline">Gets a view (profile) to which the user has access.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Create a new view (profile).</p>
86<p class="toc_element">
87 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
88<p class="firstline">Lists views (profiles) to which the user has access.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#patch">patch(accountId, webPropertyId, profileId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Updates an existing view (profile). This method supports patch semantics.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#update">update(accountId, webPropertyId, profileId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Updates an existing view (profile).</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(accountId, webPropertyId, profileId)</code>
98 <pre>Deletes a view (profile).
99
100Args:
101 accountId: string, Account ID to delete the view (profile) for. (required)
102 webPropertyId: string, Web property ID to delete the view (profile) for. (required)
103 profileId: string, ID of the view (profile) to be deleted. (required)
104</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="get">get(accountId, webPropertyId, profileId)</code>
109 <pre>Gets a view (profile) to which the user has access.
110
111Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]112 accountId: string, Account ID to retrieve the view (profile) for. (required)
113 webPropertyId: string, Web property ID to retrieve the view (profile) for. (required)
114 profileId: string, View (Profile) ID to retrieve the view (profile) for. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115
116Returns:
117 An object of the form:
118
119 { # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]121 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
123 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
124 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
125 "id": "A String", # View (Profile) ID.
126 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]127 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
129 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
130 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
131 "updated": "A String", # Time this view (profile) was last modified.
132 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
133 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
134 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
135 "href": "A String", # Link to the list of goals for this view (profile).
136 "type": "analytics#goals", # Value is "analytics#goals".
137 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]138 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
140 "href": "A String", # Link to the web property to which this view (profile) belongs.
141 "type": "analytics#webproperty", # Value is "analytics#webproperty".
142 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 "permissions": { # Permissions the user has for this view (profile).
144 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
145 "A String",
146 ],
147 },
148 "defaultPage": "A String", # Default page for this view (profile).
149 "kind": "analytics#profile", # Resource type for Analytics view (profile).
150 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
151 "name": "A String", # Name of this view (profile).
152 "created": "A String", # Time this view (profile) was created.
153 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
154 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]155 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]156 "selfLink": "A String", # Link for this view (profile).
157 }</pre>
158</div>
159
160<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 <pre>Create a new view (profile).
163
164Args:
165 accountId: string, Account ID to create the view (profile) for. (required)
166 webPropertyId: string, Web property ID to create the view (profile) for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 The object takes the form of:
169
170{ # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]172 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
174 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
175 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
176 "id": "A String", # View (Profile) ID.
177 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]178 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
180 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
181 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
182 "updated": "A String", # Time this view (profile) was last modified.
183 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
184 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
185 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
186 "href": "A String", # Link to the list of goals for this view (profile).
187 "type": "analytics#goals", # Value is "analytics#goals".
188 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]189 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]190 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
191 "href": "A String", # Link to the web property to which this view (profile) belongs.
192 "type": "analytics#webproperty", # Value is "analytics#webproperty".
193 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 "permissions": { # Permissions the user has for this view (profile).
195 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
196 "A String",
197 ],
198 },
199 "defaultPage": "A String", # Default page for this view (profile).
200 "kind": "analytics#profile", # Resource type for Analytics view (profile).
201 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
202 "name": "A String", # Name of this view (profile).
203 "created": "A String", # Time this view (profile) was created.
204 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
205 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]206 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 "selfLink": "A String", # Link for this view (profile).
208 }
209
210
211Returns:
212 An object of the form:
213
214 { # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]215 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]216 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
218 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
219 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
220 "id": "A String", # View (Profile) ID.
221 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]222 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
224 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
225 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
226 "updated": "A String", # Time this view (profile) was last modified.
227 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
228 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
229 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
230 "href": "A String", # Link to the list of goals for this view (profile).
231 "type": "analytics#goals", # Value is "analytics#goals".
232 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]233 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]234 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
235 "href": "A String", # Link to the web property to which this view (profile) belongs.
236 "type": "analytics#webproperty", # Value is "analytics#webproperty".
237 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 "permissions": { # Permissions the user has for this view (profile).
239 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
240 "A String",
241 ],
242 },
243 "defaultPage": "A String", # Default page for this view (profile).
244 "kind": "analytics#profile", # Resource type for Analytics view (profile).
245 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
246 "name": "A String", # Name of this view (profile).
247 "created": "A String", # Time this view (profile) was created.
248 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
249 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]250 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]251 "selfLink": "A String", # Link for this view (profile).
252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
257 <pre>Lists views (profiles) to which the user has access.
258
259Args:
260 accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
261 webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
262 max_results: integer, The maximum number of views (profiles) to include in this response.
263 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
264
265Returns:
266 An object of the form:
267
268 { # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
269 "username": "A String", # Email ID of the authenticated user
270 "kind": "analytics#profiles", # Collection type.
271 "items": [ # A list of views (profiles).
272 { # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]273 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]274 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
276 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
277 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
278 "id": "A String", # View (Profile) ID.
279 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]280 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]281 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
282 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
283 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
284 "updated": "A String", # Time this view (profile) was last modified.
285 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
286 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
287 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
288 "href": "A String", # Link to the list of goals for this view (profile).
289 "type": "analytics#goals", # Value is "analytics#goals".
290 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]291 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]292 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
293 "href": "A String", # Link to the web property to which this view (profile) belongs.
294 "type": "analytics#webproperty", # Value is "analytics#webproperty".
295 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 "permissions": { # Permissions the user has for this view (profile).
297 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
298 "A String",
299 ],
300 },
301 "defaultPage": "A String", # Default page for this view (profile).
302 "kind": "analytics#profile", # Resource type for Analytics view (profile).
303 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
304 "name": "A String", # Name of this view (profile).
305 "created": "A String", # Time this view (profile) was created.
306 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
307 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]308 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]309 "selfLink": "A String", # Link for this view (profile).
310 },
311 ],
312 "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.
313 "previousLink": "A String", # Link to previous page for this view (profile) collection.
314 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
315 "nextLink": "A String", # Link to next page for this view (profile) collection.
316 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
317 }</pre>
318</div>
319
320<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 <code class="details" id="patch">patch(accountId, webPropertyId, profileId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]322 <pre>Updates an existing view (profile). This method supports patch semantics.
323
324Args:
325 accountId: string, Account ID to which the view (profile) belongs (required)
326 webPropertyId: string, Web property ID to which the view (profile) belongs (required)
327 profileId: string, ID of the view (profile) to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 The object takes the form of:
330
331{ # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]332 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]333 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
335 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
336 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
337 "id": "A String", # View (Profile) ID.
338 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
341 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
342 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
343 "updated": "A String", # Time this view (profile) was last modified.
344 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
345 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
346 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
347 "href": "A String", # Link to the list of goals for this view (profile).
348 "type": "analytics#goals", # Value is "analytics#goals".
349 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]350 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]351 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
352 "href": "A String", # Link to the web property to which this view (profile) belongs.
353 "type": "analytics#webproperty", # Value is "analytics#webproperty".
354 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]355 "permissions": { # Permissions the user has for this view (profile).
356 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
357 "A String",
358 ],
359 },
360 "defaultPage": "A String", # Default page for this view (profile).
361 "kind": "analytics#profile", # Resource type for Analytics view (profile).
362 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
363 "name": "A String", # Name of this view (profile).
364 "created": "A String", # Time this view (profile) was created.
365 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
366 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]367 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]368 "selfLink": "A String", # Link for this view (profile).
369 }
370
371
372Returns:
373 An object of the form:
374
375 { # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]376 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]377 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]378 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
379 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
380 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
381 "id": "A String", # View (Profile) ID.
382 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]383 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]384 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
385 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
386 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
387 "updated": "A String", # Time this view (profile) was last modified.
388 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
389 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
390 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
391 "href": "A String", # Link to the list of goals for this view (profile).
392 "type": "analytics#goals", # Value is "analytics#goals".
393 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]394 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]395 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
396 "href": "A String", # Link to the web property to which this view (profile) belongs.
397 "type": "analytics#webproperty", # Value is "analytics#webproperty".
398 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 "permissions": { # Permissions the user has for this view (profile).
400 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
401 "A String",
402 ],
403 },
404 "defaultPage": "A String", # Default page for this view (profile).
405 "kind": "analytics#profile", # Resource type for Analytics view (profile).
406 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
407 "name": "A String", # Name of this view (profile).
408 "created": "A String", # Time this view (profile) was created.
409 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
410 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]411 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]412 "selfLink": "A String", # Link for this view (profile).
413 }</pre>
414</div>
415
416<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 <code class="details" id="update">update(accountId, webPropertyId, profileId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]418 <pre>Updates an existing view (profile).
419
420Args:
421 accountId: string, Account ID to which the view (profile) belongs (required)
422 webPropertyId: string, Web property ID to which the view (profile) belongs (required)
423 profileId: string, ID of the view (profile) to be updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]424 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 The object takes the form of:
426
427{ # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]428 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]429 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]430 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
431 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
432 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
433 "id": "A String", # View (Profile) ID.
434 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]435 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]436 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
437 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
438 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
439 "updated": "A String", # Time this view (profile) was last modified.
440 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
441 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
442 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
443 "href": "A String", # Link to the list of goals for this view (profile).
444 "type": "analytics#goals", # Value is "analytics#goals".
445 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]446 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]447 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
448 "href": "A String", # Link to the web property to which this view (profile) belongs.
449 "type": "analytics#webproperty", # Value is "analytics#webproperty".
450 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]451 "permissions": { # Permissions the user has for this view (profile).
452 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
453 "A String",
454 ],
455 },
456 "defaultPage": "A String", # Default page for this view (profile).
457 "kind": "analytics#profile", # Resource type for Analytics view (profile).
458 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
459 "name": "A String", # Name of this view (profile).
460 "created": "A String", # Time this view (profile) was created.
461 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
462 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]463 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]464 "selfLink": "A String", # Link for this view (profile).
465 }
466
467
468Returns:
469 An object of the form:
470
471 { # JSON template for an Analytics view (profile).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]472 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]473 # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]474 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
475 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
476 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
477 "id": "A String", # View (Profile) ID.
478 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]479 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]480 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
481 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
482 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
483 "updated": "A String", # Time this view (profile) was last modified.
484 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
485 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
486 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
487 "href": "A String", # Link to the list of goals for this view (profile).
488 "type": "analytics#goals", # Value is "analytics#goals".
489 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]490 "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]491 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
492 "href": "A String", # Link to the web property to which this view (profile) belongs.
493 "type": "analytics#webproperty", # Value is "analytics#webproperty".
494 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]495 "permissions": { # Permissions the user has for this view (profile).
496 "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
497 "A String",
498 ],
499 },
500 "defaultPage": "A String", # Default page for this view (profile).
501 "kind": "analytics#profile", # Resource type for Analytics view (profile).
502 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
503 "name": "A String", # Name of this view (profile).
504 "created": "A String", # Time this view (profile) was created.
505 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
506 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]507 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]508 "selfLink": "A String", # Link for this view (profile).
509 }</pre>
510</div>
511
512</body></html>