Граф наследования:YandexDirect:

Открытые члены
	__construct ()

	getCurrentUser ()

	addCampaign (array $campaignParam)

	updateCampaign (array $campaignParam)

	getCampaign ($campaignsId)

	getCampaignList ()

	archiveCampaign ($campaignId)

	unArchiveCampaign ($campaignId)

	resumeCampaign ($campaignId)

	stopCampaign ($campaignId)

	deleteCampaign ($campaignId)

	addBanner (array $bannerParam)

	updateBanner (array $bannerParam)

	getBanners ($bannerId)

	getCampaignBanners ($campaignId)

	moderateBanners ($campaignId, array $bannerIDs)

	stopBanners ($campaignId, array $bannerIDs)

	resumeBanners ($campaignId, array $bannerIDs)

	archiveBanners ($campaignId, array $bannerIDs)

	unArchiveBanners ($campaignId, array $bannerIDs)

	deleteBanners ($campaignId, array $bannerIDs)

	getRegions ()

	getClientsSettings ()

	createWordstatReport (array $phrase, $geo=NULL)

	deleteWordstatReport ($reportId)

	getWordstatReport ($reportId)

	getWordstatReportList ()

	createForecastReport (array $phrase, $geo=NULL)

	deleteForecastReport ($reportId)

	getForecastReport ($reportId)

	getForecastReportList ()

	getBannerStats (array $params)

	finance_query ($method, $masterToken, $operationNum, $param=array(), $skipRefreshAuth=false)

	updateCampaignManual ($campaignId=NULL)

	updateBannersManual ($campaignId, $bannerId=NULL)

Открытые члены унаследованные от YandexBase
	getAuthUrl ()

	getInterface ()

	clearSitesSettings ()

	setAuthSettings ($settings=null)

	checkAuthExpired ()

	getAuth ($code)

Открытые члены унаследованные от BitrixEngine
	getProxy ()

	getAuthSettings ()

Открытые члены унаследованные от Engine
	getId ()

	getCode ()

	getSettings ()

	getClientId ()

	getClientSecret ()

	clearAuthSettings ()

Открытые члены унаследованные от IEngine
	getCode ()

	getInterface ()

	getAuthSettings ()

	setAuthSettings ($settings)

Открытые статические члены
static	updateAgent ()

Открытые атрибуты
const	ENGINE_ID = 'yandex_direct'

const	API_URL = YANDEX_DIRECT_API_URL

const	METHOD_REGION_GET = 'GetRegions'

const	METHOD_CAMPAIGN_ADD = 'CreateOrUpdateCampaign'

const	METHOD_CAMPAIGN_UPDATE = 'CreateOrUpdateCampaign'

const	METHOD_CAMPAIGN_GET = 'GetCampaignsParams'

const	METHOD_CAMPAIGN_LIST = 'GetCampaignsList'

const	METHOD_CAMPAIGN_ARCHIVE = 'ArchiveCampaign'

const	METHOD_CAMPAIGN_UNARCHIVE = 'UnArchiveCampaign'

const	METHOD_CAMPAIGN_STOP = 'StopCampaign'

const	METHOD_CAMPAIGN_RESUME = 'ResumeCampaign'

const	METHOD_CAMPAIGN_DELETE = 'DeleteCampaign'

const	METHOD_BANNER_ADD = 'CreateOrUpdateBanners'

const	METHOD_BANNER_UPDATE = 'CreateOrUpdateBanners'

const	METHOD_BANNER_LIST = 'GetBanners'

const	METHOD_BANNER_MODERATE = 'ModerateBanners'

const	METHOD_BANNER_STOP = 'StopBanners'

const	METHOD_BANNER_RESUME = 'ResumeBanners'

const	METHOD_BANNER_ARCHIVE = 'ArchiveBanners'

const	METHOD_BANNER_UNARCHIVE = 'UnArchiveBanners'

const	METHOD_BANNER_DELETE = 'DeleteBanners'

const	METHOD_WORDSTAT_REPORT_CREATE = 'CreateNewWordstatReport'

const	METHOD_WORDSTAT_REPORT_DELETE = 'DeleteWordstatReport'

