Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dc6c1efea8e6c89afa94df984d9291359cb04797 / . / docs / dyn / analytics_v3.provisioning.html
blob: 261154aea3626331d9187fb74895b73f7ad1d121 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.provisioning.html">provisioning</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#createAccountTicket">createAccountTicket(body)</a></code></p>
79<p class="firstline">Creates an account ticket.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="createAccountTicket">createAccountTicket(body)</code>
83 <pre>Creates an account ticket.
84
85Args:
86 body: object, The request body. (required)
87 The object takes the form of:
88
89{ # 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.
90 "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]91 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]92 # 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
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]93 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
94 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
95 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
96 "id": "A String", # View (Profile) ID.
97 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]98 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]99 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
100 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
101 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
102 "updated": "A String", # Time this view (profile) was last modified.
103 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
104 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
105 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
106 "href": "A String", # Link to the list of goals for this view (profile).
107 "type": "analytics#goals", # Value is "analytics#goals".
108 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]109 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]110 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
111 "href": "A String", # Link to the web property to which this view (profile) belongs.
112 "type": "analytics#webproperty", # Value is "analytics#webproperty".
113 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]114 "permissions": { # Permissions the user has for this view (profile).
115 "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.
116 "A String",
117 ],
118 },
119 "defaultPage": "A String", # Default page for this view (profile).
120 "kind": "analytics#profile", # Resource type for Analytics view (profile).
121 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
122 "name": "A String", # Name of this view (profile).
123 "created": "A String", # Time this view (profile) was created.
124 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
125 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]126 "starred": True or False, # Indicates whether this view (profile) is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 "selfLink": "A String", # Link for this view (profile).
128 },
129 "account": { # JSON template for Analytics account entry. # Account for this ticket.
130 "kind": "analytics#account", # Resource type for Analytics account.
131 "name": "A String", # Account name.
132 "created": "A String", # Time the account was created.
133 "updated": "A String", # Time the account was last modified.
134 "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
135 "href": "A String", # Link to the list of web properties for this account.
136 "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
137 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]138 "starred": True or False, # Indicates whether this account is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 "id": "A String", # Account ID.
140 "selfLink": "A String", # Link for this account.
141 "permissions": { # Permissions the user has for this account.
142 "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
143 "A String",
144 ],
145 },
146 },
147 "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
148 "websiteUrl": "A String", # Website url for this web property.
149 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
150 "name": "A String", # Name of this web property.
151 "created": "A String", # Time this web property was created.
152 "defaultProfileId": "A String", # Default view (profile) ID.
153 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
154 "updated": "A String", # Time this web property was last modified.
155 "profileCount": 42, # View (Profile) count for this web property.
156 "internalWebPropertyId": "A String", # Internal ID for this web property.
157 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
158 "href": "A String", # Link to the list of views (profiles) for this web property.
159 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
160 },
161 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]162 "starred": True or False, # Indicates whether this web property is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]163 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
164 "href": "A String", # Link to the account for this web property.
165 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
166 },
167 "permissions": { # Permissions the user has for this web property.
168 "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.
169 "A String",
170 ],
171 },
172 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
173 "selfLink": "A String", # Link for this web property.
174 "accountId": "A String", # Account ID to which this web property belongs.
175 },
176 "kind": "analytics#accountTicket", # Resource type for account ticket.
177 "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.
178 "id": "A String", # Account ticket ID used to access the account ticket.
179 }
180
181
182Returns:
183 An object of the form:
184
185 { # 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.
186 "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]187 "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]188 # 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
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]189 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
190 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
191 "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
192 "id": "A String", # View (Profile) ID.
193 "accountId": "A String", # Account ID to which this view (profile) belongs.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194 "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]195 "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
196 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
197 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
198 "updated": "A String", # Time this view (profile) was last modified.
199 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
200 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
201 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
202 "href": "A String", # Link to the list of goals for this view (profile).
203 "type": "analytics#goals", # Value is "analytics#goals".
204 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]205 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]206 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
207 "href": "A String", # Link to the web property to which this view (profile) belongs.
208 "type": "analytics#webproperty", # Value is "analytics#webproperty".
209 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 "permissions": { # Permissions the user has for this view (profile).
211 "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.
212 "A String",
213 ],
214 },
215 "defaultPage": "A String", # Default page for this view (profile).
216 "kind": "analytics#profile", # Resource type for Analytics view (profile).
217 "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
218 "name": "A String", # Name of this view (profile).
219 "created": "A String", # Time this view (profile) was created.
220 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
221 "websiteUrl": "A String", # Website URL for this view (profile).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]222 "starred": True or False, # Indicates whether this view (profile) is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]223 "selfLink": "A String", # Link for this view (profile).
224 },
225 "account": { # JSON template for Analytics account entry. # Account for this ticket.
226 "kind": "analytics#account", # Resource type for Analytics account.
227 "name": "A String", # Account name.
228 "created": "A String", # Time the account was created.
229 "updated": "A String", # Time the account was last modified.
230 "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
231 "href": "A String", # Link to the list of web properties for this account.
232 "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
233 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]234 "starred": True or False, # Indicates whether this account is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]235 "id": "A String", # Account ID.
236 "selfLink": "A String", # Link for this account.
237 "permissions": { # Permissions the user has for this account.
238 "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
239 "A String",
240 ],
241 },
242 },
243 "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
244 "websiteUrl": "A String", # Website url for this web property.
245 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
246 "name": "A String", # Name of this web property.
247 "created": "A String", # Time this web property was created.
248 "defaultProfileId": "A String", # Default view (profile) ID.
249 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
250 "updated": "A String", # Time this web property was last modified.
251 "profileCount": 42, # View (Profile) count for this web property.
252 "internalWebPropertyId": "A String", # Internal ID for this web property.
253 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
254 "href": "A String", # Link to the list of views (profiles) for this web property.
255 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
256 },
257 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]258 "starred": True or False, # Indicates whether this web property is starred or not.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]259 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
260 "href": "A String", # Link to the account for this web property.
261 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
262 },
263 "permissions": { # Permissions the user has for this web property.
264 "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.
265 "A String",
266 ],
267 },
268 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
269 "selfLink": "A String", # Link for this web property.
270 "accountId": "A String", # Account ID to which this web property belongs.
271 },
272 "kind": "analytics#accountTicket", # Resource type for account ticket.
273 "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.
274 "id": "A String", # Account ticket ID used to access the account ticket.
275 }</pre>
276</div>
277
278</body></html>