Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / analytics_v3.management.webproperties.html
blob: 40dc20736eb490162fb5b5c84be9f0e8868f21a9 [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.webproperties.html">webproperties</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(accountId, webPropertyId)</a></code></p>
79<p class="firstline">Gets a web property to which the user has access.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#insert">insert(accountId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.</p>
83<p class="toc_element">
84 <code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>
85<p class="firstline">Lists web properties to which the user has access.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#patch">patch(accountId, webPropertyId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Updates an existing web property. This method supports patch semantics.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#update">update(accountId, webPropertyId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Updates an existing web property.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="get">get(accountId, webPropertyId)</code>
95 <pre>Gets a web property to which the user has access.
96
97Args:
98 accountId: string, Account ID to retrieve the web property for. (required)
99 webPropertyId: string, ID to retrieve the web property for. (required)
100
101Returns:
102 An object of the form:
103
104 { # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 "profileCount": 42, # View (Profile) count for this web property.
106 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
109 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110 "created": "A String", # Time this web property was created.
111 "defaultProfileId": "A String", # Default view (profile) ID.
112 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
114 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
115 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116 "internalWebPropertyId": "A String", # Internal ID for this web property.
117 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
118 "href": "A String", # Link to the list of views (profiles) for this web property.
119 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
120 },
121 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
123 # Set to false to delete data associated with the user identifier automatically after the rentention period.
124 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]125 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 "permissions": { # Permissions the user has for this web property.
127 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
128 "A String",
129 ],
130 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
132 "href": "A String", # Link to the account for this web property.
133 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
134 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]135 "selfLink": "A String", # Link for this web property.
136 "accountId": "A String", # Account ID to which this web property belongs.
137 }</pre>
138</div>
139
140<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 <code class="details" id="insert">insert(accountId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 <pre>Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.
143
144Args:
145 accountId: string, Account ID to create the web property for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]146 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147 The object takes the form of:
148
149{ # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]150 "profileCount": 42, # View (Profile) count for this web property.
151 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
154 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 "created": "A String", # Time this web property was created.
156 "defaultProfileId": "A String", # Default view (profile) ID.
157 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
159 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
160 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 "internalWebPropertyId": "A String", # Internal ID for this web property.
162 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
163 "href": "A String", # Link to the list of views (profiles) for this web property.
164 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
165 },
166 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
168 # Set to false to delete data associated with the user identifier automatically after the rentention period.
169 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 "permissions": { # Permissions the user has for this web property.
172 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
173 "A String",
174 ],
175 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]176 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
177 "href": "A String", # Link to the account for this web property.
178 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
179 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180 "selfLink": "A String", # Link for this web property.
181 "accountId": "A String", # Account ID to which this web property belongs.
182 }
183
184
185Returns:
186 An object of the form:
187
188 { # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 "profileCount": 42, # View (Profile) count for this web property.
190 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
193 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 "created": "A String", # Time this web property was created.
195 "defaultProfileId": "A String", # Default view (profile) ID.
196 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]197 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
198 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
199 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 "internalWebPropertyId": "A String", # Internal ID for this web property.
201 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
202 "href": "A String", # Link to the list of views (profiles) for this web property.
203 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
204 },
205 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
207 # Set to false to delete data associated with the user identifier automatically after the rentention period.
208 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]209 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 "permissions": { # Permissions the user has for this web property.
211 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
212 "A String",
213 ],
214 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]215 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
216 "href": "A String", # Link to the account for this web property.
217 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
218 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]219 "selfLink": "A String", # Link for this web property.
220 "accountId": "A String", # Account ID to which this web property belongs.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="list">list(accountId, max_results=None, start_index=None)</code>
226 <pre>Lists web properties to which the user has access.
227
228Args:
229 accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
230 max_results: integer, The maximum number of web properties to include in this response.
231 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
232
233Returns:
234 An object of the form:
235
236 { # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
237 "username": "A String", # Email ID of the authenticated user
238 "kind": "analytics#webproperties", # Collection type.
239 "items": [ # A list of web properties.
240 { # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "profileCount": 42, # View (Profile) count for this web property.
242 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
245 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 "created": "A String", # Time this web property was created.
247 "defaultProfileId": "A String", # Default view (profile) ID.
248 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]249 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
250 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
251 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]252 "internalWebPropertyId": "A String", # Internal ID for this web property.
253 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
254 "href": "A String", # Link to the list of views (profiles) for this web property.
255 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
256 },
257 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
259 # Set to false to delete data associated with the user identifier automatically after the rentention period.
260 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]261 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "permissions": { # Permissions the user has for this web property.
263 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
264 "A String",
265 ],
266 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
268 "href": "A String", # Link to the account for this web property.
269 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
270 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]271 "selfLink": "A String", # Link for this web property.
272 "accountId": "A String", # Account ID to which this web property belongs.
273 },
274 ],
275 "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.
276 "previousLink": "A String", # Link to previous page for this web property collection.
277 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
278 "nextLink": "A String", # Link to next page for this web property collection.
279 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
280 }</pre>
281</div>
282
283<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 <code class="details" id="patch">patch(accountId, webPropertyId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]285 <pre>Updates an existing web property. This method supports patch semantics.
286
287Args:
288 accountId: string, Account ID to which the web property belongs (required)
289 webPropertyId: string, Web property ID (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]290 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 The object takes the form of:
292
293{ # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "profileCount": 42, # View (Profile) count for this web property.
295 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
298 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]299 "created": "A String", # Time this web property was created.
300 "defaultProfileId": "A String", # Default view (profile) ID.
301 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]302 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
303 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
304 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]305 "internalWebPropertyId": "A String", # Internal ID for this web property.
306 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
307 "href": "A String", # Link to the list of views (profiles) for this web property.
308 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
309 },
310 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
312 # Set to false to delete data associated with the user identifier automatically after the rentention period.
313 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]314 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]315 "permissions": { # Permissions the user has for this web property.
316 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
317 "A String",
318 ],
319 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
321 "href": "A String", # Link to the account for this web property.
322 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
323 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 "selfLink": "A String", # Link for this web property.
325 "accountId": "A String", # Account ID to which this web property belongs.
326 }
327
328
329Returns:
330 An object of the form:
331
332 { # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 "profileCount": 42, # View (Profile) count for this web property.
334 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]335 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]336 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
337 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]338 "created": "A String", # Time this web property was created.
339 "defaultProfileId": "A String", # Default view (profile) ID.
340 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]341 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
342 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
343 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344 "internalWebPropertyId": "A String", # Internal ID for this web property.
345 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
346 "href": "A String", # Link to the list of views (profiles) for this web property.
347 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
348 },
349 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
351 # Set to false to delete data associated with the user identifier automatically after the rentention period.
352 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]353 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]354 "permissions": { # Permissions the user has for this web property.
355 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
356 "A String",
357 ],
358 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
360 "href": "A String", # Link to the account for this web property.
361 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
362 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]363 "selfLink": "A String", # Link for this web property.
364 "accountId": "A String", # Account ID to which this web property belongs.
365 }</pre>
366</div>
367
368<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]369 <code class="details" id="update">update(accountId, webPropertyId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]370 <pre>Updates an existing web property.
371
372Args:
373 accountId: string, Account ID to which the web property belongs (required)
374 webPropertyId: string, Web property ID (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]375 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]376 The object takes the form of:
377
378{ # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379 "profileCount": 42, # View (Profile) count for this web property.
380 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
383 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]384 "created": "A String", # Time this web property was created.
385 "defaultProfileId": "A String", # Default view (profile) ID.
386 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]387 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
388 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
389 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]390 "internalWebPropertyId": "A String", # Internal ID for this web property.
391 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
392 "href": "A String", # Link to the list of views (profiles) for this web property.
393 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
394 },
395 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
397 # Set to false to delete data associated with the user identifier automatically after the rentention period.
398 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]399 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400 "permissions": { # Permissions the user has for this web property.
401 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
402 "A String",
403 ],
404 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
406 "href": "A String", # Link to the account for this web property.
407 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
408 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]409 "selfLink": "A String", # Link for this web property.
410 "accountId": "A String", # Account ID to which this web property belongs.
411 }
412
413
414Returns:
415 An object of the form:
416
417 { # JSON template for an Analytics web property.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 "profileCount": 42, # View (Profile) count for this web property.
419 "updated": "A String", # Time this web property was last modified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]420 "name": "A String", # Name of this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
422 # This property cannot be set on insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]423 "created": "A String", # Time this web property was created.
424 "defaultProfileId": "A String", # Default view (profile) ID.
425 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]426 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
427 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
428 "websiteUrl": "A String", # Website url for this web property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]429 "internalWebPropertyId": "A String", # Internal ID for this web property.
430 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
431 "href": "A String", # Link to the list of views (profiles) for this web property.
432 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
433 },
434 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435 "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
436 # Set to false to delete data associated with the user identifier automatically after the rentention period.
437 # This property cannot be set on insert.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]438 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]439 "permissions": { # Permissions the user has for this web property.
440 "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
441 "A String",
442 ],
443 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]444 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
445 "href": "A String", # Link to the account for this web property.
446 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
447 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]448 "selfLink": "A String", # Link for this web property.
449 "accountId": "A String", # Account ID to which this web property belongs.
450 }</pre>
451</div>
452
453</body></html>