const	METHOD_WORDSTAT_REPORT_GET = 'GetWordstatReport'

const	METHOD_WORDSTAT_REPORT_LIST = 'GetWordstatReportList'

const	METHOD_FORECAST_REPORT_CREATE = 'CreateNewForecast'

const	METHOD_FORECAST_REPORT_DELETE = 'DeleteForecastReport'

const	METHOD_FORECAST_REPORT_GET = 'GetForecast'

const	METHOD_FORECAST_REPORT_LIST = 'GetForecastList'

const	METHOD_STAT_BANNER = 'GetBannersStat'

const	BOOL_YES = "Yes"

const	BOOL_NO = "No"

const	STATUS_NEW = "New"

const	STATUS_PENDING = "Pending"

const	PRIORITY_LOW = "Low"

const	PRIORITY_MEDIUM = "Medium"

const	PRIORITY_HIGH = "High"

const	TTL_WORDSTAT_REPORT = 3600

const	TTL_WORDSTAT_REPORT_EXT = 18000

const	TTL_FORECAST_REPORT = 3600

const	TTL_FORECAST_REPORT_EXT = 18000

const	MAX_WORDSTAT_REPORTS = 5

const	MAX_FORECAST_REPORTS = 5

const	MAX_CAMPAIGNS_BANNER_UPDATE = 10

const	ERROR_NOT_FOUND = 27

const	ERROR_NO_STATS = 2

const	MAX_STAT_DAYS_DELTA = 7

const	CAMPAIGN_LIMIT = 100

const	ERROR_WRONG_CURRENCY = 245

const	CACHE_DIR = '/seo/yandexdirect/'

const	CACHE_TTL = 86400

const	CACHE_ID = "yandexdirect_client_cache"

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

Открытые атрибуты унаследованные от YandexBase
const	QUERY_USER = 'https://login.yandex.ru/info'

Открытые атрибуты унаследованные от Engine
const	HTTP_STATUS_OK = 200

const	HTTP_STATUS_CREATED = 201

const	HTTP_STATUS_NO_CONTENT = 204

const	HTTP_STATUS_AUTHORIZATION = 401

Защищенные члены
	query ($scope, $method="GET", $param=NULL, $skipRefreshAuth=false)

Защищенные члены унаследованные от YandexBase
	prepareQueryResult (array $result)

Защищенные члены унаследованные от Engine
	saveSettings ()

Защищенные данные
	$engineId = 'yandex_direct'

	$locale = NULL

Защищенные данные унаследованные от YandexBase
	$engineId = 'yandex_generic'

Защищенные данные унаследованные от BitrixEngine
	$engineId = 'bitrix_generic'

Защищенные данные унаследованные от Engine
	$engineId = 'unknown engine'

	$engine = null

	$engineSettings = array()

	$authInterface = null

Дополнительные унаследованные члены
Защищенные статические члены унаследованные от Engine
static	getEngine ($engineId)

Подробное описание

См. определение в файле yandexdirect.php строка 31

Конструктор(ы)

◆ __construct()

__construct ( )

Переопределяет метод предка BitrixEngine.

См. определение в файле yandexdirect.php строка 102

Методы

◆ addBanner()

addBanner ( array $bannerParam )

Sends request to create new banner

Аргументы

array $bannerParam Banner params.

Возвращает: string XML_ID for newly created banner

Исключения

SystemException
YandexDirectException

См. также: YandexBannerTable::createParam

См. определение в файле yandexdirect.php строка 319

◆ addCampaign()

addCampaign ( array $campaignParam )

Sends request to create new campaign

Аргументы

array $campaignParam Campaign params.

Возвращает: string XML_ID for newly created campaign

Исключения

SystemException
YandexDirectException

См. также: YandexCampaignTable::createParam

См. определение в файле yandexdirect.php строка 133

◆ archiveBanners()

archiveBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 468

◆ archiveCampaign()

archiveCampaign ( $campaignId )

См. определение в файле yandexdirect.php строка 224

◆ createForecastReport()

createForecastReport	(	array	$phrase,
			$geo = NULL )

См. определение в файле yandexdirect.php строка 634

◆ createWordstatReport()

