patch method

Future<CustomMetric> patch(CustomMetric request, String accountId, String webPropertyId, String customMetricId, { bool? ignoreCustomDataSourceLinks, String? $fields, })

Updates an existing custom metric.

This method supports patch semantics.

request - The metadata request object.

Request parameters:

accountId - Account ID for the custom metric to update.

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

customMetricId - Custom metric ID for the custom metric to update.

ignoreCustomDataSourceLinks - Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

$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> patch(
  CustomMetric request,
  core.String accountId,
  core.String webPropertyId,
  core.String customMetricId, {
  core.bool? ignoreCustomDataSourceLinks,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (ignoreCustomDataSourceLinks != null)
      'ignoreCustomDataSourceLinks': ['${ignoreCustomDataSourceLinks}'],
    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_,
    'PATCH',
    body: body_,
    queryParams: queryParams_,
  );
  return CustomMetric.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}