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