createWordstatReport	(	array	$phrase,
			$geo = NULL )

См. определение в файле yandexdirect.php строка 577

◆ deleteBanners()

deleteBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 512

◆ deleteCampaign()

deleteCampaign ( $campaignId )

См. определение в файле yandexdirect.php строка 292

◆ deleteForecastReport()

deleteForecastReport ( $reportId )

См. определение в файле yandexdirect.php строка 655

◆ deleteWordstatReport()

deleteWordstatReport ( $reportId )

См. определение в файле yandexdirect.php строка 598

◆ finance_query()

finance_query	(	$method,
		$masterToken,
		$operationNum,
		$param = array(),
		$skipRefreshAuth = false )

См. определение в файле yandexdirect.php строка 779

◆ getBanners()

getBanners ( $bannerId )

См. определение в файле yandexdirect.php строка 353

◆ getBannerStats()

getBannerStats ( array $params )

Sends request for banner stats.

Аргументы

array $params Stats query params.

Возвращает: array

Исключения

YandexDirectException

Bitrix\Main\SystemException

См. также: https://tech.yandex.ru/direct/doc/dg-v4/live/GetBannersStat-docpage/

Переопределяется в YandexDirectLive.

См. определение в файле yandexdirect.php строка 702

◆ getCampaign()

getCampaign ( $campaignsId )

Get campaigns by IDs (not all)

Аргументы

mixed $campaignsId XML_ID or array of XML_IDs

Возвращает: array with campaign data

Исключения

SystemException
YandexDirectException

См. определение в файле yandexdirect.php строка 176

◆ getCampaignBanners()

getCampaignBanners ( $campaignId )

См. определение в файле yandexdirect.php строка 377

◆ getCampaignList()

getCampaignList ( )

См. определение в файле yandexdirect.php строка 212

◆ getClientsSettings()

getClientsSettings ( )

См. определение в файле yandexdirect.php строка 553

◆ getCurrentUser()

getCurrentUser ( )

Returns current Yandex user data

Возвращает: array

Исключения

SystemException
YandexException

Переопределяет метод предка YandexBase.

См. определение в файле yandexdirect.php строка 109

◆ getForecastReport()

getForecastReport ( $reportId )

См. определение в файле yandexdirect.php строка 667

◆ getForecastReportList()

getForecastReportList ( )

См. определение в файле yandexdirect.php строка 679

◆ getRegions()

getRegions ( )

Returns Yandex regions list

Возвращает: array of regions

Исключения

SystemException

См. также: https://tech.yandex.ru/direct/doc/dg-v4/reference/GetRegions-docpage/

См. определение в файле yandexdirect.php строка 541

◆ getWordstatReport()

getWordstatReport ( $reportId )

См. определение в файле yandexdirect.php строка 610

◆ getWordstatReportList()

getWordstatReportList ( )

См. определение в файле yandexdirect.php строка 622

◆ moderateBanners()

moderateBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 401

◆ query()

query	(	$scope,
		$method = "GET",
		$param = NULL,
		$skipRefreshAuth = false )

protected

Returns HttpClient object with query result

Аргументы

string	$scope
string	$method	Method
array	$param	array of query data
bool	$skipRefreshAuth	Skip authorization refresh. Doesn't work with Yandex.

Возвращает: HttpClient

Исключения

SystemException

Exception

Переопределяет метод предка YandexBase.

См. определение в файле yandexdirect.php строка 725

◆ resumeBanners()

resumeBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 446

◆ resumeCampaign()

resumeCampaign ( $campaignId )

См. определение в файле yandexdirect.php строка 258

◆ stopBanners()

stopBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 423

◆ stopCampaign()

stopCampaign ( $campaignId )

См. определение в файле yandexdirect.php строка 275

◆ unArchiveBanners()

unArchiveBanners	(		$campaignId,
		array	$bannerIDs )

См. определение в файле yandexdirect.php строка 490

◆ unArchiveCampaign()

unArchiveCampaign ( $campaignId )

См. определение в файле yandexdirect.php строка 241

◆ updateAgent()

static updateAgent ( )

static

См. определение в файле yandexdirect.php строка 1100

