Premiers pas avec le SDK Meta Business

Ce document explique comment installer le SDK Meta Business et tester son installation. Des SDK sont disponibles pour Java, JavaScript, PHP, Python et Ruby. Si vous avez déjà installé l’API Marketing, découvrez comment mettre à jour le SDK Meta Business.

Avant de commencer

Vous devrez avoir accès aux éléments suivants :

Un compte de développeur Meta
Une application Meta enregistrée dont les paramètres de base sont configurés
Votre clé secrète
Un compte publicitaire
Un token d’accès de Page

Java

Pour les applications Java, vous pouvez utiliser l’environnement de développement de votre choix, à condition qu’il prenne en charge les builds Maven.

Installer le SDK

Dans votre projet Maven, ajoutez le code XML suivant à la section dependency de votre fichier pom.xml :

<!-- https://mvnrepository.com/artifact/com.facebook.business.sdk/facebook-java-business-sdk -->
<dependency>
    <groupId>com.facebook.business.sdk</groupId>
    <artifactId>facebook-java-business-sdk</artifactId> 
    <version>[8.0.3,)</version>
</dependency>

Créer une classe Java

Sous src/main/java, créez une classe Java nommée TestFBJavaSDK et ajoutez le code suivant. Veillez à remplacer {access-token}, {appsecret} et {adaccount-id} par vos valeurs.

import com.facebook.ads.sdk.APIContext;
import com.facebook.ads.sdk.APINodeList;
import com.facebook.ads.sdk.AdAccount;
import com.facebook.ads.sdk.Campaign;

