Erste Schritte

Referenzdokumentation

Ein Unternehmen muss mindestens eine Seite, einen Administrator, einen Firmennamen und eine gültige E-Mail-Adresse aufweisen, um Business Manager zu verwenden.

Der Firmenname wird nur für dein Unternehmen und alle weiteren Unternehmen verwendet, mit denen du Objekte teilst. Nach der Erstellung dieses Unternehmens kannst du Seiten, Werbekonten, Apps, externe Conversion Tracking-Objekte und weitere anzeigenbezogene Elemente für das Unternehmen hinzufügen.

Anforderungen

  • Für deine App ist für die Nutzung der Business Manager API eine entsprechende Marketing-API-Zugriffsebene erforderlich. Bitte beachte, dass für deine App unter Umständen erweiterter Zugriff erforderlich sein kann. Weitere Informationen zu verschiedenen Zugriffsebenen.
  • Für deine App ist auch die business_management-Berechtigung erforderlich.
  • Dein*e Nutzer*in benötigt auch die business_management-Berechtigung.

Einen neuen Business Manager erstellen

Erstelle einen neuen Business Manager für dein Unternehmen. Erstelle nur dann einen neuen Business Manager, wenn du einen neuen Business Manager für dich selbst oder deine Kunden einrichtest. Wenn du ein anderes Werbekonto oder Zugriff auf eine andere Seite benötigst, solltest du deinen bestehenden Manager und Elementberechtigungen verwenden. Du kannst einen Business Manager nicht löschen.

Erstelle beispielsweise einen neuen Business Manager mit einer POST-Anfrage:

curl \
  -F "name=Pomni Media" \
  -F "vertical=ADVERTISING" \
  -F "primary_page=<PAGE_ID>" \
  -F "timezone_id=1" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<USER_ID>/businesses"

Anforderungen

Zum Erstellen eines Unternehmens benötigst du:

  • Einen Zugriffsschlüssel
  • Eine Seiten-ID
  • Eine Branche
  • Eine App-spezifische Nutzer-ID

Die angegebene Seiten-ID sollte die primäre Seite deines Unternehmens sein. Diese Seite repräsentiert dein Unternehmen auf Facebook gegenüber der Öffentlichkeit. Der Ersteller des Unternehmens ist immer ein Manager dieser Seite. Wenn du keine Seite hast, die dein Unternehmen auf Facebook repräsentiert, erstelle eine.

Die Branche ist eine der folgenden String-Konstanten:

ADVERTISING , AUTOMOTIVE , CONSUMER_PACKAGED_GOODS , ECOMMERCE , EDUCATION , ENERGY_AND_UTILITIES , ENTERTAINMENT_AND_MEDIA , FINANCIAL_SERVICES , GAMING , GOVERNMENT_AND_POLITICS ,MARKETING , ORGANIZATIONS_AND_ASSOCIATIONS , PROFESSIONAL_SERVICES , RETAIL , TECHNOLOGY , TELECOM , TRAVEL , OTHER

Um Eigenschaften für ein Unternehmen anzuzeigen, verwende dessen ID: Die ID ist Teil der Antwort auf die Anfrage zur Erstellung eines Business Manager:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>?access_token=<ACCESS_TOKEN>"

Du kannst auch eine Liste der Business Manager anzeigen, auf die du Zugriff hast:

curl "https://graph.facebook.com/<API_VERSION>/me/businesses?access_token=<ACCESS_TOKEN>"

Antwortfelder:

Name Beschreibung

name

Typ: String

Name des Unternehmens

timezone_id

Typ: Ganzzahl

ID der Zeitzone des Unternehmens

primary_page

Typ: JSON-Objekt

Das Objekt der primären Seite, die mit diesem Business Manager verknüpft ist.

{ "category": "App page", "name": "Sample Primary Page", "id": "123456789" }

id

Typ: Long

Business Manager-ID

update_time

Typ: String

Letzte Aktualisierungszeit des Business Manager

updated_by

Typ: JSON-Objekt

Name und ID des letzten Nutzers, der diesen Manager aktualisiert hat

creation_time

Typ: String

Erstellungszeit des Unternehmens

created_by

Typ: JSON-Objekt

Name und ID des Nutzers, der diesen Manager erstellt hat

Business Manager aktualisieren

Aktualisiere die Felder im Business Manager über eine POST-Anfrage an https://graph.facebook.com/{API_VERSION}/{BUSINESS_ID}. So änderst du beispielsweise den Namen des Unternehmens:

