Promopult\TikTokMarketingApi\Service\Pages

Complexity

Total Complexity

1

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	get()	0	20	1

<?php

declare(strict_types=1);

namespace Promopult\TikTokMarketingApi\Service;

/**
 * @psalm-suppress UnusedClass
 */
final class Pages extends \Promopult\TikTokMarketingApi\AbstractService
{
    /**
     * After an instant page is created, you can get the page ID and then use it in your lead ads or collection ads.
     *
     * @param int $advertiserId         Advertiser ID
     * @param ?string $status           Form status, optional values: EDITED, PUBLISHED
     * @param ?string $title            Instant Form title, will filter the form that **contains** the words in the
     *                                  title.
     * @param ?array $updateTimeRange   Filter for Instant Forms updated in time range.
     *                                  ['start' => (unix timestamp), 'end' => (unix timestamp)]
     * @param ?string $businessType     Instant page type，optional values:
     *                                  LEAD_GEN(InstantForm), STORE_FRONT(Storefront Page). Default: LEAD_GEN
     * @param ?int $page                Current number of pages, default: 1, range: ≥ 1
     * @param ?int $pageSize            Pagination size, default: 10, range: 1-100
     * @return array
     *
     * @throws \Throwable
     *
     * @see https://ads.tiktok.com/marketing_api/docs?id=1701890945985537
     */
    public function get(
        int $advertiserId,
        ?string $status = null,
        ?string $title = null,
        ?array $updateTimeRange = null,
        ?string $businessType = null,
        ?int $page = null,
        ?int $pageSize = null
    ): array {
        return $this->requestApi(
            'GET',
            '/open_api/v1.3/page/get/',
            [
                'advertiser_id' => $advertiserId,
                'page' => $page,
                'page_size' => $pageSize,
                'status' => $status,
                'title' => $title,
                'update_time_range' => $updateTimeRange,
                'business_type' => $businessType
            ]
        );
    }
}