◆ updateBanner()

updateBanner ( array $bannerParam )

Sends request to update an existing banner

Аргументы

array $bannerParam Banner params.

Возвращает: string XML_ID for newly created banner

Исключения

SystemException
YandexDirectException

См. также: YandexBannerTable::createParam

См. определение в файле yandexdirect.php строка 341

◆ updateBannersManual()

updateBannersManual	(		$campaignId,
			$bannerId = NULL )

См. определение в файле yandexdirect.php строка 969

◆ updateCampaign()

updateCampaign ( array $campaignParam )

Sends request to update an existing campaign

Аргументы

array $campaignParam Campaign params.

Возвращает: string XML_ID for newly created campaign

Исключения

SystemException
YandexDirectException

См. также: YandexCampaignTable::createParam

См. определение в файле yandexdirect.php строка 155

◆ updateCampaignManual()

updateCampaignManual ( $campaignId = NULL )

См. определение в файле yandexdirect.php строка 826

Данные класса

◆ $allowedCurrency

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

См. определение в файле yandexdirect.php строка 97

◆ $engineId

$engineId = 'yandex_direct'

protected

См. определение в файле yandexdirect.php строка 99

◆ $locale

$locale = NULL

protected

См. определение в файле yandexdirect.php строка 100

◆ API_URL

const API_URL = YANDEX_DIRECT_API_URL

См. определение в файле yandexdirect.php строка 35

◆ BOOL_NO

const BOOL_NO = "No"

См. определение в файле yandexdirect.php строка 67

◆ BOOL_YES

const BOOL_YES = "Yes"

См. определение в файле yandexdirect.php строка 66

◆ CACHE_DIR

const CACHE_DIR = '/seo/yandexdirect/'

См. определение в файле yandexdirect.php строка 93

◆ CACHE_ID

const CACHE_ID = "yandexdirect_client_cache"

См. определение в файле yandexdirect.php строка 95

◆ CACHE_TTL

const CACHE_TTL = 86400

См. определение в файле yandexdirect.php строка 94

◆ CAMPAIGN_LIMIT

const CAMPAIGN_LIMIT = 100

См. определение в файле yandexdirect.php строка 89

◆ ENGINE_ID

const ENGINE_ID = 'yandex_direct'

См. определение в файле yandexdirect.php строка 33

◆ ERROR_NO_STATS

const ERROR_NO_STATS = 2

См. определение в файле yandexdirect.php строка 86

◆ ERROR_NOT_FOUND

const ERROR_NOT_FOUND = 27

См. определение в файле yandexdirect.php строка 85

◆ ERROR_WRONG_CURRENCY

const ERROR_WRONG_CURRENCY = 245

См. определение в файле yandexdirect.php строка 91

◆ MAX_CAMPAIGNS_BANNER_UPDATE

const MAX_CAMPAIGNS_BANNER_UPDATE = 10

См. определение в файле yandexdirect.php строка 83

◆ MAX_FORECAST_REPORTS

const MAX_FORECAST_REPORTS = 5

См. определение в файле yandexdirect.php строка 82

◆ MAX_STAT_DAYS_DELTA

const MAX_STAT_DAYS_DELTA = 7

См. определение в файле yandexdirect.php строка 88

◆ MAX_WORDSTAT_REPORTS

const MAX_WORDSTAT_REPORTS = 5

См. определение в файле yandexdirect.php строка 81

◆ METHOD_BANNER_ADD

const METHOD_BANNER_ADD = 'CreateOrUpdateBanners'

См. определение в файле yandexdirect.php строка 47

◆ METHOD_BANNER_ARCHIVE

const METHOD_BANNER_ARCHIVE = 'ArchiveBanners'

См. определение в файле yandexdirect.php строка 53

◆ METHOD_BANNER_DELETE

const METHOD_BANNER_DELETE = 'DeleteBanners'

См. определение в файле yandexdirect.php строка 55

◆ METHOD_BANNER_LIST

const METHOD_BANNER_LIST = 'GetBanners'

См. определение в файле yandexdirect.php строка 49

◆ METHOD_BANNER_MODERATE

const METHOD_BANNER_MODERATE = 'ModerateBanners'