curl \
-F "name=My Actual Business Name" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Ändere die Branche des Unternehmens mit der folgenden POST-Anfrage:

curl \
-F "vertical=RETAIL" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Du hast die folgenden Möglichkeiten:

Name Beschreibung

name

Erforderlich.

Der Name des Unternehmens

primary_page

Die ID der primären Seite, die mit diesem Business Manager verknüpft ist

Du kannst die primäre Seite mit der folgenden POST-Anfrage aktualisieren. Der Business Manager muss der Eigentümer der primären Seite sein.

curl \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Du kannst auch alle der oben genannten Elemente in einer POST-Anfrage aktualisieren:

curl \
  -F "name=My Actual Business Name" \
  -F "vertical=RETAIL" \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Personen und Rollen verwalten

Es gibt zwei Arten von Rollen im Business Manager:

Name API-Konstante Beschreibung

Admin

ADMIN

  • Kann alle Aspekte des Unternehmens steuern, einschließlich Ändern oder Löschen des Kontos sowie Hinzufügen oder Entfernen von Personen aus der Mitarbeiterliste.
  • Hat READ- und WRITE-Zugriff auf alle Elemente, mit denen der Business Manager verbunden ist.

Mitarbeiter

EMPLOYEE

  • Kann alle Informationen in den Unternehmenseinstellungen sehen und von Unternehmensadministratoren Rollen zugewiesen bekommen. Kann keine Änderungen vornehmen, außer Seiten oder Werbekonten, von denen dieser Nutzer Administrator ist, zum Unternehmen hinzufügen.
  • Hat READ-Zugriff auf alle Elemente, mit denen der Business Manager verbunden ist.

Weitere Informationen zu Rollen findest du unter Katalogrollen in Business Manager einrichten.

Anfänglich ist der Ersteller des Unternehmens der einzige Nutzer im Unternehmen und automatisch auch der Administrator.

Personen einladen

Um Arbeitskollegen zu deinem Unternehmen hinzuzufügen, musst du diese einladen. Gib dazu eine gültige E-Mail-Adresse an, auf die die gewünschte Person Zugriff hat. Du kannst nur begrenzte Anfragen versenden, um Mitarbeiter zu einem Business Manager hinzuzufügen. Wenn du den Grenzwert erreichst, erhältst du den Fehlercode 17. Dann solltest du 24 Stunden warten, bevor du den Vorgang fortsetzt.

Um jemanden als Administrator einzuladen, versende eine POST-Anfrage:

curl \
-F "email=some@email.com" \
-F "role=ADMIN" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Um jemanden als Mitarbeiter einzuladen, versende eine POST-Anfrage:

curl \
-F "email=some@email.com" \
-F "role=EMPLOYEE" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Facebook sendet eine E-Mail-Einladung an die angegebene geschäftliche E-Mail-Adresse. Die eingeladene Person muss die E-Mail lesen und den Registrierungsprozess durchführen. Anschließend wird sie in deiner Nutzerliste angezeigt.

Personen im Business Manager

Ab Version 2.11 bieten wir verschiedene Endpunkte an, um Nutzer basierend auf ihrem Status abzurufen. Tätige eine GET-Anfrage, um die einzelnen Nutzergruppen abzurufen. So rufst du alle Unternehmensnutzer ab (Bitte beachte, dass Erweiterter Zugriff erforderlich ist.):

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users?access_token=<ACCESS_TOKEN>"

So rufst du Systemnutzer mit Systemzugriff ab:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/system_users?access_token=<ACCESS_TOKEN>"

So rufst du ausstehende Nutzer ab, die zu einem Unternehmen eingeladen wurden, die Einladung aber noch nicht angenommen haben:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/pending_users?access_token=<ACCESS_TOKEN>"

Die Endpunkte geben entweder aktive, ausstehende oder Systemnutzer für dein Unternehmen zurück. Beispiel:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "name": "Alpha MK",
      "email": "some@email.com",
      "role": "EMPLOYEE",
    }
  ]
}

Die Ergebnisse für ausstehende Nutzer sehen wie folgt aus:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "email": "some@email.com",
      "role": "EMPLOYEE",
      "status": "PENDING",
      "owner": {
        "id": "USER_ID",
        "name": "Generic Emporium"
      }
    }
  ]
}

Definitionen für zurückgegebene Felder:

