Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс AudienceYandex
+ Граф наследования:AudienceYandex:

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

 add (array $data)
 
 importContacts ($audienceId, array $contacts, array $options)
 
 removeContacts ($audienceId, array $contacts, array $options)
 
 getList ()
 
 getLookalikeAudiencesParams ()
 
 createLookalike ($sourceAudienceId, array $options)
 
- Открытые члены унаследованные от 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)
 
 isQueueProcessed ($parentId)
 
- Открытые члены унаследованные от BaseApiObject
 __construct ()
 
 getRequest ()
 
 setRequest (Request $request)
 
 setService (IService $service)
 

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

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

Открытые атрибуты

const TYPE_CODE = 'yandex'
 
const MAX_CONTACTS_PER_PACKET = 0
 
const MIN_CONTACTS_FOR_ACTIVATING = 1000
 
const URL_AUDIENCE_LIST = 'https://audience.yandex.ru/'
 
const NEW_AUDIENCE_FAKE_ID = -1
 
const UPDATE_AUDIENCE_TIMEOUT = 60
 
- Открытые атрибуты унаследованные от 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=array(), $hashed=false, $type='')
 
 addNewAudienceValue ($data)
 
- Защищенные члены унаследованные от Audience
 normalizeContacts (array $contacts=array())
 
 addToQueue ($audienceId, $contacts, $options=[], $isRemove=false)
 
 deleteFromQueue ($audienceId, $contacts)
 

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

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

Дополнительные унаследованные члены

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

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

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

Методы

◆ add()

add ( array $data)
Аргументы
array$dataData.
Возвращает
\Bitrix\Seo\Retargeting\Response
Исключения
NotImplementedException

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

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

◆ addNewAudienceValue()

addNewAudienceValue ( $data)
protected

"New audience" value in audiences list

Аргументы
array$dataAudiences list.
Возвращает
array

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

◆ createLookalike()

createLookalike ( $sourceAudienceId,
array $options )
Аргументы
$sourceAudienceId
array$options
Возвращает
Response
Исключения

Bitrix\Main\SystemException

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

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

◆ getList()

getList ( )

Audiences list

Возвращает
\Bitrix\Seo\Retargeting\Response
Исключения

Bitrix\Main\SystemException

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

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

◆ getLookalikeAudiencesParams()

getLookalikeAudiencesParams ( )
Возвращает
array

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

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

◆ importContacts()

importContacts ( $audienceId,
array $contacts,
array $options )
Аргументы
string$audienceIdAudience id.
array$contactsContacts.
array$optionsOptions.
Возвращает
Result|\Bitrix\Seo\Retargeting\Response
Исключения

Bitrix\Main\SystemException

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

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

◆ isAddingRequireContacts()

static isAddingRequireContacts ( )
static

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

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

◆ isSupportAccount()

static isSupportAccount ( )
static

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

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

◆ isSupportAddAudience()

static isSupportAddAudience ( )
static

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

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

◆ isSupportCreateLookalikeFromSegments()

static isSupportCreateLookalikeFromSegments ( )
static

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

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

◆ isSupportMultiTypeContacts()

static isSupportMultiTypeContacts ( )
static

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

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

◆ isSupportRemoveContacts()

static isSupportRemoveContacts ( )
static

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

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

◆ normalizeListRow()

static normalizeListRow ( array $row)
static

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

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

◆ prepareContacts()

prepareContacts ( array $contacts = array(),
$hashed = false,
$type = '' )
protected

Create contacts list in proper format.

Аргументы
array$contactsContacts.
bool$hashedShould result be hashed.
string$typeType (email|phone).
Возвращает
string

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

◆ removeContacts()

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

Remove contacts from audience

Аргументы
string$audienceIdAudience id.
array$contactsContacts.
array$optionsOptions.
Возвращает
\Bitrix\Seo\Retargeting\Response|null

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

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

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

◆ $listRowMap

$listRowMap
staticprotected
Инициализатор
= array(
'ID' => 'ID',
'NAME' => 'NAME',
'COUNT_VALID' => 'VALID_UNIQUE_QUANTITY',
'COUNT_MATCHED' => 'MATCHED_QUANTITY',
'HASHED' => 'HASHED',
'STATUS' => 'STATUS',
'SUPPORTED_CONTACT_TYPES' => array(
self::ENUM_CONTACT_TYPE_PHONE,
self::ENUM_CONTACT_TYPE_EMAIL
),
)

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

◆ MAX_CONTACTS_PER_PACKET

const MAX_CONTACTS_PER_PACKET = 0

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

◆ MIN_CONTACTS_FOR_ACTIVATING

const MIN_CONTACTS_FOR_ACTIVATING = 1000

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

◆ NEW_AUDIENCE_FAKE_ID

const NEW_AUDIENCE_FAKE_ID = -1

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

◆ TYPE_CODE

const TYPE_CODE = 'yandex'

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

◆ UPDATE_AUDIENCE_TIMEOUT

const UPDATE_AUDIENCE_TIMEOUT = 60

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

◆ URL_AUDIENCE_LIST

const URL_AUDIENCE_LIST = 'https://audience.yandex.ru/'

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