get method

Future<CustomMetric> get(String accountId, String webPropertyId, String customMetricId, { String? $fields, })

Get a custom metric to which the user has access.

Request parameters:

accountId - Account ID for the custom metric to retrieve.

webPropertyId - Web property ID for the custom metric to retrieve.

customMetricId - The ID of the custom metric to retrieve.

$fields - Selector specifying which fields to include in a partial response.

Completes with a CustomMetric.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<CustomMetric> get(
  core.String accountId,
  core.String webPropertyId,
  core.String customMetricId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'management/accounts/' +
      commons.escapeVariable('$accountId') +
      '/webproperties/' +
      commons.escapeVariable('$webPropertyId') +
      '/customMetrics/' +
      commons.escapeVariable('$customMetricId');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return CustomMetric.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}