adsaudience.php

См. документацию.

<?php
 
namespace Bitrix\Seo\Retargeting;
 
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Loader;
use Bitrix\Seo\Retargeting\Audience\Status\AudienceStatusNormalizerFactory;

class AdsAudience
{
    protected static $errors = array();

    protected static $isQueueUsed = false;

    public static function canUse()
    {
        return Loader::includeModule('seo') && Loader::includeModule('socialservices');
    }

    public static function useQueue()
    {
        self::$isQueueUsed = true;
    }

    public static function getService()
    {
        return Service::getInstance();
    }

    public static function addAudience($type, $accountId = null, $name = null)
    {
        $audience = Service::getAudience($type);
        if (!$audience)
        {
            return null;
        }
 
        if (!$name)
        {
            self::$errors[] = Loc::getMessage("SEO_RETARGETING_EMPTY_AUDIENCE_NAME");
            return null;
        }
        $audience->setAccountId($accountId);
        $parameters = array(
            'NAME' => $name
        );
        $addResult = $audience->add($parameters);
        if ($addResult->isSuccess() && $addResult->getId())
        {
            return $addResult->getId();
        }
        else
        {
            self::$errors = $addResult->getErrorMessages();
            return null;
        }
    }
 
    public static function addLookalikeAudience($type, $accountId = null, $sourceAudienceId = null, $options = [])
    {
        $audience = Service::getAudience($type);
        if (!$audience)
        {
            return null;
        }
        $audience->setAccountId($accountId);
        $addResult = $audience->createLookalike($sourceAudienceId, $options);
        if ($addResult->isSuccess() && $addResult->getId())
        {
            return $addResult->getId();
        }
        else
        {
            self::$errors = $addResult->getErrorMessages();
            return null;
        }
    }

    public static function getAudiences($type, $accountId = null): array
    {
        $result = array();
 
        $audience = Service::getAudience($type);
 
        $audience->setAccountId($accountId);
        $audiencesResult = $audience->getList();
        if ($audiencesResult->isSuccess())
        {
            while ($audienceData = $audiencesResult->fetch())
            {
                $audienceData = $audience->normalizeListRow($audienceData);
                if ($audienceData['ID'])
                {
                    $result[] = array(
                        'id' => $audienceData['ID'],
                        'isSupportMultiTypeContacts' => $audience->isSupportMultiTypeContacts(),
                        //'isAddingRequireContacts' => $audience->isAddingRequireContacts(),
                        'supportedContactTypes' => $audienceData['SUPPORTED_CONTACT_TYPES'],
                        'status' => $audienceData['STATUS'] ?? '',
                        'name' =>
                            $audienceData['NAME']
                                ?
                                $audienceData['NAME'] . (
                                $audienceData['COUNT_VALID'] > 0 ?
                                    ' (' . $audienceData['COUNT_VALID'] . ')'
                                    :
                                    ''
                                )
                                :
                                $audienceData['ID']
                    );
                }
            }
        }
        else
        {
            self::$errors = $audiencesResult->getErrorMessages();
        }
 
        return $result;
    }
 
    public static function getAudienceWithNormalizedStatus($type, string $messageCode, $accountId = null): array
    {
        $audiences = static::getAudiences($type, $accountId);
 
        $audienceService = Service::getAudience($type);
        $audienceStatusNormalizer = AudienceStatusNormalizerFactory::build($audienceService::TYPE_CODE, $messageCode);
 
        foreach ($audiences as &$audience)
        {
            $audienceStatus = $audience['status'];
 
            $audience['normalizedStatus'] = $audienceStatusNormalizer->getNormalizedStatus($audienceStatus);
            $audience['normalizedStatusMessage'] = $audienceStatusNormalizer->getNormalizedStatusTranslation($audienceStatus);
            $audience['isEnabled'] = $audienceStatusNormalizer->isEnabled($audienceStatus);
        }
 
        return $audiences;
    }
 
    public static function getRegions($type)
    {
        $account = Service::getAccount($type);
        if (!$account)
        {
            return [];
        }
 
        return $account->getRegionsList();
    }

    public static function getProviders(array $types = null)
    {
        $providers = static::getServiceProviders($types);
        foreach ($providers as $type => $provider)
        {
            $audience = Service::getAudience($type);
            $providers[$type]['URL_AUDIENCE_LIST'] =  $audience->getUrlAudienceList();
            $providers[$type]['IS_SUPPORT_ACCOUNT'] =  $audience->isSupportAccount();
            $providers[$type]['IS_SUPPORT_REMOVE_CONTACTS'] =  $audience->isSupportRemoveContacts();
            //$providers[$type]['IS_ADDING_REQUIRE_CONTACTS'] =  $audience->isAddingRequireContacts();
            $providers[$type]['IS_SUPPORT_MULTI_TYPE_CONTACTS'] =  $audience->isSupportMultiTypeContacts();
            $providers[$type]['IS_SUPPORT_ADD_AUDIENCE'] =  $audience->isSupportAddAudience();
            $lookalikeAudienceParams = $audience->getLookalikeAudiencesParams();
            $providers[$type]['IS_SUPPORT_LOOKALIKE_AUDIENCE'] =  !!$lookalikeAudienceParams;
            $providers[$type]['LOOKALIKE_AUDIENCE_PARAMS'] = $lookalikeAudienceParams;
            $providers[$type]['IS_SUPPORT_CREATE_LOOKALIKE_FROM_SEGMENTS'] = $audience::isSupportCreateLookalikeFromSegments();
        }
 
        return $providers;
    }

