Debian Codegraph @

docs/dyn/analytics_v3.management.customDimensions.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.customDimensions.html">customDimensions</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(accountId, webPropertyId, customDimensionId)</a></code></p>
82 <p class="firstline">Get a custom dimension to which the user has access.</p>
83 <p class="toc_element">
84 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
85 <p class="firstline">Create a new custom dimension.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
88 <p class="firstline">Lists custom dimensions to which the user has access.</p>
89 <p class="toc_element">
90 <code><a href="#patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
91 <p class="firstline">Updates an existing custom dimension. This method supports patch semantics.</p>
92 <p class="toc_element">
93 <code><a href="#update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
94 <p class="firstline">Updates an existing custom dimension.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="get">get(accountId, webPropertyId, customDimensionId)</code>
103 <pre>Get a custom dimension to which the user has access.
104
105 Args:
106 accountId: string, Account ID for the custom dimension to retrieve. (required)
107 webPropertyId: string, Web property ID for the custom dimension to retrieve. (required)
108 customDimensionId: string, The ID of the custom dimension to retrieve. (required)
109
110 Returns:
111 An object of the form:
112
113 { # JSON template for Analytics Custom Dimension.
114 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
115 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
116 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
117 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
118 &quot;index&quot;: 42, # Index of the custom dimension.
119 &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.
120 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
121 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
122 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
123 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
124 },
125 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
126 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
127 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
128 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
129 }</pre>
130 </div>
131
132 <div class="method">
133 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
134 <pre>Create a new custom dimension.
135
136 Args:
137 accountId: string, Account ID for the custom dimension to create. (required)
138 webPropertyId: string, Web property ID for the custom dimension to create. (required)
139 body: object, The request body.
140 The object takes the form of:
141
142 { # JSON template for Analytics Custom Dimension.
143 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
144 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
145 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
146 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
147 &quot;index&quot;: 42, # Index of the custom dimension.
148 &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.
149 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
150 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
151 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
152 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
153 },
154 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
155 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
156 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
157 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
158 }
159
160
161 Returns:
162 An object of the form:
163
164 { # JSON template for Analytics Custom Dimension.
165 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
166 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
167 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
168 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
169 &quot;index&quot;: 42, # Index of the custom dimension.
170 &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.
171 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
172 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
173 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
174 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
175 },
176 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
177 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
178 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
179 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
180 }</pre>
181 </div>
182
183 <div class="method">
184 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
185 <pre>Lists custom dimensions to which the user has access.
186
187 Args:
188 accountId: string, Account ID for the custom dimensions to retrieve. (required)
189 webPropertyId: string, Web property ID for the custom dimensions to retrieve. (required)
190 max_results: integer, The maximum number of custom dimensions to include in this response.
191 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
192
193 Returns:
194 An object of the form:
195
196 { # 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.
197 &quot;items&quot;: [ # Collection of custom dimensions.
198 { # JSON template for Analytics Custom Dimension.
199 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
200 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
201 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
202 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
203 &quot;index&quot;: 42, # Index of the custom dimension.
204 &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.
205 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
206 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
207 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
208 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
209 },
210 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
211 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
212 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
213 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
214 },
215 ],
216 &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.
217 &quot;kind&quot;: &quot;analytics#customDimensions&quot;, # Collection type.
218 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this custom dimension collection.
219 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this custom dimension collection.
220 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
221 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
222 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
223 }</pre>
224 </div>
225
226 <div class="method">
227 <code class="details" id="patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
228 <pre>Updates an existing custom dimension. This method supports patch semantics.
229
230 Args:
231 accountId: string, Account ID for the custom dimension to update. (required)
232 webPropertyId: string, Web property ID for the custom dimension to update. (required)
233 customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
234 body: object, The request body.
235 The object takes the form of:
236
237 { # JSON template for Analytics Custom Dimension.
238 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
239 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
240 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
241 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
242 &quot;index&quot;: 42, # Index of the custom dimension.
243 &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.
244 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
245 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
246 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
247 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
248 },
249 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
250 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
251 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
252 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
253 }
254
255 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
256
257 Returns:
258 An object of the form:
259
260 { # JSON template for Analytics Custom Dimension.
261 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
262 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
263 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
264 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
265 &quot;index&quot;: 42, # Index of the custom dimension.
266 &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.
267 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
268 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
269 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
270 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
271 },
272 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
273 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
274 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
275 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
276 }</pre>
277 </div>
278
279 <div class="method">
280 <code class="details" id="update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
281 <pre>Updates an existing custom dimension.
282
283 Args:
284 accountId: string, Account ID for the custom dimension to update. (required)
285 webPropertyId: string, Web property ID for the custom dimension to update. (required)
286 customDimensionId: string, Custom dimension ID for the custom dimension to update. (required)
287 body: object, The request body.
288 The object takes the form of:
289
290 { # JSON template for Analytics Custom Dimension.
291 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
292 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
293 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
294 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
295 &quot;index&quot;: 42, # Index of the custom dimension.
296 &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.
297 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
298 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
299 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
300 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
301 },
302 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
303 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
304 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
305 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
306 }
307
308 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
309
310 Returns:
311 An object of the form:
312
313 { # JSON template for Analytics Custom Dimension.
314 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
315 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
316 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
317 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
318 &quot;index&quot;: 42, # Index of the custom dimension.
319 &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.
320 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
321 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
322 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
323 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
324 },
325 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
326 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
327 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
328 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
329 }</pre>
330 </div>
331
332 </body></html>