Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / analytics_v3.management.customMetrics.html
blob: f0acf67057c4a3e79be50aa064bb9e1aff698ebc [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.customMetrics.html">customMetrics</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, customMetricId)</a></code></p>
82<p class="firstline">Get a custom metric 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 metric.</p>
86<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[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 metrics 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, customMetricId, 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 metric. 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, customMetricId, 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 metric.</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, customMetricId)</code>
103 <pre>Get a custom metric to which the user has access.
104
105Args:
106 accountId: string, Account ID for the custom metric to retrieve. (required)
107 webPropertyId: string, Web property ID for the custom metric to retrieve. (required)
108 customMetricId: string, The ID of the custom metric to retrieve. (required)
109
110Returns:
111 An object of the form:
112
113 { # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]114 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]115 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]116 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]117 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
118 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
119 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
120 },
121 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
122 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
123 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
124 &quot;index&quot;: 42, # Index of the custom metric.
125 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
126 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
127 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
128 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
129 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
130 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
131 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]132 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]133</div>
134
135<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]136 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 <pre>Create a new custom metric.
138
139Args:
140 accountId: string, Account ID for the custom metric to create. (required)
141 webPropertyId: string, Web property ID for the custom dimension to create. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]142 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]143 The object takes the form of:
144
145{ # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]146 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]147 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]148 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]149 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
150 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
151 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
152 },
153 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
154 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
155 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
156 &quot;index&quot;: 42, # Index of the custom metric.
157 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
158 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
159 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
160 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
161 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
162 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
163 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]164 }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]165
166
167Returns:
168 An object of the form:
169
170 { # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]171 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]172 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]174 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
175 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
176 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
177 },
178 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
179 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
180 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
181 &quot;index&quot;: 42, # Index of the custom metric.
182 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
183 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
184 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
185 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
186 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
187 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
188 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]189 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190</div>
191
192<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]193 <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]194 <pre>Lists custom metrics to which the user has access.
195
196Args:
197 accountId: string, Account ID for the custom metrics to retrieve. (required)
198 webPropertyId: string, Web property ID for the custom metrics to retrieve. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]200 max_results: integer, The maximum number of custom metrics to include in this response.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]201
202Returns:
203 An object of the form:
204
205 { # A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]206 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this custom metric collection.
207 &quot;kind&quot;: &quot;analytics#customMetrics&quot;, # Collection type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]208 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
209 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
210 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
211 &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.
212 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this custom metric collection.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]213 &quot;items&quot;: [ # Collection of custom metrics.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]214 { # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]215 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]216 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]217 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]218 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
219 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
220 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
221 },
222 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
223 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
224 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
225 &quot;index&quot;: 42, # Index of the custom metric.
226 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
227 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
228 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
229 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
230 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
231 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
232 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]233 },
234 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 }</pre>
236</div>
237
238<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]239 <code class="details" id="patch">patch(accountId, webPropertyId, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]240 <pre>Updates an existing custom metric. This method supports patch semantics.
241
242Args:
243 accountId: string, Account ID for the custom metric to update. (required)
244 webPropertyId: string, Web property ID for the custom metric to update. (required)
245 customMetricId: string, Custom metric ID for the custom metric to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]247 The object takes the form of:
248
249{ # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]250 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]251 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]252 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]253 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
254 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
255 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
256 },
257 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
258 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
259 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
260 &quot;index&quot;: 42, # Index of the custom metric.
261 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
262 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
263 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
264 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
265 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
266 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
267 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]268 }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]269
270 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
271
272Returns:
273 An object of the form:
274
275 { # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]276 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]277 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]278 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]279 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
280 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
281 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
282 },
283 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
284 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
285 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
286 &quot;index&quot;: 42, # Index of the custom metric.
287 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
288 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
289 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
290 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
291 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
292 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
293 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]294 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]295</div>
296
297<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]298 <code class="details" id="update">update(accountId, webPropertyId, customMetricId, body=None, ignoreCustomDataSourceLinks=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]299 <pre>Updates an existing custom metric.
300
301Args:
302 accountId: string, Account ID for the custom metric to update. (required)
303 webPropertyId: string, Web property ID for the custom metric to update. (required)
304 customMetricId: string, Custom metric ID for the custom metric to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]305 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]306 The object takes the form of:
307
308{ # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]309 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]310 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]311 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]312 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
313 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
314 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
315 },
316 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
317 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
318 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
319 &quot;index&quot;: 42, # Index of the custom metric.
320 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
321 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
322 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
323 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
324 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
325 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
326 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]327 }
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]328
329 ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
330
331Returns:
332 An object of the form:
333
334 { # JSON template for Analytics Custom Metric.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]335 &quot;kind&quot;: &quot;analytics#customMetric&quot;, # Kind value for a custom metric. Set to &quot;analytics#customMetric&quot;. It is a read-only field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]336 &quot;id&quot;: &quot;A String&quot;, # Custom metric ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]337 &quot;type&quot;: &quot;A String&quot;, # Data type of custom metric.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]338 &quot;parentLink&quot;: { # Parent link for the custom metric. Points to the property to which the custom metric belongs.
339 &quot;href&quot;: &quot;A String&quot;, # Link to the property to which the custom metric belongs.
340 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Type of the parent link. Set to &quot;analytics#webproperty&quot;.
341 },
342 &quot;scope&quot;: &quot;A String&quot;, # Scope of the custom metric: HIT or PRODUCT.
343 &quot;name&quot;: &quot;A String&quot;, # Name of the custom metric.
344 &quot;min_value&quot;: &quot;A String&quot;, # Min value of custom metric.
345 &quot;index&quot;: 42, # Index of the custom metric.
346 &quot;updated&quot;: &quot;A String&quot;, # Time the custom metric was last modified.
347 &quot;active&quot;: True or False, # Boolean indicating whether the custom metric is active.
348 &quot;max_value&quot;: &quot;A String&quot;, # Max value of custom metric.
349 &quot;selfLink&quot;: &quot;A String&quot;, # Link for the custom metric
350 &quot;accountId&quot;: &quot;A String&quot;, # Account ID.
351 &quot;webPropertyId&quot;: &quot;A String&quot;, # Property ID.
352 &quot;created&quot;: &quot;A String&quot;, # Time the custom metric was created.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]353 }</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]354</div>
355
356</body></html>