Promopult\TikTokMarketingApi\Service\Tools

Complexity

Total Complexity

5

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	osVersion()	0	8	1
A	carrier()	0	7	1
A	interestCategory()	0	12	1
A	actionCategory()	0	7	1
A	language()	0	7	1

<?php

declare(strict_types=1);

namespace Promopult\TikTokMarketingApi\Service;

final class Tools extends \Promopult\TikTokMarketingApi\AbstractService
{
    /**
     * Getting Language enumeration values.
     *
     * @param int $advertiserId     # Advertiser ID
     *
     * @return array
     *
     * @throws \Throwable
     */
    public function language(int $advertiserId): array
    {
        return $this->requestApi(
            'GET',
            '/open_api/v1.1/tools/language/',
            [
                'advertiser_id' => $advertiserId
            ]
        );
    }

    /**
     * Getting Behavior Category enumeration values.
     *
     * @param int $advertiserId     # Advertiser ID
     *
     * @return array
     *
     * @throws \Throwable
     */
    public function actionCategory(int $advertiserId): array
    {
        return $this->requestApi(
            'GET',
            '/open_api/v1.1/tools/action_category/',
            [
                'advertiser_id' => $advertiserId
            ]
        );
    }

    /**
     * Geting Carriers enumeration values.
     *
     * @param int $advertiserId     # Advertiser ID
     * @return array
     * @throws \Throwable
     */
    public function carrier(int $advertiserId): array
    {
        return $this->requestApi(
            'GET',
            '/open_api/v1.1/tools/carrier/',
            [
                'advertiser_id' => $advertiserId
            ]
        );
    }

    /**
     * Getting OS Version enumeration values.
     *
     * @param int $advertiserId     # Advertiser ID
     * @param string $osType        # OStype, optional values include: ANDROID,IOS
     * @return array
     * @throws \Throwable
     */
    public function osVersion(int $advertiserId, string $osType): array
    {
        return $this->requestApi(
            'GET',
            '/open_api/v1.1/tools/os_version/',
            [
                'advertiser_id' => $advertiserId,
                'os_type' => $osType
            ]
        );
    }

    /**
     * @param int $advertiserId     # Advertiser ID
     * @param ?int $version          # Version of interest category，optional values include:
     *                                1 (interest_category), 2 (interest_category_v2). Default: 2.
     * @param ?array $placement
     * @return array
     * @throws \Throwable
     */
    public function interestCategory(
        int $advertiserId,
        ?int $version = null,
        ?array $placement = null
    ): array {
        return $this->requestApi(
            'GET',
            '/open_api/v1.1/tools/interest_category/',
            [
                'advertiser_id' => $advertiserId,
                'version' => $version,
                'placement' => $placement
            ]
        );
    }
}