Method: accounts.networkReport.generate

Hiermit wird auf Grundlage der bereitgestellten Berichtsspezifikation ein Bericht für das AdMob-Werbenetzwerk erstellt. Gibt das Ergebnis eines serverseitigen Streaming-RPC zurück. Das Ergebnis wird in einer Folge von Antworten zurückgegeben.

HTTP-Anfrage

POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport: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 (NetworkReportSpec)
  }
}
Felder
reportSpec

object (NetworkReportSpec)

Netzwerk-Report-Spezifikation.

Antworttext

Die Streamingantwort für den Bericht für das AdMob-Werbenetzwerk, bei der die erste Antwort die Kopfzeile, dann einen Stream von Zeilenantworten und schließlich eine Fußzeile als letzte Antwort 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": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

Bei Erfolg enthält der Antworttext Daten mit der folgenden 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 für die Berichterstellung, in denen der Inhalt des Berichts beschrieben wird, etwa der Zeitraum und die 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.

NetworkReportSpec

Die Spezifikation zum Erstellen eines Berichts für das AdMob-Werbenetzwerk. Die Spezifikation zum Abrufen von Klicks und geschätzten Einnahmen nur für die Länder "US" und "CN" könnte wie folgt aussehen:

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

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

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
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 Dimensionen des Berichts. Die Wertekombination dieser Dimensionen bestimmt die Zeile des Berichts. Wenn keine Dimensionen angegeben werden, enthält der Bericht eine einzelne Zeile mit angeforderten Messwerten für das gesamte Konto.
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 Berichtzeilen. Die Reihenfolge der Bedingung in der Liste definiert ihre Priorität. Je früher die Bedingung, desto höher ihre Priorität. Wenn keine Sortierbedingungen angegeben sind, ist die Zeilensortierung 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). Werte über 100.000 geben einen Fehler zurück.
timeZone

string

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

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

Dimension

Die Dimensionen des Netzwerkberichts. Dimensionen sind Datenattribute, mit denen die quantitativen Messungen (Messwerte) nach bestimmten Attributen aufgeschlüsselt oder verfeinert werden, z. B. nach dem Anzeigenformat oder der Plattform, auf der die Anzeige angesehen wurde.

Enums
DIMENSION_UNSPECIFIED Standardwert für ein nicht festgelegtes Feld. Nicht verwenden.
DATE Ein Datum im Format JJJJMMTT (z. B. „20210701“). In Anfragen kann höchstens eine Zeitdimension angegeben werden.
MONTH Ein Monat im Format JJJJMM (z. B. „202107“). In Anfragen kann höchstens eine Zeitdimension angegeben werden.
WEEK Das Datum des ersten Tages einer Woche im Format JJJJMMTT (z. B. „20210701“). In Anfragen kann höchstens eine Zeitdimension angegeben werden.
AD_UNIT Die eindeutige ID des Anzeigenblocks, z. B. "ca-app-pub-1234/1234" Wenn die Dimension AD_UNIT angegeben ist, wird APP automatisch eingeschlossen.
APP Die eindeutige ID der mobilen App, z. B. "ca-app-pub-1234~1234".
AD_TYPE

Der Typ der Anzeige, z. B. "Text" oder "Bild", eine Dimension für die Anzeigenauslieferung.

Warnung:Die Dimension ist nicht mit den Messwerten AD_REQUESTS, MATCH_RATE und IMPRESSION_RPM kompatibel.
COUNTRY CLDR-Ländercode des Ortes, an dem Anzeigenaufrufe/Klicks erfolgen (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 Versionsnamen der App in „versionName“ in PackageInfo. Für iOS finden Sie den Versionsnamen der App in "CFBundleShortVersionString".
SERVING_RESTRICTION Einschränkungsmodus für die Anzeigenbereitstellung (z.B. „nicht personalisierte Anzeigen“).

Messwert

Die Messwerte des Netzwerkberichts. Messwerte sind quantitative Messungen, die die Leistung des Publisher-Geschäfts anzeigen. 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 festgelegtes Feld. Nicht verwenden.
AD_REQUESTS

Die Anzahl der Anzeigenanfragen. Bei dem Wert handelt es sich um eine ganze Zahl.

Warnung:Der Messwert ist mit der Dimension AD_TYPE nicht kompatibel.
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 Mikroeinheiten angegeben. Beispiel: 6, 50 € wird als 6.500.000 dargestellt.
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.
IMPRESSION_RPM

Die geschätzten Einnahmen pro 1.000 Anzeigenimpressionen. Der Wert wird in Mikros angegeben. 1, 03 € würde beispielsweise als 1030000 dargestellt. Entspricht dem eCPM auf der AdMob-Benutzeroberfläche.

Warnung:Der Messwert ist mit der Dimension AD_TYPE nicht kompatibel.
MATCHED_REQUESTS Die Häufigkeit, mit der als Antwort auf eine Anfrage Anzeigen 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.

Warnung:Der Messwert ist mit der Dimension AD_TYPE nicht kompatibel.
SHOW_RATE Das Verhältnis der Anzeigen, die zu den zurückgegebenen Anzeigen erscheinen, gemessen als Impressionen geteilt durch Anfragen mit Übereinstimmung. Der Wert ist ein (ungefähre) Dezimalwert mit doppelter Genauigkeit.

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)

Nach der angegebenen Dimension sortieren.
metric

enum (Metric)

Nach dem angegebenen Messwert sortieren.