archive method

Future<GoogleProtobufEmpty> archive(
  1. GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest request,
  2. String name, {
  3. String? $fields,
})

Archives a CustomDimension on a property.

request - The metadata request object.

Request parameters:

name - Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 Value must have pattern ^properties/\[^/\]+/customDimensions/\[^/\]+$.

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

Completes with a GoogleProtobufEmpty.

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<GoogleProtobufEmpty> archive(
  GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request);
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1alpha/' + core.Uri.encodeFull('$name') + ':archive';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return GoogleProtobufEmpty.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}