audit method

Future<AuditAdvertiserResponse> audit(
  1. String advertiserId, {
  2. String? readMask,
  3. String? $fields,
})

Audits an advertiser.

Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450.

Request parameters:

advertiserId - Required. The ID of the advertiser to audit. Value must have pattern ^\[^/\]+$.

readMask - Optional. The specific fields to return. If no mask is specified, all fields in the response proto will be filled. Valid values are: * usedLineItemsCount * usedInsertionOrdersCount * usedCampaignsCount

  • channelsCount * negativelyTargetedChannelsCount * negativeKeywordListsCount * adGroupCriteriaCount * campaignCriteriaCount

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

Completes with a AuditAdvertiserResponse.

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<AuditAdvertiserResponse> audit(
  core.String advertiserId, {
  core.String? readMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (readMask != null) 'readMask': [readMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v3/advertisers/' + core.Uri.encodeFull('$advertiserId') + ':audit';

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