Method: accounts.networkReport.generate

Erstellt einen Bericht für das AdMob-Werbenetzwerk basierend auf der angegebenen Berichtsspezifikation. 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/*}/networkReport:generate

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (NetworkReportSpec)

Spezifikation für Werbenetzwerkberichte.

Antworttext

Die Streaming-Antwort für den AdMob-Werbenetzwerkbericht, wobei die erste Antwort die Berichtskopfzeile, dann ein 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": {"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 Stream-Antwortnachricht enthält einen Nutzlasttyp. Für payload ist nur einer der folgenden Werte zulässig:
header

object (ReportHeader)

Einstellungen für die Berichterstellung, die den Inhalt des Berichts beschreiben, z. B. den Zeitraum des Berichts und die Lokalisierungseinstellungen.
row

object (ReportRow)

Tatsächliche Berichtsdaten.
footer

object (ReportFooter)

Zusätzliche Informationen zum generierten 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 unter OAuth 2.0 Overview.

NetworkReportSpec

Die Spezifikation zum Generieren eines Berichts für das AdMob-Werbenetzwerk. Die Spezifikation zum Abrufen von Klicks und geschätztem Umsatz nur für die Länder „US“ und „CN“ kann beispielsweise so 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 den folgenden Pseudo-SQL-Code 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 generiert wird.
dimensions[]

enum (Dimension)

Liste der Dimensionen des Berichts. Die Zeile des Berichts wird durch die Kombination der Werte dieser Dimensionen bestimmt. Wenn keine Dimensionen angegeben sind, enthält der Bericht eine einzelne Zeile mit den angeforderten Messwerten für das gesamte Konto.
metrics[]

enum (Metric)

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

object (DimensionFilter)

Beschreibt, welche Berichtszeilen anhand ihrer Dimensionswerte abgeglichen werden sollen.
sortConditions[]

object (SortCondition)

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

object (LocalizationSettings)

Lokalisierungseinstellungen des Berichts.
maxReportRows

integer

Maximale Anzahl der zurückzugebenden Zeilen mit Berichtsdaten. 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, die größer als 100.000 sind, führen zu einem Fehler.
timeZone

string

Eine Zeitzone für Berichte. Akzeptiert IANA-TZ-Namen wie „America/Los_Angeles“. Wenn keine Zeitzone definiert ist, wird die Standardzeitzone des Kontos verwendet. Standardwert mit der Aktion „Konto abrufen“ prüfen.

Warnung:Derzeit wird nur der Wert „America/Los_Angeles“ unterstützt.

Dimension

Die Dimensionen des Netzwerkberichts. Dimensionen sind Datenattribute, mit denen die quantitativen Messungen (Messwerte) nach bestimmten Attributen aufgeschlüsselt oder optimiert werden können, 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 maximal eine Zeitdimension angegeben werden.
MONTH Ein Monat im Format JJJJMM (z. B. „202107“). In Anfragen kann maximal eine Zeitdimension angegeben werden.
WEEK Das Datum des ersten Tages einer Woche im Format JJJJMMTT (z. B. „20210701“). In Anfragen kann maximal 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“. Dies ist 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 Orts, an dem die Anzeigenaufrufe/-klicks erfolgen (z. B. „US“ oder „FR“). Das ist eine geografische Dimension.
FORMAT Das Format des Anzeigenblocks (z. B. „Banner“ oder „Nativ“), eine Dimension für die Anzeigenauslieferung.
PLATFORM Die 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 finden Sie den Namen der App-Version in „versionName“ in „PackageInfo“. Bei iOS finden Sie den App-Versionsnamen 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 angeben, wie gut das Verlagsgeschäft läuft. Sie werden aus den einzelnen Anzeigenereignissen aggregiert 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 nicht mit der Dimension AD_TYPE kompatibel.
CLICKS Dieser Wert gibt an, wie oft ein Nutzer auf eine Anzeige geklickt hat. Bei dem Wert handelt es sich um eine ganze Zahl.
ESTIMATED_EARNINGS Die geschätzten Einnahmen des AdMob-Publishers. Die Währungseinheit (USD, EUR oder andere) der Umsatzmesswerte wird durch die Lokalisierungseinstellung für die Währung bestimmt. Der Betrag wird in Micros angegeben. Beispiel: 6, 50 $ werden als 6500000 dargestellt.
IMPRESSIONS Die Gesamtzahl der Anzeigen, die für Nutzer ausgeliefert werden. Bei dem Wert handelt es sich um eine ganze Zahl.
IMPRESSION_CTR Das Verhältnis von Klicks zu Impressionen. Der Wert ist ein Dezimalwert (angenähert) mit doppelter Genauigkeit.
IMPRESSION_RPM

Die geschätzten Einnahmen pro 1.000 Anzeigenimpressionen. Der Wert wird in „micros“ angegeben. 1, 03 $ würden beispielsweise als 1030000 dargestellt. Entspricht dem eCPM in der AdMob-Benutzeroberfläche.

Warnung:Der Messwert ist nicht mit der Dimension AD_TYPE kompatibel.
MATCHED_REQUESTS Die Anzahl der Anzeigen, die als Antwort auf eine Anfrage zurückgegeben werden. Bei dem Wert handelt es sich um eine ganze Zahl.
MATCH_RATE

Das Verhältnis von Anzeigenanfragen mit Übereinstimmung zur Gesamtzahl der Anzeigenanfragen. Der Wert ist ein Dezimalwert (angenähert) mit doppelter Genauigkeit.

Warnung:Der Messwert ist nicht mit der Dimension AD_TYPE kompatibel.
SHOW_RATE Das Verhältnis der ausgelieferten Anzeigen zu den zurückgegebenen Anzeigen, definiert als Impressionen / Anfragen mit Übereinstimmung. Der Wert ist ein Dezimalwert (angenähert) mit doppelter Genauigkeit.

DimensionFilter

Beschreibt, welche Berichtszeilen anhand ihrer Dimensionswerte 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. Der anzuwendende Filteroperator. Für operator ist nur einer der folgenden Werte zulässig:
matchesAny

object (StringList)

Trifft auf eine Zeile zu, wenn ihr Wert für die angegebene Dimension mit einem der in dieser Bedingung angegebenen Werte übereinstimmt.

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.