google.ads.googleads.v25.common.FrequencyCapKey
*/
class FrequencyCapKey extends \Google\Protobuf\Internal\Message
{
/**
* The level on which the cap is to be applied (for example, ad group ad, ad
* group). The cap is applied to all the entities of this level.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
*/
protected $level = 0;
/**
* The type of event that the cap applies to (for example, impression).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
*/
protected $event_type = 0;
/**
* Unit of time the cap is defined at (for example, day, week).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
*/
protected $time_unit = 0;
/**
* Number of time units the cap lasts.
*
* Generated from protobuf field optional int32 time_length = 5;
*/
protected $time_length = null;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type int $level
* The level on which the cap is to be applied (for example, ad group ad, ad
* group). The cap is applied to all the entities of this level.
* @type int $event_type
* The type of event that the cap applies to (for example, impression).
* @type int $time_unit
* Unit of time the cap is defined at (for example, day, week).
* @type int $time_length
* Number of time units the cap lasts.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Ads\GoogleAds\V25\Common\FrequencyCap::initOnce();
parent::__construct($data);
}
/**
* The level on which the cap is to be applied (for example, ad group ad, ad
* group). The cap is applied to all the entities of this level.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
* @return int
*/
public function getLevel()
{
return $this->level;
}
/**
* The level on which the cap is to be applied (for example, ad group ad, ad
* group). The cap is applied to all the entities of this level.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
* @param int $var
* @return $this
*/
public function setLevel($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\FrequencyCapLevelEnum\FrequencyCapLevel::class);
$this->level = $var;
return $this;
}
/**
* The type of event that the cap applies to (for example, impression).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
* @return int
*/
public function getEventType()
{
return $this->event_type;
}
/**
* The type of event that the cap applies to (for example, impression).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
* @param int $var
* @return $this
*/
public function setEventType($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\FrequencyCapEventTypeEnum\FrequencyCapEventType::class);
$this->event_type = $var;
return $this;
}
/**
* Unit of time the cap is defined at (for example, day, week).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
* @return int
*/
public function getTimeUnit()
{
return $this->time_unit;
}
/**
* Unit of time the cap is defined at (for example, day, week).
*
* Generated from protobuf field .google.ads.googleads.v25.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
* @param int $var
* @return $this
*/
public function setTimeUnit($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\FrequencyCapTimeUnitEnum\FrequencyCapTimeUnit::class);
$this->time_unit = $var;
return $this;
}
/**
* Number of time units the cap lasts.
*
* Generated from protobuf field optional int32 time_length = 5;
* @return int
*/
public function getTimeLength()
{
return isset($this->time_length) ? $this->time_length : 0;
}
public function hasTimeLength()
{
return isset($this->time_length);
}
public function clearTimeLength()
{
unset($this->time_length);
}
/**
* Number of time units the cap lasts.
*
* Generated from protobuf field optional int32 time_length = 5;
* @param int $var
* @return $this
*/
public function setTimeLength($var)
{
GPBUtil::checkInt32($var);
$this->time_length = $var;
return $this;
}
}