| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Frenkel | 3e17f89 | 2020-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 Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#insert">insert(accountId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-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"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(accountId, start_index=None, max_results=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#patch">patch(accountId, webPropertyId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#update">update(accountId, webPropertyId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-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 Frenkel | 3e17f89 | 2020-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 Asmuth | 614db98 | 2014-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 | |
| 105 | Args: |
| 106 | accountId: string, Account ID to retrieve the web property for. (required) |
| 107 | webPropertyId: string, ID to retrieve the web property for. (required) |
| 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| 112 | { # JSON template for an Analytics web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 113 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 114 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 115 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 116 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 118 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 119 | }, |
| 120 | "permissions": { # Permissions the user has for this web property. |
| 121 | "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. |
| 122 | "A String", |
| 123 | ], |
| 124 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 125 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 126 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 127 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 128 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 129 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 130 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 131 | "href": "A String", # Link to the account for this web property. |
| 132 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 133 | }, |
| 134 | "name": "A String", # Name of this web property. |
| 135 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 136 | "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). |
| 137 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 138 | # This property cannot be set on insert. |
| 139 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 140 | "created": "A String", # Time this web property was created. |
| 141 | "updated": "A String", # Time this web property was last modified. |
| 142 | "websiteUrl": "A String", # Website url for this web property. |
| 143 | "profileCount": 42, # View (Profile) count for this web property. |
| 144 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 145 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 146 | </div> |
| 147 | |
| 148 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 149 | <code class="details" id="insert">insert(accountId, body=None)</code> |
| John Asmuth | 614db98 | 2014-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 | |
| 152 | Args: |
| 153 | accountId: string, Account ID to create the web property for. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 154 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 155 | The object takes the form of: |
| 156 | |
| 157 | { # JSON template for an Analytics web property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 159 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 160 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 161 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 162 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 163 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 164 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "permissions": { # Permissions the user has for this web property. |
| 166 | "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. |
| 167 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 168 | ], |
| 169 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 170 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 171 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 172 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 173 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 174 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 175 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 176 | "href": "A String", # Link to the account for this web property. |
| 177 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 178 | }, |
| 179 | "name": "A String", # Name of this web property. |
| 180 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 181 | "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). |
| 182 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 183 | # This property cannot be set on insert. |
| 184 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 185 | "created": "A String", # Time this web property was created. |
| 186 | "updated": "A String", # Time this web property was last modified. |
| 187 | "websiteUrl": "A String", # Website url for this web property. |
| 188 | "profileCount": 42, # View (Profile) count for this web property. |
| 189 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| 196 | { # JSON template for an Analytics web property. |
| 197 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 198 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 199 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 200 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 201 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 202 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | }, |
| 204 | "permissions": { # Permissions the user has for this web property. |
| 205 | "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. |
| 206 | "A String", |
| 207 | ], |
| 208 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 209 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 210 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 211 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 212 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 213 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 214 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 215 | "href": "A String", # Link to the account for this web property. |
| 216 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 217 | }, |
| 218 | "name": "A String", # Name of this web property. |
| 219 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 220 | "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). |
| 221 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 222 | # This property cannot be set on insert. |
| 223 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 224 | "created": "A String", # Time this web property was created. |
| 225 | "updated": "A String", # Time this web property was last modified. |
| 226 | "websiteUrl": "A String", # Website url for this web property. |
| 227 | "profileCount": 42, # View (Profile) count for this web property. |
| 228 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 229 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 230 | </div> |
| 231 | |
| 232 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 233 | <code class="details" id="list">list(accountId, start_index=None, max_results=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 234 | <pre>Lists web properties to which the user has access. |
| 235 | |
| 236 | Args: |
| Bu Sun Kim | 6502091 | 2020-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 '~all', which refers to all the accounts that user has access to. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 238 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 239 | max_results: integer, The maximum number of web properties to include in this response. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 240 | |
| 241 | Returns: |
| 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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 245 | "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. |
| 246 | "kind": "analytics#webproperties", # Collection type. |
| 247 | "previousLink": "A String", # Link to previous page for this web property collection. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 248 | "items": [ # A list of web properties. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 249 | { # JSON template for an Analytics web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 251 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 252 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 253 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 254 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 255 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 256 | }, |
| 257 | "permissions": { # Permissions the user has for this web property. |
| 258 | "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. |
| 259 | "A String", |
| 260 | ], |
| 261 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 262 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 263 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 264 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 265 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 266 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 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 | }, |
| 271 | "name": "A String", # Name of this web property. |
| 272 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 273 | "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). |
| 274 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 275 | # This property cannot be set on insert. |
| 276 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 277 | "created": "A String", # Time this web property was created. |
| 278 | "updated": "A String", # Time this web property was last modified. |
| 279 | "websiteUrl": "A String", # Website url for this web property. |
| 280 | "profileCount": 42, # View (Profile) count for this web property. |
| 281 | "accountId": "A String", # Account ID to which this web property belongs. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 282 | }, |
| 283 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 284 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 285 | "nextLink": "A String", # Link to next page for this web property collection. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 286 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| 287 | "username": "A String", # Email ID of the authenticated user |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 288 | }</pre> |
| 289 | </div> |
| 290 | |
| 291 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 292 | <code class="details" id="patch">patch(accountId, webPropertyId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 293 | <pre>Updates an existing web property. This method supports patch semantics. |
| 294 | |
| 295 | Args: |
| 296 | accountId: string, Account ID to which the web property belongs (required) |
| 297 | webPropertyId: string, Web property ID (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 298 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 299 | The object takes the form of: |
| 300 | |
| 301 | { # JSON template for an Analytics web property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 302 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 303 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 304 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 305 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 306 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 307 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 308 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 309 | "permissions": { # Permissions the user has for this web property. |
| 310 | "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. |
| 311 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 312 | ], |
| 313 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 314 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 315 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 316 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 317 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 318 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 319 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 320 | "href": "A String", # Link to the account for this web property. |
| 321 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 322 | }, |
| 323 | "name": "A String", # Name of this web property. |
| 324 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 325 | "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). |
| 326 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 327 | # This property cannot be set on insert. |
| 328 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 329 | "created": "A String", # Time this web property was created. |
| 330 | "updated": "A String", # Time this web property was last modified. |
| 331 | "websiteUrl": "A String", # Website url for this web property. |
| 332 | "profileCount": 42, # View (Profile) count for this web property. |
| 333 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 334 | } |
| 335 | |
| 336 | |
| 337 | Returns: |
| 338 | An object of the form: |
| 339 | |
| 340 | { # JSON template for an Analytics web property. |
| 341 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 342 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 343 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 344 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 345 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 346 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 347 | }, |
| 348 | "permissions": { # Permissions the user has for this web property. |
| 349 | "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. |
| 350 | "A String", |
| 351 | ], |
| 352 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 353 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 354 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 355 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 356 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 357 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 358 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 359 | "href": "A String", # Link to the account for this web property. |
| 360 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 361 | }, |
| 362 | "name": "A String", # Name of this web property. |
| 363 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 364 | "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). |
| 365 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 366 | # This property cannot be set on insert. |
| 367 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 368 | "created": "A String", # Time this web property was created. |
| 369 | "updated": "A String", # Time this web property was last modified. |
| 370 | "websiteUrl": "A String", # Website url for this web property. |
| 371 | "profileCount": 42, # View (Profile) count for this web property. |
| 372 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 373 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 374 | </div> |
| 375 | |
| 376 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 377 | <code class="details" id="update">update(accountId, webPropertyId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 378 | <pre>Updates an existing web property. |
| 379 | |
| 380 | Args: |
| 381 | accountId: string, Account ID to which the web property belongs (required) |
| 382 | webPropertyId: string, Web property ID (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 383 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 384 | The object takes the form of: |
| 385 | |
| 386 | { # JSON template for an Analytics web property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 388 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 389 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 390 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 391 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 392 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 393 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 394 | "permissions": { # Permissions the user has for this web property. |
| 395 | "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. |
| 396 | "A String", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 397 | ], |
| 398 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 399 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 400 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 401 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 402 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 403 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 404 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 405 | "href": "A String", # Link to the account for this web property. |
| 406 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 407 | }, |
| 408 | "name": "A String", # Name of this web property. |
| 409 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 410 | "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). |
| 411 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 412 | # This property cannot be set on insert. |
| 413 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 414 | "created": "A String", # Time this web property was created. |
| 415 | "updated": "A String", # Time this web property was last modified. |
| 416 | "websiteUrl": "A String", # Website url for this web property. |
| 417 | "profileCount": 42, # View (Profile) count for this web property. |
| 418 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 419 | } |
| 420 | |
| 421 | |
| 422 | Returns: |
| 423 | An object of the form: |
| 424 | |
| 425 | { # JSON template for an Analytics web property. |
| 426 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 427 | # This property cannot be set on insert. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 428 | "selfLink": "A String", # Link for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 429 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 430 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 431 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 432 | }, |
| 433 | "permissions": { # Permissions the user has for this web property. |
| 434 | "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. |
| 435 | "A String", |
| 436 | ], |
| 437 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 438 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 439 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 440 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 441 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 442 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 443 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 444 | "href": "A String", # Link to the account for this web property. |
| 445 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 446 | }, |
| 447 | "name": "A String", # Name of this web property. |
| 448 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 449 | "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). |
| 450 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 451 | # This property cannot be set on insert. |
| 452 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 453 | "created": "A String", # Time this web property was created. |
| 454 | "updated": "A String", # Time this web property was last modified. |
| 455 | "websiteUrl": "A String", # Website url for this web property. |
| 456 | "profileCount": 42, # View (Profile) count for this web property. |
| 457 | "accountId": "A String", # Account ID to which this web property belongs. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 458 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 459 | </div> |
| 460 | |
| 461 | </body></html> |