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