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="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.customMetrics.html">customMetrics</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Archives a CustomMetric on a property.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a CustomMetric.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Lookup for a single CustomMetric.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists CustomMetrics on a property.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a CustomMetric on a property.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code> 101 <pre>Archives a CustomMetric on a property. 102 103Args: 104 name: string, Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 (required) 105 body: object, The request body. 106 The object takes the form of: 107 108{ # Request message for ArchiveCustomMetric RPC. 109} 110 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 120}</pre> 121</div> 122 123<div class="method"> 124 <code class="details" id="close">close()</code> 125 <pre>Close httplib2 connections.</pre> 126</div> 127 128<div class="method"> 129 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 130 <pre>Creates a CustomMetric. 131 132Args: 133 parent: string, Required. Example format: properties/1234 (required) 134 body: object, The request body. 135 The object takes the form of: 136 137{ # A definition for a custom metric. 138 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 139 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 140 "measurementUnit": "A String", # Required. The type for the custom metric's value. 141 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 142 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 143 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 144 "A String", 145 ], 146 "scope": "A String", # Required. Immutable. The scope of this custom metric. 147} 148 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # A definition for a custom metric. 158 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 159 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 160 "measurementUnit": "A String", # Required. The type for the custom metric's value. 161 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 162 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 163 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 164 "A String", 165 ], 166 "scope": "A String", # Required. Immutable. The scope of this custom metric. 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="get">get(name, x__xgafv=None)</code> 172 <pre>Lookup for a single CustomMetric. 173 174Args: 175 name: string, Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 (required) 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # A definition for a custom metric. 185 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 186 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 187 "measurementUnit": "A String", # Required. The type for the custom metric's value. 188 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 189 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 190 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 191 "A String", 192 ], 193 "scope": "A String", # Required. Immutable. The scope of this custom metric. 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 199 <pre>Lists CustomMetrics on a property. 200 201Args: 202 parent: string, Required. Example format: properties/1234 (required) 203 pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). 204 pageToken: string, A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token. 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # Response message for ListCustomMetrics RPC. 214 "customMetrics": [ # List of CustomMetrics. 215 { # A definition for a custom metric. 216 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 217 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 218 "measurementUnit": "A String", # Required. The type for the custom metric's value. 219 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 220 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 221 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 222 "A String", 223 ], 224 "scope": "A String", # Required. Immutable. The scope of this custom metric. 225 }, 226 ], 227 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 233 <pre>Retrieves the next page of results. 234 235Args: 236 previous_request: The request for the previous page. (required) 237 previous_response: The response from the request for the previous page. (required) 238 239Returns: 240 A request object that you can call 'execute()' on to request the next 241 page. Returns None if there are no more items in the collection. 242 </pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 247 <pre>Updates a CustomMetric on a property. 248 249Args: 250 name: string, Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} (required) 251 body: object, The request body. 252 The object takes the form of: 253 254{ # A definition for a custom metric. 255 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 256 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 257 "measurementUnit": "A String", # Required. The type for the custom metric's value. 258 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 259 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 260 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 261 "A String", 262 ], 263 "scope": "A String", # Required. Immutable. The scope of this custom metric. 264} 265 266 updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. 267 x__xgafv: string, V1 error format. 268 Allowed values 269 1 - v1 error format 270 2 - v2 error format 271 272Returns: 273 An object of the form: 274 275 { # A definition for a custom metric. 276 "description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. 277 "displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. 278 "measurementUnit": "A String", # Required. The type for the custom metric's value. 279 "name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} 280 "parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. 281 "restrictedMetricType": [ # Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. 282 "A String", 283 ], 284 "scope": "A String", # Required. Immutable. The scope of this custom metric. 285}</pre> 286</div> 287 288</body></html>