generated/googleapis/lib/adexperiencereport/v1.dart

// Copyright 2017 Google LLC
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd

// This is a generated file (see the discoveryapis_generator project).

// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: deprecated_member_use_from_same_package
// ignore_for_file: doc_directive_unknown
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unintended_html_in_doc_comment
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_string_interpolations

/// Ad Experience Report API - v1
///
/// Views Ad Experience Report data, and gets a list of sites that have a
/// significant number of annoying ads.
///
/// For more information, see
/// <https://developers.google.com/ad-experience-report/>
///
/// Create an instance of [AdExperienceReportApi] to access these resources:
///
/// - [SitesResource]
/// - [ViolatingSitesResource]
library;

import 'dart:async' as async;
import 'dart:core' as core;

import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;

import '../src/user_agent.dart';

export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
    show ApiRequestError, DetailedApiRequestError;

/// Views Ad Experience Report data, and gets a list of sites that have a
/// significant number of annoying ads.
class AdExperienceReportApi {
  final commons.ApiRequester _requester;

  SitesResource get sites => SitesResource(_requester);
  ViolatingSitesResource get violatingSites =>
      ViolatingSitesResource(_requester);

  AdExperienceReportApi(
    http.Client client, {
    core.String rootUrl = 'https://adexperiencereport.googleapis.com/',
    core.String servicePath = '',
  }) : _requester = commons.ApiRequester(
         client,
         rootUrl,
         servicePath,
         requestHeaders,
       );
}

class SitesResource {
  final commons.ApiRequester _requester;

  SitesResource(commons.ApiRequester client) : _requester = client;

  /// Gets a site's Ad Experience Report summary.
  ///
  /// Request parameters:
  ///
  /// [name] - Required. The name of the site whose summary to get, e.g.
  /// `sites/http%3A%2F%2Fwww.google.com%2F`. Format: `sites/{site}`
  /// Value must have pattern `^sites/\[^/\]+$`.
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [SiteSummaryResponse].
  ///
  /// 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.
  async.Future<SiteSummaryResponse> get(
    core.String name, {
    core.String? $fields,
  }) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    final url_ = 'v1/' + core.Uri.encodeFull('$name');

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

class ViolatingSitesResource {
  final commons.ApiRequester _requester;

  ViolatingSitesResource(commons.ApiRequester client) : _requester = client;

