Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / analytics_v3.management.customDimensions.html
blob: ca06351b27cb7fce75fddbee82d84db05ccd7220 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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.management.html">management</a> . <a href="analytics_v3.management.customDimensions.html">customDimensions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]85<p class="firstline">Create a new custom dimension.</p>
86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]87 <code><a href="#list">list(accountId, webPropertyId, start_index=None, max_results=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]88<p class="firstline">Lists custom dimensions to which the user has access.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<p class="firstline">Updates an existing custom dimension. This method supports patch semantics.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]94<p class="firstline">Updates an existing custom dimension.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]102 <code class="details" id="get">get(accountId, webPropertyId, customDimensionId)</code>
103 <pre>Get a custom dimension to which the user has access.
104
105Args:
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
110Returns:
111 An object of the form:
112
113 { # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]114 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]115 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]116 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
117 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
118 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
119 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
120 },
121 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]122 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
123 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]124 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]125 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]126 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]127 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]128 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]129 }</pre>
130</div>
131
132<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]134 <pre>Create a new custom dimension.
135
136Args:
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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140 The object takes the form of:
141
142{ # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]143 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]144 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]145 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
146 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
147 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
148 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
149 },
150 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]151 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
152 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]153 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]154 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]155 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]156 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]157 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]158 }
159
160
161Returns:
162 An object of the form:
163
164 { # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]165 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]166 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]167 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
168 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
169 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
170 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
171 },
172 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
174 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]175 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]176 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]177 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]178 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]179 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]180 }</pre>
181</div>
182
183<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]184 <code class="details" id="list">list(accountId, webPropertyId, start_index=None, max_results=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]185 <pre>Lists custom dimensions to which the user has access.
186
187Args:
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)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]190 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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]191 max_results: integer, The maximum number of custom dimensions to include in this response.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]192
193Returns:
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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]197 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this custom dimension collection.
198 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;items&quot;: [ # Collection of custom dimensions.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]200 { # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]201 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]202 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]203 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
204 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
205 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
206 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
207 },
208 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]209 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
210 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]211 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]212 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]213 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]214 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]215 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]216 },
217 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]218 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this custom dimension collection.
219 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]220 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]221 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
222 &quot;kind&quot;: &quot;analytics#customDimensions&quot;, # Collection type.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]223 }</pre>
224</div>
225
226<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 <code class="details" id="patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]228 <pre>Updates an existing custom dimension. This method supports patch semantics.
229
230Args:
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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]234 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 The object takes the form of:
236
237{ # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]238 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]239 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]240 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
241 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
242 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
243 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
244 },
245 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]246 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
247 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]248 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]249 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]250 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]251 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]252 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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
257Returns:
258 An object of the form:
259
260 { # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]261 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]262 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]263 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
264 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
265 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
266 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
267 },
268 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]269 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
270 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]271 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]272 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]273 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]274 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]275 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]276 }</pre>
277</div>
278
279<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]280 <code class="details" id="update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]281 <pre>Updates an existing custom dimension.
282
283Args:
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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]288 The object takes the form of:
289
290{ # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]291 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]292 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]293 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
294 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
295 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
296 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
297 },
298 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]299 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
300 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]301 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]302 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]303 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]304 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]305 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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
310Returns:
311 An object of the form:
312
313 { # JSON template for Analytics Custom Dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]314 &quot;index&quot;: 42, # Index of the custom dimension.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]315 &quot;updated&quot;: &quot;A String&quot;, # Time the custom dimension was last modified.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]316 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom dimension
317 &quot;parentLink&quot;: { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
318 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom dimension belongs.
319 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
320 },
321 &quot;id&quot;: &quot;A String&quot;, # Custom dimension ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]322 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
323 &quot;name&quot;: &quot;A String&quot;, # Name of the custom dimension.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]324 &quot;created&quot;: &quot;A String&quot;, # Time the custom dimension was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]325 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]326 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]327 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]328 &quot;active&quot;: True or False, # Boolean indicating whether the custom dimension is active.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]329 }</pre>
330</div>
331
332</body></html>