google.ads.googleads.v23.services.MutateCustomerLabelsRequest
*/
class MutateCustomerLabelsRequest extends \Google\Protobuf\Internal\Message
{
/**
* Required. ID of the customer whose customer-label relationships are being
* modified.
*
* Generated from protobuf field string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
*/
protected $customer_id = '';
/**
* Required. The list of operations to perform on customer-label
* relationships.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CustomerLabelOperation operations = 2 [(.google.api.field_behavior) = REQUIRED];
*/
private $operations;
/**
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, all operations will be carried
* out in one transaction if and only if they are all valid.
* Default is false.
*
* Generated from protobuf field bool partial_failure = 3;
*/
protected $partial_failure = false;
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* Generated from protobuf field bool validate_only = 4;
*/
protected $validate_only = false;
/**
* @param string $customerId Required. ID of the customer whose customer-label relationships are being
* modified.
* @param \Google\Ads\GoogleAds\V23\Services\CustomerLabelOperation[] $operations Required. The list of operations to perform on customer-label
* relationships.
*
* @return \Google\Ads\GoogleAds\V23\Services\MutateCustomerLabelsRequest
*
* @experimental
*/
public static function build(string $customerId, array $operations): self
{
return (new self())
->setCustomerId($customerId)
->setOperations($operations);
}
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $customer_id
* Required. ID of the customer whose customer-label relationships are being
* modified.
* @type \Google\Ads\GoogleAds\V23\Services\CustomerLabelOperation[] $operations
* Required. The list of operations to perform on customer-label
* relationships.
* @type bool $partial_failure
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, all operations will be carried
* out in one transaction if and only if they are all valid.
* Default is false.
* @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\CustomerLabelService::initOnce();
parent::__construct($data);
}
/**
* Required. ID of the customer whose customer-label relationships are being
* modified.
*
* Generated from protobuf field string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return string
*/
public function getCustomerId()
{
return $this->customer_id;
}
/**
* Required. ID of the customer whose customer-label relationships are being
* modified.
*
* Generated from protobuf field string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @param string $var
* @return $this
*/
public function setCustomerId($var)
{
GPBUtil::checkString($var, true);
$this->customer_id = $var;
return $this;
}
/**
* Required. The list of operations to perform on customer-label
* relationships.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CustomerLabelOperation operations = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return RepeatedField<\Google\Ads\GoogleAds\V23\Services\CustomerLabelOperation>
*/
public function getOperations()
{
return $this->operations;
}
/**
* Required. The list of operations to perform on customer-label
* relationships.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.CustomerLabelOperation operations = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @param \Google\Ads\GoogleAds\V23\Services\CustomerLabelOperation[] $var
* @return $this
*/
public function setOperations($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Services\CustomerLabelOperation::class);
$this->operations = $arr;
return $this;
}
/**
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, all operations will be carried
* out in one transaction if and only if they are all valid.
* Default is false.
*
* Generated from protobuf field bool partial_failure = 3;
*
* @return bool
*/
public function getPartialFailure()
{
return $this->partial_failure;
}
/**
* If true, successful operations will be carried out and invalid
* operations will return errors. If false, all operations will be carried
* out in one transaction if and only if they are all valid.
* Default is false.
*
* Generated from protobuf field bool partial_failure = 3;
*
* @param bool $var
* @return $this
*/
public function setPartialFailure($var)
{
GPBUtil::checkBool($var);
$this->partial_failure = $var;
return $this;
}
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* Generated from protobuf field bool validate_only = 4;
*
* @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 = 4;
*
* @param bool $var
* @return $this
*/
public function setValidateOnly($var)
{
GPBUtil::checkBool($var);
$this->validate_only = $var;
return $this;
}
}