Bitrix API

YandexDirect extends YandexBase implements IEngine

Table of Contents

Interfaces

IEngine

Constants

API_URL  = YANDEX_DIRECT_API_URL
BOOL_NO  = "No"
BOOL_YES  = "Yes"
CACHE_DIR  = '/seo/yandexdirect/'
CACHE_ID  = "yandexdirect_client_cache"
CACHE_TTL  = 86400
CAMPAIGN_LIMIT  = 100
ENGINE_ID  = 'yandex_direct'
ERROR_NO_STATS  = 2
ERROR_NOT_FOUND  = 27
ERROR_WRONG_CURRENCY  = 245
MAX_CAMPAIGNS_BANNER_UPDATE  = 10
MAX_FORECAST_REPORTS  = 5
MAX_STAT_DAYS_DELTA  = 7
MAX_WORDSTAT_REPORTS  = 5
METHOD_BANNER_ADD  = 'CreateOrUpdateBanners'
METHOD_BANNER_ARCHIVE  = 'ArchiveBanners'
METHOD_BANNER_DELETE  = 'DeleteBanners'
METHOD_BANNER_LIST  = 'GetBanners'
METHOD_BANNER_MODERATE  = 'ModerateBanners'
METHOD_BANNER_RESUME  = 'ResumeBanners'
METHOD_BANNER_STOP  = 'StopBanners'
METHOD_BANNER_UNARCHIVE  = 'UnArchiveBanners'
METHOD_BANNER_UPDATE  = 'CreateOrUpdateBanners'
METHOD_CAMPAIGN_ADD  = 'CreateOrUpdateCampaign'
METHOD_CAMPAIGN_ARCHIVE  = 'ArchiveCampaign'
METHOD_CAMPAIGN_DELETE  = 'DeleteCampaign'
METHOD_CAMPAIGN_GET  = 'GetCampaignsParams'
METHOD_CAMPAIGN_LIST  = 'GetCampaignsList'
METHOD_CAMPAIGN_RESUME  = 'ResumeCampaign'
METHOD_CAMPAIGN_STOP  = 'StopCampaign'
METHOD_CAMPAIGN_UNARCHIVE  = 'UnArchiveCampaign'
METHOD_CAMPAIGN_UPDATE  = 'CreateOrUpdateCampaign'
METHOD_FORECAST_REPORT_CREATE  = 'CreateNewForecast'
METHOD_FORECAST_REPORT_DELETE  = 'DeleteForecastReport'
METHOD_FORECAST_REPORT_GET  = 'GetForecast'
METHOD_FORECAST_REPORT_LIST  = 'GetForecastList'
METHOD_REGION_GET  = 'GetRegions'
METHOD_STAT_BANNER  = 'GetBannersStat'
METHOD_WORDSTAT_REPORT_CREATE  = 'CreateNewWordstatReport'
METHOD_WORDSTAT_REPORT_DELETE  = 'DeleteWordstatReport'
METHOD_WORDSTAT_REPORT_GET  = 'GetWordstatReport'
METHOD_WORDSTAT_REPORT_LIST  = 'GetWordstatReportList'
PRIORITY_HIGH  = "High"
PRIORITY_LOW  = "Low"
PRIORITY_MEDIUM  = "Medium"
QUERY_USER  = 'https://login.yandex.ru/info'
STATUS_NEW  = "New"
STATUS_PENDING  = "Pending"
TTL_FORECAST_REPORT  = 3600
TTL_FORECAST_REPORT_EXT  = 18000
TTL_WORDSTAT_REPORT  = 3600
TTL_WORDSTAT_REPORT_EXT  = 18000

Properties

$allowedCurrency  : mixed

Methods

