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