<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/ads/googleads/v25/services/content_creator_insights_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
 * [ContentCreatorInsightsService.GenerateTrendingInsights][google.ads.googleads.v25.services.ContentCreatorInsightsService.GenerateTrendingInsights].
 *
 * Generated from protobuf message <code>google.ads.googleads.v25.services.GenerateTrendingInsightsRequest</code>
 */
class GenerateTrendingInsightsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The ID of the customer.
     *
     * Generated from protobuf field <code>string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $customer_id = '';
    /**
     * Required. The name of the customer being planned for. This is a
     * user-defined value.
     *
     * Generated from protobuf field <code>string customer_insights_group = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $customer_insights_group = '';
    /**
     * Optional. Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.AdditionalApplicationInfo insights_application_info = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $insights_application_info = null;
    /**
     * Required. The country to find trends in.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.LocationInfo country_location = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $country_location = null;
    /**
     * Optional. The sub-country geographic locations to search that apply to the
     * criteria. Only supported for `search_audience` criteria.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $sub_country_locations;
    /**
     * Optional. Optional features to include in the response. By default, only
     * core insight data is returned. Including supplemental data here will
     * populate additional fields in the response.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 7 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $supplemental_data;
    protected $criteria;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $customer_id
     *           Required. The ID of the customer.
     *     @type string $customer_insights_group
     *           Required. The name of the customer being planned for. This is a
     *           user-defined value.
     *     @type \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo $insights_application_info
     *           Optional. Additional information on the application issuing the request.
     *     @type \Google\Ads\GoogleAds\V25\Common\LocationInfo $country_location
     *           Required. The country to find trends in.
     *     @type \Google\Ads\GoogleAds\V25\Common\LocationInfo[] $sub_country_locations
     *           Optional. The sub-country geographic locations to search that apply to the
     *           criteria. Only supported for `search_audience` criteria.
     *     @type int[] $supplemental_data
     *           Optional. Optional features to include in the response. By default, only
     *           core insight data is returned. Including supplemental data here will
     *           populate additional fields in the response.
     *     @type \Google\Ads\GoogleAds\V25\Services\SearchAudience $search_audience
     *           An audience to search for trending content in. Data fetched is based on
     *           the country or sub-country locations specified in
     *           [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
     *           or
     *           [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
     *     @type \Google\Ads\GoogleAds\V25\Services\SearchTopics $search_topics
     *           Content topics to return trend information for.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V25\Services\ContentCreatorInsightsService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The ID of the customer.
     *
     * 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.
     *
     * 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;
    }

    /**
     * Required. The name of the customer being planned for. This is a
     * user-defined value.
     *
     * Generated from protobuf field <code>string customer_insights_group = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return string
     */
    public function getCustomerInsightsGroup()
    {
        return $this->customer_insights_group;
    }

    /**
     * Required. The name of the customer being planned for. This is a
     * user-defined value.
     *
     * Generated from protobuf field <code>string customer_insights_group = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param string $var
     * @return $this
     */
    public function setCustomerInsightsGroup($var)
    {
        GPBUtil::checkString($var, True);
        $this->customer_insights_group = $var;

        return $this;
    }

    /**
     * Optional. Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.AdditionalApplicationInfo insights_application_info = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Ads\GoogleAds\V25\Common\AdditionalApplicationInfo|null
     */
    public function getInsightsApplicationInfo()
    {
        return $this->insights_application_info;
    }

    public function hasInsightsApplicationInfo()
    {
        return isset($this->insights_application_info);
    }

    public function clearInsightsApplicationInfo()
    {
        unset($this->insights_application_info);
    }

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

        return $this;
    }

    /**
     * Required. The country to find trends in.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.common.LocationInfo country_location = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Ads\GoogleAds\V25\Common\LocationInfo|null
     */
    public function getCountryLocation()
    {
        return $this->country_location;
    }

    public function hasCountryLocation()
    {
        return isset($this->country_location);
    }

    public function clearCountryLocation()
    {
        unset($this->country_location);
    }

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

        return $this;
    }

    /**
     * Optional. The sub-country geographic locations to search that apply to the
     * criteria. Only supported for `search_audience` criteria.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return RepeatedField<\Google\Ads\GoogleAds\V25\Common\LocationInfo>
     */
    public function getSubCountryLocations()
    {
        return $this->sub_country_locations;
    }

    /**
     * Optional. The sub-country geographic locations to search that apply to the
     * criteria. Only supported for `search_audience` criteria.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.common.LocationInfo sub_country_locations = 8 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Ads\GoogleAds\V25\Common\LocationInfo[] $var
     * @return $this
     */
    public function setSubCountryLocations($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V25\Common\LocationInfo::class);
        $this->sub_country_locations = $arr;

        return $this;
    }

    /**
     * Optional. Optional features to include in the response. By default, only
     * core insight data is returned. Including supplemental data here will
     * populate additional fields in the response.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 7 [(.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 insight data is returned. Including supplemental data here will
     * populate additional fields in the response.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData supplemental_data = 7 [(.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\ContentCreatorInsightsSupplementalDataEnum\ContentCreatorInsightsSupplementalData::class);
        $this->supplemental_data = $arr;

        return $this;
    }

    /**
     * An audience to search for trending content in. Data fetched is based on
     * the country or sub-country locations specified in
     * [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
     * or
     * [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.SearchAudience search_audience = 4;</code>
     * @return \Google\Ads\GoogleAds\V25\Services\SearchAudience|null
     */
    public function getSearchAudience()
    {
        return $this->readOneof(4);
    }

    public function hasSearchAudience()
    {
        return $this->hasOneof(4);
    }

    /**
     * An audience to search for trending content in. Data fetched is based on
     * the country or sub-country locations specified in
     * [country_location][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.country_location]
     * or
     * [sub_country_locations][google.ads.googleads.v25.services.GenerateTrendingInsightsRequest.sub_country_locations].
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.SearchAudience search_audience = 4;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\SearchAudience $var
     * @return $this
     */
    public function setSearchAudience($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\SearchAudience::class);
        $this->writeOneof(4, $var);

        return $this;
    }

    /**
     * Content topics to return trend information for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.SearchTopics search_topics = 5;</code>
     * @return \Google\Ads\GoogleAds\V25\Services\SearchTopics|null
     */
    public function getSearchTopics()
    {
        return $this->readOneof(5);
    }

    public function hasSearchTopics()
    {
        return $this->hasOneof(5);
    }

    /**
     * Content topics to return trend information for.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.services.SearchTopics search_topics = 5;</code>
     * @param \Google\Ads\GoogleAds\V25\Services\SearchTopics $var
     * @return $this
     */
    public function setSearchTopics($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Services\SearchTopics::class);
        $this->writeOneof(5, $var);

        return $this;
    }

    /**
     * @return string
     */
    public function getCriteria()
    {
        return $this->whichOneof("criteria");
    }

}