__construct()  : mixed
addBanner()  : mixed
Sends request to create new banner
addCampaign()  : mixed
Sends request to create new campaign
archiveBanners()  : mixed
archiveCampaign()  : mixed
checkAuthExpired()  : mixed
clearSitesSettings()  : mixed
createForecastReport()  : mixed
createWordstatReport()  : mixed
deleteBanners()  : mixed
deleteCampaign()  : mixed
deleteForecastReport()  : mixed
deleteWordstatReport()  : mixed
finance_query()  : mixed
getAuth()  : mixed
getAuthSettings()  : mixed
getAuthUrl()  : string
Returns URL to authorize app
getBanners()  : mixed
getBannerStats()  : array<string|int, mixed>
Sends request for banner stats.
getCampaign()  : array<string|int, mixed>
Get campaigns by IDs (not all)
getCampaignBanners()  : mixed
getCampaignList()  : mixed
getClientsSettings()  : mixed
getCurrentUser()  : array<string|int, mixed>
Returns current Yandex user data
getForecastReport()  : mixed
getForecastReportList()  : mixed
getInterface()  : CYandexOAuthInterface
Creates OAuth interface object instance
getProxy()  : mixed
getRegions()  : array<string|int, mixed>
Returns Yandex regions list
getWordstatReport()  : mixed
getWordstatReportList()  : mixed
moderateBanners()  : mixed
resumeBanners()  : mixed
resumeCampaign()  : mixed
setAuthSettings()  : mixed
stopBanners()  : mixed
stopCampaign()  : mixed
unArchiveBanners()  : mixed
unArchiveCampaign()  : mixed
updateAgent()  : mixed
updateBanner()  : mixed
Sends request to update an existing banner
updateBannersManual()  : mixed
updateCampaign()  : mixed
Sends request to update an existing campaign
updateCampaignManual()  : mixed

Constants

CACHE_ID

public mixed CACHE_ID = "yandexdirect_client_cache"

ERROR_WRONG_CURRENCY

public mixed ERROR_WRONG_CURRENCY = 245

MAX_CAMPAIGNS_BANNER_UPDATE

public mixed MAX_CAMPAIGNS_BANNER_UPDATE = 10

MAX_FORECAST_REPORTS

public mixed MAX_FORECAST_REPORTS = 5

MAX_STAT_DAYS_DELTA

public mixed MAX_STAT_DAYS_DELTA = 7

MAX_WORDSTAT_REPORTS

public mixed MAX_WORDSTAT_REPORTS = 5

METHOD_BANNER_ADD

public mixed METHOD_BANNER_ADD = 'CreateOrUpdateBanners'

METHOD_BANNER_ARCHIVE

public mixed METHOD_BANNER_ARCHIVE = 'ArchiveBanners'

METHOD_BANNER_DELETE

public mixed METHOD_BANNER_DELETE = 'DeleteBanners'

METHOD_BANNER_LIST

public mixed METHOD_BANNER_LIST = 'GetBanners'

METHOD_BANNER_MODERATE

public mixed METHOD_BANNER_MODERATE = 'ModerateBanners'

METHOD_BANNER_RESUME

public mixed METHOD_BANNER_RESUME = 'ResumeBanners'

METHOD_BANNER_STOP

public mixed METHOD_BANNER_STOP = 'StopBanners'

METHOD_BANNER_UNARCHIVE

public mixed METHOD_BANNER_UNARCHIVE = 'UnArchiveBanners'

METHOD_BANNER_UPDATE

public mixed METHOD_BANNER_UPDATE = 'CreateOrUpdateBanners'

METHOD_CAMPAIGN_ADD

public mixed METHOD_CAMPAIGN_ADD = 'CreateOrUpdateCampaign'

METHOD_CAMPAIGN_ARCHIVE

public mixed METHOD_CAMPAIGN_ARCHIVE = 'ArchiveCampaign'

METHOD_CAMPAIGN_DELETE

public mixed METHOD_CAMPAIGN_DELETE = 'DeleteCampaign'

METHOD_CAMPAIGN_GET

public mixed METHOD_CAMPAIGN_GET = 'GetCampaignsParams'

