Globale Statistiken API
Dieser Abschnitt beschreibt die Anfrageparameter und Ergebnisdaten der Global Statistics API.
Die Routen der Statistik-API wurden umbenannt:
/statistics/advertiser/...->/statistics/a/.../statistics/publisher/...->/statistics/p/...
Die Global Statistics API zeigt übersprungene RTB-Abfragen nur für Datum, Sites, Zonen, Länder, Regionen und Sub-IDs an.
count
Nur die Gesamtsumme der Ergebnisse zurückgeben.
Ganzzahl
optional
detailliert
Falls möglich, mehr Details abrufen.
Ganzzahl
optional
Zeitzone
Zeitzoneneinstellung für den Filter 'hour' und 'group_by'
Zeichenfolge
optional
Gesamtsummen
Gibt an, ob Gesamtsummen zur Antwort hinzugefügt werden sollen oder nicht.
Ganzzahl
optional
Filter
Filter zur Einschränkung der zurückgegebenen Werte einer Statistikanfrage
Objekt
optional
group_by
Eine Liste von group_by-Werten, die in den Daten angewendet werden sollen. Maximal vier sind erlaubt.
Array
erforderlich
order_by
Sortierung der Ergebnisse nach einem bestimmten Feld bzw. bestimmten Feldern. Maximal zwei sind erlaubt.
Array
optional
Projektion
Einzelne Unterstrukturen, die ein Benutzer in der Antwort zurückerhalten möchte.
Array
optional
limit
Die Anzahl der Datensätze, die in dieser Antwort zurückgegeben werden sollen.
Ganzzahl
optional
offset
Die Position, ab der die Datensätze abgerufen werden sollen.
Ganzzahl
optional
Parameter „count“
Eigenschaft
count
Typ
optional
Variablentyp
Ganzzahl
Standardwert
0
Verfügbare Werte
[0, 1]
Beschreibung
Nur die Gesamtsumme der Ergebnisse zurückgeben.
Beispiel:
Parameter „detailed“
Eigenschaft
detailliert
Typ
optional
Variablentyp
Ganzzahl
Standardwert
0
Verfügbare Werte
[0, 1]
Beschreibung
Ob detaillierte Informationen zurückgegeben werden sollen oder nicht.
Beispiel:
Parameter „timezone“
Zeitzoneneinstellung für hour Filter und group_by.
Eigenschaft
Zeitzone
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
America/New_york
Verfügbare Werte
Zeitzonenfeld von /collections/timezones festlegen
Beschreibung
HINWEIS: Zeitzonen sind nur relevant, wenn wir anhand stündlicher Daten abfragen; für nicht stündliche Daten ist dies ohne Wirkung.
Beispiel:
Parameter „totals“
Eigenschaft
Gesamtsummen
Typ
optional
Variablentyp
Ganzzahl
Standardwert
0
Verfügbare Werte
[0,1]
Beschreibung
Gibt an, ob Gesamtsummen zur Antwort hinzugefügt werden sollen oder nicht.
Beispiel:
Parameter „filter“
Eigenschaft
Filter
Typ
optional
Variablentyp
Objekt
Verfügbare Option für Werbetreibende
[”adblock”, ”advertiser_ad_type_id”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “size”, “sub”, “zone_id”, “campaign_group_id”, “campaign_id”, “exclude_deleted”, “offer_id”, “offer_landing_page_id”, “variation_id”]
Verfügbare Option für Publisher
[”adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “zone_id”, “publisher_ad_type_id”, “size”, “sub”]
Beschreibung
Nach bestimmten Parametern filtern.
Filter: country_iso
country_isoEigenschaft
country_iso
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
-
Verfügbare Werte
Siehe die Eigenschaft iso3 des Endpunkts /collections/countries
Beschreibung
Liste der ISO-3-Codes
Beispiel:
Filter date_from, date_to
date_from, date_toDie date_from und date_to Die Parameter steuern das Zeitfenster, über das Sie Statistikinformationen abrufen möchten.
date_from: Datum ab Bereich für Statistiken, (Standard: Monatsanfang),
date_to: Datum bis Bereich für Statistiken, (Standard: heute)
Eigenschaft
date_from, date_to
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
Die Datumswerte sind standardmäßig der aktuelle Monat.
Verfügbare Werte
YYYY-mm-dd
Beschreibung
Datumsbereich von/bis für Statistiken. Format YYYY-mm-dd
Beispiel:
Zeitzonen sind nur relevant, wenn wir anhand stündlicher Daten abfragen; für nicht stündliche Daten ist dies ohne Wirkung.
Filter: advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, publisher_ad_type_id
Eigenschaft
advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, advertiser_ad_type_id, publisher_ad_type_id
Typ
optional
Variablentyp
Array
Elementtyp
Ganzzahl
Standardwert
-
Verfügbare Werte
Relative Eigenschaften ODER Sammlungen
Beschreibung
Liste der Entitäts-IDs
Beispiel:
Filter: exclude_deleted
exclude_deletedEigenschaft
exclude_deleted
Typ
optional
Variablentyp
Ganzzahl
Standardwert
0
Verfügbare Werte
[0, 1]
Beschreibung
Ob gelöschte Kampagnen ausgeschlossen werden sollen oder nicht.
Beispiel:
Filter: adblock
adblockEigenschaft
adblock
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
"all"
Verfügbare Werte
"adblock", "all", "standard"
Beschreibung
Ob Adblock-Zonen einbezogen werden sollen oder nicht.
Beispiel:
Filter: site_hostname
site_hostnameEigenschaft
site_hostname
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
-
Verfügbare Werte
Gültige Zeichen für Hostnamen sind die Buchstaben a bis z, die Ziffern 0 bis 9, Bindestrich und Punkt.
Beschreibung
Nach dem Site-Hostname filtern.
Beispiel:
Filter: size
sizeEigenschaft
size
Typ
optional
Variablentyp
Zeichenfolge
Standardwert
-
Verfügbare Werte
Gültige Zeichen für die Größe sind die Ziffern 0 bis 9 und das Zeichen x. Beispiel 300x100
Beschreibung
Nach Größe filtern
Beispiel:
Parameter „group_by“
Eigenschaft
group_by
Typ
erforderlich
Variablentyp
Array
Elementtyp
Zeichenfolge
Standardwert
-
Verfügbare Werte für Werbetreibende
[”adblock”, “advertiser_ad_type_id”, browser_id”, “idcampaign_group“, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “hour”, “device_id”, “device_type_id”, “language_id”, “operating_system_id”, “region_id”, “site_id”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”, “offer_id”, “offer_landing_page_id”, “site_hostname”, “size”, “variation_id”]
Verfügbare Werte für Publisher
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “publisher_ad_type_id” “region_id”, “site_id”, “size”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”]
Beschreibung
Eine Liste von Unteranfragen, um zusätzliche Daten in die Antwort aufzunehmen.
Beispiel:
Parameter „order_by“
Typ
optional
Variablentyp
Array
Elementtyp
Zeichenfolge
Standardwert
-
Verfügbare Feldwerte für Metriken
[“cpc”, “cpc”, “cpm”, “cpv”, “ctr”, “clicks”, “impressions”, “video_impressions”, “video_views”, “vtr”, “rtb_win_ratio”, “rtb_avg_total_time”, “rtb_skipped”, “rtb_bid_response_ratio”, “rtb_avg_cpm”, “rtb_timeouts_ratio”, “rt_errors_ratio”, “rtb_no_bid_ratio”, “rtb_skipped_ratio”]
Verfügbare Feldwerte abhängig von `group_by` für Werbetreibende
[”adblock”, “browser_id”, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id”, “hour”, “ecpa1”, “g1”,“language_id”, “month”, “offer_id”, “offer_landing_page_id”, “operating_system_id”, “quarter”, “region_id”, “site_hostname”, “site_id”, “sub”, “variation_id”, “week”, “year” ,“zone_id”]
Verfügbare Feldwerte abhängig von `group_by` für Publisher
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]
Verfügbare Sortierwerte
[“asc”, “desc”]
Beschreibung
Eine Liste verfügbarer Order-by-Optionen
Hinweise:
Die Metrikfelder sind jederzeit verfügbar, um als Order-by-Feld verwendet zu werden.
Um nach einem bestimmten Wert zu sortieren (zum Beispiel nach “browser_id”), müssen Sie ihn im Parameter “group_by” einschließen.
Die Werte “g1” und “ecpa1” sind nur verfügbar, wenn der Benutzer Conversion Tracking (Goals) hat. Alle Ziele sind mit einer Seriennummer (g1, g2, …gx) verknüpft. Die eCPA-Werte sind entsprechend ecpa1, ecpa2, …ecpax.
Beispiel:
Beispiel zur chronologischen Sortierung der Kampagnenergebnisse muss „date“ sowohl in „group_by“ als auch in „order_by“ enthalten sein:
Parameter „projection“
Der Parameter projection gibt an, was in der resultierenden Nutzlast zurückgegeben wird. Wenn nicht angegeben, werden alle Unterstrukturen zurückgegeben.
Typ
optional
Variablentyp
Objekt
Elementtyp
Array
Standardwert
alle Optionen, siehe unten
Verfügbare Feldwerte für Werbetreibende
[“base”, “rtb”, “video”, “goals*”]
Verfügbare Feldwerte für Publisher
[“base”, “rtb”, “video”, “wpn”]
Einige „goal“-Felder, wie „profit“ und „roi“, werden auf Basis der Kampagnenkosten berechnet. Daher müssen Sie auch das Feld „base“ verwenden, wenn Sie die korrekten „goals“-Metriken erhalten möchten.
Beispiele:
Um als Werbetreibender alle möglichen Metriken zu erhalten, verwenden Sie:
Um als Publisher alle möglichen Metriken zu erhalten, verwenden Sie:
Sie können die Metriken auch innerhalb jedes Projection-Feldes angeben:
Das einzige Feld, das keine spezifische Metrikprojektion zulässt, ist "goals"
Parameter „limit“
Die Anzahl der Datensätze, die in dieser Antwort zurückgegeben werden sollen.
Eigenschaft
limit
Typ
optional
Variablentyp
Ganzzahl
Standardwert
50
Beispiel:
Parameter „offset“
Die Position, ab der die Datensätze abgerufen werden sollen.
Eigenschaft
offset
Typ
optional
Variablentyp
Ganzzahl
Standardwert
0
Beispiel
Beispiel 1
Kampagnenstatistik des Werbetreibenden mit Filterung.
Anfrage:
Antwort:
Beispiel 2
Werbetreibendenstatistik nach Datum für den aktuellen Monat, sortiert nach Impressionen.
Anfrage:
Antwort:
Beispiel 3
Publisher-Statistik nach date und region_id, sortiert nach impressions.
Anfrage:
Antwort:
Beispiel 4
Publisher-Statistik nach site_id mit Projektion.
Anfrage:
Antwort
Zuletzt aktualisiert
War das hilfreich?

