Laravel Facebook Ads

Usage

Follow this steps to use this package on your Laravel installation

1. Require it on composer

composer require edbizarro/laravel-facebook-ads

2. Load service provider

You need to update your config/app.php configuration file to register our service provider, adding this line on providers array:

Edbizarro\LaravelFacebookAds\Providers\LaravelFacebookServiceProvider::class

3. Enable the facade (optional)

This package comes with an facade to make the usage easier. To enable it, add this line at config/app.php on alias array:

'FacebookAds' => Edbizarro\LaravelFacebookAds\Facades\FacebookAds::class

Configuration

If you want to change any configurations, you need to publish the package configuration file. To do this, run php artisan vendor:publish on terminal. This will publish a facebook-ads.php file on your configuration folder like this:

<?php
return [
    'app_id' => env('FB_ADS_APP_ID'),
    'app_secret' => env('FB_ADS_APP_SECRET'),
];

Note that this file uses environment variables, it's a good practice put your secret keys on your .env file adding this lines on it:

FB_ADS_APP_ID="YOUR_APP_ID"
FB_ADS_APP_SECRET="YOUR_APP_SECRET_KEY"

First steps

Now that everything is set up, it's easy to start using!

This package is divided in services to make easy to acess things. At this moment, we just have the adAccounts and insights services.

Before using it, it's necessary to initialize the library with an valid access token, php example.

<?php
/** Your controller */
namespace App\Http\Controllers;

use Edbizarro\LaravelFacebookAds\FacebookAds;

class ExampleController extends Controller
{
    public function __construct(FacebookAds $ads)
    {
        $adsApi = $ads->init($accessToken);
        //
    }
    //
}

adAccounts

To obtain an adAccounts instance:

$adAccounts = $adsApi->adAccounts();

all

Use this method to retrieve your owned Ad Accounts. This methods accepts an array as argument containing a list of fields.

To obtain a list of all available fields, look at this.

$adAccounts->all(['account_id', 'balance', 'name']);

getAds

Use this method to retrieve an account ads. This method requires an account_id and a list of fields to be retrieved.

To obtain a list of all available fields, look at this.

$adAccounts->getAds('account_XXXX', ['name', 'adset_id', 'targeting']);

Insights

To obtain an insights instance:

$insights = $adsApi->insights();

get

Use this method to retrieve insights of a Campaign, AdSet, AdAccount or Ad. This methods requires an type which may be ad_account, ad, ad_set or campaign, a objectId and accepts an array as argument containing a list of fields.

To obtain a list of all available fields, look at this.

$adAccountInsights  = $insights->get('ad_account', 'act_xxxxxx', ['date_start', 'date_stop', 'ad_name']]);

$adSetInsights      = $insights->get('ad_set', 'xxxxxx', ['date_start', 'date_stop', 'ad_name']]);

$adInsights         = $insights->get('ad', 'xxxxxx', ['date_start', 'date_stop', 'ad_name']]);

$campaignInsights   = $insights->get('campaign', 'xxxxxx', ['date_start', 'date_stop', 'ad_name']]);