Bitrix API

AudienceVkads extends Audience

Table of Contents

Constants

ENUM_CONTACT_TYPE_EMAIL  = 'email'
ENUM_CONTACT_TYPE_IDFA_GAID  = 'idfa_gaid'
ENUM_CONTACT_TYPE_INTERNAL_ID  = 'int'
ENUM_CONTACT_TYPE_PHONE  = 'phone'
MAX_CONTACTS_PER_PACKET  = 1000
MIN_CONTACTS_FOR_ACTIVATING  = 20
TYPE_CODE  = 'vkads'
TYPE_FACEBOOK  = 'facebook'
TYPE_GOOGLE  = 'google'
TYPE_MYCOM  = 'mycom'
TYPE_VKONTAKTE  = 'vkontakte'
TYPE_YANDEX  = 'yandex'
URL_AUDIENCE_LIST  = 'https://ads.vk.com/hq/audience/user_lists'

Methods

__construct()  : mixed
add()  : Response
Add.
addContacts()  : Response
create()  : static
createLookalike()  : mixed
deleteContacts()  : Response
disableQueueAutoRemove()  : mixed
disableQueueMode()  : mixed
enableQueueAutoRemove()  : mixed
enableQueueMode()  : mixed
getById()  : mixed
getList()  : Response
Get list.
getLookalikeAudiencesParams()  : mixed
getMaxContactsPerPacket()  : mixed
getMinContactsForActivating()  : mixed
getRequest()  : Request
getUrlAudienceList()  : mixed
importContacts()  : mixed
isAddingRequireContacts()  : mixed
isQueueModeEnabled()  : mixed
isQueueProcessed()  : mixed
isSupportAccount()  : mixed
isSupportAddAudience()  : mixed
isSupportCreateLookalikeFromSegments()  : bool
isSupportMultiTypeContacts()  : mixed
isSupportRemoveContacts()  : mixed
normalizeEmail()  : mixed
normalizeListRow()  : mixed
normalizePhone()  : mixed
processLookalikeAudienceAgent()  : mixed
removeContacts()  : mixed
setAccountId()  : mixed
setRequest()  : mixed
setService()  : mixed

Constants

ENUM_CONTACT_TYPE_EMAIL

public mixed ENUM_CONTACT_TYPE_EMAIL = 'email'

ENUM_CONTACT_TYPE_IDFA_GAID

public mixed ENUM_CONTACT_TYPE_IDFA_GAID = 'idfa_gaid'

ENUM_CONTACT_TYPE_INTERNAL_ID

public mixed ENUM_CONTACT_TYPE_INTERNAL_ID = 'int'

ENUM_CONTACT_TYPE_PHONE

public mixed ENUM_CONTACT_TYPE_PHONE = 'phone'

MAX_CONTACTS_PER_PACKET

public mixed MAX_CONTACTS_PER_PACKET = 1000

MIN_CONTACTS_FOR_ACTIVATING

public mixed MIN_CONTACTS_FOR_ACTIVATING = 20

TYPE_FACEBOOK

public mixed TYPE_FACEBOOK = 'facebook'

TYPE_GOOGLE

public mixed TYPE_GOOGLE = 'google'

TYPE_MYCOM

public mixed TYPE_MYCOM = 'mycom'

TYPE_VKONTAKTE

public mixed TYPE_VKONTAKTE = 'vkontakte'

TYPE_YANDEX

public mixed TYPE_YANDEX = 'yandex'

URL_AUDIENCE_LIST

public mixed URL_AUDIENCE_LIST = 'https://ads.vk.com/hq/audience/user_lists'

Methods

__construct()

public __construct([mixed $accountId = null ]) : mixed
Parameters
$accountId : mixed = null

addContacts()

public addContacts(mixed $audienceId, array<string|int, mixed> $contacts, array<string|int, mixed> $options) : Response
Parameters
$audienceId : mixed
$contacts : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
Response

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

createLookalike()

public createLookalike(mixed $sourceAudienceId, array<string|int, mixed> $options) : mixed
Parameters
$sourceAudienceId : mixed
$options : array<string|int, mixed>

deleteContacts()

public deleteContacts(mixed $audienceId, array<string|int, mixed> $contacts, array<string|int, mixed> $options) : Response
Parameters
$audienceId : mixed
$contacts : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
Response

disableQueueAutoRemove()

public disableQueueAutoRemove() : mixed

disableQueueMode()

public disableQueueMode() : mixed

enableQueueAutoRemove()

public enableQueueAutoRemove([mixed $daysNumber = null ]) : mixed
Parameters
$daysNumber : mixed = null

enableQueueMode()

public enableQueueMode() : mixed

getById()

public getById(mixed $itemId) : mixed
Parameters
$itemId : mixed

getLookalikeAudiencesParams()

public getLookalikeAudiencesParams() : mixed

getMaxContactsPerPacket()

public static getMaxContactsPerPacket() : mixed

getMinContactsForActivating()

public static getMinContactsForActivating() : mixed

getUrlAudienceList()

public static getUrlAudienceList() : mixed

importContacts()

public importContacts(mixed $audienceId, array<string|int, mixed> $contacts, array<string|int, mixed> $options) : mixed
Parameters
$audienceId : mixed
$contacts : array<string|int, mixed>
$options : array<string|int, mixed>

isAddingRequireContacts()

public static isAddingRequireContacts() : mixed

isQueueModeEnabled()

public isQueueModeEnabled() : mixed

isQueueProcessed()

public isQueueProcessed(mixed $parentId) : mixed
Parameters
$parentId : mixed

isSupportAccount()

public static isSupportAccount() : mixed

isSupportAddAudience()

public static isSupportAddAudience() : mixed

isSupportCreateLookalikeFromSegments()

public static isSupportCreateLookalikeFromSegments() : bool
Return values
bool

isSupportMultiTypeContacts()

public static isSupportMultiTypeContacts() : mixed

isSupportRemoveContacts()

public static isSupportRemoveContacts() : mixed

normalizeEmail()

public static normalizeEmail(mixed $email) : mixed
Parameters
$email : mixed

normalizeListRow()

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

normalizePhone()

public static normalizePhone(mixed $phone) : mixed
Parameters
$phone : mixed

processLookalikeAudienceAgent()

public static processLookalikeAudienceAgent(mixed $clientId, mixed $accountId, mixed $audienceRequestId, mixed $audienceSize) : mixed
Parameters
$clientId : mixed
$accountId : mixed
$audienceRequestId : mixed
$audienceSize : mixed

removeContacts()

public removeContacts(mixed $audienceId, array<string|int, mixed> $contacts, array<string|int, mixed> $options) : mixed
Parameters
$audienceId : mixed
$contacts : array<string|int, mixed>
$options : array<string|int, mixed>

setAccountId()

public setAccountId(mixed $accountId) : mixed
Parameters
$accountId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results