Reports: generate

Es wird sofort ein Bericht erstellt und zurückgegeben. Jetzt testen

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate

Autorisierung

Für diese Anfrage ist eine Autorisierung in folgendem Umfang erforderlich:

Umfang
https://www.googleapis.com/auth/doubleclicksearch

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext Daten mit der folgenden Struktur ein:

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}
Attributname Wert Beschreibung Hinweise
reportScope object Der reportScope umfasst mehrere IDs, mit denen festgelegt wird, welche Teilmenge von Entitäten im Bericht zurückgegeben wird. Es ist die vollständige Herkunft der IDs der untersten Ebene erforderlich, die über die Agentur angefordert wird.
reportScope.agencyId long DS-Agentur-ID.
reportScope.advertiserId long ID des DS-Werbetreibenden
reportScope.engineAccountId long DS-Suchmaschinenkonto-ID.
reportScope.campaignId long DS-Kampagnen-ID.
reportScope.adGroupId long DS-Anzeigengruppen-ID.
reportScope.keywordId long DS-Keyword-ID
reportScope.adId long DS-Anzeigen-ID.
reportType string Legt den Typ der Zeilen fest, die im Bericht zurückgegeben werden. Wenn Sie beispielsweise reportType: keyword angeben, enthält jede Zeile im Bericht Daten zu einem Keyword. In der Referenz zu Berichtstypen finden Sie die für jeden Typ verfügbaren Spalten.
columns[] list Die Spalten, die in den Bericht aufgenommen werden sollen. Dazu gehören sowohl DoubleClick Search-Spalten als auch gespeicherte Spalten. Bei DoubleClick Search-Spalten ist nur der Parameter columnName erforderlich. Bei gespeicherten Spalten ist nur der Parameter savedColumnName erforderlich. columnName und savedColumnName können nicht in derselben Stanza festgelegt werden.

Die maximale Anzahl von Spalten pro Anfrage beträgt 300.

columns[].columnName string Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll
columns[].savedColumnName string Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss auf Ebene des Werbetreibenden oder einer niedrigeren Ebene erstellt werden und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
columns[].headerText string Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird. Wenn keine Angabe erfolgt, wird standardmäßig columnName oder savedColumnName verwendet. Damit lassen sich Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen vermeiden.
columns[].startDate string Inklusives Datum im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit endDate angegeben werden.
columns[].endDate string Inklusiver Tag im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit startDate angegeben werden.
columns[].groupByColumn boolean Nur synchroner Bericht Legen Sie true fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist false.
timeRange object Wenn Messwerte in einem Bericht angefordert werden, wird dieses Argument verwendet, um die Messwerte auf einen bestimmten Zeitraum zu beschränken.
timeRange.startDate string Inklusives Datum im Format JJJJ-MM-TT.
timeRange.endDate string Inklusives Datum im Format JJJJ-MM-TT.
timeRange.changedMetricsSinceTimestamp datetime Eingeschlossener UTC-Zeitstempel im RFC-Format, z.B. 2013-07-16T10:16:23.555Z. Weitere Informationen zur Funktionsweise von Berichten zu geänderten Messwerten
timeRange.changedAttributesSinceTimestamp datetime Eingeschlossener UTC-Zeitstempel im RFC-Format, z.B. 2013-07-16T10:16:23.555Z. Weitere Informationen zur Funktionsweise von Berichten zu geänderten Attributen
filters[] list Eine Liste der Filter, die auf den Bericht angewendet werden sollen.

Pro Anfrage sind maximal 300 Filter zulässig.

filters[].column nested object Spalte, auf die der Filter angewendet werden soll. Dies kann eine DoubleClick Search-Spalte oder eine gespeicherte Spalte sein.
filters[].column.columnName string Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll
filters[].column.savedColumnName string Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss auf Ebene des Werbetreibenden oder einer niedrigeren Ebene erstellt werden und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
filters[].operator string Operator, der im Filter verwendet werden soll. Eine Liste der verfügbaren Operatoren finden Sie in der Filterreferenz.
filters[].values[] list Eine Liste von Werten, nach denen der Spaltenwert gefiltert werden soll.

Die maximale Anzahl von Filterwerten pro Anfrage ist 300.

orderBy[] list Nur synchroner Bericht Eine Liste der Spalten und Richtungen, mit denen die Sortierung für die Berichtszeilen definiert wird.

Die maximale Anzahl von Bestellungen pro Anfrage beträgt 300.

