google.ads.googleads.v23.services.GraduateExperimentRequest
*/
class GraduateExperimentRequest extends \Google\Protobuf\Internal\Message
{
/**
* Required. The experiment to be graduated.
*
* Generated from protobuf field string experiment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
*/
protected $experiment = '';
/**
* Required. List of campaign budget mappings for graduation. Each campaign
* that appears here will graduate, and will be assigned a new budget that is
* paired with it in the mapping. The maximum size is one.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CampaignBudgetMapping campaign_budget_mappings = 2 [(.google.api.field_behavior) = REQUIRED];
*/
private $campaign_budget_mappings;
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* Generated from protobuf field bool validate_only = 3;
*/
protected $validate_only = false;
/**
* @param string $experiment Required. The experiment to be graduated.
* @param \Google\Ads\GoogleAds\V23\Services\CampaignBudgetMapping[] $campaignBudgetMappings Required. List of campaign budget mappings for graduation. Each campaign
* that appears here will graduate, and will be assigned a new budget that is
* paired with it in the mapping. The maximum size is one.
*
* @return \Google\Ads\GoogleAds\V23\Services\GraduateExperimentRequest
*
* @experimental
*/
public static function build(string $experiment, array $campaignBudgetMappings): self
{
return (new self())
->setExperiment($experiment)
->setCampaignBudgetMappings($campaignBudgetMappings);
}
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $experiment
* Required. The experiment to be graduated.
* @type \Google\Ads\GoogleAds\V23\Services\CampaignBudgetMapping[] $campaign_budget_mappings
* Required. List of campaign budget mappings for graduation. Each campaign
* that appears here will graduate, and will be assigned a new budget that is
* paired with it in the mapping. The maximum size is one.
* @type bool $validate_only
* If true, the request is validated but not executed. Only errors are
* returned, not results.
* }
*/
public function __construct($data = null)
{
\GPBMetadata\Google\Ads\GoogleAds\V23\Services\ExperimentService::initOnce();
parent::__construct($data);
}
/**
* Required. The experiment to be graduated.
*
* Generated from protobuf field string experiment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
*
* @return string
*/
public function getExperiment()
{
return $this->experiment;
}
/**
* Required. The experiment to be graduated.
*
* Generated from protobuf field string experiment = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
*
* @param string $var
* @return $this
*/
public function setExperiment($var)
{
GPBUtil::checkString($var, true);
$this->experiment = $var;
return $this;
}
/**
* Required. List of campaign budget mappings for graduation. Each campaign
* that appears here will graduate, and will be assigned a new budget that is
* paired with it in the mapping. The maximum size is one.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CampaignBudgetMapping campaign_budget_mappings = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return RepeatedField<\Google\Ads\GoogleAds\V23\Services\CampaignBudgetMapping>
*/
public function getCampaignBudgetMappings()
{
return $this->campaign_budget_mappings;
}
/**
* Required. List of campaign budget mappings for graduation. Each campaign
* that appears here will graduate, and will be assigned a new budget that is
* paired with it in the mapping. The maximum size is one.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CampaignBudgetMapping campaign_budget_mappings = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @param \Google\Ads\GoogleAds\V23\Services\CampaignBudgetMapping[] $var
* @return $this
*/
public function setCampaignBudgetMappings($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Services\CampaignBudgetMapping::class);
$this->campaign_budget_mappings = $arr;
return $this;
}
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* Generated from protobuf field bool validate_only = 3;
*
* @return bool
*/
public function getValidateOnly()
{
return $this->validate_only;
}
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* Generated from protobuf field bool validate_only = 3;
*
* @param bool $var
* @return $this
*/
public function setValidateOnly($var)
{
GPBUtil::checkBool($var);
$this->validate_only = $var;
return $this;
}
}