API-Aufrufe

Hier findest du Beispiel für API-Aufrufe an die Anzeigeregel-Engine.

Alle Regeln eines Kontos lesen

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_library

Regel lesen

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Regel aktualisieren

Um eine Spezifikation zu aktualisieren, gib alle Felder an, einschließlich der unveränderten. Im folgenden Beispiel wird der Regel-Trigger so aktualisiert, dass er alle 1.000 Impressionen ausgelöst wird. Für die Aktualisierung des Status einer Regel sind keine Spezifikationsänderungen notwendig.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "trigger" : {
        "type": "STATS_MILESTONE",
        "field": "impressions",
        "value": 1000,
        "operator": "EQUAL"
      },
      "filters": ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

In diesem Beispiel werden die Filter so aktualisiert, dass alle Werbeanzeigen mit mehr als 200 Klicks ausgewählt werden. Andere Filter wie entity_type und time_preset müssen in dieser Aktualisierung weiterhin vorhanden sein.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "filters" : [
       {
         "field": "clicks",
         "value": 200,
         "operator": "GREATER_THAN",
       },
       {
       ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Regel löschen

curl -X DELETE \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Ausführungsverlauf einer Regel aufrufen

Wir bieten einen Endpunkt an, über den du Verlaufsdaten für die Ausführungen jeder Regel abrufen kannst. Standardmäßig gibt dieser Endpunkt relevante Daten wie Ergebnisse und Handlungen zurück. Du kannst auch den Zustand der Regel bei jeder Ausführung prüfen, um Änderungen zu erfassen.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

Zusätzlich unterstützt dieser Endpunkt drei Filtermechanismen für die Daten: object_id, action und hide_no_changes. Du kannst die Ergebnisse nach einer object_id oder einer action filtern, um nur Ergebnisse für diese object_id oder diese action-Art anzuzeigen.

Du kannst die Ergebnisse auch mit dem hide_no_changes-Kennzeichen filtern, um alle Ausführungen auszuschließen, bei denen keine Änderungen stattgefunden haben. Du kannst diese Filter kombinieren, um deine Ergebnisse weiter einzugrenzen.

curl -G   \
-d 'object_id=123' \
-d 'action=CHANGED_BID' \
-d 'hide_no_changes=true' \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

Ausführungsverlauf eines Kontos aufrufen

Wir bieten einen Endpunkt an, mit dem du die gesammelten Verlaufsdaten aller Regeln deines Kontos aufrufen kannst. Standardmäßig gibt dieser Endpunkt dieselben relevanten Daten wie der Ausführungsverlauf der Regel sowie die ID der Regeln für jeden Eintrag zurück.

Dieser Endpunkt zeigt die neuesten Einträge zuerst an. Zusätzlich unterstützt dieser Endpunkt dieselben Filtermechanismen wie oben: object_id, action und hide_no_changes.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_history

Vorschau einer Regel ansehen

Wir bieten einen Endpunkt an, mit dem du eine Vorschau der Prüfung einer zeitplanbasierten Regel anzeigen kannst. Wenn eine POST-Anfrage gesendet wird, gibt dieser Endpunkt eine Liste der Objekte zurück, die zu diesem Zeitpunkt alle angegebenen Filter der Regel erfüllen.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/preview

Regel manuell ausführen

Wir bieten einen Endpunkt an, mit dem du eine zeitplanbasierte Regel manuell ausführen kannst. Wenn eine POST-Anfrage an diesen Endpunkt gesendet wird, wird die Ausführung der Regel sofort geplant.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/execute

Die Ergebnisse können aus dem Ausführungsverlauf abgerufen werden, wenn die Ausführung der Regel abgeschlossen ist.

Geltende Regeln für ein Objekt lesen

Wir bieten Endpunkte zum Lesen aller Regeln an, die für die einzelnen Werbeanzeigen, Anzeigengruppen und Werbekampagnen gelten. Standardmäßig gilt eine Regel für ein Objekt, wenn sie es statisch mit dem id-Filter oder dynamisch mit dem entity_type-Filter referenziert.

Dieser Endpunkt unterstützt auch eine optionale pass_evaluation. Damit kannst du die Liste der Regeln weiter eingrenzen, und zwar danach, ob das Objekt zu diesem Zeitpunkt den Filtern der Regel entspricht. Wenn pass_evaluationtrue ist, werden alle Regeln zurückgegeben, die das Objekt in der Vorschau zurückgeben würden. Bei false werden alle anderen Regeln zurückgegeben.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_OBJECT_ID>/adrules_governed