<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/ads/googleads/v25/services/benchmarks_service.proto

namespace Google\Ads\GoogleAds\V25\Services;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Response message for
 * [BenchmarksService.GenerateBenchmarksMetrics][google.ads.googleads.v25.services.BenchmarksService.GenerateBenchmarksMetrics].
 *
 * Generated from protobuf message <code>google.ads.googleads.v25.services.GenerateBenchmarksMetricsResponse</code>
 */
class GenerateBenchmarksMetricsResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * Metrics representing the customer's Ad performance.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CustomerMetrics customer_metrics = 4;</code>
     */
    protected $customer_metrics = null;
    /**
     * Metrics for the selected benchmarks source. Rate metrics for the benchmarks
     * source are only returned when the request `date_range` is a subset of
     * `supported_dates_for_all_metrics` returned by
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates]
     * due to limited availability.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.Metrics average_benchmarks_metrics = 2;</code>
     */
    protected $average_benchmarks_metrics = null;
    /**
     * Breakdown metrics grouped by dimensions.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.services.BreakdownMetrics breakdown_metrics = 3;</code>
     */
    private $breakdown_metrics;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Ads\GoogleAds\V25\Services\CustomerMetrics $customer_metrics
     *           Metrics representing the customer's Ad performance.
     *     @type \Google\Ads\GoogleAds\V25\Services\Metrics $average_benchmarks_metrics
     *           Metrics for the selected benchmarks source. Rate metrics for the benchmarks
     *           source are only returned when the request `date_range` is a subset of
     *           `supported_dates_for_all_metrics` returned by
     *           [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates]
     *           due to limited availability.
     *     @type \Google\Ads\GoogleAds\V25\Services\BreakdownMetrics[] $breakdown_metrics
     *           Breakdown metrics grouped by dimensions.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V25\Services\BenchmarksService::initOnce();
        parent::__construct($data);
    }

    /**
     * Metrics representing the customer's Ad performance.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CustomerMetrics customer_metrics = 4;</code>
     * @return \Google\Ads\GoogleAds\V25\Services\CustomerMetrics|null
     */
    public function getCustomerMetrics()
    {
        return $this->customer_metrics;
    }

    public function hasCustomerMetrics()
    {
        return isset($this->customer_metrics);
    }

    public function clearCustomerMetrics()
    {
        unset($this->customer_metrics);
    }

    /**
     * Metrics representing the customer's Ad performance.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CustomerMetrics customer_metrics = 4;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\CustomerMetrics $var
     * @return $this
     */
    public function setCustomerMetrics($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\CustomerMetrics::class);
        $this->customer_metrics = $var;

        return $this;
    }

    /**
     * Metrics for the selected benchmarks source. Rate metrics for the benchmarks
     * source are only returned when the request `date_range` is a subset of
     * `supported_dates_for_all_metrics` returned by
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates]
     * due to limited availability.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.Metrics average_benchmarks_metrics = 2;</code>
     * @return \Google\Ads\GoogleAds\V25\Services\Metrics|null
     */
    public function getAverageBenchmarksMetrics()
    {
        return $this->average_benchmarks_metrics;
    }

    public function hasAverageBenchmarksMetrics()
    {
        return isset($this->average_benchmarks_metrics);
    }

    public function clearAverageBenchmarksMetrics()
    {
        unset($this->average_benchmarks_metrics);
    }

    /**
     * Metrics for the selected benchmarks source. Rate metrics for the benchmarks
     * source are only returned when the request `date_range` is a subset of
     * `supported_dates_for_all_metrics` returned by
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates]
     * due to limited availability.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.Metrics average_benchmarks_metrics = 2;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\Metrics $var
     * @return $this
     */
    public function setAverageBenchmarksMetrics($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\Metrics::class);
        $this->average_benchmarks_metrics = $var;

        return $this;
    }

    /**
     * Breakdown metrics grouped by dimensions.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.services.BreakdownMetrics breakdown_metrics = 3;</code>
     * @return RepeatedField<\Google\Ads\GoogleAds\V25\Services\BreakdownMetrics>
     */
    public function getBreakdownMetrics()
    {
        return $this->breakdown_metrics;
    }

    /**
     * Breakdown metrics grouped by dimensions.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.services.BreakdownMetrics breakdown_metrics = 3;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\BreakdownMetrics[] $var
     * @return $this
     */
    public function setBreakdownMetrics($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V25\Services\BreakdownMetrics::class);
        $this->breakdown_metrics = $arr;

        return $this;
    }

}

