Method: accounts.mediationReport.generate

Auf Grundlage der bereitgestellten Berichtsspezifikation wird ein Bericht zur AdMob-Vermittlung erstellt. Gibt das Ergebnis eines serverseitigen Streaming-RPC zurück. Das Ergebnis wird in einer Reihe von Antworten zurückgegeben.

HTTP-Anfrage

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/mediationReport:generate

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Ressourcenname des Kontos, für das der Bericht erstellt werden soll. Beispiel: accounts/pub-9876543210987654

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "reportSpec": {
    object (MediationReportSpec)
  }
}
Felder
reportSpec

object (MediationReportSpec)

Netzwerkberichtsspezifikation

Antworttext

Die Streaming-Antwort für den AdMob Mediation-Bericht, bei der die erste Antwort den Berichtskopf, dann einen Stream von Zeilenantworten und schließlich eine Fußzeile als letzte Antwortnachricht enthält.

Beispiel:

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         "displayLabel": "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
Felder
Union-Feld payload. Jede Streamantwortnachricht enthält einen Nutzlasttyp. Für payload ist nur einer der folgenden Werte zulässig:
header

object (ReportHeader)

Einstellungen zur Berichterstellung, in denen der Inhalt des Berichts beschrieben wird, z. B. Zeitraum und Lokalisierungseinstellungen
row

object (ReportRow)

Tatsächliche Berichtsdaten
footer

object (ReportFooter)

Zusätzliche Informationen zum erstellten Bericht, z. B. Warnungen zu den Daten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

MediationReportSpec

Die Spezifikation zum Erstellen eines AdMob Mediation-Berichts. Die Spezifikation für den beobachteten eCPM, aufgeteilt nach Anzeigenquelle und App für die Länder „US“ und „CN“, könnte beispielsweise so aussehen:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 9, "day": 1},
    "endDate": {"year": 2021, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimensionFilters": [
    {
      "dimension": "COUNTRY",
      "matchesAny": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sortConditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localizationSettings": {
    "currencyCode": "USD",
    "languageCode": "en-US"
  }
}

Zum besseren Verständnis können Sie die vorherige Spezifikation wie die folgende Pseudo-SQL behandeln:

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
JSON-Darstellung 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Felder
dateRange

object (DateRange)

Der Zeitraum, für den der Bericht erstellt wird.
dimensions[]

enum (Dimension)

Liste der Berichtsdimensionen Die Wertekombination dieser Dimensionen bestimmt die Zeile des Berichts. Wenn keine Dimensionen angegeben werden, wird im Bericht eine einzelne Zeile mit angeforderten Messwerten für das gesamte Konto zurückgegeben.
metrics[]

enum (Metric)

Liste der Messwerte des Berichts. In einem Bericht muss mindestens ein Messwert angegeben sein.
dimensionFilters[]

object (DimensionFilter)

Beschreibt, welche Berichtszeilen basierend auf ihren Dimensionswerten abgeglichen werden sollen.
sortConditions[]

object (SortCondition)

Beschreibt das Sortieren von Berichtszeilen. Die Reihenfolge der Bedingung in der Liste definiert ihre Rangfolge. Je früher die Bedingung, desto höher ihre Priorität. Wenn keine Sortierbedingungen angegeben sind, ist die Zeilenreihenfolge nicht definiert.
localizationSettings

object (LocalizationSettings)

Lokalisierungseinstellungen des Berichts
maxReportRows

integer

Maximale Anzahl der zurückzugebenden Berichtsdatenzeilen. Wenn der Wert nicht festgelegt ist, gibt die API so viele Zeilen wie möglich zurück (bis zu 100.000). Zulässige Werte sind 1–100.000 (einschließlich). Bei Werten über 100.000 wird ein Fehler zurückgegeben.
timeZone

string

Eine Zeitzone für den Bericht Akzeptiert die IANA-TZ-Namenswerte wie „America/Los_Angeles“. Wurde keine Zeitzone festgelegt, wird die Standardeinstellung des Kontos verwendet. Prüfen Sie den Standardwert mithilfe der Aktion „Konto abrufen“.

Warnung: „America/Los_Angeles“ ist derzeit der einzige unterstützte Wert.

Dimension

Die Dimensionen des Vermittlungsberichts. Dimensionen sind Datenattribute, mit denen die quantitativen Messungen (Messwerte) anhand bestimmter Attribute aufgeschlüsselt oder verfeinert werden, z. B. dem Anzeigenformat oder der Plattform, auf der die Anzeige angesehen wurde.

