<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/ads/googleads/v23/services/audience_insights_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
 * [AudienceInsightsService.GenerateAudienceDefinition][google.ads.googleads.v23.services.AudienceInsightsService.GenerateAudienceDefinition].
 *
 * Generated from protobuf message <code>google.ads.googleads.v23.services.GenerateAudienceDefinitionRequest</code>
 */
class GenerateAudienceDefinitionRequest 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. Provide a text description of an audience to get AI-generated
     * structured suggestions. This can take around 5 or more seconds to complete
     * Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
     * Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
     * AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
     * CATEGORY and KNOWLEDGE_GRAPH.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $audience_description = null;
    /**
     * Optional. The name of the customer being planned for.  This is a
     * user-defined value.
     *
     * Generated from protobuf field <code>string customer_insights_group = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $customer_insights_group = '';
    /**
     * Optional. Additional information on the application issuing the request.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $insights_application_info = null;

    /**
     * @param string                                                         $customerId          Required. The ID of the customer.
     * @param \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription $audienceDescription Required. Provide a text description of an audience to get AI-generated
     *                                                                                            structured suggestions. This can take around 5 or more seconds to complete
     *                                                                                            Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
     *                                                                                            Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
     *                                                                                            AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
     *                                                                                            CATEGORY and KNOWLEDGE_GRAPH.
     *
     * @return \Google\Ads\GoogleAds\V23\Services\GenerateAudienceDefinitionRequest
     *
     * @experimental
     */
    public static function build(string $customerId, \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription $audienceDescription): self
    {
        return (new self())
            ->setCustomerId($customerId)
            ->setAudienceDescription($audienceDescription);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $customer_id
     *           Required. The ID of the customer.
     *     @type \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription $audience_description
     *           Required. Provide a text description of an audience to get AI-generated
     *           structured suggestions. This can take around 5 or more seconds to complete
     *           Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
     *           Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
     *           AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
     *           CATEGORY and KNOWLEDGE_GRAPH.
     *     @type string $customer_insights_group
     *           Optional. The name of the customer being planned for.  This is a
     *           user-defined value.
     *     @type \Google\Ads\GoogleAds\V23\Common\AdditionalApplicationInfo $insights_application_info
     *           Optional. Additional information on the application issuing the request.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V23\Services\AudienceInsightsService::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. Provide a text description of an audience to get AI-generated
     * structured suggestions. This can take around 5 or more seconds to complete
     * Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
     * Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
     * AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
     * CATEGORY and KNOWLEDGE_GRAPH.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription|null
     */
    public function getAudienceDescription()
    {
        return $this->audience_description;
    }

    public function hasAudienceDescription()
    {
        return isset($this->audience_description);
    }

    public function clearAudienceDescription()
    {
        unset($this->audience_description);
    }

    /**
     * Required. Provide a text description of an audience to get AI-generated
     * structured suggestions. This can take around 5 or more seconds to complete
     * Supported marketing objectives are: AWARENESS, CONSIDERATION and RESEARCH.
     * Supported dimensions are: AGE_RANGE, GENDER, PARENTAL_STATUS,
     * AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, LIFE_EVENT_USER_INTEREST,
     * CATEGORY and KNOWLEDGE_GRAPH.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v23.services.InsightsAudienceDescription audience_description = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription $var
     * @return $this
     */
    public function setAudienceDescription($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Services\InsightsAudienceDescription::class);
        $this->audience_description = $var;

        return $this;
    }

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

    /**
     * Optional. The name of the customer being planned for.  This is a
     * user-defined value.
     *
     * Generated from protobuf field <code>string customer_insights_group = 3 [(.google.api.field_behavior) = OPTIONAL];</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.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Ads\GoogleAds\V23\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.v23.common.AdditionalApplicationInfo insights_application_info = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Ads\GoogleAds\V23\Common\AdditionalApplicationInfo $var
     * @return $this
     */
    public function setInsightsApplicationInfo($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\AdditionalApplicationInfo::class);
        $this->insights_application_info = $var;

        return $this;
    }

}

