Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/

namespace Google\Service\SA360;

class GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings extends \Google\Model
{
/**
* Whether to adjust bids for loyalty members.
*
* @var bool
*/
public $enableBidAdjustmentsForLoyaltyMembers;
/**
* Whether to show targeted loyalty member benefits in PLA format in eligible
* countries.
*
* @var bool
*/
public $showTargetedLoyaltyMemberBenefitsInPla;
protected $valueSettingsOverrideType = GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings::class;
protected $valueSettingsOverrideDataType = '';

/**
* Whether to adjust bids for loyalty members.
*
* @param bool $enableBidAdjustmentsForLoyaltyMembers
*/
public function setEnableBidAdjustmentsForLoyaltyMembers($enableBidAdjustmentsForLoyaltyMembers)
{
$this->enableBidAdjustmentsForLoyaltyMembers = $enableBidAdjustmentsForLoyaltyMembers;
}
/**
* @return bool
*/
public function getEnableBidAdjustmentsForLoyaltyMembers()
{
return $this->enableBidAdjustmentsForLoyaltyMembers;
}
/**
* Whether to show targeted loyalty member benefits in PLA format in eligible
* countries.
*
* @param bool $showTargetedLoyaltyMemberBenefitsInPla
*/
public function setShowTargetedLoyaltyMemberBenefitsInPla($showTargetedLoyaltyMemberBenefitsInPla)
{
$this->showTargetedLoyaltyMemberBenefitsInPla = $showTargetedLoyaltyMemberBenefitsInPla;
}
/**
* @return bool
*/
public function getShowTargetedLoyaltyMemberBenefitsInPla()
{
return $this->showTargetedLoyaltyMemberBenefitsInPla;
}
/**
* Loyalty retention goal campaign specific value settings.
*
* @param GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings $valueSettingsOverride
*/
public function setValueSettingsOverride(GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings $valueSettingsOverride)
{
$this->valueSettingsOverride = $valueSettingsOverride;
}
/**
* @return GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings
*/
public function getValueSettingsOverride()
{
return $this->valueSettingsOverride;
}
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings::class, 'Google_Service_SA360_GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings');
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/

namespace Google\Service\SA360;

class GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings extends \Google\Model
{
/**
* Not specified.
*/
public const TARGET_OPTION_UNSPECIFIED = 'UNSPECIFIED';
/**
* Used for return value only. Represents value unknown in this version.
*/
public const TARGET_OPTION_UNKNOWN = 'UNKNOWN';
/**
* The mode is used when the campaign optimizes for all customers, which is
* the default value.
*/
public const TARGET_OPTION_TARGET_ALL = 'TARGET_ALL';
/**
* This mode configures the campaign to target only customers who have
* previously interacted but are now lapsed or disengaged.
*/
public const TARGET_OPTION_TARGET_SPECIFIC = 'TARGET_SPECIFIC';
/**
* New Customer Acquisition goal optimization mode for this campaign. Defaults
* to TARGET_ALL. Whether the campaign is targeting new customers only.
*
* @var string
*/
public $targetOption;
protected $valueSettingsOverrideType = GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings::class;
protected $valueSettingsOverrideDataType = '';

/**
* New Customer Acquisition goal optimization mode for this campaign. Defaults
* to TARGET_ALL. Whether the campaign is targeting new customers only.
*
* Accepted values: UNSPECIFIED, UNKNOWN, TARGET_ALL, TARGET_SPECIFIC
*
* @param self::TARGET_OPTION_* $targetOption
*/
public function setTargetOption($targetOption)
{
$this->targetOption = $targetOption;
}
/**
* @return self::TARGET_OPTION_*
*/
public function getTargetOption()
{
return $this->targetOption;
}
/**
* New Customer Acquisition goal campaign specific value settings.
*
* @param GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings $valueSettingsOverride
*/
public function setValueSettingsOverride(GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings $valueSettingsOverride)
{
$this->valueSettingsOverride = $valueSettingsOverride;
}
/**
* @return GoogleAdsSearchads360V23CommonCustomerLifecycleOptimizationValueSettings
*/
public function getValueSettingsOverride()
{
return $this->valueSettingsOverride;
}
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings::class, 'Google_Service_SA360_GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings');
25 changes: 24 additions & 1 deletion src/SA360/GoogleAdsSearchads360V23ErrorsErrorCode.php
Original file line number Diff line number Diff line change
Expand Up @@ -3679,6 +3679,26 @@ class GoogleAdsSearchads360V23ErrorsErrorCode extends \Google\Model
* Customer must be allowlisted to use retention only goal.
*/
public const CAMPAIGN_GOAL_CONFIG_ERROR_CUSTOMER_NOT_ALLOWLISTED_FOR_RETENTION_ONLY = 'CUSTOMER_NOT_ALLOWLISTED_FOR_RETENTION_ONLY';
/**
* New customer acquisition customer lifecycle optimization goal targeting
* only new customers should not have campaign override values set.
*/
public const CAMPAIGN_GOAL_CONFIG_ERROR_CAMPAIGN_OVERRIDE_VALUES_SET_FOR_NEW_CUSTOMER_ACQUISITION_TARGET_SPECIFIC_OPTION = 'CAMPAIGN_OVERRIDE_VALUES_SET_FOR_NEW_CUSTOMER_ACQUISITION_TARGET_SPECIFIC_OPTION';
/**
* New customer acquisition customer lifecycle optimization goal campaign
* override high lifetime values should only be set for supported campaign
* type.
*/
public const CAMPAIGN_GOAL_CONFIG_ERROR_CAMPAIGN_OVERRIDE_HIGH_LIFETIME_VALUE_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE = 'CAMPAIGN_OVERRIDE_HIGH_LIFETIME_VALUE_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE';
/**
* Error when the campaign is attempting to combine incompatible CLO goals.
*/
public const CAMPAIGN_GOAL_CONFIG_ERROR_CANNOT_USE_INCOMPATIBLE_CLO_GOALS = 'CANNOT_USE_INCOMPATIBLE_CLO_GOALS';
/**
* At least one mode (either enabling bid adjustments or showing benefits in
* PLA) must be enabled for loyalty retention goal.
*/
public const CAMPAIGN_GOAL_CONFIG_ERROR_LOYALTY_RETENTION_GOAL_INVALID_MODE = 'LOYALTY_RETENTION_GOAL_INVALID_MODE';
/**
* Enum unspecified.
*/
Expand Down Expand Up @@ -12956,7 +12976,10 @@ public function getCampaignFeedError()
* HIGH_LIFETIME_VALUE_PRESENT_BUT_VALUE_ABSENT,
* HIGH_LIFETIME_VALUE_LESS_THAN_OR_EQUAL_TO_VALUE,
* CUSTOMER_LIFECYCLE_OPTIMIZATION_CAMPAIGN_TYPE_NOT_SUPPORTED,
* CUSTOMER_NOT_ALLOWLISTED_FOR_RETENTION_ONLY
* CUSTOMER_NOT_ALLOWLISTED_FOR_RETENTION_ONLY, CAMPAIGN_OVERRIDE_VALUES_SET_F
* OR_NEW_CUSTOMER_ACQUISITION_TARGET_SPECIFIC_OPTION,
* CAMPAIGN_OVERRIDE_HIGH_LIFETIME_VALUE_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE,
* CANNOT_USE_INCOMPATIBLE_CLO_GOALS, LOYALTY_RETENTION_GOAL_INVALID_MODE
*
* @param self::CAMPAIGN_GOAL_CONFIG_ERROR_* $campaignGoalConfigError
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ class GoogleAdsSearchads360V23ResourcesCampaignGoalConfig extends \Google\Model
* @var string
*/
public $campaign;
protected $campaignLoyaltyRetentionSettingsType = GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings::class;
protected $campaignLoyaltyRetentionSettingsDataType = '';
protected $campaignNewCustomerAcquisitionSettingsType = GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings::class;
protected $campaignNewCustomerAcquisitionSettingsDataType = '';
protected $campaignRetentionSettingsType = GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignRetentionGoalSettings::class;
protected $campaignRetentionSettingsDataType = '';
/**
Expand Down Expand Up @@ -78,6 +82,38 @@ public function getCampaign()
{
return $this->campaign;
}
/**
* Loyalty retention goal campaign settings.
*
* @param GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings $campaignLoyaltyRetentionSettings
*/
public function setCampaignLoyaltyRetentionSettings(GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings $campaignLoyaltyRetentionSettings)
{
$this->campaignLoyaltyRetentionSettings = $campaignLoyaltyRetentionSettings;
}
/**
* @return GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignLoyaltyRetentionGoalSettings
*/
public function getCampaignLoyaltyRetentionSettings()
{
return $this->campaignLoyaltyRetentionSettings;
}
/**
* New customer acquisition goal campaign settings.
*
* @param GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings $campaignNewCustomerAcquisitionSettings
*/
public function setCampaignNewCustomerAcquisitionSettings(GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings $campaignNewCustomerAcquisitionSettings)
{
$this->campaignNewCustomerAcquisitionSettings = $campaignNewCustomerAcquisitionSettings;
}
/**
* @return GoogleAdsSearchads360V23CommonCampaignGoalSettingsCampaignNewCustomerAcquisitionGoalSettings
*/
public function getCampaignNewCustomerAcquisitionSettings()
{
return $this->campaignNewCustomerAcquisitionSettings;
}
/**
* Retention goal campaign settings.
*
Expand Down
Loading