| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [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.provisioning.html">provisioning</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#createAccountTicket">createAccountTicket(body=None)</a></code></p> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates an account ticket.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#createAccountTree">createAccountTree(body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Provision account.</p> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 85 | <code class="details" id="createAccountTicket">createAccountTicket(body=None)</code> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 86 | <pre>Creates an account ticket. |
| 87 | |
| 88 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 89 | body: object, The request body. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 90 | The object takes the form of: |
| 91 | |
| 92 | { # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 93 | "id": "A String", # Account ticket ID used to access the account ticket. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 94 | "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL. |
| 95 | "webproperty": { # JSON template for an Analytics web property. # Web property for the account. |
| 96 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 97 | # This property cannot be set on insert. |
| 98 | "updated": "A String", # Time this web property was last modified. |
| 99 | "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). |
| 100 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 101 | # This property cannot be set on insert. |
| 102 | "name": "A String", # Name of this web property. |
| 103 | "websiteUrl": "A String", # Website url for this web property. |
| 104 | "created": "A String", # Time this web property was created. |
| 105 | "selfLink": "A String", # Link for this web property. |
| 106 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 107 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 108 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 109 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 110 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 111 | "href": "A String", # Link to the account for this web property. |
| 112 | }, |
| 113 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| 114 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| 115 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| 116 | }, |
| 117 | "permissions": { # Permissions the user has for this web property. |
| 118 | "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. |
| 119 | "A String", |
| 120 | ], |
| 121 | }, |
| 122 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 123 | "accountId": "A String", # Account ID to which this web property belongs. |
| 124 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 125 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 126 | "profileCount": 42, # View (Profile) count for this web property. |
| 127 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| 128 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 129 | "account": { # JSON template for Analytics account entry. # Account for this ticket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 130 | "kind": "analytics#account", # Resource type for Analytics account. |
| 131 | "created": "A String", # Time the account was created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 132 | "permissions": { # Permissions the user has for this account. |
| 133 | "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW). |
| 134 | "A String", |
| 135 | ], |
| 136 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 137 | "updated": "A String", # Time the account was last modified. |
| 138 | "childLink": { # Child link for an account entry. Points to the list of web properties for this account. |
| 139 | "href": "A String", # Link to the list of web properties for this account. |
| 140 | "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties". |
| 141 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 142 | "selfLink": "A String", # Link for this account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 143 | "id": "A String", # Account ID. |
| 144 | "starred": True or False, # Indicates whether this account is starred or not. |
| 145 | "name": "A String", # Account name. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 146 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 147 | "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 148 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 150 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 152 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 154 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 155 | "created": "A String", # Time this view (profile) was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 157 | # 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 158 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 159 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 160 | "id": "A String", # View (Profile) ID. |
| 161 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 163 | "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. |
| 164 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 165 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 166 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 167 | "updated": "A String", # Time this view (profile) was last modified. |
| 168 | "name": "A String", # Name of this view (profile). |
| 169 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 170 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 171 | "href": "A String", # Link to the list of goals for this view (profile). |
| 172 | "type": "analytics#goals", # Value is "analytics#goals". |
| 173 | }, |
| 174 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 175 | "websiteUrl": "A String", # Website URL for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | "permissions": { # Permissions the user has for this view (profile). |
| 177 | "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. |
| 178 | "A String", |
| 179 | ], |
| 180 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 181 | "selfLink": "A String", # Link for this view (profile). |
| 182 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 183 | "defaultPage": "A String", # Default page for this view (profile). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 184 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 186 | "kind": "analytics#accountTicket", # Resource type for account ticket. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | |
| 190 | Returns: |
| 191 | An object of the form: |
| 192 | |
| 193 | { # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 194 | "id": "A String", # Account ticket ID used to access the account ticket. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 195 | "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL. |
| 196 | "webproperty": { # JSON template for an Analytics web property. # Web property for the account. |
| 197 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 198 | # This property cannot be set on insert. |
| 199 | "updated": "A String", # Time this web property was last modified. |
| 200 | "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). |
| 201 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 202 | # This property cannot be set on insert. |
| 203 | "name": "A String", # Name of this web property. |
| 204 | "websiteUrl": "A String", # Website url for this web property. |
| 205 | "created": "A String", # Time this web property was created. |
| 206 | "selfLink": "A String", # Link for this web property. |
| 207 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 208 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 209 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 210 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 211 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 212 | "href": "A String", # Link to the account for this web property. |
| 213 | }, |
| 214 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| 215 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| 216 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| 217 | }, |
| 218 | "permissions": { # Permissions the user has for this web property. |
| 219 | "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. |
| 220 | "A String", |
| 221 | ], |
| 222 | }, |
| 223 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 224 | "accountId": "A String", # Account ID to which this web property belongs. |
| 225 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 226 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 227 | "profileCount": 42, # View (Profile) count for this web property. |
| 228 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| 229 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 230 | "account": { # JSON template for Analytics account entry. # Account for this ticket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 231 | "kind": "analytics#account", # Resource type for Analytics account. |
| 232 | "created": "A String", # Time the account was created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 233 | "permissions": { # Permissions the user has for this account. |
| 234 | "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW). |
| 235 | "A String", |
| 236 | ], |
| 237 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 238 | "updated": "A String", # Time the account was last modified. |
| 239 | "childLink": { # Child link for an account entry. Points to the list of web properties for this account. |
| 240 | "href": "A String", # Link to the list of web properties for this account. |
| 241 | "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties". |
| 242 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 243 | "selfLink": "A String", # Link for this account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 244 | "id": "A String", # Account ID. |
| 245 | "starred": True or False, # Indicates whether this account is starred or not. |
| 246 | "name": "A String", # Account name. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 247 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 248 | "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 249 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 250 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 253 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 255 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 256 | "created": "A String", # Time this view (profile) was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 257 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 258 | # 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 259 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 260 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 261 | "id": "A String", # View (Profile) ID. |
| 262 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 264 | "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. |
| 265 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 266 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 267 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 268 | "updated": "A String", # Time this view (profile) was last modified. |
| 269 | "name": "A String", # Name of this view (profile). |
| 270 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 271 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 272 | "href": "A String", # Link to the list of goals for this view (profile). |
| 273 | "type": "analytics#goals", # Value is "analytics#goals". |
| 274 | }, |
| 275 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 276 | "websiteUrl": "A String", # Website URL for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 277 | "permissions": { # Permissions the user has for this view (profile). |
| 278 | "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. |
| 279 | "A String", |
| 280 | ], |
| 281 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 282 | "selfLink": "A String", # Link for this view (profile). |
| 283 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | "defaultPage": "A String", # Default page for this view (profile). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 285 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 287 | "kind": "analytics#accountTicket", # Resource type for account ticket. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 288 | }</pre> |
| 289 | </div> |
| 290 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 291 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 292 | <code class="details" id="createAccountTree">createAccountTree(body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 293 | <pre>Provision account. |
| 294 | |
| 295 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 296 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 297 | The object takes the form of: |
| 298 | |
| 299 | { # JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 300 | "timezone": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 301 | "kind": "analytics#accountTreeRequest", # Resource type for account ticket. |
| 302 | "webpropertyName": "A String", |
| 303 | "profileName": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 304 | "accountName": "A String", |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 305 | "websiteUrl": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | |
| 309 | Returns: |
| 310 | An object of the form: |
| 311 | |
| 312 | { # JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "webproperty": { # JSON template for an Analytics web property. # Web property for the account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 314 | "dataRetentionTtl": "A String", # The length of time for which user and event data is retained. |
| 315 | # This property cannot be set on insert. |
| 316 | "updated": "A String", # Time this web property was last modified. |
| 317 | "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). |
| 318 | # Set to false to delete data associated with the user identifier automatically after the rentention period. |
| 319 | # This property cannot be set on insert. |
| 320 | "name": "A String", # Name of this web property. |
| 321 | "websiteUrl": "A String", # Website url for this web property. |
| 322 | "created": "A String", # Time this web property was created. |
| 323 | "selfLink": "A String", # Link for this web property. |
| 324 | "starred": True or False, # Indicates whether this web property is starred or not. |
| 325 | "id": "A String", # Web property ID of the form UA-XXXXX-YY. |
| 326 | "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. |
| 327 | "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs. |
| 328 | "type": "analytics#account", # Type of the parent link. Its value is "analytics#account". |
| 329 | "href": "A String", # Link to the account for this web property. |
| 330 | }, |
| 331 | "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property. |
| 332 | "href": "A String", # Link to the list of views (profiles) for this web property. |
| 333 | "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles". |
| 334 | }, |
| 335 | "permissions": { # Permissions the user has for this web property. |
| 336 | "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. |
| 337 | "A String", |
| 338 | ], |
| 339 | }, |
| 340 | "industryVertical": "A String", # The industry vertical/category selected for this web property. |
| 341 | "accountId": "A String", # Account ID to which this web property belongs. |
| 342 | "defaultProfileId": "A String", # Default view (profile) ID. |
| 343 | "internalWebPropertyId": "A String", # Internal ID for this web property. |
| 344 | "profileCount": 42, # View (Profile) count for this web property. |
| 345 | "kind": "analytics#webproperty", # Resource type for Analytics WebProperty. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 346 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 347 | "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 348 | "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 349 | "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 350 | "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 351 | "type": "analytics#webproperty", # Value is "analytics#webproperty". |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 352 | "href": "A String", # Link to the web property to which this view (profile) belongs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 353 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 354 | "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). |
| 355 | "created": "A String", # Time this view (profile) was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are: |
| 357 | # 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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 358 | "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| 359 | "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). |
| 360 | "id": "A String", # View (Profile) ID. |
| 361 | "type": "A String", # View (Profile) type. Supported types: WEB or APP. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 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 | "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| 365 | "accountId": "A String", # Account ID to which this view (profile) belongs. |
| 366 | "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). |
| 367 | "updated": "A String", # Time this view (profile) was last modified. |
| 368 | "name": "A String", # Name of this view (profile). |
| 369 | "kind": "analytics#profile", # Resource type for Analytics view (profile). |
| 370 | "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile). |
| 371 | "href": "A String", # Link to the list of goals for this view (profile). |
| 372 | "type": "analytics#goals", # Value is "analytics#goals". |
| 373 | }, |
| 374 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| 375 | "websiteUrl": "A String", # Website URL for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "permissions": { # Permissions the user has for this view (profile). |
| 377 | "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. |
| 378 | "A String", |
| 379 | ], |
| 380 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 381 | "selfLink": "A String", # Link for this view (profile). |
| 382 | "starred": True or False, # Indicates whether this view (profile) is starred or not. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 383 | "defaultPage": "A String", # Default page for this view (profile). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 384 | "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 385 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 386 | "kind": "analytics#accountTreeResponse", # Resource type for account ticket. |
| 387 | "account": { # JSON template for Analytics account entry. # The account created. |
| 388 | "kind": "analytics#account", # Resource type for Analytics account. |
| 389 | "created": "A String", # Time the account was created. |
| 390 | "permissions": { # Permissions the user has for this account. |
| 391 | "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW). |
| 392 | "A String", |
| 393 | ], |
| 394 | }, |
| 395 | "updated": "A String", # Time the account was last modified. |
| 396 | "childLink": { # Child link for an account entry. Points to the list of web properties for this account. |
| 397 | "href": "A String", # Link to the list of web properties for this account. |
| 398 | "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties". |
| 399 | }, |
| 400 | "selfLink": "A String", # Link for this account. |
| 401 | "id": "A String", # Account ID. |
| 402 | "starred": True or False, # Indicates whether this account is starred or not. |
| 403 | "name": "A String", # Account name. |
| 404 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 405 | }</pre> |
| 406 | </div> |
| 407 | |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 408 | </body></html> |