edbizarro/laravel-facebook-ads

适用于 Laravel 5.6+ 的 Facebook & Instagram 广告

v0.14.2 2019-06-04 12:08 UTC

README

logo

Laravel Facebook Ads

从 Facebook & Instagram Ads API 获取广告信息(活动、广告、洞察等...)

  • 支持的 Facebook API 版本:>= v3.0

Packagist Code Climate Codacy Badge StyleCI Packagist

安装

按照以下步骤在您的 Laravel 安装上使用此包

使用 composer 安装

composer require edbizarro/laravel-facebook-ads

该包将自动注册其服务提供者。

对于 Laravel <= 5.4,请手动添加提供者

加载服务提供者(可选 Laravel <= 5.4)

您需要更新您的 config/app.php 配置文件以注册我们的服务提供者,在 providers 数组中添加此行

Edbizarro\LaravelFacebookAds\Providers\LaravelFacebookServiceProvider::class

启用外观(可选)

此包附带了一个外观,可以使使用更加简单。要启用它,在 config/app.php 中的 alias 数组中添加此行

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

配置

如果您想更改任何配置,您需要发布包配置文件。要这样做,请在终端中运行 artisan vendor:publish --provider="Edbizarro\LaravelFacebookAds\Providers\LaravelFacebookServiceProvider"。这将发布一个 facebook-ads.php 文件到您的配置文件夹,如下所示

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

注意,此文件使用环境变量,将您的密钥放在 .env 文件中是一种好习惯,向其中添加以下行

FB_ADS_APP_ID="YOUR_APP_ID"
FB_ADS_APP_SECRET="YOUR_APP_SECRET_KEY"

第一步

在使用之前,您需要使用有效的 访问令牌 初始化库,php 示例

FacebookAds::init($accessToken);

现在一切就绪,开始使用非常简单!

示例:获取所有广告

$ads = FacebookAds::adAccounts()->all()->map(function ($adAccount) {
  return $adAccount->ads(
      [
          'name',
          'account_id',
          'account_status',
          'balance',
          'campaign',
          'campaign_id',
          'status'
      ]
  );
});

用法

要获取所有 AdAccount 可用字段的列表,请查看

adAccounts

要获取一个 adAccounts 实例

$adAccounts = $adsApi->adAccounts();

all

使用此方法检索您的广告账户。此方法接受一个数组作为参数,其中包含字段列表。

要获取所有可用字段的列表,请查看

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

get

使用此方法获取 AdAccount 的详细信息。此方法接受一个数组作为参数,其中包含字段列表和一个 account_id act_<AD_ACCOUNT_ID>

要获取所有可用字段的列表,请查看

$adAccounts->get(['account_id', 'balance', 'name'], 'act_<AD_ACCOUNT_ID>');

活动

要获取一个 Campaigns 实例

$campaigns = $adsApi->campaigns();

all

使用此方法检索您的广告账户活动。此方法接受一个数组作为参数,其中包含字段列表和一个 account_id act_<AD_ACCOUNT_ID>

要获取所有可用字段的列表,请查看

$campaigns->all(['name'], 'act_<AD_ACCOUNT_ID>');

许可

FOSSA Status