Bitrix API

Configurator

Class AdsAudience.

Table of Contents

Methods

canUse()  : bool
Return true if it can use.
createAudience()  : array<string|int, mixed>
create audiences for campaign.
createCampaign()  : array<string|int, mixed>
create ads campaign with ads.
getAccounts()  : array<string|int, mixed>
Get accounts.
getAds()  : array<string|int, mixed>|mixed
get Ads by id
getAdSetList()  : array<string|int, mixed>
Get ad set list.
getAudiences()  : array<string|int, mixed>
Get audience list.
getCampaignList()  : array<string|int, mixed>
Get campaign list.
getErrors()  : array<string|int, mixed>
Get errors.
getInstagramAccounts()  : array<string|int, mixed>
Get instagram accounts.
getPostList()  : array<string|int, mixed>
Get post media list.
getProviders()  : array<string|int, mixed>
Get providers.
getRegions()  : mixed
getService()  : Service
Get service.
getServiceTypes()  : array<string|int, mixed>
Get service types.
hasErrors()  : bool
Return true if it has errors.
removeAuth()  : void
Remove auth.
resetErrors()  : void
Reset errors.
searchTargetingData()  : array<string|int, mixed>|mixed
Search targeting data by query
useQueue()  : void
Use queue.

Methods

canUse()

Return true if it can use.

public static canUse() : bool
Return values
bool

createAudience()

create audiences for campaign.

public static createAudience(mixed $type, mixed $data) : array<string|int, mixed>
Parameters
$type : mixed
$data : mixed
Return values
array<string|int, mixed>

createCampaign()

create ads campaign with ads.

public static createCampaign(mixed $type, mixed $data) : array<string|int, mixed>
Parameters
$type : mixed
$data : mixed
Return values
array<string|int, mixed>

getAccounts()

Get accounts.

public static getAccounts(string $type) : array<string|int, mixed>
Parameters
$type : string

Type.

Return values
array<string|int, mixed>

getAds()

get Ads by id

public static getAds(mixed $type, mixed $adsId) : array<string|int, mixed>|mixed
Parameters
$type : mixed
$adsId : mixed
Return values
array<string|int, mixed>|mixed

getAdSetList()

Get ad set list.

public static getAdSetList(string $type, mixed $accountId) : array<string|int, mixed>
Parameters
$type : string

Type.

$accountId : mixed
Return values
array<string|int, mixed>

getAudiences()

Get audience list.

public static getAudiences(string $type, mixed $accountId) : array<string|int, mixed>
Parameters
$type : string

Type.

$accountId : mixed
Return values
array<string|int, mixed>

getCampaignList()

Get campaign list.

public static getCampaignList(string $type, mixed $accountId) : array<string|int, mixed>
Parameters
$type : string

Type.

$accountId : mixed
Return values
array<string|int, mixed>

getErrors()

Get errors.

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

getInstagramAccounts()

Get instagram accounts.

public static getInstagramAccounts(string $type) : array<string|int, mixed>
Parameters
$type : string

Type.

Return values
array<string|int, mixed>

getPostList()

Get post media list.

public static getPostList(string $type, mixed $params) : array<string|int, mixed>
Parameters
$type : string

Type.

$params : mixed
Return values
array<string|int, mixed>

getProviders()

Get providers.

public static getProviders([array<string|int, mixed>|null $types = null ]) : array<string|int, mixed>
Parameters
$types : array<string|int, mixed>|null = null

Types.

Return values
array<string|int, mixed>

getRegions()

public static getRegions(mixed $type) : mixed
Parameters
$type : mixed

getServiceTypes()

Get service types.

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

hasErrors()

Return true if it has errors.

public static hasErrors() : bool
Return values
bool

removeAuth()

Remove auth.

public static removeAuth(string $type) : void
Parameters
$type : string

Type.

resetErrors()

Reset errors.

public static resetErrors() : void

searchTargetingData()

Search targeting data by query

public static searchTargetingData(mixed $type, mixed $params) : array<string|int, mixed>|mixed
Parameters
$type : mixed
$params : mixed
Return values
array<string|int, mixed>|mixed

        
On this page

Search results