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