  /// Lists sites that are failing in the Ad Experience Report on at least one
  /// platform.
  ///
  /// Request parameters:
  ///
  /// [$fields] - Selector specifying which fields to include in a partial
  /// response.
  ///
  /// Completes with a [ViolatingSitesResponse].
  ///
  /// 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.
  async.Future<ViolatingSitesResponse> list({core.String? $fields}) async {
    final queryParams_ = <core.String, core.List<core.String>>{
      'fields': ?$fields == null ? null : [$fields],
    };

    const url_ = 'v1/violatingSites';

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

/// A site's Ad Experience Report summary on a single platform.
class PlatformSummary {
  /// The site's Ad Experience Report status on this platform.
  /// Possible string values are:
  /// - "UNKNOWN" : Not reviewed.
  /// - "PASSING" : Passing.
  /// - "WARNING" : Warning. No longer a possible status.
  /// - "FAILING" : Failing.
  core.String? betterAdsStatus;

  /// The time at which
  /// [enforcement](https://support.google.com/webtools/answer/7308033) against
  /// the site began or will begin on this platform.
  ///
  /// Not set when the filter_status is OFF.
  core.String? enforcementTime;

  /// The site's
  /// [enforcement status](https://support.google.com/webtools/answer/7308033)
  /// on this platform.
  /// Possible string values are:
  /// - "UNKNOWN" : N/A.
  /// - "ON" : Ad filtering is on.
  /// - "OFF" : Ad filtering is off.
  /// - "PAUSED" : Ad filtering is paused.
  /// - "PENDING" : Ad filtering is pending.
  core.String? filterStatus;

  /// The time at which the site's status last changed on this platform.
  core.String? lastChangeTime;

  /// The site's regions on this platform.
  ///
  /// No longer populated, because there is no longer any semantic difference
  /// between sites in different regions.
  @core.Deprecated(
    'Not supported. Member documentation may have more information.',
  )
  core.List<core.String>? region;

  /// A link to the full Ad Experience Report for the site on this platform..
  ///
  /// Not set in ViolatingSitesResponse. Note that you must complete the
  /// [Search Console verification process](https://support.google.com/webmasters/answer/9008080)
  /// for the site before you can access the full report.
  core.String? reportUrl;

  /// Whether the site is currently under review on this platform.
  core.bool? underReview;

  PlatformSummary({
    this.betterAdsStatus,
    this.enforcementTime,
    this.filterStatus,
    this.lastChangeTime,
    this.region,
    this.reportUrl,
    this.underReview,
  });

  PlatformSummary.fromJson(core.Map json_)
    : this(
        betterAdsStatus: json_['betterAdsStatus'] as core.String?,
        enforcementTime: json_['enforcementTime'] as core.String?,
        filterStatus: json_['filterStatus'] as core.String?,
        lastChangeTime: json_['lastChangeTime'] as core.String?,
        region: (json_['region'] as core.List?)
            ?.map((value) => value as core.String)
            .toList(),
        reportUrl: json_['reportUrl'] as core.String?,
        underReview: json_['underReview'] as core.bool?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final betterAdsStatus = this.betterAdsStatus;
    final enforcementTime = this.enforcementTime;
    final filterStatus = this.filterStatus;
    final lastChangeTime = this.lastChangeTime;
    final region = this.region;
    final reportUrl = this.reportUrl;
    final underReview = this.underReview;
    return {
      'betterAdsStatus': ?betterAdsStatus,
      'enforcementTime': ?enforcementTime,
      'filterStatus': ?filterStatus,
      'lastChangeTime': ?lastChangeTime,
      'region': ?region,
      'reportUrl': ?reportUrl,
      'underReview': ?underReview,
    };
  }
}

/// Response message for GetSiteSummary.
class SiteSummaryResponse {
  /// The site's Ad Experience Report summary on desktop.
  PlatformSummary? desktopSummary;

  /// The site's Ad Experience Report summary on mobile.
  PlatformSummary? mobileSummary;

  /// The name of the reviewed site, e.g. `google.com`.
  core.String? reviewedSite;

  SiteSummaryResponse({
    this.desktopSummary,
    this.mobileSummary,
    this.reviewedSite,
  });

  SiteSummaryResponse.fromJson(core.Map json_)
    : this(
        desktopSummary: json_.containsKey('desktopSummary')
            ? PlatformSummary.fromJson(
                json_['desktopSummary'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        mobileSummary: json_.containsKey('mobileSummary')
            ? PlatformSummary.fromJson(
                json_['mobileSummary'] as core.Map<core.String, core.dynamic>,
              )
            : null,
        reviewedSite: json_['reviewedSite'] as core.String?,
      );

  core.Map<core.String, core.dynamic> toJson() {
    final desktopSummary = this.desktopSummary;
    final mobileSummary = this.mobileSummary;
    final reviewedSite = this.reviewedSite;
    return {
      'desktopSummary': ?desktopSummary,
      'mobileSummary': ?mobileSummary,
      'reviewedSite': ?reviewedSite,
    };
  }
}

/// Response message for ListViolatingSites.
class ViolatingSitesResponse {
  /// The list of violating sites.
  core.List<SiteSummaryResponse>? violatingSites;

  ViolatingSitesResponse({this.violatingSites});

  ViolatingSitesResponse.fromJson(core.Map json_)
    : this(
        violatingSites: (json_['violatingSites'] as core.List?)
            ?.map(
              (value) => SiteSummaryResponse.fromJson(
                value as core.Map<core.String, core.dynamic>,
              ),
            )
            .toList(),
      );

  core.Map<core.String, core.dynamic> toJson() {
    final violatingSites = this.violatingSites;
    return {'violatingSites': ?violatingSites};
  }
}