METHOD_CAMPAIGN_LIST

public mixed METHOD_CAMPAIGN_LIST = 'GetCampaignsList'

METHOD_CAMPAIGN_RESUME

public mixed METHOD_CAMPAIGN_RESUME = 'ResumeCampaign'

METHOD_CAMPAIGN_STOP

public mixed METHOD_CAMPAIGN_STOP = 'StopCampaign'

METHOD_CAMPAIGN_UNARCHIVE

public mixed METHOD_CAMPAIGN_UNARCHIVE = 'UnArchiveCampaign'

METHOD_CAMPAIGN_UPDATE

public mixed METHOD_CAMPAIGN_UPDATE = 'CreateOrUpdateCampaign'

METHOD_FORECAST_REPORT_CREATE

public mixed METHOD_FORECAST_REPORT_CREATE = 'CreateNewForecast'

METHOD_FORECAST_REPORT_DELETE

public mixed METHOD_FORECAST_REPORT_DELETE = 'DeleteForecastReport'

METHOD_FORECAST_REPORT_GET

public mixed METHOD_FORECAST_REPORT_GET = 'GetForecast'

METHOD_FORECAST_REPORT_LIST

public mixed METHOD_FORECAST_REPORT_LIST = 'GetForecastList'

METHOD_REGION_GET

public mixed METHOD_REGION_GET = 'GetRegions'

METHOD_STAT_BANNER

public mixed METHOD_STAT_BANNER = 'GetBannersStat'

METHOD_WORDSTAT_REPORT_CREATE

public mixed METHOD_WORDSTAT_REPORT_CREATE = 'CreateNewWordstatReport'

METHOD_WORDSTAT_REPORT_DELETE

public mixed METHOD_WORDSTAT_REPORT_DELETE = 'DeleteWordstatReport'

METHOD_WORDSTAT_REPORT_GET

public mixed METHOD_WORDSTAT_REPORT_GET = 'GetWordstatReport'

METHOD_WORDSTAT_REPORT_LIST

public mixed METHOD_WORDSTAT_REPORT_LIST = 'GetWordstatReportList'

QUERY_USER

public mixed QUERY_USER = 'https://login.yandex.ru/info'

TTL_FORECAST_REPORT

public mixed TTL_FORECAST_REPORT = 3600

TTL_FORECAST_REPORT_EXT

public mixed TTL_FORECAST_REPORT_EXT = 18000

TTL_WORDSTAT_REPORT

public mixed TTL_WORDSTAT_REPORT = 3600

TTL_WORDSTAT_REPORT_EXT

public mixed TTL_WORDSTAT_REPORT_EXT = 18000

Properties

$allowedCurrency

public mixed $allowedCurrency = array('RUB', 'CHF', 'EUR', 'KZT', 'TRY', 'UAH', 'USD')

Methods

addBanner()

Sends request to create new banner

public addBanner(array<string|int, mixed> $bannerParam) : mixed
Parameters
$bannerParam : array<string|int, mixed>

Banner params.

Tags
returns

string XML_ID for newly created banner

throws
SystemException
throws
YandexDirectException
see
YandexBannerTable::createParam

addCampaign()

Sends request to create new campaign

public addCampaign(array<string|int, mixed> $campaignParam) : mixed
Parameters
$campaignParam : array<string|int, mixed>

Campaign params.

Tags
returns

string XML_ID for newly created campaign

throws
SystemException
throws
YandexDirectException
see
YandexCampaignTable::createParam

archiveBanners()

public archiveBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

archiveCampaign()

