Erste Schritte mit dem Meta Business SDK

In diesem Dokument wird erläutert, wie das Meta Business SDK installiert und die Installation getestet wird. Es sind SDKs für Java, JavaScript, PHP, Python und Ruby verfügbar. Wenn die Marketing API bereits installiert ist, kannst du auf das Meta Business SDK aktualisieren.

Bevor du beginnst

Du benötigst Zugriff auf Folgendes:

• Ein Meta-Entwicklungskonto
• Eine registrierte Meta-App mit konfigurierten allgemeinen Einstellungen
• Deinen App-Geheimcode
• Ein Werbekonto
• Einen Seiten-Zugriffsschlüssel

Java

Für Java-Apps kannst du eine beliebige Entwicklungsumgebung nutzen. Sie muss jedoch Maven-Builds unterstützen.

SDK installieren

Füge für dein Maven-Projekt den folgenden XML-Code zum Abschnitt dependency der Datei pom.xml hinzu:

<!-- 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>

Java-Klasse erstellen

Erstelle unter src/main/java eine Java-Klasse mit dem Namen TestFBJavaSDK und füge den folgenden Code hinzu. Ersetze {access-token}, {appsecret} und {adaccount-id} durch deine Werte.

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

Installation testen

Gestalte deine App und führe sie aus. Das Ergebnis sollte im Protokollfenster deiner Konsole angezeigt werden. Wenn dort eine Meldung zu einem abgelaufenen Token angezeigt wird, fordere einen neuen Seiten-Zugriffsschlüssel an und versuche es noch einmal.

JavaScript (Node.js)

Für JavaScript-Apps wird das SDK als Node.js-Paket vertrieben.

Öffne ein Terminal-Fenster zum Ausführen von Befehlen und erstelle einen neuen Projektordner. Erstelle, konfiguriere und installiere dein Projekt mit dem folgenden Befehl:

npm init

Du kannst deine Konfigurationseinstellungen später aktualisieren, indem du die Datei package.json direkt bearbeitest.

SDK installieren

Installiere das SDK-Paket mit dem folgenden Befehl:

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

Projektdatei ändern

Öffne die Datei index.js und füge den folgenden Code hinzu. Ersetze {access-token} und {adaccount-id} durch deine Werte.

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);

Installation testen

Teste deine Installation mit dem folgenden Befehl:

 node index.js

Das Ergebnis sollte im Terminal-Fenster angezeigt werden. Wenn dort eine Meldung zu einem abgelaufenen Token angezeigt wird, fordere einen neuen Seiten-Zugriffsschlüssel an und versuche es noch einmal.

PHP

Verwende für PHP-Apps Composer zum Installieren des SDK.

SDK installieren

Erstelle die Datei composer.json mit folgendem Inhalt in einem neuen Projektordner. Ersetze {project-name}, {Your Name} und {your@email.com} durch deine Werte.

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

Installiere das SDK, indem du den folgenden Befehl im Terminal-Fenster ausführst:

composer install

Projektdatei erstellen

Erstelle eine src/test.php-Datei mit folgendem Inhalt. Ersetze {app-id}, {access-token}, {appsecret} und {adaccount-id} durch deine Werte.

<?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;
}

Installation testen

Teste deine Installation mit dem folgenden Befehl:

php src/test.php

Das Ergebnis sollte im Terminal-Fenster angezeigt werden. Wenn dort eine Meldung zu einem abgelaufenen Token angezeigt wird, fordere einen neuen Seiten-Zugriffsschlüssel an und versuche es noch einmal.

Python

Für Python-Apps wird das SDK als pypi-Modul vertrieben. Vergewissere dich daher, dass pip bei dir installiert ist. Je nachdem, welches System du verwendest, musst du eventuell virtualenv, pyenv oder conda einrichten.

SDK installieren

Installiere das SDK mit dem folgenden Befehl.

pip install facebook_business

Projektdatei erstellen

Erstelle die Datei test.py mit folgendem Inhalt. Ersetze {app-id}, {access-token}, {appsecret} und {adaccount-id} durch deine Werte.

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)

Installation testen

Teste deine Installation mit dem folgenden Befehl:

python test.py

Das Ergebnis sollte im Terminal-Fenster angezeigt werden. Wenn dort eine Meldung zu einem abgelaufenen Token angezeigt wird, fordere einen neuen Seiten-Zugriffsschlüssel an und versuche es noch einmal.

Ruby

Für Ruby wird das SDK als RubyGem-Paket vertrieben.

SDK installieren

Führe in einem Terminal-Fenster den folgenden Befehl aus dem Projektordner aus, um das Meta Business SDK für Ruby zu installieren. Je nach Umgebung musst du eventuell rbenv oder rvm einrichten oder sudo verwenden, bevor du den Befehl ausführst.

gem install facebookbusiness

Projektdatei erstellen

Erstelle eine test.rb-Datei mit folgendem Inhalt. Ersetze {access-token}, {appsecret} und {adaccount-id} durch deine Werte.

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

Installation testen

Teste deine Installation mit dem folgenden Befehl:

ruby test.rb

Das Ergebnis sollte im Terminal-Fenster angezeigt werden. Wenn dort eine Meldung zu einem abgelaufenen Token angezeigt wird, fordere einen neuen Seiten-Zugriffsschlüssel an und versuche es noch einmal.

Für Nutzer*innen der aktuellen Marketing API

Führe die folgenden Schritte aus, um von der Marketing API auf das Meta Business SDK zu aktualisieren.

Java

Nimm in der Datei pom.xml die folgenden Änderungen vor:

• Aktualisiere groupId von com.facebook.ads.sdk auf com.facebook.business.sdk.
• Aktualisiere artifactId von facebook-java-ads-sdk auf facebook-java-business-sdk.
• Aktualisiere version auf v8.0.3.

Nodejs

Nimm in der Datei package.json die folgenden Änderungen vor:

• Aktualisiere facebook-nodejs-ads-sdk auf facebook-nodejs-business-sdk:v8.0.2.
• Aktualisiere alle Verweise auf den Paketnamen facebook-nodejs-ads-sdk, z. B. require('facebook-nodejs-ads-sdk'), auf facebook-nodejs-business-sdk.
• Führe npm install aus.

PHP

Nimm in der Datei composer.json die folgenden Änderungen vor:

• Aktualisiere facebook-ads-sdk auf facebook-business-sdk mit Version 8.0.3.

Python

• Führe pip install facebook_business aus.
• Aktualisiere alle Verweise auf den Namespace facebookads auf facebook_business.
• Wenn du über eine .egg-info-Datei verfügst, aktualisiere sie von facebookads-*.egg-info auf die neu installierte egg-info-Datei, z. B. facebook_business-*.egg-info.

Ruby

• Führe gem install facebookbusiness aus.
• Aktualisiere alle Verweise von require('facebook_ads') auf require('facebookbusiness').

Mehr dazu

Sieh dir den Quellcode für das Meta Business SDK auf Github an.