blob: 2f41c5150be975daf47fc95d8e8212d0e7c36e88 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -08001<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.management.html">management</a> . <a href="analytics_v3.management.customDimensions.html">customDimensions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(accountId, webPropertyId, customDimensionId)</a></code></p>
79<p class="firstline">Get a custom dimension to which the user has access.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080082<p class="firstline">Create a new custom dimension.</p>
83<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070084 <code><a href="#list">list(accountId, webPropertyId, start_index=None, max_results=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080085<p class="firstline">Lists custom dimensions to which the user has access.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080088<p class="firstline">Updates an existing custom dimension. This method supports patch semantics.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -080091<p class="firstline">Updates an existing custom dimension.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="get">get(accountId, webPropertyId, customDimensionId)</code>
95 <pre>Get a custom dimension to which the user has access.
96
97Args:
98 accountId: string, Account ID for the custom dimension to retrieve. (required)
99 webPropertyId: string, Web property ID for the custom dimension to retrieve. (required)
100 customDimensionId: string, The ID of the custom dimension to retrieve. (required)
101
102Returns:
103 An object of the form:
104
105 { # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700108 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
109 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
110 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
111 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
113 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
114 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
115 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
116 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
117 &quot;index&quot;: 42, # Index of the custom dimension.
118 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700119 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
120 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800121 }</pre>
122</div>
123
124<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700125 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800126 <pre>Create a new custom dimension.
127
128Args:
129 accountId: string, Account ID for the custom dimension to create. (required)
130 webPropertyId: string, Web property ID for the custom dimension to create. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700131 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800132 The object takes the form of:
133
134{ # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700137 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
138 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
139 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
140 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
142 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
143 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
144 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
145 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
146 &quot;index&quot;: 42, # Index of the custom dimension.
147 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700148 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
149 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800150 }
151
152
153Returns:
154 An object of the form:
155
156 { # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700159 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
160 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
161 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
162 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
164 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
165 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
166 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
167 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
168 &quot;index&quot;: 42, # Index of the custom dimension.
169 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700170 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
171 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800172 }</pre>
173</div>
174
175<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700176 <code class="details" id="list">list(accountId, webPropertyId, start_index=None, max_results=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800177 <pre>Lists custom dimensions to which the user has access.
178
179Args:
180 accountId: string, Account ID for the custom dimensions to retrieve. (required)
181 webPropertyId: string, Web property ID for the custom dimensions to retrieve. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800182 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700183 max_results: integer, The maximum number of custom dimensions to include in this response.
Craig Citroe633be12015-03-02 13:40:36 -0800184
185Returns:
186 An object of the form:
187
188 { # A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this custom dimension collection.
190 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this custom dimension collection.
191 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
192 &quot;items&quot;: [ # Collection of custom dimensions.
Craig Citroe633be12015-03-02 13:40:36 -0800193 { # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700195 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700196 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
197 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
198 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
199 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
201 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
202 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
203 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
204 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
205 &quot;index&quot;: 42, # Index of the custom dimension.
206 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700207 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
208 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800209 },
210 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700211 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
212 &quot;itemsPerPage&quot;: 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.
213 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
214 &quot;kind&quot;: &quot;analytics#customDimensions&quot;, # Collection type.
Craig Citroe633be12015-03-02 13:40:36 -0800215 }</pre>
216</div>
217
218<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700219 <code class="details" id="patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800220 <pre>Updates an existing custom dimension. This method supports patch semantics.
221
222Args:
223 accountId: string, Account ID for the custom dimension to update. (required)
224 webPropertyId: string, Web property ID for the custom dimension to update. (required)
225 customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700226 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800227 The object takes the form of:
228
229{ # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700232 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
233 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
234 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
235 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
237 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
238 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
239 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
240 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
241 &quot;index&quot;: 42, # Index of the custom dimension.
242 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700243 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
244 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800245 }
246
247 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
248
249Returns:
250 An object of the form:
251
252 { # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700255 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
256 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
257 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
258 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
260 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
261 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
262 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
263 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
264 &quot;index&quot;: 42, # Index of the custom dimension.
265 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700266 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
267 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800268 }</pre>
269</div>
270
271<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700272 <code class="details" id="update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800273 <pre>Updates an existing custom dimension.
274
275Args:
276 accountId: string, Account ID for the custom dimension to update. (required)
277 webPropertyId: string, Web property ID for the custom dimension to update. (required)
278 customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700279 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800280 The object takes the form of:
281
282{ # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700284 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700285 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
286 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
287 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
288 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700289 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
290 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
291 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
292 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
293 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
294 &quot;index&quot;: 42, # Index of the custom dimension.
295 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700296 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
297 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800298 }
299
300 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
301
302Returns:
303 An object of the form:
304
305 { # JSON template for Analytics Custom Dimension.
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Bu Sun Kim65020912020-05-20 12:08:20 -0700307 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700308 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
309 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
310 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
311 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700312 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
313 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
314 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
315 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
316 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
317 &quot;index&quot;: 42, # Index of the custom dimension.
318 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700319 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
320 &quot;kind&quot;: &quot;analytics#customDimension&quot;, # Kind value for a custom dimension. Set to &quot;analytics#customDimension&quot;. It is a read-only field.
Craig Citroe633be12015-03-02 13:40:36 -0800321 }</pre>
322</div>
323
324</body></html>