<?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;

/**
 * Request message for
 * [BenchmarksService.GenerateBenchmarksMetrics][google.ads.googleads.v25.services.BenchmarksService.GenerateBenchmarksMetrics].
 *
 * Generated from protobuf message <code>google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest</code>
 */
class GenerateBenchmarksMetricsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The ID of the customer. Supply a client customer ID to generate
     * metrics for the customer. A manager account customer ID will not return
     * customer metrics since it does not have any associated direct ad campaigns.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $customer_id = '';
    /**
     * The date range to aggregate metrics over. If unset, data will be returned
     * for the most recent quarter for which data is available. Dates can be
     * retrieved using
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.DateRange date_range = 2;</code>
     */
    protected $date_range = null;
    /**
     * Required. The location to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $location = null;
    /**
     * Required. The source used to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $benchmarks_source = null;
    /**
     * A list of Product & Service Categories for scoping a YouTube benchmarks
     * analysis. For example, when category "/Apparel/Clothing" is selected,
     * customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
     * and the customer is benchmarking against all advertisers’ Ads in the
     * "/Apparel/Clothing" category.
     * This filter can only be used when `all_advertisers` is used as the
     * [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CategoryFilter category_filter = 10;</code>
     */
    protected $category_filter = null;
    /**
     * Required. The products to aggregate metrics over. Product filter settings
     * support a list of product IDs or a list of marketing objectives.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $product_filter = null;
    /**
     * Optional. The set of dimensions to group metrics by. If multiple dimensions
     * are selected, cross-dimension breakdowns are returned.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $breakdown_definition = null;
    /**
     * Optional. The three-character ISO 4217 currency code. If unspecified, the
     * default currency for monetary values is USD.
     *
     * Generated from protobuf field <code>string currency_code = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $currency_code = '';
    /**
     * The name of the customer being planned for. This is a user-defined value.
     *
     * Generated from protobuf field <code>string customer_benchmarks_group = 7;</code>
     */
    protected $customer_benchmarks_group = '';
    /**
     * Optional. Optional features to include in the response. By default, only
     * core data is returned. Including supplemental data here will populate
     * additional metrics in the response such as percentile metrics.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.BenchmarksSupplementalDataEnum.BenchmarksSupplementalData supplemental_data = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $supplemental_data;
    /**
     * Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;</code>
     */
    protected $application_info = null;

    /**
     * @param string                                              $customerId       Required. The ID of the customer. Supply a client customer ID to generate
     *                                                                              metrics for the customer. A manager account customer ID will not return
     *                                                                              customer metrics since it does not have any associated direct ad campaigns.
     * @param \Google\Ads\GoogleAds\V25\Common\LocationInfo       $location         Required. The location to generate benchmarks metrics for.
     * @param \Google\Ads\GoogleAds\V25\Services\BenchmarksSource $benchmarksSource Required. The source used to generate benchmarks metrics for.
     * @param \Google\Ads\GoogleAds\V25\Services\ProductFilter    $productFilter    Required. The products to aggregate metrics over. Product filter settings
     *                                                                              support a list of product IDs or a list of marketing objectives.
     *
     * @return \Google\Ads\GoogleAds\V25\Services\GenerateBenchmarksMetricsRequest
     *
     * @experimental
     */
    public static function build(string $customerId, \Google\Ads\GoogleAds\V25\Common\LocationInfo $location, \Google\Ads\GoogleAds\V25\Services\BenchmarksSource $benchmarksSource, \Google\Ads\GoogleAds\V25\Services\ProductFilter $productFilter): self
    {
        return (new self())
            ->setCustomerId($customerId)
            ->setLocation($location)
            ->setBenchmarksSource($benchmarksSource)
            ->setProductFilter($productFilter);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $customer_id
     *           Required. The ID of the customer. Supply a client customer ID to generate
     *           metrics for the customer. A manager account customer ID will not return
     *           customer metrics since it does not have any associated direct ad campaigns.
     *     @type \Google\Ads\GoogleAds\V25\Common\DateRange $date_range
     *           The date range to aggregate metrics over. If unset, data will be returned
     *           for the most recent quarter for which data is available. Dates can be
     *           retrieved using
     *           [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
     *     @type \Google\Ads\GoogleAds\V25\Common\LocationInfo $location
     *           Required. The location to generate benchmarks metrics for.
     *     @type \Google\Ads\GoogleAds\V25\Services\BenchmarksSource $benchmarks_source
     *           Required. The source used to generate benchmarks metrics for.
     *     @type \Google\Ads\GoogleAds\V25\Services\CategoryFilter $category_filter
     *           A list of Product & Service Categories for scoping a YouTube benchmarks
     *           analysis. For example, when category "/Apparel/Clothing" is selected,
     *           customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
     *           and the customer is benchmarking against all advertisers’ Ads in the
     *           "/Apparel/Clothing" category.
     *           This filter can only be used when `all_advertisers` is used as the
     *           [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
     *     @type \Google\Ads\GoogleAds\V25\Services\ProductFilter $product_filter
     *           Required. The products to aggregate metrics over. Product filter settings
     *           support a list of product IDs or a list of marketing objectives.
     *     @type \Google\Ads\GoogleAds\V25\Services\BreakdownDefinition $breakdown_definition
     *           Optional. The set of dimensions to group metrics by. If multiple dimensions
     *           are selected, cross-dimension breakdowns are returned.
     *     @type string $currency_code
     *           Optional. The three-character ISO 4217 currency code. If unspecified, the
     *           default currency for monetary values is USD.
     *     @type string $customer_benchmarks_group
     *           The name of the customer being planned for. This is a user-defined value.
     *     @type int[] $supplemental_data
     *           Optional. Optional features to include in the response. By default, only
     *           core data is returned. Including supplemental data here will populate
     *           additional metrics in the response such as percentile metrics.
     *     @type \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo $application_info
     *           Additional information on the application issuing the request.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V25\Services\BenchmarksService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The ID of the customer. Supply a client customer ID to generate
     * metrics for the customer. A manager account customer ID will not return
     * customer metrics since it does not have any associated direct ad campaigns.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return string
     */
    public function getCustomerId()
    {
        return $this->customer_id;
    }

    /**
     * Required. The ID of the customer. Supply a client customer ID to generate
     * metrics for the customer. A manager account customer ID will not return
     * customer metrics since it does not have any associated direct ad campaigns.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param string $var
     * @return $this
     */
    public function setCustomerId($var)
    {
        GPBUtil::checkString($var, True);
        $this->customer_id = $var;

        return $this;
    }

    /**
     * The date range to aggregate metrics over. If unset, data will be returned
     * for the most recent quarter for which data is available. Dates can be
     * retrieved using
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.DateRange date_range = 2;</code>
     * @return \Google\Ads\GoogleAds\V25\Common\DateRange|null
     */
    public function getDateRange()
    {
        return $this->date_range;
    }

    public function hasDateRange()
    {
        return isset($this->date_range);
    }

    public function clearDateRange()
    {
        unset($this->date_range);
    }

    /**
     * The date range to aggregate metrics over. If unset, data will be returned
     * for the most recent quarter for which data is available. Dates can be
     * retrieved using
     * [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.DateRange date_range = 2;</code>
     * @param \Google\Ads\GoogleAds\V25\Common\DateRange $var
     * @return $this
     */
    public function setDateRange($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Common\DateRange::class);
        $this->date_range = $var;

        return $this;
    }

    /**
     * Required. The location to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Ads\GoogleAds\V25\Common\LocationInfo|null
     */
    public function getLocation()
    {
        return $this->location;
    }

    public function hasLocation()
    {
        return isset($this->location);
    }

    public function clearLocation()
    {
        unset($this->location);
    }

    /**
     * Required. The location to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Ads\GoogleAds\V25\Common\LocationInfo $var
     * @return $this
     */
    public function setLocation($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Common\LocationInfo::class);
        $this->location = $var;

        return $this;
    }

    /**
     * Required. The source used to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Ads\GoogleAds\V25\Services\BenchmarksSource|null
     */
    public function getBenchmarksSource()
    {
        return $this->benchmarks_source;
    }

    public function hasBenchmarksSource()
    {
        return isset($this->benchmarks_source);
    }

    public function clearBenchmarksSource()
    {
        unset($this->benchmarks_source);
    }

    /**
     * Required. The source used to generate benchmarks metrics for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Ads\GoogleAds\V25\Services\BenchmarksSource $var
     * @return $this
     */
    public function setBenchmarksSource($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\BenchmarksSource::class);
        $this->benchmarks_source = $var;

        return $this;
    }

    /**
     * A list of Product & Service Categories for scoping a YouTube benchmarks
     * analysis. For example, when category "/Apparel/Clothing" is selected,
     * customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
     * and the customer is benchmarking against all advertisers’ Ads in the
     * "/Apparel/Clothing" category.
     * This filter can only be used when `all_advertisers` is used as the
     * [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CategoryFilter category_filter = 10;</code>
     * @return \Google\Ads\GoogleAds\V25\Services\CategoryFilter|null
     */
    public function getCategoryFilter()
    {
        return $this->category_filter;
    }

    public function hasCategoryFilter()
    {
        return isset($this->category_filter);
    }

    public function clearCategoryFilter()
    {
        unset($this->category_filter);
    }

    /**
     * A list of Product & Service Categories for scoping a YouTube benchmarks
     * analysis. For example, when category "/Apparel/Clothing" is selected,
     * customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
     * and the customer is benchmarking against all advertisers’ Ads in the
     * "/Apparel/Clothing" category.
     * This filter can only be used when `all_advertisers` is used as the
     * [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.CategoryFilter category_filter = 10;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\CategoryFilter $var
     * @return $this
     */
    public function setCategoryFilter($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\CategoryFilter::class);
        $this->category_filter = $var;

        return $this;
    }

    /**
     * Required. The products to aggregate metrics over. Product filter settings
     * support a list of product IDs or a list of marketing objectives.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Ads\GoogleAds\V25\Services\ProductFilter|null
     */
    public function getProductFilter()
    {
        return $this->product_filter;
    }

    public function hasProductFilter()
    {
        return isset($this->product_filter);
    }

    public function clearProductFilter()
    {
        unset($this->product_filter);
    }

    /**
     * Required. The products to aggregate metrics over. Product filter settings
     * support a list of product IDs or a list of marketing objectives.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Ads\GoogleAds\V25\Services\ProductFilter $var
     * @return $this
     */
    public function setProductFilter($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\ProductFilter::class);
        $this->product_filter = $var;

        return $this;
    }

    /**
     * Optional. The set of dimensions to group metrics by. If multiple dimensions
     * are selected, cross-dimension breakdowns are returned.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Ads\GoogleAds\V25\Services\BreakdownDefinition|null
     */
    public function getBreakdownDefinition()
    {
        return $this->breakdown_definition;
    }

    public function hasBreakdownDefinition()
    {
        return isset($this->breakdown_definition);
    }

    public function clearBreakdownDefinition()
    {
        unset($this->breakdown_definition);
    }

    /**
     * Optional. The set of dimensions to group metrics by. If multiple dimensions
     * are selected, cross-dimension breakdowns are returned.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Ads\GoogleAds\V25\Services\BreakdownDefinition $var
     * @return $this
     */
    public function setBreakdownDefinition($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\BreakdownDefinition::class);
        $this->breakdown_definition = $var;

        return $this;
    }

    /**
     * Optional. The three-character ISO 4217 currency code. If unspecified, the
     * default currency for monetary values is USD.
     *
     * Generated from protobuf field <code>string currency_code = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getCurrencyCode()
    {
        return $this->currency_code;
    }

    /**
     * Optional. The three-character ISO 4217 currency code. If unspecified, the
     * default currency for monetary values is USD.
     *
     * Generated from protobuf field <code>string currency_code = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setCurrencyCode($var)
    {
        GPBUtil::checkString($var, True);
        $this->currency_code = $var;

        return $this;
    }

    /**
     * The name of the customer being planned for. This is a user-defined value.
     *
     * Generated from protobuf field <code>string customer_benchmarks_group = 7;</code>
     * @return string
     */
    public function getCustomerBenchmarksGroup()
    {
        return $this->customer_benchmarks_group;
    }

    /**
     * The name of the customer being planned for. This is a user-defined value.
     *
     * Generated from protobuf field <code>string customer_benchmarks_group = 7;</code>
     * @param string $var
     * @return $this
     */
    public function setCustomerBenchmarksGroup($var)
    {
        GPBUtil::checkString($var, True);
        $this->customer_benchmarks_group = $var;

        return $this;
    }

    /**
     * Optional. Optional features to include in the response. By default, only
     * core data is returned. Including supplemental data here will populate
     * additional metrics in the response such as percentile metrics.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.BenchmarksSupplementalDataEnum.BenchmarksSupplementalData supplemental_data = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return RepeatedField<int>
     */
    public function getSupplementalData()
    {
        return $this->supplemental_data;
    }

    /**
     * Optional. Optional features to include in the response. By default, only
     * core data is returned. Including supplemental data here will populate
     * additional metrics in the response such as percentile metrics.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.BenchmarksSupplementalDataEnum.BenchmarksSupplementalData supplemental_data = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int[] $var
     * @return $this
     */
    public function setSupplementalData($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V25\Enums\BenchmarksSupplementalDataEnum\BenchmarksSupplementalData::class);
        $this->supplemental_data = $arr;

        return $this;
    }

    /**
     * Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;</code>
     * @return \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo|null
     */
    public function getApplicationInfo()
    {
        return $this->application_info;
    }

    public function hasApplicationInfo()
    {
        return isset($this->application_info);
    }

    public function clearApplicationInfo()
    {
        unset($this->application_info);
    }

    /**
     * Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;</code>
     * @param \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo $var
     * @return $this
     */
    public function setApplicationInfo($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo::class);
        $this->application_info = $var;

        return $this;
    }

}