Name Beschreibung

id

Typ: Long

Unternehmensspezifische ID dieses Nutzers.

name

Typ: String

Name dieses Nutzers unter diesem Unternehmen

business

Typ: JSON-Objekt

Business Manager, zu dem dieser Nutzer gehört

first_name

Typ: String

Vorname dieses Nutzers unter diesem Unternehmen

last_name

Typ: String

Nachname dieses Nutzers unter diesem Unternehmen

title

Typ: String

Titel dieses Nutzers unter diesem Unternehmen

role

Typ: String

Die Rolle, die diese Person für dieses Unternehmen hat. EMPLOYEE oder ADMIN

email

Typ: String

E-Mail-Adresse des Nutzers

Rollen ändern

Um die Rolle eines aktiven Nutzers in deinem Unternehmen zu ändern, gib die jeweilige Nutzer-ID an. Du kannst beispielsweise mit dieser POST-Anfrage einen Mitarbeiter zu einem Administrator hochstufen:

curl \
  -F "role=ADMIN" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Um einen Administrator zu einem Mitarbeiter zu machen, tätige eine POST-Anfrage:

curl \
  -F "role=EMPLOYEE" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Du kannst die Rolle für einen ausstehenden Nutzer mit dieser POST-Anfrage ändern:

curl \
  -F "role=EMPLOYEE" \
    -F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Benutzer entfernen

Entferne Berechtigungen, die jemandem basierend auf der Mitgliedschaft unter deinen Business Managern erteilt wurden. Schränke den Zugriff auf Werbekonten und Seiten ein. Wenn der Nutzer Zugriff auf Werbekonten oder Seiten außerhalb deines Business Manager hat, werden diese Berechtigungen dadurch nicht geändert. Jemand kann sich beispielsweise selbst hinzugefügt oder Zugriff über einen anderen Business Manager haben

Tätige einen DELETE-Aufruf, um einen aktiven Nutzer aus deinem Unternehmen zu entfernen:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

So brichst du einen ausstehenden Nutzer mit einer DELETE-Anfrage ab:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Dadurch werden die Nutzer*innen von deinem Unternehmen und der Zugriff auf deine Business-Assets entfernt.

Business-Assets verwalten

Referenzdokumentation

Business-Assets sind die Facebook-Objekte (wie Seiten, Apps usw.), die ein* Administrator*in verwaltet. Ein*e Administrator*in kann ein*e Nutzer*in oder ein Unternehmen oder im Falle von Apps ein*e Entwickler*in oder Werbetreibende*r sein. Arten von Business-Assets:

  • Seiten
  • Konten
  • Apps
  • Kataloge
  • Facebook-Pixel

Unter Business-Assets findest du eine Beispielanfrage und weitere Informationen.

Rechnungen

Referenzdokumentation

Mit der Business Manager API kannst du Kreditquellen, die mit einem Unternehmen verknüpft sind, anzeigen und verwalten. Die API wiederholt die Versuche für alle Rechnungen, die für einen Business Manager sichtbar sind. Dies bedeutet, dass alle Rechnungen, für die dieser Business Manager verantwortlich ist, über die API einsehbar sind, und nicht nur die Rechnungen für eine individuelle Unternehmens-ID.

Normale Kreditlinie im Besitz des Business Manager

Für die Marketing API-Partner mit aktivierter Rechnungsstellung kannst du die normale Kreditlinie des Business Manager nutzen.

Facebook-Marketingpartner (FBMP) müssen sich an ihre Vertriebsmitarbeiter wenden, um Kredite für den Business Manager einzurichten. Achte darauf, nach der normalen Kreditlinie des Business Manager zu fragen. Nach dem Setup kannst du die Ad Account Creation API verwenden, um Werbekonten zu erstellen. Gebühren werden mit deiner Kreditlinie im Business Manager abgerechnet.

Für die mit der folgenden API erstellten Werbekonten verteilen wir den Kredit dynamisch auf Konten. Außerdem aktualisieren wir Kreditlimits und Ausgaben, damit die Kreditlimits nicht erreicht werden. Darüber hinaus kannst du den summierten verfügbaren Kredit und den Kreditbetrag für jedes Werbekonto anzeigen.

Derzeit unterstützen wir nur normale Haftung. Folgehaftung wird nicht unterstützt. Der Setup-Prozess bleibt gleich.

Rechnung am Monatsende

