Bitrix API

AccountVkontakte extends Account implements IRequestDirectly

Table of Contents

Interfaces

IRequestDirectly

Constants

CURRENCY_CODE  = 'RUB'
MAX_ADS_EDIT  = 20
PROFILE_INFO_CACHE_TTL  = 86400
TYPE_CODE  = 'vkontakte'

Methods

__construct()  : mixed
checkNewAuthInfo()  : bool
clearCache()  : void
Clear profile cache
create()  : static
getDailyExpensesReport()  : Result
Get expenses report by day
getExpenses()  : Response
Get expenses.
getExpensesReport()  : Result
Get expenses report.
getList()  : Response
getProfile()  : Response
getProfileCached()  : array<string|int, mixed>
Get profile data (cached)
getPublicPages()  : Response
Get public pages.
getRegionsList()  : mixed
getRequest()  : Request
hasAccounts()  : bool
Return true if it has accounts.
hasDailyExpensesReport()  : bool
Return true if it has daily expenses report
hasExpensesReport()  : bool
Return true if it has expenses report.
hasPublicPages()  : bool
manageAdCampaign()  : Result
Manage activity of campaign.
manageAdGroup()  : Result
Manage activity of ad group.
manageAdKeyword()  : Result
Manage activity of keyword.
normalizeListRow()  : mixed
setRequest()  : mixed
setService()  : mixed
updateAnalyticParams()  : Response

Constants

PROFILE_INFO_CACHE_TTL

public mixed PROFILE_INFO_CACHE_TTL = 86400

Methods

checkNewAuthInfo()

public checkNewAuthInfo() : bool
Return values
bool

clearCache()

Clear profile cache

public clearCache() : void
Tags
throws
SystemException

create()

public static create(mixed $type[, null $parameters = null ][, IService|null $service = null ]) : static
Parameters
$type : mixed
$parameters : null = null
$service : IService|null = null
Return values
static

getDailyExpensesReport()

Get expenses report by day

public getDailyExpensesReport(string|null $accountId, Date|null $dateFrom, Date|null $dateTo) : Result
Parameters
$accountId : string|null
$dateFrom : Date|null
$dateTo : Date|null
Return values
Result

getExpenses()

Get expenses.

public getExpenses(mixed $accountId[, Date|null $dateFrom = null ][, Date|null $dateTo = null ]) : Response
Parameters
$accountId : mixed

VK Ad Account Id.

$dateFrom : Date|null = null
$dateTo : Date|null = null
Return values
Response

getExpensesReport()

Get expenses report.

public getExpensesReport(mixed $accountId[, Date|null $dateFrom = null ][, Date|null $dateTo = null ]) : Result
Parameters
$accountId : mixed
$dateFrom : Date|null = null
$dateTo : Date|null = null
Tags
throws
NotImplementedException
Return values
Result

getProfileCached()

Get profile data (cached)

public getProfileCached() : array<string|int, mixed>
Tags
throws
SystemException
Return values
array<string|int, mixed>

getPublicPages()

Get public pages.

public getPublicPages(mixed $accountId) : Response
Parameters
$accountId : mixed
Tags
throws
SystemException
Return values
Response

getRegionsList()

public getRegionsList() : mixed

hasAccounts()

Return true if it has accounts.

public hasAccounts() : bool
Return values
bool

hasDailyExpensesReport()

Return true if it has daily expenses report

public hasDailyExpensesReport() : bool
Return values
bool

hasExpensesReport()

Return true if it has expenses report.

public hasExpensesReport() : bool
Return values
bool

manageAdCampaign()

Manage activity of campaign.

public manageAdCampaign(string $accountId, string $id[, bool $active = true ]) : Result
Parameters
$accountId : string

Account ID.

$id : string

ID.

$active : bool = true

Active.

Tags
throws
NotImplementedException
Return values
Result

manageAdGroup()

Manage activity of ad group.

public manageAdGroup(string $accountId, string $id[, bool $active = true ]) : Result
Parameters
$accountId : string

Account ID.

$id : string

ID.

$active : bool = true

Active.

Tags
throws
NotImplementedException
Return values
Result

manageAdKeyword()

Manage activity of keyword.

public manageAdKeyword(string $accountId, string $groupId, string $id[, bool $active = true ]) : Result
Parameters
$accountId : string

Account ID.

$groupId : string

Group ID.

$id : string

ID.

$active : bool = true

Active.

Tags
throws
NotImplementedException
Return values
Result

normalizeListRow()

public static normalizeListRow(array<string|int, mixed> $row) : mixed
Parameters
$row : array<string|int, mixed>

updateAnalyticParams()

public updateAnalyticParams(mixed $accountId, array<string|int, mixed> $params[, array<string|int, mixed> $publicPageIds = [] ]) : Response
Parameters
$accountId : mixed
$params : array<string|int, mixed>
$publicPageIds : array<string|int, mixed> = []
Tags
throws
SystemException
Return values
Response 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results