Класс AudienceVkontakte

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

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

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

Открытые атрибуты
const	TYPE_CODE = 'vkontakte'
const	MAX_CONTACTS_PER_PACKET = 1000
const	MIN_CONTACTS_FOR_ACTIVATING = 20
const	URL_AUDIENCE_LIST = 'https://ads.vk.com/hq/audience/user_lists'
const	ENUM_CONTACT_TYPE_IDFA_GAID = 'gaid'
const	ENUM_CONTACT_TYPE_INTERNAL_ID = 'vk'
Открытые атрибуты унаследованные от Audience
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 = ''

Защищенные члены
	prepareContacts (array $contacts=[])
	addLookalikeAudienceAgent ($audienceRequestId, $audienceSize)
	getLookalikeAudienceAgentName ($audienceRequestId, $audienceSize)
Защищенные члены унаследованные от Audience
	normalizeContacts (array $contacts=array())
	addToQueue ($audienceId, $contacts, $options=[], $isRemove=false)
	deleteFromQueue ($audienceId, $contacts)

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

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

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

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

Методы

add()

add

(

array

$data

)

Add.

Аргументы

array

$data

Data.

Возвращает

Response

Переопределяет метод предка Audience.

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

addLookalikeAudienceAgent()

addLookalikeAudienceAgent ( $audienceRequestId, $audienceSize )

protected

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

getList()

getList

(

)

Get list.

Возвращает

Response

Переопределяет метод предка Audience.

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

getLookalikeAudienceAgentName()

getLookalikeAudienceAgentName ( $audienceRequestId, $audienceSize )

protected

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

getLookalikeAudiencesParams()

getLookalikeAudiencesParams

(

)

Переопределяет метод предка Audience.

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

importContacts()

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

Import contacts.

Аргументы

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

Возвращает

Response

Переопределяет метод предка Audience.

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

isSupportAddAudience()

static isSupportAddAudience ( )

static

Переопределяет метод предка Audience.

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

isSupportCreateLookalikeFromSegments()

static isSupportCreateLookalikeFromSegments ( )

static

Переопределяет метод предка Audience.

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

isSupportRemoveContacts()

static isSupportRemoveContacts ( )

static

Переопределяет метод предка Audience.

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

prepareContacts()

prepareContacts ( array $contacts = [] )

protected

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

processLookalikeAudienceAgent()

static processLookalikeAudienceAgent ( $clientId, $accountId, $audienceRequestId, $audienceSize )

static

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

removeContacts()

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

Remove contacts.

Аргументы

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

Возвращает

Response

Переопределяет метод предка Audience.

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

Данные класса

$listRowMap

$listRowMap

staticprotected

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

= [
        'ID' => 'ID',
        'NAME' => 'NAME',
        'COUNT_VALID' => 'AUDIENCE_COUNT',
        'COUNT_MATCHED' => 'AUDIENCE_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
        ],
    ]

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

ENUM_CONTACT_TYPE_IDFA_GAID

const ENUM_CONTACT_TYPE_IDFA_GAID = 'gaid'

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

ENUM_CONTACT_TYPE_INTERNAL_ID

const ENUM_CONTACT_TYPE_INTERNAL_ID = 'vk'

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

MAX_CONTACTS_PER_PACKET

const MAX_CONTACTS_PER_PACKET = 1000

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

MIN_CONTACTS_FOR_ACTIVATING

const MIN_CONTACTS_FOR_ACTIVATING = 20

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

TYPE_CODE

const TYPE_CODE = 'vkontakte'

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

URL_AUDIENCE_LIST

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

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

USER_LIST_TYPE_HUMAN

const USER_LIST_TYPE_HUMAN = 'human'

protected

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