Reports: generate

Autorisierung erforderlich

Hiermit können Sie einen AdSense-Bericht basierend auf der Berichtanforderung erstellen, die in den Abfrageparametern gesendet wurde. Das Ergebnis wird im JSON-Format zurückgegeben. Geben Sie "alt=csv" als Abfrageparameter an, um eine Ausgabe im CSV-Format zu erhalten. Probieren Sie es aus.

Anforderung

HTTP-Anforderung

GET https://www.googleapis.com/adsensehost/v4.1/reports

Parameter

Parametername Wert Beschreibung
Erforderliche Parameter
endDate string Hiermit wird das Ende des Zeitraums für die Berichterstellung im Format "JJJJ-MM-TT" (einschließlich) angegeben.
startDate string Hiermit wird der Beginn des Zeitraums für die Berichterstellung im Format "JJJJ-MM-TT" (einschließlich) angegeben.
Optionale Parameter
dimension string

Die Dimensionen, auf denen der Bericht basiert. Verfügbare Dimensionen:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string Die Filter, die für den Bericht ausgeführt werden
locale string Optionale Sprache zur Übersetzung der Ausgabe des Berichts in eine lokale Sprache. Wird keine Angabe gemacht, wird standardmäßig "en_US" verwendet.
maxResults unsigned integer

Die maximale Anzahl an Zeilen mit zurückzugebenden Berichtdaten.

Wenn startIndex nicht festgelegt oder null ist, werden mit der API so viele Zeilen zurückgegeben, wie mit dem Wert unter maxResults angegeben. Wenn maxResults nicht festgelegt ist, werden mit der API so viele Zeilen wie möglich zurückgegeben (bis zu 50.000).

Wenn startIndex auf einen anderen Wert als null festgelegt ist, darf die Summe von startIndex und maxResults nicht größer als 5.000 sein, da sonst ein Fehler zurückgegeben wird, der besagt, dass eine Seitenordnung über Zeile 5.000 hinaus nicht möglich ist.

Zulässige Werte sind 0 bis 50000 (einschließlich).
metric string Die numerischen Spalten, die in den Bericht aufgenommen werden sollen. Verfügbare Messwerte:
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

Der Name einer Dimension oder eines Messwerts, nach der bzw. dem der resultierende Bericht sortiert werden soll. Optional kann "+" oder "-" vorangestellt werden, um aufsteigend bzw. absteigend zu sortieren. Ist kein Präfix vorhanden, wird die Spalte aufsteigend sortiert.

Dimensionen und Messwerte:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

Index der ersten Zeile mit Berichtdaten, die zurückgegeben werden sollen

Wenn startIndex nicht festgelegt oder null ist, werden mit der API so viele Zeilen zurückgegeben, wie vom Wert unter maxResults angegeben. Wenn maxResults nicht festgelegt ist, werden mit der API so viele Zeilen wie möglich zurückgegeben (bis zu 50.000).

Wenn startIndex auf einen anderen Wert als null festgelegt ist, darf die Summe von startIndex und maxResults nicht größer als 5.000 sein, da sonst ein Fehler zurückgegeben wird, der besagt, dass eine Seitenordnung über Zeile 5.000 hinaus nicht möglich ist.

Zulässige Werte sind 0 bis 5000 (einschließlich).

Autorisierung

Für diese Anforderung ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich. Weitere Informationen zu Authentifizierung und Autorisierung.

Bereich
https://www.googleapis.com/auth/adsensehost

Anforderungstext

Geben Sie für diese Methode keinen Anforderungstext an.

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode ein Antworttext mit folgender Struktur zurückgegeben:

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
Name der Eigenschaft Wert Beschreibung Anmerkungen
kind string Der Typ, in diesem Fall "adsensehost#report"
totalMatchedRows long Die Gesamtzahl der Zeilen, für die sich eine Übereinstimmung mit der Berichtanforderung ergibt. Möglicherweise werden in der Antwort weniger Zeilen zurückgegeben, weil eine Einschränkung durch die angeforderte Zeilenanzahl oder das Zeilenlimit des Berichts vorliegt.
headers[] list Die Kopfzeileninformationen der Spalten, die im Bericht angefordert werden. Dies ist eine Liste mit Kopfzeilen mit folgender Struktur: eine für jede Dimension in der Anforderung, gefolgt von einer Kopfzeile für jeden Messwert in der Anforderung.
headers[].name string Der Name der Kopfzeile
headers[].type string Der Typ der Kopfzeile: DIMENSION, METRIC_TALLY, METRIC_RATIO oder METRIC_CURRENCY
headers[].currency string Die Währung der Spalte. Ist nur vorhanden, wenn der Kopfzeilentyp METRIC_CURRENCY lautet.
rows[] list Die Ausgabezeilen des Berichts. Jede Zeile besteht aus einer Liste von Zellen: eine für jede Dimension in der Anforderung, gefolgt von einer Zeile für jeden Messwert in der Anforderung. Die Dimensionszellen enthalten Strings und die Messwertzellen enthalten Zahlen.
totals[] list Die Gesamtsummen des Berichts. Entspricht der Länge der anderen Zeilen im Bericht. Zellen von Dimensionsspalten sind leer.
averages[] list Die Durchschnittswerte des Berichts. Entspricht der Länge der anderen Zeilen im Bericht. Zellen von Dimensionsspalten sind leer.
warnings[] list Sämtliche Warnungen, die mit der Berichterstellung in Verbindung stehen

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
Name der Eigenschaft Wert Beschreibung Anmerkungen
(dynamic)"> (dynamic) (any)

Jetzt ausprobieren

Rufen Sie diese Methode mit dem unten angegebenen APIs Explorer für Live-Daten auf und sehen Sie sich die Antwort an.