См. определение в файле yandexdirect.php строка 50

◆ METHOD_BANNER_RESUME

const METHOD_BANNER_RESUME = 'ResumeBanners'

См. определение в файле yandexdirect.php строка 52

◆ METHOD_BANNER_STOP

const METHOD_BANNER_STOP = 'StopBanners'

См. определение в файле yandexdirect.php строка 51

◆ METHOD_BANNER_UNARCHIVE

const METHOD_BANNER_UNARCHIVE = 'UnArchiveBanners'

См. определение в файле yandexdirect.php строка 54

◆ METHOD_BANNER_UPDATE

const METHOD_BANNER_UPDATE = 'CreateOrUpdateBanners'

См. определение в файле yandexdirect.php строка 48

◆ METHOD_CAMPAIGN_ADD

const METHOD_CAMPAIGN_ADD = 'CreateOrUpdateCampaign'

См. определение в файле yandexdirect.php строка 38

◆ METHOD_CAMPAIGN_ARCHIVE

const METHOD_CAMPAIGN_ARCHIVE = 'ArchiveCampaign'

См. определение в файле yandexdirect.php строка 42

◆ METHOD_CAMPAIGN_DELETE

const METHOD_CAMPAIGN_DELETE = 'DeleteCampaign'

См. определение в файле yandexdirect.php строка 46

◆ METHOD_CAMPAIGN_GET

const METHOD_CAMPAIGN_GET = 'GetCampaignsParams'

См. определение в файле yandexdirect.php строка 40

◆ METHOD_CAMPAIGN_LIST

const METHOD_CAMPAIGN_LIST = 'GetCampaignsList'

См. определение в файле yandexdirect.php строка 41

◆ METHOD_CAMPAIGN_RESUME

const METHOD_CAMPAIGN_RESUME = 'ResumeCampaign'

См. определение в файле yandexdirect.php строка 45

◆ METHOD_CAMPAIGN_STOP

const METHOD_CAMPAIGN_STOP = 'StopCampaign'

См. определение в файле yandexdirect.php строка 44

◆ METHOD_CAMPAIGN_UNARCHIVE

const METHOD_CAMPAIGN_UNARCHIVE = 'UnArchiveCampaign'

См. определение в файле yandexdirect.php строка 43

◆ METHOD_CAMPAIGN_UPDATE

const METHOD_CAMPAIGN_UPDATE = 'CreateOrUpdateCampaign'

См. определение в файле yandexdirect.php строка 39

◆ METHOD_FORECAST_REPORT_CREATE

const METHOD_FORECAST_REPORT_CREATE = 'CreateNewForecast'

См. определение в файле yandexdirect.php строка 60

◆ METHOD_FORECAST_REPORT_DELETE

const METHOD_FORECAST_REPORT_DELETE = 'DeleteForecastReport'

См. определение в файле yandexdirect.php строка 61

◆ METHOD_FORECAST_REPORT_GET

const METHOD_FORECAST_REPORT_GET = 'GetForecast'

См. определение в файле yandexdirect.php строка 62

◆ METHOD_FORECAST_REPORT_LIST

const METHOD_FORECAST_REPORT_LIST = 'GetForecastList'

См. определение в файле yandexdirect.php строка 63

◆ METHOD_REGION_GET

const METHOD_REGION_GET = 'GetRegions'

См. определение в файле yandexdirect.php строка 37

◆ METHOD_STAT_BANNER

const METHOD_STAT_BANNER = 'GetBannersStat'

См. определение в файле yandexdirect.php строка 64

◆ METHOD_WORDSTAT_REPORT_CREATE

const METHOD_WORDSTAT_REPORT_CREATE = 'CreateNewWordstatReport'

См. определение в файле yandexdirect.php строка 56

◆ METHOD_WORDSTAT_REPORT_DELETE

const METHOD_WORDSTAT_REPORT_DELETE = 'DeleteWordstatReport'

См. определение в файле yandexdirect.php строка 57

◆ METHOD_WORDSTAT_REPORT_GET

const METHOD_WORDSTAT_REPORT_GET = 'GetWordstatReport'