public archiveCampaign(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

checkAuthExpired()

public checkAuthExpired() : mixed

clearSitesSettings()

public clearSitesSettings() : mixed

createForecastReport()

public createForecastReport(array<string|int, mixed> $phrase[, mixed $geo = NULL ]) : mixed
Parameters
$phrase : array<string|int, mixed>
$geo : mixed = NULL

createWordstatReport()

public createWordstatReport(array<string|int, mixed> $phrase[, mixed $geo = NULL ]) : mixed
Parameters
$phrase : array<string|int, mixed>
$geo : mixed = NULL

deleteBanners()

public deleteBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

deleteCampaign()

public deleteCampaign(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

deleteForecastReport()

public deleteForecastReport(mixed $reportId) : mixed
Parameters
$reportId : mixed

deleteWordstatReport()

public deleteWordstatReport(mixed $reportId) : mixed
Parameters
$reportId : mixed

finance_query()

public finance_query(mixed $method, mixed $masterToken, mixed $operationNum[, mixed $param = array() ][, mixed $skipRefreshAuth = false ]) : mixed
Parameters
$method : mixed
$masterToken : mixed
$operationNum : mixed
$param : mixed = array()
$skipRefreshAuth : mixed = false

getAuth()

public getAuth(mixed $code) : mixed
Parameters
$code : mixed

getAuthUrl()

Returns URL to authorize app

public getAuthUrl() : string
Return values
string —

Url

getBanners()

public getBanners(mixed $bannerId) : mixed
Parameters
$bannerId : mixed

getCampaign()

Get campaigns by IDs (not all)

public getCampaign(mixed $campaignsId) : array<string|int, mixed>
Parameters
$campaignsId : mixed

XML_ID or array of XML_IDs

Tags
throws
SystemException
throws
YandexDirectException
Return values
array<string|int, mixed> —

with campaign data

getCampaignBanners()

public getCampaignBanners(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

getClientsSettings()

public getClientsSettings() : mixed

getCurrentUser()

Returns current Yandex user data

public getCurrentUser() : array<string|int, mixed>
Return values
array<string|int, mixed>

getForecastReport()

public getForecastReport(mixed $reportId) : mixed
Parameters
$reportId : mixed

getForecastReportList()

public getForecastReportList() : mixed

getInterface()

Creates OAuth interface object instance

public getInterface() : CYandexOAuthInterface
Return values
CYandexOAuthInterface

getWordstatReport()

public getWordstatReport(mixed $reportId) : mixed
Parameters
$reportId : mixed

getWordstatReportList()

public getWordstatReportList() : mixed

moderateBanners()

public moderateBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

resumeBanners()

public resumeBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

resumeCampaign()

public resumeCampaign(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

setAuthSettings()

public setAuthSettings([mixed $settings = null ]) : mixed
Parameters
$settings : mixed = null

stopBanners()

public stopBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

stopCampaign()

public stopCampaign(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

unArchiveBanners()

public unArchiveBanners(mixed $campaignId, array<string|int, mixed> $bannerIDs) : mixed
Parameters
$campaignId : mixed
$bannerIDs : array<string|int, mixed>

unArchiveCampaign()

public unArchiveCampaign(mixed $campaignId) : mixed
Parameters
$campaignId : mixed

updateBanner()

Sends request to update an existing banner

public updateBanner(array<string|int, mixed> $bannerParam) : mixed
Parameters
$bannerParam : array<string|int, mixed>

Banner params.

Tags
returns

string XML_ID for newly created banner

throws
SystemException
throws
YandexDirectException
see
YandexBannerTable::createParam

updateBannersManual()

public updateBannersManual(mixed $campaignId[, mixed $bannerId = NULL ]) : mixed
Parameters
$campaignId : mixed
$bannerId : mixed = NULL

updateCampaign()

Sends request to update an existing campaign

public updateCampaign(array<string|int, mixed> $campaignParam) : mixed
Parameters
$campaignParam : array<string|int, mixed>

Campaign params.

Tags
returns

string XML_ID for newly created campaign

throws
SystemException
throws
YandexDirectException
see
YandexCampaignTable::createParam

updateCampaignManual()

public updateCampaignManual([mixed $campaignId = NULL ]) : mixed
Parameters
$campaignId : mixed = NULL 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results