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

Открытые члены
	__construct ($accountId=null)
	setAccountId ($accountId)
	getLookalikeAudiencesParams ()
	disableQueueAutoRemove ()
	enableQueueAutoRemove ($daysNumber=null)
	disableQueueMode ()
	enableQueueMode ()
	isQueueModeEnabled ()
	getById ($itemId)
	addContacts ($audienceId, array $contacts, array $options)
	deleteContacts ($audienceId, array $contacts, array $options)
	add (array $data)
	getList ()
	createLookalike ($sourceAudienceId, array $options)
	isQueueProcessed ($parentId)
Открытые члены унаследованные от BaseApiObject
	__construct ()
	getRequest ()
	setRequest (Request $request)
	setService (IService $service)

Открытые статические члены
static	normalizeEmail ($email)
static	normalizePhone ($phone)
static	isSupportMultiTypeContacts ()
static	isSupportAccount ()
static	isSupportAddAudience ()
static	isAddingRequireContacts ()
static	isSupportRemoveContacts ()
static	isSupportCreateLookalikeFromSegments ()
static	getUrlAudienceList ()
static	getMaxContactsPerPacket ()
static	getMinContactsForActivating ()
Открытые статические члены унаследованные от BaseApiObject
static	normalizeListRow (array $row)
static	create ($type, $parameters=null, IService $service=null)

Поля данных
const	TYPE_FACEBOOK = 'facebook'
const	TYPE_VKONTAKTE = 'vkontakte'
const	TYPE_MYCOM = 'mycom'
const	TYPE_YANDEX = 'yandex'
const	TYPE_GOOGLE = 'google'
const	ENUM_CONTACT_TYPE_EMAIL = 'email'
const	ENUM_CONTACT_TYPE_PHONE = 'phone'
const	ENUM_CONTACT_TYPE_IDFA_GAID = 'idfa_gaid'
const	ENUM_CONTACT_TYPE_INTERNAL_ID = 'int'
const	MAX_CONTACTS_PER_PACKET = 100
const	MIN_CONTACTS_FOR_ACTIVATING = 5000
const	URL_AUDIENCE_LIST = ''
Поля данных унаследованные от BaseApiObject
const	TYPE_CODE = ''

Защищенные члены
	normalizeContacts (array $contacts=array())
	addToQueue ($audienceId, $contacts, $options=[], $isRemove=false)
	deleteFromQueue ($audienceId, $contacts)
	importContacts ($audienceId, array $contacts, array $options)
	removeContacts ($audienceId, array $contacts, array $options)

Защищенные данные
	$accountId
	$audienceId
	$isQueueModeEnabled = false
	$isQueueAutoRemove = true
	$queueDaysAutoRemove = 7
	$emptyResponse = null
Защищенные данные унаследованные от BaseApiObject
	$request
	$service

Статические защищенные данные
static	$listRowMap
Статические защищенные данные унаследованные от BaseApiObject
static	$listRowMap = array()

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

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

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

◆ __construct()

__construct ( $accountId = null )

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

Методы

◆ add()

add ( array $data )

abstract

Add.

Аргументы

array $data Data.

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

Переопределяется в AudienceFacebook, AudienceFacebook, AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

◆ addContacts()

addContacts	(		$audienceId,
		array	$contacts,
		array	$options )

Аргументы

	$audienceId
array	$contacts
array	$options

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

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

◆ addToQueue()

addToQueue	(	$audienceId,
		$contacts,
		$options = [],
		$isRemove = false )

protected

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

◆ createLookalike()

createLookalike	(		$sourceAudienceId,
		array	$options )

Переопределяется в AudienceFacebook, AudienceVkads и AudienceYandex.

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

◆ deleteContacts()

deleteContacts	(		$audienceId,
		array	$contacts,
		array	$options )

Аргументы

	$audienceId
array	$contacts
array	$options

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

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

◆ deleteFromQueue()

deleteFromQueue	(		$audienceId,
			$contacts )

protected

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

◆ disableQueueAutoRemove()

disableQueueAutoRemove ( )

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

◆ disableQueueMode()

disableQueueMode ( )

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

◆ enableQueueAutoRemove()

enableQueueAutoRemove ( $daysNumber = null )

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

◆ enableQueueMode()

enableQueueMode ( )

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

◆ getById()

getById ( $itemId )

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

◆ getList()

getList ( )

abstract

Get list.

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

Переопределяется в AudienceFacebook, AudienceFacebook, AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

◆ getLookalikeAudiencesParams()

getLookalikeAudiencesParams ( )

Переопределяется в AudienceFacebook, AudienceVkads, AudienceVkontakte и AudienceYandex.

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

◆ getMaxContactsPerPacket()

getMaxContactsPerPacket ( )

static

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

◆ getMinContactsForActivating()

getMinContactsForActivating ( )

static

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

◆ getUrlAudienceList()

getUrlAudienceList ( )

static

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

◆ importContacts()

importContacts	(		$audienceId,
		array	$contacts,
		array	$options )

abstractprotected

Import contacts.

Аргументы

string	$audienceId	Audience ID.
array	$contacts	Contacts.
array	$options	Options.

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

Переопределяется в AudienceFacebook, AudienceFacebook, AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

◆ isAddingRequireContacts()

isAddingRequireContacts ( )

static

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

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

◆ isQueueModeEnabled()

isQueueModeEnabled ( )

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

◆ isQueueProcessed()

isQueueProcessed ( $parentId )

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

◆ isSupportAccount()

isSupportAccount ( )

static

Переопределяется в AudienceGoogle и AudienceYandex.

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

◆ isSupportAddAudience()

isSupportAddAudience ( )

