Bitrix API

YandexCampaignTable extends AdvEntity

Class YandexCampaignTable

Local mirror for Yandex.Direct campaigns

Fields:

  • ID int mandatory
  • ENGINE_ID int mandatory
  • XML_ID string(255) mandatory
  • LAST_UPDATE datetime optional
  • SETTINGS string optional

Table of Contents

Constants

CACHE_LIFETIME  = 3600
ENGINE  = 'yandex_direct'
MONEY_WARN_PLACE_INTERVAL_DEFAULT  = 30
MONEY_WARNING_VALUE_DEFAULT  = 20
STRATEGY_AVERAGE_CLICK_PRICE  = 'AverageClickPrice'
STRATEGY_WEEKLY_BUDGET  = 'WeeklyBudget'
STRATEGY_WEEKLY_PACKET_OF_CLICKS  = 'WeeklyPacketOfClicks'

Properties

$allowedMoneyWarningInterval  : mixed
$allowedWarnPlaceIntervalValues  : mixed
$strategyConfig  : mixed
$supportedStrategy  : mixed

Methods

createCollection()  : EO_YandexCampaign_Collection
createObject()  : EO_YandexCampaign
getById()  : EO_YandexCampaign_Result
getByPrimary()  : EO_YandexCampaign_Result
getEngine()  : YandexDirect|null
Returns link to transport engine object.
getEntity()  : EO_YandexCampaign_Entity
getFilePath()  : string
Returns path to the file which contains definition of the class.
getList()  : EO_YandexCampaign_Result
getTableName()  : string
Returns DB table name for entity
onAfterDelete()  : void
Deletes all campaign banners.
onBeforeAdd()  : EventResult
Makes fields validation and adds new Yandex.Direct campaign.
onBeforeUpdate()  : EventResult
Makes fields validation and updates Yandex.Direct campaign.
onDelete()  : void
Deletes Yandex.Direct campaign.
query()  : EO_YandexCampaign_Query
wakeUpCollection()  : EO_YandexCampaign_Collection
wakeUpObject()  : EO_YandexCampaign

Constants

MONEY_WARN_PLACE_INTERVAL_DEFAULT

public mixed MONEY_WARN_PLACE_INTERVAL_DEFAULT = 30

MONEY_WARNING_VALUE_DEFAULT

public mixed MONEY_WARNING_VALUE_DEFAULT = 20

STRATEGY_AVERAGE_CLICK_PRICE

public mixed STRATEGY_AVERAGE_CLICK_PRICE = 'AverageClickPrice'

STRATEGY_WEEKLY_BUDGET

public mixed STRATEGY_WEEKLY_BUDGET = 'WeeklyBudget'

STRATEGY_WEEKLY_PACKET_OF_CLICKS

public mixed STRATEGY_WEEKLY_PACKET_OF_CLICKS = 'WeeklyPacketOfClicks'

Properties

$allowedMoneyWarningInterval

public static mixed $allowedMoneyWarningInterval = array(1, 50)

$allowedWarnPlaceIntervalValues

public static mixed $allowedWarnPlaceIntervalValues = array(15, 30, 60)

$strategyConfig

public static mixed $strategyConfig = array(self::STRATEGY_WEEKLY_BUDGET => array('WeeklySumLimit' => array('type' => 'float', 'mandatory' => true), 'MaxPrice' => array('type' => 'float', 'mandatory' => false)), self::STRATEGY_WEEKLY_PACKET_OF_CLICKS => array('ClicksPerWeek' => array('type' => 'int', 'mandatory' => true), 'MaxPrice' => array('type' => 'float', 'mandatory' => false), 'AveragePrice' => array('type' => 'float', 'mandatory' => false)), self::STRATEGY_AVERAGE_CLICK_PRICE => array('AveragePrice' => array('type' => 'float', 'mandatory' => true), 'WeeklySumLimit' => array('type' => 'float', 'mandatory' => false)))

$supportedStrategy

public static mixed $supportedStrategy = array("WEEKLY_BUDGET" => self::STRATEGY_WEEKLY_BUDGET, "WEEKLY_PACKET_OF_CLICKS" => self::STRATEGY_WEEKLY_PACKET_OF_CLICKS, "AVERAGE_CLICK_PRICE" => self::STRATEGY_AVERAGE_CLICK_PRICE)

Methods

createCollection()

public static createCollection() : EO_YandexCampaign_Collection
Return values
EO_YandexCampaign_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_YandexCampaign
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_YandexCampaign

getById()

public static getById(mixed $id) : EO_YandexCampaign_Result
Parameters
$id : mixed
Return values
EO_YandexCampaign_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_YandexCampaign_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_YandexCampaign_Result

getEntity()

public static getEntity() : EO_YandexCampaign_Entity
Return values
EO_YandexCampaign_Entity

getFilePath()

Returns path to the file which contains definition of the class.

public static getFilePath() : string
Return values
string

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_YandexCampaign_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_YandexCampaign_Result

getTableName()

Returns DB table name for entity

public static getTableName() : string
Return values
string

onAfterDelete()

Deletes all campaign banners.

public static onAfterDelete(Event $event) : void
Parameters
$event : Event

Event data.

Tags
throws
ArgumentException

onBeforeAdd()

Makes fields validation and adds new Yandex.Direct campaign.

public static onBeforeAdd(Event $event) : EventResult
Parameters
$event : Event

Event data.

Tags
throws
YandexException
throws
ArgumentException
throws
ArgumentNullException
Return values
EventResult

onBeforeUpdate()

Makes fields validation and updates Yandex.Direct campaign.

public static onBeforeUpdate(Event $event) : EventResult
Parameters
$event : Event

Event data.

Tags
throws
YandexException
throws
ArgumentException
throws
ArgumentNullException
Return values
EventResult

onDelete()

Deletes Yandex.Direct campaign.

public static onDelete(Event $event) : void
Parameters
$event : Event

Event data.

Tags
throws
YandexException
throws
ArgumentException

query()

public static query() : EO_YandexCampaign_Query
Return values
EO_YandexCampaign_Query

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_YandexCampaign_Collection
Parameters
$rows : mixed
Return values
EO_YandexCampaign_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_YandexCampaign
Parameters
$row : mixed
Return values
EO_YandexCampaign 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results