Enums
DIMENSION_UNSPECIFIED Standardwert für ein nicht konfiguriertes Feld. Nicht verwenden.
DATE Ein Datum im Format JJJJMMTT (z. B. „20210701“). In den Anfragen kann höchstens eine Zeitdimension angegeben werden.
MONTH Ein Monat im Format JJJJMM (z. B. „202107“). In den Anfragen kann höchstens eine Zeitdimension angegeben werden.
WEEK Das Datum des ersten Tags einer Woche im Format JJJJMMTT (z. B. „20210701“). In den Anfragen kann höchstens eine Zeitdimension angegeben werden.
AD_SOURCE Die eindeutige ID der Anzeigenquelle, z. B. „5450213213286189855“ und „AdMob-Werbenetzwerk“ als Labelwert.
AD_SOURCE_INSTANCE Die eindeutige ID der Anzeigenquelleninstanz, z. B. „ca-app-pub-1234:asi:5678“ und „AdMob (Standardeinstellung)“ als Labelwert
AD_UNIT Die eindeutige ID des Anzeigenblocks, z. B. „ca-app-pub-1234/8790“. Wenn die Dimension AD_UNIT angegeben wird, wird APP automatisch eingeschlossen.
APP Die eindeutige ID der mobilen App, z. B. „ca-app-pub-1234~1234“.
MEDIATION_GROUP Die eindeutige ID der Vermittlungsgruppe, z. B. „ca-app-pub-1234:mg:1234“ und „AdMob (Standard)“ als Labelwert.
COUNTRY Der CLDR-Ländercode des Orts, an dem die Anzeige aufgerufen bzw. angeklickt wird (z. B. „US“ oder „FR“) Dies ist eine geografische Dimension.
FORMAT Format des Anzeigenblocks, z. B. „Banner“ oder „Nativ“, eine Dimension für die Anzeigenauslieferung.
PLATFORM Mobile Betriebssystemplattform der App, z. B. „Android“ oder „iOS“
MOBILE_OS_VERSION Version des mobilen Betriebssystems, z.B. „iOS 13.5.1“.
GMA_SDK_VERSION GMA SDK-Version, z.B. „iOS 7.62.0“.
APP_VERSION_NAME Bei Android findest du den Namen der App-Version in „versionName“ in „PackageInfo“. Für iOS ist der Name der App-Version in „CFBundleShortVersionString“ zu finden.
SERVING_RESTRICTION Einschränkungsmodus für die Anzeigenbereitstellung (z. B. „nicht personalisierte Anzeigen“)

Messwert

Die Messwerte des Vermittlungsberichts. Messwerte sind quantitative Messungen der Leistung des Publishers. Sie werden aus den einzelnen Anzeigenereignissen zusammengefasst und nach den Berichtsdimensionen gruppiert. Der Messwert ist entweder eine Ganzzahl oder eine Dezimalzahl (ohne Rundung).

Enums
METRIC_UNSPECIFIED Standardwert für ein nicht konfiguriertes Feld. Nicht verwenden.
AD_REQUESTS Die Anzahl der Anfragen. Bei dem Wert handelt es sich um eine ganze Zahl.
CLICKS Dieser Wert gibt an, wie oft ein Nutzer auf eine Anzeige klickt. Bei dem Wert handelt es sich um eine ganze Zahl.
ESTIMATED_EARNINGS

Die geschätzten Einnahmen des AdMob-Publishers. Die Währungseinheit (z. B. USD, EUR) der Messwerte zu Einnahmen wird durch die Lokalisierungseinstellung für die Währung bestimmt. Der Betrag wird in Mikros angegeben. Beispiel: 6, 50 € würden als 6.500.000 dargestellt.

Geschätzte Einnahmen pro Vermittlungsgruppe und Anzeigenquelleninstanzebene werden seit dem 20. Oktober 2019 unterstützt. Für die geschätzten Drittanbietereinnahmen wird für Zeiträume vor dem 20. Oktober 2019 „0“ angezeigt.
IMPRESSIONS Die Gesamtzahl der Anzeigen, die Nutzern präsentiert wurden. Bei dem Wert handelt es sich um eine ganze Zahl.
IMPRESSION_CTR Das Verhältnis von Klicks zu Impressionen. Der Wert ist ein (ungefähre) Dezimalwert mit doppelter Genauigkeit.
MATCHED_REQUESTS Die Häufigkeit, mit der Anzeigen als Antwort auf eine Anfrage zurückgegeben werden. Bei dem Wert handelt es sich um eine ganze Zahl.
MATCH_RATE Das Verhältnis der Anzeigenanfragen mit Übereinstimmung zur Gesamtzahl der Anzeigenanfragen. Der Wert ist ein (ungefähre) Dezimalwert mit doppelter Genauigkeit.
OBSERVED_ECPM

Geschätzter durchschnittlicher eCPM des Drittanbieter-Werbenetzwerks Die Währungseinheit (z. B. USD, EUR) der Messwerte zu Einnahmen wird durch die Lokalisierungseinstellung für die Währung bestimmt. Der Betrag wird in Mikros angegeben. Beispiel: 2, 30 € wird als 2.300.000 dargestellt.

Der geschätzte durchschnittliche eCPM pro Vermittlungsgruppe und Ebene der Anzeigenquelleninstanz wird seit dem 20. Oktober 2019 unterstützt. Für den geschätzten durchschnittlichen eCPM des Drittanbieters wird für Zeiträume vor dem 20. Oktober 2019 „0“ angezeigt.

DimensionFilter

Beschreibt, welche Berichtszeilen basierend auf ihren Dimensionswerten abgeglichen werden sollen.

JSON-Darstellung 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Felder
dimension

enum (Dimension)

Wendet das Filterkriterium auf die angegebene Dimension an.
Union-Feld operator. Anzuwendender Filteroperator. Für operator ist nur einer der folgenden Werte zulässig:
matchesAny

object (StringList)

Entspricht einer Zeile, wenn ihr Wert für die angegebene Dimension in einem der in dieser Bedingung angegebenen Werte liegt.

SortCondition

Sortierrichtung, die auf eine Dimension oder einen Messwert angewendet werden soll.

JSON-Darstellung 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Felder
order

enum (SortOrder)

Sortierreihenfolge der Dimension oder des Messwerts
Union-Feld sort_on. Gibt an, nach welchen Werten sortiert werden soll. Für sort_on ist nur einer der folgenden Werte zulässig:
dimension

enum (Dimension)

Sortiert nach der angegebenen Dimension.
metric

enum (Metric)

Sortiert nach dem angegebenen Messwert.