    public static function addToAudience(AdsAudienceConfig $config, $contacts)
    {
        static $audiences = array();
        if (!isset($audiences[$config->type]))
        {
            if ($config->clientId)
            {
                $service = static::getService();
                $service->setClientId($config->clientId);
            }
            $audience = Service::getAudience($config->type);
            $audiences[$config->type] = $audience;
        }
        else
        {
            $audience = $audiences[$config->type];
        }
 
        $audience->setAccountId($config->accountId);
        static::$isQueueUsed ? $audience->enableQueueMode() : $audience->disableQueueMode();
        if ($config->autoRemoveDayNumber)
        {
            $audience->enableQueueAutoRemove($config->autoRemoveDayNumber);
        }
        else
        {
            $audience->disableQueueAutoRemove();
        }
 
        $audienceImportResult = $audience->addContacts(
            $config->audienceId,
            $contacts,
            array(
                'type' => $config->contactType,
                'parentId' => $config->parentId
            )
        );
 
        self::$errors = $audienceImportResult->getErrorMessages();
        return $audienceImportResult->isSuccess();
    }

    public static function getErrors()
    {
        return self::$errors;
    }

    public static function resetErrors()
    {
        self::$errors = array();
    }

    public static function hasErrors()
    {
        return count(self::$errors) > 0;
    }

    public static function removeAuth($type)
    {
        static::getService()->getAuthAdapter($type)->removeAuth();
    }

    public static function getServiceTypes()
    {
        if (!static::canUse())
        {
            return array();
        }
 
        return static::getService()->getTypes();
    }

    protected static function getServiceProviders(array $types = null)
    {
        $typeList = static::getServiceTypes();
 
        $providers = array();
        foreach ($typeList as $type)
        {
            if ($types && !in_array($type, $types))
            {
                continue;
            }
 
            $service = static::getService();
            $authAdapter = $service->getAuthAdapter($type);
            $account = $service->getAccount($type);
            $canUserMultiClients = $authAdapter->canUseMultipleClients();
 
            $providers[$type] = array(
                'TYPE' => $type,
                'HAS_AUTH' => $authAdapter->hasAuth(),
                'AUTH_URL' => $authAdapter->getAuthUrl(),
                'PROFILE' => $authAdapter->getToken() ? $account->getProfileCached() : false,
                'ENGINE_CODE' => $service::getEngineCode($type)
            );
            if ($canUserMultiClients)
            {
                $providers[$type]['CLIENTS'] = static::getClientsProfiles($authAdapter);
                if (empty($providers[$type]['CLIENTS']))
                {
                    $providers[$type]['HAS_AUTH'] = false;
                }
            }
 
            // check if no profile, then may be auth was removed in service
            if ($providers[$type]['HAS_AUTH'] && empty($providers[$type]['PROFILE']))
            {
                static::removeAuth($type);
                if (!$canUserMultiClients)
                {
                    $providers[$type]['HAS_AUTH'] = false;
                }
            }
        }
 
        return $providers;
    }

    protected static function getClientsProfiles(AuthAdapter $authAdapter)
    {
        $type = $authAdapter->getType();
        return array_values(array_filter(array_map(function ($item) use ($type) {
            $service = new Service();
            $service->setClientId($item['proxy_client_id']);
 
            $authAdapter = Service::getAuthAdapter($type);
            $authAdapter->setService($service);
 
            $account = Service::getAccount($type);
            $account->setService($service);
            $account->getRequest()->setAuthAdapter($authAdapter);
 
            $profile = $account->getProfileCached();
            if ($profile)
            {
                return $profile;
            }
            else
            {
                // if no profile, then may be auth was removed in service
                $authAdapter->removeAuth();
            }
        }, $authAdapter->getAuthorizedClientsList())));
    }

    public static function getAccounts($type)
    {
        if (!static::canUse())
        {
            return array();
        }
 
        $result = array();
 
        $account = static::getService()->getAccount($type);
        $accountsResult = $account->getList();
        if ($accountsResult->isSuccess())
        {
            while ($accountData = $accountsResult->fetch())
            {
                $accountData = $account->normalizeListRow($accountData);
                if ($accountData['ID'])
                {
                    $result[] = array(
                        'id' => $accountData['ID'],
                        'name' => $accountData['NAME'] ? $accountData['NAME'] : $accountData['ID']
                    );
                }
            }
        }
        else
        {
            self::$errors = $accountsResult->getErrorMessages();
        }
 
        return $result;
    }
}