| 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.profiles.html">profiles</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="#delete">delete(accountId, webPropertyId, profileId)</a></code></p> |
| 82 | <p class="firstline">Deletes a view (profile).</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(accountId, webPropertyId, profileId)</a></code></p> |
| 85 | <p class="firstline">Gets a view (profile) to which the user has access.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Create a new view (profile).</p> |
| 89 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 90 | <code><a href="#list">list(accountId, webPropertyId, start_index=None, max_results=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Lists views (profiles) to which the user has access.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(accountId, webPropertyId, profileId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Updates an existing view (profile). This method supports patch semantics.</p> |
| 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#update">update(accountId, webPropertyId, profileId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 97 | <p class="firstline">Updates an existing view (profile).</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | <code class="details" id="delete">delete(accountId, webPropertyId, profileId)</code> |
| 106 | <pre>Deletes a view (profile). |
| 107 | |
| 108 | Args: |
| 109 | accountId: string, Account ID to delete the view (profile) for. (required) |
| 110 | webPropertyId: string, Web property ID to delete the view (profile) for. (required) |
| 111 | profileId: string, ID of the view (profile) to be deleted. (required) |
| 112 | </pre> |
| 113 | </div> |
| 114 | |
| 115 | <div class="method"> |
| 116 | <code class="details" id="get">get(accountId, webPropertyId, profileId)</code> |
| 117 | <pre>Gets a view (profile) to which the user has access. |
| 118 | |
| 119 | Args: |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 120 | accountId: string, Account ID to retrieve the view (profile) for. (required) |
| 121 | webPropertyId: string, Web property ID to retrieve the view (profile) for. (required) |
| 122 | profileId: string, View (Profile) ID to retrieve the view (profile) for. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 123 | |
| 124 | Returns: |
| 125 | An object of the form: |
| 126 | |
| 127 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 128 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 129 | "name": "A String", # Name of this view (profile). |
| 130 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 131 | "created": "A String", # Time this view (profile) was created. |
| 132 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 133 | "defaultPage": "A String", # Default page for this view (profile). |
| 134 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 135 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 136 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 137 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 138 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 139 | }, |
| 140 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 141 | "permissions": { # Permissions the user has for this view (profile). |
| 142 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 143 | "A String", |
| 144 | ], |
| 145 | }, |
| 146 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 147 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 148 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 149 | "updated": "A String", # Time this view (profile) was last modified. |
| 150 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 151 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 152 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 153 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 154 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 155 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 156 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 157 | "id": "A String", # View (Profile) ID. |
| 158 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 159 | "selfLink": "A String", # Link for this view (profile). |
| 160 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 161 | "type": "analytics#goals", # Value is "analytics#goals". |
| 162 | "href": "A String", # Link to the list of goals for this view (profile). |
| 163 | }, |
| 164 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 165 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 166 | </div> |
| 167 | |
| 168 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 169 | <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 170 | <pre>Create a new view (profile). |
| 171 | |
| 172 | Args: |
| 173 | accountId: string, Account ID to create the view (profile) for. (required) |
| 174 | webPropertyId: string, Web property ID to create the view (profile) for. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 175 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 176 | The object takes the form of: |
| 177 | |
| 178 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 179 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 180 | "name": "A String", # Name of this view (profile). |
| 181 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 182 | "created": "A String", # Time this view (profile) was created. |
| 183 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 184 | "defaultPage": "A String", # Default page for this view (profile). |
| 185 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 186 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 187 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 188 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 189 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 190 | }, |
| 191 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 192 | "permissions": { # Permissions the user has for this view (profile). |
| 193 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 194 | "A String", |
| 195 | ], |
| 196 | }, |
| 197 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 198 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 199 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 200 | "updated": "A String", # Time this view (profile) was last modified. |
| 201 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 202 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 203 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 204 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 205 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 206 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 207 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 208 | "id": "A String", # View (Profile) ID. |
| 209 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 210 | "selfLink": "A String", # Link for this view (profile). |
| 211 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 212 | "type": "analytics#goals", # Value is "analytics#goals". |
| 213 | "href": "A String", # Link to the list of goals for this view (profile). |
| 214 | }, |
| 215 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 216 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 217 | |
| 218 | |
| 219 | Returns: |
| 220 | An object of the form: |
| 221 | |
| 222 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 223 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 224 | "name": "A String", # Name of this view (profile). |
| 225 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 226 | "created": "A String", # Time this view (profile) was created. |
| 227 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 228 | "defaultPage": "A String", # Default page for this view (profile). |
| 229 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 230 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 231 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 232 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 233 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 234 | }, |
| 235 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 236 | "permissions": { # Permissions the user has for this view (profile). |
| 237 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 238 | "A String", |
| 239 | ], |
| 240 | }, |
| 241 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 242 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 243 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 244 | "updated": "A String", # Time this view (profile) was last modified. |
| 245 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 246 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 247 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 248 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 249 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 250 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 251 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 252 | "id": "A String", # View (Profile) ID. |
| 253 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 254 | "selfLink": "A String", # Link for this view (profile). |
| 255 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 256 | "type": "analytics#goals", # Value is "analytics#goals". |
| 257 | "href": "A String", # Link to the list of goals for this view (profile). |
| 258 | }, |
| 259 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 260 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 261 | </div> |
| 262 | |
| 263 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 264 | <code class="details" id="list">list(accountId, webPropertyId, start_index=None, max_results=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 265 | <pre>Lists views (profiles) to which the user has access. |
| 266 | |
| 267 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 268 | accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required) |
| 269 | webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 270 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 271 | max_results: integer, The maximum number of views (profiles) to include in this response. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 272 | |
| 273 | Returns: |
| 274 | An object of the form: |
| 275 | |
| 276 | { # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 277 | "kind": "analytics#profiles", # Collection type. |
| 278 | "previousLink": "A String", # Link to previous page for this view (profile) collection. |
| 279 | "username": "A String", # Email ID of the authenticated user |
| 280 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 281 | "items": [ # A list of views (profiles). |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 282 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 283 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 284 | "name": "A String", # Name of this view (profile). |
| 285 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 286 | "created": "A String", # Time this view (profile) was created. |
| 287 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 288 | "defaultPage": "A String", # Default page for this view (profile). |
| 289 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 290 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 291 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 292 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 293 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 294 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 295 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 296 | "permissions": { # Permissions the user has for this view (profile). |
| 297 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 298 | "A String", |
| 299 | ], |
| 300 | }, |
| 301 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 302 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 303 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 304 | "updated": "A String", # Time this view (profile) was last modified. |
| 305 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 306 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 307 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 308 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 309 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 310 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 311 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 312 | "id": "A String", # View (Profile) ID. |
| 313 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 314 | "selfLink": "A String", # Link for this view (profile). |
| 315 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 316 | "type": "analytics#goals", # Value is "analytics#goals". |
| 317 | "href": "A String", # Link to the list of goals for this view (profile). |
| 318 | }, |
| 319 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 320 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 321 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 322 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 323 | "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. |
| 324 | "nextLink": "A String", # Link to next page for this view (profile) collection. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 325 | }</pre> |
| 326 | </div> |
| 327 | |
| 328 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 329 | <code class="details" id="patch">patch(accountId, webPropertyId, profileId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 330 | <pre>Updates an existing view (profile). This method supports patch semantics. |
| 331 | |
| 332 | Args: |
| 333 | accountId: string, Account ID to which the view (profile) belongs (required) |
| 334 | webPropertyId: string, Web property ID to which the view (profile) belongs (required) |
| 335 | profileId: string, ID of the view (profile) to be updated. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 336 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 337 | The object takes the form of: |
| 338 | |
| 339 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 340 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 341 | "name": "A String", # Name of this view (profile). |
| 342 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 343 | "created": "A String", # Time this view (profile) was created. |
| 344 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 345 | "defaultPage": "A String", # Default page for this view (profile). |
| 346 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 347 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 348 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 349 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 350 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 351 | }, |
| 352 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 353 | "permissions": { # Permissions the user has for this view (profile). |
| 354 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 355 | "A String", |
| 356 | ], |
| 357 | }, |
| 358 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 359 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 360 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 361 | "updated": "A String", # Time this view (profile) was last modified. |
| 362 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 363 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 364 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 365 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 366 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 367 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 368 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 369 | "id": "A String", # View (Profile) ID. |
| 370 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 371 | "selfLink": "A String", # Link for this view (profile). |
| 372 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 373 | "type": "analytics#goals", # Value is "analytics#goals". |
| 374 | "href": "A String", # Link to the list of goals for this view (profile). |
| 375 | }, |
| 376 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 377 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 378 | |
| 379 | |
| 380 | Returns: |
| 381 | An object of the form: |
| 382 | |
| 383 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 384 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 385 | "name": "A String", # Name of this view (profile). |
| 386 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 387 | "created": "A String", # Time this view (profile) was created. |
| 388 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 389 | "defaultPage": "A String", # Default page for this view (profile). |
| 390 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 391 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 392 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 393 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 394 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 395 | }, |
| 396 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 397 | "permissions": { # Permissions the user has for this view (profile). |
| 398 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 399 | "A String", |
| 400 | ], |
| 401 | }, |
| 402 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 403 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 404 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 405 | "updated": "A String", # Time this view (profile) was last modified. |
| 406 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 407 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 408 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 409 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 410 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 411 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 412 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 413 | "id": "A String", # View (Profile) ID. |
| 414 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 415 | "selfLink": "A String", # Link for this view (profile). |
| 416 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 417 | "type": "analytics#goals", # Value is "analytics#goals". |
| 418 | "href": "A String", # Link to the list of goals for this view (profile). |
| 419 | }, |
| 420 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 421 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 422 | </div> |
| 423 | |
| 424 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 425 | <code class="details" id="update">update(accountId, webPropertyId, profileId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 426 | <pre>Updates an existing view (profile). |
| 427 | |
| 428 | Args: |
| 429 | accountId: string, Account ID to which the view (profile) belongs (required) |
| 430 | webPropertyId: string, Web property ID to which the view (profile) belongs (required) |
| 431 | profileId: string, ID of the view (profile) to be updated. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 432 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 433 | The object takes the form of: |
| 434 | |
| 435 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 436 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 437 | "name": "A String", # Name of this view (profile). |
| 438 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 439 | "created": "A String", # Time this view (profile) was created. |
| 440 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 441 | "defaultPage": "A String", # Default page for this view (profile). |
| 442 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 443 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 444 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 445 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 446 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 447 | }, |
| 448 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 449 | "permissions": { # Permissions the user has for this view (profile). |
| 450 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 451 | "A String", |
| 452 | ], |
| 453 | }, |
| 454 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 455 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 456 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 457 | "updated": "A String", # Time this view (profile) was last modified. |
| 458 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 459 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 460 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 461 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 462 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 463 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 464 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 465 | "id": "A String", # View (Profile) ID. |
| 466 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 467 | "selfLink": "A String", # Link for this view (profile). |
| 468 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 469 | "type": "analytics#goals", # Value is "analytics#goals". |
| 470 | "href": "A String", # Link to the list of goals for this view (profile). |
| 471 | }, |
| 472 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 473 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 474 | |
| 475 | |
| 476 | Returns: |
| 477 | An object of the form: |
| 478 | |
| 479 | { # JSON template for an Analytics view (profile). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 480 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| 481 | "name": "A String", # Name of this view (profile). |
| 482 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 483 | "created": "A String", # Time this view (profile) was created. |
| 484 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| 485 | "defaultPage": "A String", # Default page for this view (profile). |
| 486 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 487 | # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| 488 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| 489 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| 490 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| 491 | }, |
| 492 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| 493 | "permissions": { # Permissions the user has for this view (profile). |
| 494 | "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. |
| 495 | "A String", |
| 496 | ], |
| 497 | }, |
| 498 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 499 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| 500 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 501 | "updated": "A String", # Time this view (profile) was last modified. |
| 502 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 503 | "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| 504 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| 505 | "websiteUrl": "A String", # Website URL for this view (profile). |
| 506 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 507 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 508 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| 509 | "id": "A String", # View (Profile) ID. |
| 510 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 511 | "selfLink": "A String", # Link for this view (profile). |
| 512 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 513 | "type": "analytics#goals", # Value is "analytics#goals". |
| 514 | "href": "A String", # Link to the list of goals for this view (profile). |
| 515 | }, |
| 516 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 517 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 518 | </div> |
| 519 | |
| 520 | </body></html> |