Wenn deine Kreditlinie für ein Unternehmen eingerichtet wurde und das Unternehmen damit Werbeanzeigen schaltet, generieren wir am Monatsende Rechnungen für das Unternehmenskonto. Zum Anzeigen der Rechnungen des Unternehmens benötigst du eine Finanzrolle. Für normale Administratoren und Mitarbeiter eines Unternehmens kannst du im Business Manager unter People Berechtigungen zuweisen. Du kannst auch Systemnutzern, die Business Manager verwenden, Finanzierungsberechtigungen zuweisen.

Sende eine GET Anfrage, um Rechnungen unter einem Unternehmenskonto mit der API abzurufen:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?start_date=2017-01-01&end_date=2017-04-01"

Beispielergebnisse sehen wie folgt aus:

{
  "business_invoices": {
    "data": [
      {
        "id": "1659175694099710",
        "billing_period": "2017-03-01"
      },
      {
        "id": "1303851778395619",
        "billing_period": "2017-01-01"
      },
      {
        "id": "1415846861611329",
        "billing_period": "2017-02-01"
      }
    ],
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "249554531892085"
}

Du kannst Rechnungsdetails auf Kampagnenebene mit der folgenden Anfrage abrufen:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?fields=billed_amount_details,billing_period,entity,id,invoice_id,payment_term,type,campaigns&start_date=2019-06-01&end_date=2019-07-01"

Die Antwort sieht in etwa wie folgt aus:

{
  "business_invoices": {
    "data": [
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "387.70",
          "tax_amount": "0.00",
          "total_amount": "387.70"
        },
        "billing_period": "2017-03-01",
        "entity": "FBUS",
        "id": "1659175694099710",
        "invoice_id": "22736800",
        "liability_type": "Normal",
        "invoice_type": "Invoice",
        "payment_term": "CUSTOMER",
        "type": "Invoice",
        "campaigns": {
          "data": [
            {
              "campaign_id": "6056967798500",
              "campaign_name": "Nhận ưu đãi",
              "tags": [
                "hello2"
              ],
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "207.62",
                "tax_amount": "0.00",
                "total_amount": "207.62"
              }
            },
            {
              "campaign_id": "6056958052500",
              "campaign_name": "Nhận ưu đãi",
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "180.08",
                "tax_amount": "0.00",
                "total_amount": "180.08"
              }
              "impressions": 100,
              "clicks": 50,
              "conversions": 30
            }
          ]
        }
      },
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "382.99",
          "tax_amount": "0.00",
          "total_amount": "382.99"
        },
        ......
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "1515766328651000"
}

Außerdem kannst du zusätzliche Rechnungsfelder abrufen:

  • invoice_date: Datum, an dem Facebook die Rechnung erstellt hat
  • due_date: Fälligkeitsdatum der Rechnung
  • payment_status: gibt an, ob die Rechnung Paid, Unpaid oder Partially Paid ist
  • amount_due: gibt an, welcher Betrag derzeit für die Rechnung fällig und ausstehend ist
  • download_uri: unter dieser URI kannst du eine PDF der Rechnung herunterladen

Funding Source API

Sende diese GET-Anfrage, um die mit einem Business Manager verknüpfte Finanzierungsquelle für einen erweiterten Kredit abzurufen.

curl "https://www.graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/extendedcredits"

Zum Einrichten einer Finanzierungsquelle für ein Unternehmen gehst du im Business Manager zu den Einstellungen für dein Unternehmen.

Dynamische Gutschriftenzuordnung

Die dynamische Gutschriftenzuordnung (Dynamic Credit Allocation, DCAF) ist unser Gutschriftenzuordnungssystem für die regelmäßige Anpassung der verfügbaren Gutschriften pro Werbekonto. Unser automatisiertes Skript wird ungefähr alle 30 Minuten ausgeführt und verteilt dein verfügbares Guthaben gleichmäßig auf alle aktiven Konten, die für DCAF aktiviert sind. Das verfügbare Guthaben umfasst die insgesamt genehmigte Gutschrift minus insgesamt ausstehende Beträge. So kannst du Ausgaben auf Werbekontoebene managen und die Mittel für jedes Werbekonto zuteilen.

Ein Unternehmen kann ein fakturiertes Werbekonto auch „deaktivieren“ und von der Liste der Werbekonten, denen Guthaben zugeteilt werden muss, entfernen. Dieser Status muss jetzt nicht mehr von Facebook verwaltet werden.