setono/meta-conversions-api-bundle

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

dev-master 2022-07-27 12:17 UTC

Requires

• php: >=7.4
• 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

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
• setono/consent-bundle: ^0.1
• setono/tag-bag: ^2.0@alpha
• setono/tag-bag-bundle: ^3.0@alpha

MIT

• Joachim Løvgaard

README

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

Installation

To install this bundle, simply run:

composer require setono/meta-conversions-api-bundle

This will install the bundle and enable it if you're using Symfony Flex. If you're not using Flex, add the bundle manually to bundles.php instead.

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\ConversionApiEventRaised;

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 ConversionApiEventRaised($event));
    }
}