Bitrix API

Service implements IService, IMultiClientService, IInternalService

Class Service

Table of Contents

Interfaces

IService
IMultiClientService
IInternalService

Constants

GROUP  = 'marketing'
TYPE_FACEBOOK  = 'facebook'
TYPE_INSTAGRAM  = 'instagram'

Methods

canUseAsInternal()  : bool
check if service can use as internal
canUseMultipleClients()  : bool
Can use multiple clients
createAudience()  : mixed
createCampaign()  : mixed
getAccount()  : Account
Get Account by type.
getAds()  : mixed
getAdSetList()  : array<string|int, mixed>|null
getAudience()  : Audience|null
getAudienceList()  : array<string|int, mixed>|null
getAuthAdapter()  : AuthAdapter
Get auth adapter.
getCampaignList()  : array<string|int, mixed>|null
getClientId()  : string
Get client id
getEngineCode()  : string
Get engine code by type.
getInstance()  : static
Get instance.
getMethodPrefix()  : string
get seoproxy method prefix
getPostList()  : array<string|int, mixed>|null
getTypeByEngine()  : string|null
get type by engineCode
getTypes()  : array<string|int, mixed>
Get type list.
searchTargetingData()  : mixed
setClientId()  : void
Set client id.

Constants

GROUP

public mixed GROUP = 'marketing'

TYPE_FACEBOOK

public mixed TYPE_FACEBOOK = 'facebook'

TYPE_INSTAGRAM

public mixed TYPE_INSTAGRAM = 'instagram'

Methods

canUseAsInternal()

check if service can use as internal

public static canUseAsInternal() : bool
Tags
inheritDoc
Return values
bool

canUseMultipleClients()

Can use multiple clients

public static canUseMultipleClients() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

createAudience()

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

createCampaign()

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

getAccount()

Get Account by type.

public static getAccount(string $type) : Account
Parameters
$type : string

Type

Return values
Account

getAds()

public static getAds(mixed $type, mixed $adsId) : mixed
Parameters
$type : mixed
$adsId : mixed

getAdSetList()

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

getAudience()

public static getAudience(mixed $type) : Audience|null
Parameters
$type : mixed
Return values
Audience|null

getAudienceList()

public static getAudienceList(mixed $type, mixed $accountId) : array<string|int, mixed>|null
Parameters
$type : mixed
$accountId : mixed
Return values
array<string|int, mixed>|null

getAuthAdapter()

Get auth adapter.

public static getAuthAdapter(string $type) : AuthAdapter
Parameters
$type : string

Type.

Return values
AuthAdapter

getCampaignList()

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

getClientId()

Get client id

public getClientId() : string
Return values
string

getEngineCode()

Get engine code by type.

public static getEngineCode(string $type) : string
Parameters
$type : string

Type

Return values
string

getInstance()

Get instance.

public static getInstance() : static
Return values
static

getMethodPrefix()

get seoproxy method prefix

public static getMethodPrefix() : string
Tags
inheritDoc
Return values
string

getPostList()

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

getTypeByEngine()

get type by engineCode

public static getTypeByEngine(string $engineCode) : string|null
Parameters
$engineCode : string
Tags
inheritDoc
Return values
string|null

getTypes()

Get type list.

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

searchTargetingData()

public static searchTargetingData(mixed $type, mixed $params) : mixed
Parameters
$type : mixed
$params : mixed

setClientId()

Set client id.

public setClientId(string $clientId) : void
Parameters
$clientId : string

Client id.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results