Класс AdsAudience

Открытые статические члены
static	canUse ()
static	useQueue ()
static	getService ()
static	addAudience ($type, $accountId=null, $name=null)
static	addLookalikeAudience ($type, $accountId=null, $sourceAudienceId=null, $options=[])
static	getAudiences ($type, $accountId=null)
static	getAudienceWithNormalizedStatus ($type, string $messageCode, $accountId=null)
static	getRegions ($type)
static	getProviders (array $types=null)
static	addToAudience (AdsAudienceConfig $config, $contacts)
static	getErrors ()
static	resetErrors ()
static	hasErrors ()
static	removeAuth ($type)
static	getServiceTypes ()
static	getAccounts ($type)

Защищенные статические члены
static	getServiceProviders (array $types=null)
static	getClientsProfiles (AuthAdapter $authAdapter)

Статические защищенные данные
static	$errors = array()
static	$isQueueUsed = false

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

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

Методы

addAudience()

addAudience ( $type, $accountId = null, $name = null )

static

Add audience.

Аргументы

string	$type	Type.
integer | null	$accountId	Account ID.
string | null	$name	Name.

Возвращает

integer|null

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

addLookalikeAudience()

addLookalikeAudience ( $type, $accountId = null, $sourceAudienceId = null, $options = [] )

static

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

addToAudience()

addToAudience ( AdsAudienceConfig $config, $contacts )

static

Add to audience

Аргументы

AdsAudienceConfig	$config	Config.
array	$contacts	Contacts.

Возвращает

bool

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

canUse()

canUse ( )

static

Return true if it can use.

Возвращает

bool

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

getAccounts()

getAccounts ( $type )

static

Get accounts.

Аргументы

string

$type

Type.

Возвращает

array

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

getAudiences()

getAudiences ( $type, $accountId = null )

static

Get audiences.

Аргументы

string	$type	Type.
integer | null	$accountId	Account ID.

Возвращает

array<array{ id: int, isSupportMultiTypeContacts: bool, supportedContactTypes: ?array<string>, status: string, name: string }>

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

getAudienceWithNormalizedStatus()

getAudienceWithNormalizedStatus ( $type, string $messageCode, $accountId = null )

static

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

getClientsProfiles()

getClientsProfiles ( AuthAdapter $authAdapter )

staticprotected

Get client profiles.

Аргументы

AuthAdapter

$authAdapter

Auth adapter.

Возвращает

array

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

getErrors()

getErrors ( )

static

Get errors.

Возвращает

array

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

getProviders()

getProviders ( array $types = null )

static

Get providers.

Аргументы

array | null

$types

Types.

Возвращает

array

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

getRegions()

getRegions ( $type )

static

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

getService()

getService ( )

static

Get service.

Возвращает

Service

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

getServiceProviders()

getServiceProviders ( array $types = null )

staticprotected

Get providers list

Аргументы

array | null

$types

Provider types.

Возвращает

array

Исключения

Bitrix\Main\SystemException

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

getServiceTypes()

getServiceTypes ( )

static

Get service types.

Возвращает

array

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

hasErrors()

hasErrors ( )

static

Return true if it has errors.

Возвращает

bool

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

removeAuth()

removeAuth ( $type )

static

Remove auth.

Аргументы

string

$type

Type.

Возвращает

void

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

resetErrors()

resetErrors ( )

static

Reset errors.

Возвращает

void

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

useQueue()

useQueue ( )

static

Use queue.

Возвращает

void

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

Поля

$errors

$errors = array()

staticprotected

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

$isQueueUsed

$isQueueUsed = false

staticprotected

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

---

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

• C:/bitrix/modules/seo/lib/retargeting/adsaudience.php