public class TestFBJavaSDK
{
    public static final APIContext context = new APIContext(
            "{access-token}",
            "{appsecret}"
    );
    public static void main(String[] args)
    {
        AdAccount account = new AdAccount("act_{{adaccount-id}}", context);
        try {
            APINodeList<Campaign> campaigns = account.getCampaigns().requestAllFields().execute();
            for(Campaign campaign : campaigns) {
                System.out.println(campaign.getFieldName());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }}

Tester votre installation

Créez un build de votre application et exécutez-la. Vous devriez voir le résultat dans la fenêtre de journalisation de votre console. Si elle signale un token expiré, demandez un nouveau token d’accès de Page, puis réessayez.

JavaScript (Node.js)

Pour les applications JavaScript, le SDK est distribué sous la forme d’un package Node.js.

Ouvrez une fenêtre de terminal et créez un nouveau dossier de projet. Créez, configurez et installez votre projet avec la commande suivante :

npm init

Vous pourrez mettre à jour vos paramètres de configuration plus tard en modifiant le fichier package.json directement.

Installer le SDK

Installez le package du SDK avec la commande suivante :

npm install --save facebook-nodejs-business-sdk

Modifier le fichier du projet

Ouvrez le fichier index.js et ajoutez le code suivant. Remplacez {access-token} et {adaccount-id} par vos valeurs.

const bizSdk = require('facebook-nodejs-business-sdk');

const accessToken = '{access-token}';
const accountId = 'act_{{adaccount-id}}';

const FacebookAdsApi = bizSdk.FacebookAdsApi.init(accessToken);
const AdAccount = bizSdk.AdAccount;
const Campaign = bizSdk.Campaign;

const account = new AdAccount(accountId);
var campaigns;
    
account.read([AdAccount.Fields.name])
  .then((account) =>{
    return account.getCampaigns([Campaign.Fields.name], { limit: 10 }) // fields array and params
  })
  .then((result) =>{
    campaigns = result
    campaigns.forEach((campaign) =>console.log(campaign.name))  
  }).catch(console.error);

Tester votre installation

Testez votre installation avec la commande suivante :

 node index.js

Vous devriez voir le résultat dans votre fenêtre de terminal. Si elle signale un token expiré, demandez un nouveau token d’accès de Page, puis réessayez.

PHP

Pour les applications PHP, installez le SDK avec Composer.

Installer le SDK

Dans un nouveau dossier de projet, créez le fichier composer.json avec le contenu suivant. Remplacez {project-name}, {Your Name} et {your@email.com} par vos valeurs.

{
    "name": "name/{project-name}",
    "type": "project",
    "require": {
        "facebook/php-business-sdk": "^8.0.3"
    },
    "authors": [
        {
            "name": "{Your Name}",
            "email": "{your@email.com}"
        }
    ]
}

Installez le SDK en exécutant la commande suivante dans votre fenêtre de terminal :

composer install

Créer un fichier de projet

Créez un fichier src/test.php avec le contenu suivant. Remplacez {app-id}, {access-token}, {appsecret} et {adaccount-id} par vos valeurs.

<?php
require_once __DIR__ . '/../vendor/autoload.php';
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;
use FacebookAds\Object\AdAccount;
use FacebookAds\Object\Campaign;
use FacebookAds\Object\Fields\CampaignFields;

$app_id = "{app-id}";
$app_secret = "{appsecret}";
$access_token = "{access-token}";
$account_id = "act_{{adaccount-id}}";

Api::init($app_id, $app_secret, $access_token);

$account = new AdAccount($account_id);
$cursor = $account->getCampaigns();

// Loop over objects
foreach ($cursor as $campaign) {
  echo $campaign->{CampaignFields::NAME}.PHP_EOL;
}

Tester votre installation

Testez votre installation avec la commande suivante :

php src/test.php

Vous devriez voir le résultat dans votre fenêtre de terminal. Si elle signale un token expiré, demandez un nouveau token d’accès de Page, puis réessayez.

Python

Pour les applications Python, le SDK est distribué sous la forme d’un module pypi, alors assurez-vous que pip est installé. En fonction de votre système, vous devrez configurer virtualenv, pyenv ou conda.

Installer le SDK

Installez le SDK avec la commande suivante.

pip install facebook_business

Créer un fichier de projet

Créez le fichier test.py avec le contenu suivant. Remplacez {app-id}, {access-token}, {appsecret} et {adaccount-id} par vos valeurs.

from facebook_business.api import FacebookAdsApi
from facebook_business.adobjects.adaccount import AdAccount

my_app_id = '{app-id}'
my_app_secret = '{appsecret}'
my_access_token = '{access-token}'
FacebookAdsApi.init(my_app_id, my_app_secret, my_access_token)
my_account = AdAccount('act_{{adaccount-id}}')
campaigns = my_account.get_campaigns()
print(campaigns)

Tester votre installation

Testez votre installation avec la commande suivante :

python test.py

Vous devriez voir le résultat dans votre fenêtre de terminal. Si elle signale un token expiré, demandez un nouveau token d’accès de Page, puis réessayez.

Ruby

Pour Ruby, le SDK est distribué sous la forme d’un package RubyGem.

Installer le SDK

Dans une fenêtre de terminal, exécutez la commande suivante à partir du dossier de votre projet afin d’installer le SDK Meta Business pour Ruby. En fonction de votre environnement, vous devrez configurer rbenv ou rvm, ou utiliser sudo avant la commande.

gem install facebookbusiness

Créer un fichier de projet

Créez un fichier test.rb avec le contenu suivant. Remplacez {access-token}, {appsecret} et {adaccount-id} par vos valeurs.

require 'facebookbusiness'
FacebookAds.configure do |config|
  config.access_token = '{access-token}'
  config.app_secret = '{appsecret}'
end

ad_account = FacebookAds::AdAccount.get('act_{{adaccount-id}}', 'name')
ad_account.campaigns(fields: 'name').each do |campaign|
  puts campaign.name
end

Tester votre installation

Testez votre installation avec la commande suivante :

ruby test.rb

Vous devriez voir le résultat dans votre fenêtre de terminal. Si elle signale un token expiré, demandez un nouveau token d’accès de Page, puis réessayez.

Pour les utilisateurs actuels de l'API Marketing

Pour mettre à jour le SDK Meta Business à partir de l’API Marketing, procédez comme suit.

Java

Dans le fichier pom.xml :

Pour groupId, remplacez com.facebook.ads.sdk par com.facebook.business.sdk
Pour artifactId, remplacez facebook-java-ads-sdk par facebook-java-business-sdk
Définissez version sur v8.0.3.

NodeJS

Dans le fichier package.json :

Définissez facebook-nodejs-ads-sdk sur facebook-nodejs-business-sdk:v8.0.2.
Remplacez toutes les références au nom de package facebook-nodejs-ads-sdk (par exemple, require('facebook-nodejs-ads-sdk')) par facebook-nodejs-business-sdk.
Exécutez npm install.

PHP

Dans le fichier composer.json :

Définissez facebook-ads-sdk sur facebook-business-sdk avec la version 8.0.3.

Python

Exécutez pip install facebook_business.
Remplacez toutes les références à l’espace de noms facebookads par facebook_business.
Si vous avez un fichier .egg-info (tel que facebookads-*.egg-info), remplacez-le par le fichier egg-info nouvellement installé (tel que facebook_business-*.egg-info).

Ruby

Exécutez gem install facebookbusiness.
Remplacez toutes les références à require('facebook_ads') par require('facebookbusiness').

En savoir plus

Consultez le code source du SDK Meta Business sur GitHub.