static

Переопределяется в AudienceFacebook, AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

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

◆ isSupportCreateLookalikeFromSegments()

isSupportCreateLookalikeFromSegments ( )

static

Переопределяется в AudienceVkontakte и AudienceYandex.

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

◆ isSupportMultiTypeContacts()

isSupportMultiTypeContacts ( )

static

Переопределяется в AudienceGoogle и AudienceYandex.

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

◆ isSupportRemoveContacts()

isSupportRemoveContacts ( )

static

Переопределяется в AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

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

◆ normalizeContacts()

normalizeContacts ( array $contacts = array() )

protected

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

◆ normalizeEmail()

normalizeEmail ( $email )

static

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

◆ normalizePhone()

normalizePhone ( $phone )

static

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

◆ removeContacts()

removeContacts	(		$audienceId,
		array	$contacts,
		array	$options )

abstractprotected

Remove contacts.

Аргументы

string	$audienceId	Audience ID.
array	$contacts	Contacts.
array	$options	Options.

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

Переопределяется в AudienceFacebook, AudienceFacebook, AudienceGoogle, AudienceVkads, AudienceVkontakte и AudienceYandex.

◆ setAccountId()

setAccountId ( $accountId )

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

Поля

◆ $accountId

$accountId

protected

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

◆ $audienceId

$audienceId

protected

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

◆ $emptyResponse

$emptyResponse = null

protected

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

◆ $isQueueAutoRemove

$isQueueAutoRemove = true

protected

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

◆ $isQueueModeEnabled

$isQueueModeEnabled = false

protected

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

◆ $listRowMap

$listRowMap

staticprotected

Инициализатор

= [
        'ID' => 'ID',
        'NAME' => 'NAME',
        'COUNT_VALID' => 'COUNT',
        'COUNT_MATCHED' => 'COUNT',
        'SUPPORTED_CONTACT_TYPES' => [
            self::ENUM_CONTACT_TYPE_EMAIL,
            self::ENUM_CONTACT_TYPE_PHONE,
            self::ENUM_CONTACT_TYPE_IDFA_GAID,
            self::ENUM_CONTACT_TYPE_INTERNAL_ID
        ],
    ]

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

◆ $queueDaysAutoRemove

$queueDaysAutoRemove = 7

protected

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

◆ ENUM_CONTACT_TYPE_EMAIL

const ENUM_CONTACT_TYPE_EMAIL = 'email'

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

◆ ENUM_CONTACT_TYPE_IDFA_GAID

const ENUM_CONTACT_TYPE_IDFA_GAID = 'idfa_gaid'

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

◆ ENUM_CONTACT_TYPE_INTERNAL_ID

const ENUM_CONTACT_TYPE_INTERNAL_ID = 'int'

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

◆ ENUM_CONTACT_TYPE_PHONE

const ENUM_CONTACT_TYPE_PHONE = 'phone'

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

◆ MAX_CONTACTS_PER_PACKET

const MAX_CONTACTS_PER_PACKET = 100

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

◆ MIN_CONTACTS_FOR_ACTIVATING

const MIN_CONTACTS_FOR_ACTIVATING = 5000

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

◆ TYPE_FACEBOOK

const TYPE_FACEBOOK = 'facebook'

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

◆ TYPE_GOOGLE

const TYPE_GOOGLE = 'google'

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

◆ TYPE_MYCOM

const TYPE_MYCOM = 'mycom'

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

◆ TYPE_VKONTAKTE

const TYPE_VKONTAKTE = 'vkontakte'

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

◆ TYPE_YANDEX

const TYPE_YANDEX = 'yandex'

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

◆ URL_AUDIENCE_LIST

const URL_AUDIENCE_LIST = ''

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

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/seo/lib/retargeting/audience.php

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

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

Поля данных

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

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

Статические защищенные данные

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

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

◆ __construct()

Методы

◆ add()

◆ addContacts()

◆ addToQueue()

◆ createLookalike()

◆ deleteContacts()

◆ deleteFromQueue()

◆ disableQueueAutoRemove()

◆ disableQueueMode()

◆ enableQueueAutoRemove()

◆ enableQueueMode()

◆ getById()

◆ getList()

◆ getLookalikeAudiencesParams()

◆ getMaxContactsPerPacket()

◆ getMinContactsForActivating()

◆ getUrlAudienceList()

◆ importContacts()

◆ isAddingRequireContacts()

◆ isQueueModeEnabled()

◆ isQueueProcessed()

◆ isSupportAccount()

◆ isSupportAddAudience()

◆ isSupportCreateLookalikeFromSegments()

◆ isSupportMultiTypeContacts()

◆ isSupportRemoveContacts()

◆ normalizeContacts()

◆ normalizeEmail()

◆ normalizePhone()

◆ removeContacts()

◆ setAccountId()

Поля

◆ $accountId

◆ $audienceId

◆ $emptyResponse

◆ $isQueueAutoRemove

◆ $isQueueModeEnabled

◆ $listRowMap

◆ $queueDaysAutoRemove

◆ ENUM_CONTACT_TYPE_EMAIL

◆ ENUM_CONTACT_TYPE_IDFA_GAID

◆ ENUM_CONTACT_TYPE_INTERNAL_ID

◆ ENUM_CONTACT_TYPE_PHONE

◆ MAX_CONTACTS_PER_PACKET

◆ MIN_CONTACTS_FOR_ACTIVATING

◆ TYPE_FACEBOOK

◆ TYPE_GOOGLE

◆ TYPE_MYCOM

◆ TYPE_VKONTAKTE

◆ TYPE_YANDEX

◆ URL_AUDIENCE_LIST