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

namespace Google\Ads\GoogleAds\V23\Services;

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

/**
 * Request message for
 * [ReachPlanService.ListPlannableUserInterests][google.ads.googleads.v23.services.ReachPlanService.ListPlannableUserInterests].
 *
 * Generated from protobuf message <code>google.ads.googleads.v23.services.ListPlannableUserInterestsRequest</code>
 */
class ListPlannableUserInterestsRequest 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 = '';
    /**
     * Optional. A filter by user interest type. If set, only user interests with
     * a type listed in the filter will be returned. If not set, user interests of
     * all supported types will be returned. Supported user interest types are
     * AFFINITY and IN_MARKET. Each type must be specified at most once.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v23.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $user_interest_taxonomy_types;
    /**
     * A filter by user interest name. If set, only user interests with a name
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string name_query = 3;</code>
     */
    protected $name_query = null;
    /**
     * A filter by user interest path. If set, only user interests with a path
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string path_query = 4;</code>
     */
    protected $path_query = null;
    /**
     * Optional. Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.common.AdditionalApplicationInfo reach_application_info = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $reach_application_info = null;

    /**
     * @param string $customerId Required. The ID of the customer.
     *
     * @return \Google\Ads\GoogleAds\V23\Services\ListPlannableUserInterestsRequest
     *
     * @experimental
     */
    public static function build(string $customerId): self
    {
        return (new self())
            ->setCustomerId($customerId);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $customer_id
     *           Required. The ID of the customer.
     *     @type array<int>|\Google\Protobuf\Internal\RepeatedField $user_interest_taxonomy_types
     *           Optional. A filter by user interest type. If set, only user interests with
     *           a type listed in the filter will be returned. If not set, user interests of
     *           all supported types will be returned. Supported user interest types are
     *           AFFINITY and IN_MARKET. Each type must be specified at most once.
     *     @type string $name_query
     *           A filter by user interest name. If set, only user interests with a name
     *           containing the literal string (case insensitive) in the filter will be
     *           returned. Maximum length is 200 characters.
     *     @type string $path_query
     *           A filter by user interest path. If set, only user interests with a path
     *           containing the literal string (case insensitive) in the filter will be
     *           returned. Maximum length is 200 characters.
     *     @type \Google\Ads\GoogleAds\V23\Common\AdditionalApplicationInfo $reach_application_info
     *           Optional. Additional information on the application issuing the request.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V23\Services\ReachPlanService::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;
    }

    /**
     * Optional. A filter by user interest type. If set, only user interests with
     * a type listed in the filter will be returned. If not set, user interests of
     * all supported types will be returned. Supported user interest types are
     * AFFINITY and IN_MARKET. Each type must be specified at most once.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v23.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Protobuf\Internal\RepeatedField
     */
    public function getUserInterestTaxonomyTypes()
    {
        return $this->user_interest_taxonomy_types;
    }

    /**
     * Optional. A filter by user interest type. If set, only user interests with
     * a type listed in the filter will be returned. If not set, user interests of
     * all supported types will be returned. Supported user interest types are
     * AFFINITY and IN_MARKET. Each type must be specified at most once.
     *
     * Generated from protobuf field <code>repeated .google.ads.googleads.v23.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param array<int>|\Google\Protobuf\Internal\RepeatedField $var
     * @return $this
     */
    public function setUserInterestTaxonomyTypes($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\UserInterestTaxonomyTypeEnum\UserInterestTaxonomyType::class);
        $this->user_interest_taxonomy_types = $arr;

        return $this;
    }

    /**
     * A filter by user interest name. If set, only user interests with a name
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string name_query = 3;</code>
     * @return string
     */
    public function getNameQuery()
    {
        return isset($this->name_query) ? $this->name_query : '';
    }

    public function hasNameQuery()
    {
        return isset($this->name_query);
    }

    public function clearNameQuery()
    {
        unset($this->name_query);
    }

    /**
     * A filter by user interest name. If set, only user interests with a name
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string name_query = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setNameQuery($var)
    {
        GPBUtil::checkString($var, True);
        $this->name_query = $var;

        return $this;
    }

    /**
     * A filter by user interest path. If set, only user interests with a path
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string path_query = 4;</code>
     * @return string
     */
    public function getPathQuery()
    {
        return isset($this->path_query) ? $this->path_query : '';
    }

    public function hasPathQuery()
    {
        return isset($this->path_query);
    }

    public function clearPathQuery()
    {
        unset($this->path_query);
    }

    /**
     * A filter by user interest path. If set, only user interests with a path
     * containing the literal string (case insensitive) in the filter will be
     * returned. Maximum length is 200 characters.
     *
     * Generated from protobuf field <code>optional string path_query = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setPathQuery($var)
    {
        GPBUtil::checkString($var, True);
        $this->path_query = $var;

        return $this;
    }

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

    public function hasReachApplicationInfo()
    {
        return isset($this->reach_application_info);
    }

    public function clearReachApplicationInfo()
    {
        unset($this->reach_application_info);
    }

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

        return $this;
    }

}

