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