См. определение в файле yandexdirect.php строка 58

◆ METHOD_WORDSTAT_REPORT_LIST

const METHOD_WORDSTAT_REPORT_LIST = 'GetWordstatReportList'

См. определение в файле yandexdirect.php строка 59

◆ PRIORITY_HIGH

const PRIORITY_HIGH = "High"

См. определение в файле yandexdirect.php строка 74

◆ PRIORITY_LOW

const PRIORITY_LOW = "Low"

См. определение в файле yandexdirect.php строка 72

◆ PRIORITY_MEDIUM

const PRIORITY_MEDIUM = "Medium"

См. определение в файле yandexdirect.php строка 73

◆ STATUS_NEW

const STATUS_NEW = "New"

См. определение в файле yandexdirect.php строка 69

◆ STATUS_PENDING

const STATUS_PENDING = "Pending"

См. определение в файле yandexdirect.php строка 70

◆ TTL_FORECAST_REPORT

const TTL_FORECAST_REPORT = 3600

См. определение в файле yandexdirect.php строка 78

◆ TTL_FORECAST_REPORT_EXT

const TTL_FORECAST_REPORT_EXT = 18000

См. определение в файле yandexdirect.php строка 79

◆ TTL_WORDSTAT_REPORT

const TTL_WORDSTAT_REPORT = 3600

См. определение в файле yandexdirect.php строка 76

◆ TTL_WORDSTAT_REPORT_EXT

const TTL_WORDSTAT_REPORT_EXT = 18000

См. определение в файле yandexdirect.php строка 77

Bitrix-D7 23.9

Открытые члены

Открытые статические члены

Открытые атрибуты

Защищенные члены

Защищенные данные

Дополнительные унаследованные члены

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ addBanner()

◆ addCampaign()

◆ archiveBanners()

◆ archiveCampaign()

◆ createForecastReport()

◆ createWordstatReport()

◆ deleteBanners()

◆ deleteCampaign()

◆ deleteForecastReport()

◆ deleteWordstatReport()

◆ finance_query()

◆ getBanners()

◆ getBannerStats()

◆ getCampaign()

◆ getCampaignBanners()

◆ getCampaignList()

◆ getClientsSettings()

◆ getCurrentUser()

◆ getForecastReport()

◆ getForecastReportList()

◆ getRegions()

◆ getWordstatReport()

◆ getWordstatReportList()

◆ moderateBanners()

◆ query()

◆ resumeBanners()

◆ resumeCampaign()

◆ stopBanners()

◆ stopCampaign()

◆ unArchiveBanners()

◆ unArchiveCampaign()

◆ updateAgent()

◆ updateBanner()

◆ updateBannersManual()

◆ updateCampaign()

◆ updateCampaignManual()

Данные класса

◆ $allowedCurrency

◆ $engineId

◆ $locale

◆ API_URL

◆ BOOL_NO

◆ BOOL_YES

◆ CACHE_DIR

◆ CACHE_ID

◆ CACHE_TTL

◆ CAMPAIGN_LIMIT

◆ ENGINE_ID

◆ ERROR_NO_STATS

◆ ERROR_NOT_FOUND

◆ ERROR_WRONG_CURRENCY

◆ MAX_CAMPAIGNS_BANNER_UPDATE

◆ MAX_FORECAST_REPORTS

◆ MAX_STAT_DAYS_DELTA

◆ MAX_WORDSTAT_REPORTS

◆ METHOD_BANNER_ADD

◆ METHOD_BANNER_ARCHIVE

◆ METHOD_BANNER_DELETE

◆ METHOD_BANNER_LIST

◆ METHOD_BANNER_MODERATE

◆ METHOD_BANNER_RESUME

◆ METHOD_BANNER_STOP

◆ METHOD_BANNER_UNARCHIVE

◆ METHOD_BANNER_UPDATE

◆ METHOD_CAMPAIGN_ADD

◆ METHOD_CAMPAIGN_ARCHIVE

◆ METHOD_CAMPAIGN_DELETE

◆ METHOD_CAMPAIGN_GET

◆ METHOD_CAMPAIGN_LIST

◆ METHOD_CAMPAIGN_RESUME