README

Requirements

PHP 7.4 and later.

Installation

composer require be-lenka/tiktok-php-sdk

Usage

$tiktok = new \Belenka\TikTok\TikTok($token, $pixelId);

// Set user info
$user = new \Belenka\TikTok\Models\User();
$user->setUserAgent($_SERVER['HTTP_USER_AGENT'])
     ->setIpAddress($_SERVER['REMOTE_ADDR'])
     ->setEmails(['test@example.com']) // optional
     ->setPhones(['+421901123456']) // optional
     ->setClickId($_REQUEST['ttclid']) // if available
     ->setCookieId($_COOKIE['ttp'])
     ->setExternalIds(['user-id-in-your-system']) // optional
;

// Set page info
$page = new \Belenka\TikTok\Models\Page();
$page->setUrl('https://example.com')
     ->setReferrer('https://example.com') // optional
;

// Set products
$contents = [];
$orderItems = []; // your order items list
foreach($orderItems as $item) {
     $contents[] = (new \Belenka\TikTok\Models\Content)
          ->setPrice($item->price)
          ->setQuantity($item->quantity)
          ->setContentId($item->product_id)
          ->setContentName($item->item_title)
     ;
}

$properties = new \Belenka\TikTok\Models\Property();
$properties->setCurrency('USD')
     ->setQuery('COUPON_CODE')
     ->setValue(100.99)
     ->setOrderId('order_id')
     ->setContents($contents)
;

// Set CompletePayment event
$eventA = new \Belenka\TikTok\Models\Event();
$eventA->setEventName(\Belenka\TikTok\Enums\EventName::COMPLETE_PAYMENT)
     ->setEventTime(time())
     ->setEventId($order->uuid)
     ->setUser($user)
     ->setPage($page)
     ->setProperties($properties)
;

// Set PlaceAnOrder event
$eventB = new \Belenka\TikTok\Models\Event();
$eventB->setEventName(\Belenka\TikTok\Enums\EventName::PLACE_AN_ORDER)
     ->setEventTime(time())
     ->setEventId($order->uuid)
     ->setUser($user)
     ->setPage($page)
     ->setProperties($properties)
;

Start event request

$eventRequest = $tiktok->events()
     ->setEventSource(\Belenka\TikTok\Enums\EventSource::WEB)
     ->setTestEventCode($testCode) // optional
;

Sending a single event

try {
     $eventRequest->execute($eventA);
     if ($eventRequest->isSuccessful()) {
          echo "Result: Success";
     }

     echo "Response:";
     $responseBody = $eventRequest->getResponseBody();
     // ...
} catch (\Exception $e) {
    echo "Error: " . $e->getMessage();
}

Batching multiple events in a single payload

Warning

You can report up to 1000 objects in one request. If a request contains more than 1000 events, the entire request will be rejected.

$eventRequest->execute([$eventA, $eventB]);

Note

To optimize campaign performance, it's highly recommended to send the event in real-time (without batching) as soon as it is seen on the advertiser's server.

be-lenka / tiktok-php-sdk

Maintainers

Details