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

namespace Google\Ads\GoogleAds\V25\Resources;

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

/**
 * A Lift Measurement Configuration (LMC), which is a lift study. This groups
 * all associated Brand Lift, Conversion Lift, and Search Lift measurements.
 *
 * Generated from protobuf message <code>google.ads.googleads.v25.resources.LiftMeasurementConfig</code>
 */
class LiftMeasurementConfig extends \Google\Protobuf\Internal\Message
{
    /**
     * Immutable. The resource name of the lift measurement config. Lift
     * measurement config resource names have the form:
     * `customers/{customer_id}/liftMeasurementConfigs/{lift_measurement_config_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     */
    protected $resource_name = '';
    /**
     * Output only. The unique identifier for the Lift Measurement Configuration
     * (LMC).
     *
     * Generated from protobuf field <code>int64 lift_measurement_config_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $lift_measurement_config_id = 0;
    /**
     * Output only. The name of the lift study.
     *
     * Generated from protobuf field <code>string name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $name = '';
    /**
     * Output only. The list of conversion action resource names associated with
     * this lift measurement configuration.
     *
     * Generated from protobuf field <code>repeated string conversion_actions = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     */
    private $conversion_actions;
    /**
     * Output only. The resource names of campaigns associated with this lift
     * measurement config. These are the ones currently linked, not historical.
     *
     * Generated from protobuf field <code>repeated string campaigns = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     */
    private $campaigns;
    /**
     * Output only. The survey language.
     *
     * Generated from protobuf field <code>string survey_language = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $survey_language = '';
    /**
     * Output only. The single measurement question set.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.resources.LiftMeasurementConfig.SingleMeasurementQuestionSet single_measurement_question_set = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $single_measurement_question_set = null;
    /**
     * Output only. The holdback ratio for Conversion Lift.
     *
     * Generated from protobuf field <code>optional int64 conversion_lift_holdback_ratio_micros = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     */
    protected $conversion_lift_holdback_ratio_micros = null;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $resource_name
     *           Immutable. The resource name of the lift measurement config. Lift
     *           measurement config resource names have the form:
     *           `customers/{customer_id}/liftMeasurementConfigs/{lift_measurement_config_id}`
     *     @type int|string $lift_measurement_config_id
     *           Output only. The unique identifier for the Lift Measurement Configuration
     *           (LMC).
     *     @type string $name
     *           Output only. The name of the lift study.
     *     @type string[] $conversion_actions
     *           Output only. The list of conversion action resource names associated with
     *           this lift measurement configuration.
     *     @type string[] $campaigns
     *           Output only. The resource names of campaigns associated with this lift
     *           measurement config. These are the ones currently linked, not historical.
     *     @type string $survey_language
     *           Output only. The survey language.
     *     @type \Google\Ads\GoogleAds\V25\Resources\LiftMeasurementConfig\SingleMeasurementQuestionSet $single_measurement_question_set
     *           Output only. The single measurement question set.
     *     @type int|string $conversion_lift_holdback_ratio_micros
     *           Output only. The holdback ratio for Conversion Lift.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V25\Resources\LiftMeasurementConfig::initOnce();
        parent::__construct($data);
    }

    /**
     * Immutable. The resource name of the lift measurement config. Lift
     * measurement config resource names have the form:
     * `customers/{customer_id}/liftMeasurementConfigs/{lift_measurement_config_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getResourceName()
    {
        return $this->resource_name;
    }

    /**
     * Immutable. The resource name of the lift measurement config. Lift
     * measurement config resource names have the form:
     * `customers/{customer_id}/liftMeasurementConfigs/{lift_measurement_config_id}`
     *
     * Generated from protobuf field <code>string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setResourceName($var)
    {
        GPBUtil::checkString($var, True);
        $this->resource_name = $var;

        return $this;
    }

    /**
     * Output only. The unique identifier for the Lift Measurement Configuration
     * (LMC).
     *
     * Generated from protobuf field <code>int64 lift_measurement_config_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return int|string
     */
    public function getLiftMeasurementConfigId()
    {
        return $this->lift_measurement_config_id;
    }

    /**
     * Output only. The unique identifier for the Lift Measurement Configuration
     * (LMC).
     *
     * Generated from protobuf field <code>int64 lift_measurement_config_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param int|string $var
     * @return $this
     */
    public function setLiftMeasurementConfigId($var)
    {
        GPBUtil::checkInt64($var);
        $this->lift_measurement_config_id = $var;

        return $this;
    }

    /**
     * Output only. The name of the lift study.
     *
     * Generated from protobuf field <code>string name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Output only. The name of the lift study.
     *
     * Generated from protobuf field <code>string name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Output only. The list of conversion action resource names associated with
     * this lift measurement configuration.
     *
     * Generated from protobuf field <code>repeated string conversion_actions = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     * @return RepeatedField<string>
     */
    public function getConversionActions()
    {
        return $this->conversion_actions;
    }

    /**
     * Output only. The list of conversion action resource names associated with
     * this lift measurement configuration.
     *
     * Generated from protobuf field <code>repeated string conversion_actions = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     * @param string[] $var
     * @return $this
     */
    public function setConversionActions($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
        $this->conversion_actions = $arr;

        return $this;
    }

    /**
     * Output only. The resource names of campaigns associated with this lift
     * measurement config. These are the ones currently linked, not historical.
     *
     * Generated from protobuf field <code>repeated string campaigns = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     * @return RepeatedField<string>
     */
    public function getCampaigns()
    {
        return $this->campaigns;
    }

    /**
     * Output only. The resource names of campaigns associated with this lift
     * measurement config. These are the ones currently linked, not historical.
     *
     * Generated from protobuf field <code>repeated string campaigns = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {</code>
     * @param string[] $var
     * @return $this
     */
    public function setCampaigns($var)
    {
        $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
        $this->campaigns = $arr;

        return $this;
    }

    /**
     * Output only. The survey language.
     *
     * Generated from protobuf field <code>string survey_language = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return string
     */
    public function getSurveyLanguage()
    {
        return $this->survey_language;
    }

    /**
     * Output only. The survey language.
     *
     * Generated from protobuf field <code>string survey_language = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param string $var
     * @return $this
     */
    public function setSurveyLanguage($var)
    {
        GPBUtil::checkString($var, True);
        $this->survey_language = $var;

        return $this;
    }

    /**
     * Output only. The single measurement question set.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.resources.LiftMeasurementConfig.SingleMeasurementQuestionSet single_measurement_question_set = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return \Google\Ads\GoogleAds\V25\Resources\LiftMeasurementConfig\SingleMeasurementQuestionSet|null
     */
    public function getSingleMeasurementQuestionSet()
    {
        return $this->single_measurement_question_set;
    }

    public function hasSingleMeasurementQuestionSet()
    {
        return isset($this->single_measurement_question_set);
    }

    public function clearSingleMeasurementQuestionSet()
    {
        unset($this->single_measurement_question_set);
    }

    /**
     * Output only. The single measurement question set.
     *
     * Generated from protobuf field <code>.google.ads.googleads.v25.resources.LiftMeasurementConfig.SingleMeasurementQuestionSet single_measurement_question_set = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param \Google\Ads\GoogleAds\V25\Resources\LiftMeasurementConfig\SingleMeasurementQuestionSet $var
     * @return $this
     */
    public function setSingleMeasurementQuestionSet($var)
    {
        GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\LiftMeasurementConfig\SingleMeasurementQuestionSet::class);
        $this->single_measurement_question_set = $var;

        return $this;
    }

    /**
     * Output only. The holdback ratio for Conversion Lift.
     *
     * Generated from protobuf field <code>optional int64 conversion_lift_holdback_ratio_micros = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @return int|string
     */
    public function getConversionLiftHoldbackRatioMicros()
    {
        return isset($this->conversion_lift_holdback_ratio_micros) ? $this->conversion_lift_holdback_ratio_micros : 0;
    }

    public function hasConversionLiftHoldbackRatioMicros()
    {
        return isset($this->conversion_lift_holdback_ratio_micros);
    }

    public function clearConversionLiftHoldbackRatioMicros()
    {
        unset($this->conversion_lift_holdback_ratio_micros);
    }

    /**
     * Output only. The holdback ratio for Conversion Lift.
     *
     * Generated from protobuf field <code>optional int64 conversion_lift_holdback_ratio_micros = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
     * @param int|string $var
     * @return $this
     */
    public function setConversionLiftHoldbackRatioMicros($var)
    {
        GPBUtil::checkInt64($var);
        $this->conversion_lift_holdback_ratio_micros = $var;

        return $this;
    }

}