Method: accounts.networkReport.generate

Erstellt einen Bericht für das AdMob-Werbenetzwerk, der auf der bereitgestellten Berichtsspezifikation basiert. Gibt das Ergebnis eines serverseitigen Streaming-RPCs 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 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 Streaming-Antwort für den Bericht für das AdMob-Werbenetzwerk, wobei die erste Antwort die Kopfzeile des Berichts, 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": {"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, die den Inhalt des Berichts beschreiben, z. B. den Zeitraum des Berichts und die Lokalisierungseinstellungen.
row

object (ReportRow)

Die tatsächlichen 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 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 USA und "CN" Länder können wie im folgenden Beispiel 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 folgenden 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 wurde.
dimensions[]

enum (Dimension)

Liste der Dimensionen des Berichts. Anhand der Wertekombination dieser Dimensionen wird die Zeile des Berichts bestimmt. Wenn keine Dimensionen angegeben werden, gibt der Bericht eine einzelne Zeile mit angeforderten Messwerten für das gesamte Konto zurück.
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 Rangfolge der Bedingung in der Liste wird durch die Reihenfolge bestimmt. Je früher die Bedingung, desto höher ihre Priorität. Wenn keine Sortierbedingungen angegeben werden, ist die Zeilenreihenfolge nicht definiert.
localizationSettings

object (LocalizationSettings)

Lokalisierungseinstellungen des Berichts
maxReportRows

integer

Maximale Anzahl der zurückzugebenden Berichtdatenzeilen. 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 des Berichts. Akzeptiert einen IANA-TZ-Namenswert wie „America/Los_Angeles“. Wenn keine Zeitzone festgelegt ist, wird die Standardeinstellung für das Konto übernommen. Prüfen Sie den Standardwert der Aktion „Konto abrufen“.

Warnung: Das Dokument "America/Los_Angeles" ist derzeit der einzige unterstützte Wert.

Dimension

Die Dimensionen des Netzwerkberichts Dimensionen sind Datenattribute, mit denen sich quantitative Messungen (Messwerte) nach bestimmten Attributen aufschlüsseln oder optimieren lassen, z. B. nach dem Anzeigenformat oder der Plattform, auf der eine Anzeige angesehen wurde.

Enums
DIMENSION_UNSPECIFIED Standardwert für ein nicht festgelegtes Feld. Nicht verwenden.
DATE Ein Datum im Format JJJJMMTT (z. B. „20210701“) Anfragen können höchstens eine Zeitdimension angeben.
MONTH Ein Monat im Format JJJJMM (z. B. „202107“) Anfragen können höchstens eine Zeitdimension angeben.
WEEK Das Datum des ersten Tags einer Woche im Format JJJJMMTT (z. B. „20210701“). Anfragen können höchstens eine Zeitdimension angeben.
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

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 Orts, an dem Anzeigenaufrufe oder Klicks erfolgen (z. B. „US“ oder „FR“). Dies ist eine geografische Dimension.
FORMAT Format des Anzeigenblocks, z. B. „Banner“ oder „Nativ“, und ist eine Dimension für die Anzeigenauslieferung.
PLATFORM Plattform des mobilen Betriebssystems der App, z. B. „Android“ oder „iOS“
MOBILE_OS_VERSION Mobile Betriebssystemversion, 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 Namen der App-Version in CFBundleShortVersionString.
SERVING_RESTRICTION Einschränkungsmodus für die Anzeigenbereitstellung (z.B. „Nicht personalisierte Anzeigen“).

Messwert

Die Messwerte des Netzwerkberichts Messwerte sind quantitative Messungen von Daten zur Leistung des Publisher-Geschäfts. Sie werden aus den einzelnen Anzeigenereignissen zusammengefasst und nach 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 Die Häufigkeit, mit der 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 (USD, EUR oder andere) der Messwerte zu Einnahmen wird durch die Lokalisierungseinstellung für die Währung bestimmt. Der Betrag wird in Mikros angegeben. Beispiel: 6, 50 € wird als 6500000 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 Dezimalwert (ungefähre) mit doppelter Genauigkeit.
IMPRESSION_RPM

Die geschätzten Einnahmen pro 1.000 Anzeigenimpressionen. Der Wert wird in Mikroeinheiten angegeben. Beispiel: 1, 03 $ wird als 1030000 dargestellt. Entspricht dem eCPM auf der AdMob-Benutzeroberfläche.

Warnung:Der Messwert ist nicht mit der Dimension AD_TYPE kompatibel.
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 Dezimalwert (ungefähre) 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 (ungefähre) 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. Filteroperator, der angewendet werden soll. 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)

Sortieren nach der angegebenen Dimension.
metric

enum (Metric)

Sortiert nach dem angegebenen Messwert.