orderBy[].column nested object Spalte, für die die Sortierung ausgeführt werden soll. Dies kann eine von DoubleClick Search definierte Spalte oder eine gespeicherte Spalte sein.
orderBy[].column.columnName string Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll
orderBy[].column.savedColumnName string Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss auf Ebene des Werbetreibenden oder einer niedrigeren Ebene erstellt werden und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
orderBy[].sortOrder string Die Sortierrichtung, entweder ascending oder descending.
includeDeletedEntities boolean Legt fest, ob entfernte Entitäten im Bericht enthalten sein sollen. Die Standardeinstellung ist false. Eingestellt. Verwende stattdessen includeRemovedEntities.
verifySingleTimeZone boolean Wenn true, wird der Bericht nur erstellt, wenn alle angeforderten Statistikdaten aus einer einzelnen Zeitzone stammen. Die Standardeinstellung ist false.
downloadFormat string Das Format, in dem der Bericht zurückgegeben werden soll. Derzeit wird csv oder tsv unterstützt.
statisticsCurrency string Gibt die Währung an, in der Geldbeträge zurückgegeben werden. Mögliche Werte sind: usd, agency (gültig, wenn der Bericht auf Agentur- oder niedrigere Ebene begrenzt), advertiser (gültig, wenn der Bericht auf * Werbetreibenden oder niedriger beschränkt ist) oder account (gültig, wenn der Bericht auf ein Suchmaschinenkonto oder niedriger ausgerichtet ist).
startRow integer Nur synchroner Bericht Nullbasierter Index der ersten Zeile, die zurückgegeben werden soll. Zulässige Werte: 0 bis 50000. Die Standardeinstellung ist 0.
rowCount integer Nur synchroner Bericht Die maximale Anzahl von Zeilen, die zurückgegeben werden sollen. Zusätzliche Zeilen werden gelöscht. Zulässige Werte: 0 bis 10000. Die Standardeinstellung ist 10000.
maxRowsPerFile integer Nur asynchroner Bericht. Die maximale Anzahl von Zeilen pro Berichtsdatei. Ein großer Bericht wird basierend auf diesem Feld in viele Dateien aufgeteilt. Zulässige Werte: 1000000 bis 100000000.
includeRemovedEntities boolean Legt fest, ob entfernte Entitäten im Bericht enthalten sein sollen. Die Standardeinstellung ist false.
columns[].customDimensionName string Hiermit wird ein Bericht nach einer benutzerdefinierten Dimension segmentiert. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Bei dem Namen der benutzerdefinierten Dimension, der in DoubleClick Search erscheint, wird zwischen Groß- und Kleinschreibung unterschieden.

Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die angegebene Conversion zurückgegeben, sofern festgelegt. In dieser Spalte wird der Conversion-Bericht nicht segmentiert.

columns[].platformSource string Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“.
filters[].column.customDimensionName string Hiermit wird ein Bericht nach einer benutzerdefinierten Dimension segmentiert. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Bei dem Namen der benutzerdefinierten Dimension, der in DoubleClick Search erscheint, wird zwischen Groß- und Kleinschreibung unterschieden.

Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die angegebene Conversion zurückgegeben, sofern festgelegt. In dieser Spalte wird der Conversion-Bericht nicht segmentiert.

filters[].column.headerText string Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird. Wenn keine Angabe erfolgt, wird standardmäßig columnName oder savedColumnName verwendet. Damit lassen sich Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen vermeiden.
filters[].column.startDate string Inklusives Datum im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit endDate angegeben werden.
filters[].column.endDate string Inklusiver Tag im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit startDate angegeben werden.
filters[].column.groupByColumn boolean Nur synchroner Bericht Legen Sie true fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist false.
filters[].column.platformSource string Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“.
orderBy[].column.customDimensionName string Hiermit wird ein Bericht nach einer benutzerdefinierten Dimension segmentiert. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Bei dem Namen der benutzerdefinierten Dimension, der in DoubleClick Search erscheint, wird zwischen Groß- und Kleinschreibung unterschieden.

Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die angegebene Conversion zurückgegeben, sofern festgelegt. In dieser Spalte wird der Conversion-Bericht nicht segmentiert.

orderBy[].column.headerText string Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird. Wenn keine Angabe erfolgt, wird standardmäßig columnName oder savedColumnName verwendet. Damit lassen sich Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen vermeiden.
orderBy[].column.startDate string Inklusives Datum im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit endDate angegeben werden.
orderBy[].column.endDate string Inklusiver Tag im Format JJJJ-MM-TT. Wenn angegeben, wird dadurch der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit startDate angegeben werden.
orderBy[].column.groupByColumn boolean Nur synchroner Bericht Legen Sie true fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist false.
orderBy[].column.platformSource string Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“.
columns[].customMetricName string Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Bei dem in DoubleClick Search angezeigten Namen des benutzerdefinierten Messwerts wird zwischen Groß- und Kleinschreibung unterschieden.
filters[].column.customMetricName string Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Bei dem in DoubleClick Search angezeigten Namen des benutzerdefinierten Messwerts wird zwischen Groß- und Kleinschreibung unterschieden.
orderBy[].column.customMetricName string Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss sich auf einen Werbetreibenden oder einen kleineren Gültigkeitsbereich beziehen und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Bei dem in DoubleClick Search angezeigten Namen des benutzerdefinierten Messwerts wird zwischen Groß- und Kleinschreibung unterschieden.
columns[].productReportPerspective string Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
  • sold“: Gibt nur Messwerte für Produkte zurück, die verkauft wurden
  • advertised“: Gibt nur Messwerte für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden
filters[].column.productReportPerspective string Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
  • sold“: Gibt nur Messwerte für Produkte zurück, die verkauft wurden
  • advertised“: Gibt nur Messwerte für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden
orderBy[].column.productReportPerspective string Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
  • sold“: Gibt nur Messwerte für Produkte zurück, die verkauft wurden
  • advertised“: Gibt nur Messwerte für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Ressource vom Typ „Reports“ im Antworttext zurückgegeben.

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Alternativ können Sie den eigenständigen Explorer ausprobieren.