Add Facebook Ads

Author: leocavalcante

bin/etl.php

@@ -4,13 +4,18 @@
 
 use AdsWarehouse\ETL\AdWords;
 use AdsWarehouse\ETL\ETL;
+use AdsWarehouse\ETL\FacebookAds;
+use FacebookAds\Api;
+use FacebookAds\Logger\CurlLogger;
 use Google_Client;
 use Google_Service_Analytics;
 use Google_Service_AnalyticsReporting;
 use Monolog\Handler\ErrorLogHandler;
 use PDO;
 use Siler\Monolog as Log;
 
+date_default_timezone_set(getenv('TZ'));
+
 $basedir = dirname(__DIR__, 1);
 require_once "$basedir/vendor/autoload.php";
 
@@ -26,9 +31,15 @@
 $google_client->setScopes([Google_Service_Analytics::ANALYTICS_READONLY]);
 
 $analytics = new Google_Service_AnalyticsReporting($google_client);
+$api = Api::init(getenv('FB_APP_ID'), getenv('FB_APP_SECRET'), getenv('FB_ACCESS_TOKEN'));
+
+if (getenv('APP_DEBUG') === 'true') {
+    $api->setLogger(new CurlLogger());
+}
 
 $elt = [
     new AdWords($warehouse, $analytics, getenv('GA_VIEW_ID')),
+    new FacebookAds($warehouse, $api, getenv('FB_AD_ACCOUNT_ID')),
 ];
 
 array_walk($elt, function (ETL $etl): void {

composer.json

@@ -1,15 +1,17 @@
 {
     "name": "multisolution/ads-warehouse",
-    "description": "Data warehouse for multi-data-source ads campaings.",
+    "description": "Data warehouse for multi-data-source ads campaigns.",
     "type": "project",
     "require": {
         "ext-pdo": "*",
+        "ext-json": "*",
         "leocavalcante/siler": "dev-master",
         "monolog/monolog": "^2.0",
         "firebase/php-jwt": "^5.0",
         "webonyx/graphql-php": "^0.13.8",
         "google/apiclient": "^2.4",
-        "ramsey/uuid": "^3.8"
+        "ramsey/uuid": "^3.8",
+        "facebook/php-business-sdk": "^5.0"
     },
     "require-dev": {
         "swoole/ide-helper": "^4.4",
@@ -28,7 +30,10 @@
             "AdsWarehouse\\": [
                 "src/"
             ]
-        }
+        },
+        "files": [
+            "src/helpers.php"
+        ]
     },
     "scripts": {
         "etl": "docker-compose exec -T server php bin/etl.php"

composer.lock

@@ -1,29 +1,37 @@
 version: '3'
 services:
-  postgres:
-    container_name: ads_warehouse_postgres
-    image: postgres:alpine
-    env_file: ./.env
-    ports:
-      - "${DOCKER_POSTGRES_PORT}:5432"
+    postgres:
+        container_name: ads_warehouse_postgres
+        image: postgres:alpine
+        env_file: ./.env
+        ports:
+            - "${DOCKER_POSTGRES_PORT}:5432"
 
-  flyway:
-    container_name: ads_warehouse_flyway
-    image: flyway/flyway:latest-alpine
-    command: migrate
-    env_file: ./.env
-    volumes:
-      - ./src:/flyway/sql
-    depends_on:
-      - postgres
+    flyway:
+        container_name: ads_warehouse_flyway
+        image: flyway/flyway:latest-alpine
+        command: migrate
+        env_file: ./.env
+        volumes:
+            - ./src:/flyway/sql
+        depends_on:
+            - postgres
 
-  server:
-    container_name: ads_warehouse_server
-    image: leocavalcante/dwoole:dev
-    ports:
-      - "${DOCKER_HTTP_PORT}:8000"
-    volumes:
-      - ./:/app
-    env_file: ./.env
-    environment:
-      ENTRY_POINT_FILE: /app/bin/server.php
+    server:
+        container_name: ads_warehouse_server
+        image: leocavalcante/dwoole:dev
+        ports:
+            - "${DOCKER_HTTP_PORT}:8000"
+        volumes:
+            - ./:/app
+        env_file: ./.env
+        environment:
+            ENTRY_POINT_FILE: /app/bin/server.php
+
+    metabase:
+        container_name: ads_warehouse_metabase
+        image: metabase/metabase
+        ports:
+            - "${DOCKER_METABASE_PORT}:3000"
+        links:
+            - postgres

docker-compose.yml

@@ -0,0 +1,81 @@
+<?php declare(strict_types=1);
+
+namespace AdsWarehouse\ETL;
+
+use AdsWarehouse\Ad\Ad;
+use AdsWarehouse\Warehouse\Warehouse;
+use FacebookAds\Api;
+use FacebookAds\Object\AdAccount;
+use FacebookAds\Object\AdsInsights;
+use FacebookAds\Object\Values\AdsInsightsDatePresetValues;
+use Ramsey\Uuid\Uuid;
+use function AdsWarehouse\yesterday;
+
+class FacebookAds extends ETL
+{
+    const SOURCE = 'Facebook';
+
+    /** @var Api */
+    private $api;
+    /** @var string */
+    private $adAccountId;
+
+    public function __construct(Warehouse $warehouse, Api $api, string $adAccountId)
+    {
+        parent::__construct($warehouse);
+        $this->api = $api;
+        $this->adAccountId = $adAccountId;
+    }
+
+    protected function extract()
+    {
+        $fields = [
+            'impressions',
+            'spend',
+            'cpm',
+            'ctr',
+            'clicks',
+            'cpc',
+            'campaign_name',
+        ];
+
+        $params = [
+            'level' => 'campaign',
+            'date_preset' => AdsInsightsDatePresetValues::YESTERDAY,
+        ];
+
+        $ad_account = new AdAccount($this->adAccountId);
+
+        return $ad_account->getInsights($fields, $params)->getArrayCopy();
+    }
+
+    /**
+     * @param AdsInsights[] $data
+     * @return Ad[]
+     */
+    protected function transform($data): array
+    {
+        return array_map(function (AdsInsights $insights): Ad {
+            $data = $insights->getData();
+
+            $ad = new Ad();
+            $ad->id = Uuid::uuid4();
+            $ad->name = $data['campaign_name'];
+            $ad->cost = $data['spend'];
+            $ad->impressions = $data['impressions'];
+            $ad->clicks = $data['clicks'];
+            $ad->cpm = $data['cpm'];
+            $ad->cpc = $data['cpc'];
+            $ad->ctr = $data['ctr'];
+            $ad->source = $this->getSource();
+            $ad->date = yesterday();
+
+            return $ad;
+        }, $data);
+    }
+
+    protected function getSource(): string
+    {
+        return self::SOURCE;
+    }
+}

src/ETL/FacebookAds.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace AdsWarehouse;
+
+use DateTime;
+
+function yesterday(): DateTime
+{
+    return (new DateTime())->modify('-1 day');
+}