setono/meta-conversions-api-bundle

Work with the Meta / Facebook Conversions API in your Symfony application

v0.1.3 2022-08-18 11:07 UTC

Requires

• php: >=7.4
• composer-runtime-api: ^2
• composer/semver: ^3.0
• setono/bot-detection-bundle: ^1.7
• setono/meta-conversions-api-php-sdk: ^0.2.1
• symfony/config: ^5.4 || ^6.0
• symfony/dependency-injection: ^5.4 || ^6.0
• symfony/event-dispatcher: ^5.4 || ^6.0
• symfony/event-dispatcher-contracts: ^1.1 || ^2.5 || ^3.1
• symfony/http-foundation: ^5.4 || ^6.0
• symfony/http-kernel: ^5.4 || ^6.0
• symfony/messenger: ^5.4 || ^6.0
• symfony/monolog-bundle: ^2.12 || ^3.8
• webmozart/assert: ^1.11

Requires (Dev)

• matthiasnoback/symfony-dependency-injection-test: ^4.3
• nyholm/symfony-bundle-test: ^2.0
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.5
• psalm/plugin-phpunit: ^0.17
• psalm/plugin-symfony: ^3.1
• roave/security-advisories: dev-latest
• setono/code-quality-pack: ^2.2.1
• setono/consent-bundle: ^0.1.4
• setono/tag-bag: ^2.0
• setono/tag-bag-bundle: ^3.0
• symfony/twig-bundle: ^5.4 || ^6.0

MIT

• Joachim Løvgaard

README

Work with the Meta / Facebook Conversions API in your Symfony application. Under the hood this bundle integrates the Meta Conversions API PHP SDK library.

Installation

To install this bundle, simply run:

composer require setono/meta-conversions-api-bundle

This also installs the Bot Detection Bundle which is used to filter bot requests.

If you want to handle consent (i.e. cookie/GDPR consent), you can use the consent bundle, by installing it:

composer require setono/consent-bundle

Usage

<?php

declare(strict_types=1);

use Psr\EventDispatcher\EventDispatcherInterface;
use Setono\MetaConversionsApi\Event\Event;
use Setono\MetaConversionsApiBundle\Event\ConversionsApiEventRaised;

final class YourService
{
    private EventDispatcherInterface $eventDispatcher;

    public function __construct(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    public function track(): void
    {
        $event = new Event(Event::EVENT_VIEW_CONTENT);
        $event->customData->contentType = 'product';
        $event->customData->contentName = 'Blue Jeans';
        $event->customData->contentIds[] = 'PRODUCT_SKU';

        $this->eventDispatcher->dispatch(new ConversionsApiEventRaised($event));
    }
}

Test the integration

To test the integration you can set the test event code (that you can retrieve from Meta / Facebooks event manager) and append it to any url on your website like so: https://example.com/?_testEventCode=[YOUR TEST EVENT CODE] or https://example.com/?_test_event_code=[YOUR TEST EVENT CODE]. This code is saved in a session and hence all your subsequent requests will be sent with the test event code.