Planauswertung

Grundanfrage

Um eine detaillierte Planauswertung zu erhalten, muss ein Plan an die API geschickt werden. In seiner einfachsten Form besteht ein Plan lediglich aus der Belegung eines Mediums:

{
    "plan": {
        "placements": [
            {
                "frequency": 1,
                "medium":
                    {
                        "type": "M",
                        "key": "SBAS"
                    }
            }
        ]
    }
}

frequency gibt an, wie häufig ein Medium belegt werden soll.

Medien in der Anfrage

Insbesondere wenn es mehrere Belegungen eines Mediums gibt und dieses damit mehrfach in der Anfrage auftaucht, bietet es sich an, eine alternative Anfragestruktur zu verwenden. Dabei werden alle verwendeten Medien unter media aufgelistet und dann über den jeweiligen Array-Index referenziert:

{
    "plan": {
        "media": [
            {
                "type": "M",
                "key": "SBAS"
            }
        ],
        "placements": [
            {
                "frequency": 1,
                "medium": 0
            }
        ]
    }
}

In weiteren Beispielen wird einheitlich diese Strukur verwendet.

Ergebnis einer Planberechnung

Der grundlegende Typ in der Rückgabe ist PlanResult. Er taucht auf verschiedenen Ebenen immer unter der Eigenschaft result auf.

Gesamtplan

Auf der obersten Ebene ist das Ergebnis der Planberechnung für den gesamten Plan zu finden:

  {
      "result": {
          "cpm": {
              "amount": 10.82,
              "currency": "€"
          },
          "cases": 3694.3701,
          "rawCases": 4044.67,
          "total": 8149,
          "contacts": 8597097.63175,
          "percent": 12.265098,
          "projection": 8597097.631751,
          "share": 100,
          "index": 100,
          "grp": 12.265098,
          "ots": 1,
          "contactsShare": 100,
          "grpIndex": 100,
          "prefilter": {
              "cases": 30121,
              "projection": 70093999.993653
          },
          "audience": {
              "cases": 30121,
              "projection": 70093999.993653
          },
          "structure": {
              "cases": 3694.3701,
              "projection": 8597097.631751,
              "contacts": 8597097.63175
          },
          "tariff": {
              "gross": {
                  "amount": 93000,
                  "currency": "€"
              },
              "net": {
                  "amount": 93000,
                  "currency": "€"
              },
              // ...
          }
          // ...
      },
  // ...

Mit diesem Plan erreicht man voraussichtlich 8597097.63175 Kontakte (contacts) bei 12,26 % der Grundgesamtheit (percent). In diesem Fall entspricht das ebenfalls der Anzahl der erreichten Personen (projection), da jede Person einen Kontakt hat (ots).

Medientyp-Gruppen

Medien in einem Plan werden automatisch nach Medientyp gruppiert. Die Ergebnisse für diese Gruppen befinden sich unter groupDetails:

"groupDetails": [{
    "groupType": "Zeitschrift",
    "title": "Magazines",
    "result": {
        // ...
        }
    },

Medien

In der Eigenschaft media werden die einzelnen Medien des Medientyps der Gruppe aufgelistet. Auch sie bieten ein result, in dem die Ergebnisse für das gesamte Medium verzeichnet sind. Hier wird also gezeigt, wie gut und zu welchen Kosten man mit diesem Medium die Zielgruppe erreicht:

"media": [{
    "result": {
        // ...
        }
    },

Belegungen

Auf der untersten Ebene des Planergebnisses befinden sich die einzelnen Belegungen zu den Medien:

            "placements": [{
                "frequency": 1,
                "result": {
                    // ...
                }
            }]
        }]
    }]
}

Discounts