Die vorherige Search Ads 360 Reporting API wird eingestellt. Sie können Ihre Berichte jetzt mit der neuen Search Ads 360 Reporting API erstellen.

Die Search Ads 360 Conversion API ist nicht betroffen und wird weiterhin unterstützt.

Diese Seite wurde von der Cloud Translation API übersetzt.

Reports

Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.

Ressourcendarstellungen

Einen DoubleClick Search-Bericht Dieses Objekt enthält die Berichtsanfrage, einige Berichtmetadaten wie den Währungscode und die generierten Berichtzeilen oder Berichtsdateien.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "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
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}

Property-Name	Wert	Beschreibung
`files[]`	`list`	Nur asynchroner Bericht. Enthält eine Liste der generierten Berichtsdateien, sobald der Bericht erfolgreich erstellt wurde.
`files[].byteCount`	`long`	Die Größe dieser Berichtsdatei in Byte.
`files[].url`	`string`	Verwenden Sie diese URL, um die Berichtsdatei herunterzuladen.
`id`	`string`	Nur asynchroner Bericht. Die ID des Berichts.
`isReportReady`	`boolean`	Nur asynchroner Bericht. Nur dann "True", wenn der Bericht erfolgreich erstellt wurde und die Berichtsdateien heruntergeladen werden können.
`kind`	`string`	Kennzeichnet dies als Berichtsressource. Wert: der feste String `doubleclicksearch#report`.
`request`	`nested object`	Die Anfrage, mit der der Bericht erstellt wurde. Optionale Felder, die in der ursprünglichen Anfrage nicht angegeben wurden, werden mit Standardwerten gefüllt.
`request.columns[]`	`list`	Die in den Bericht aufzunehmenden Spalten. Dies gilt sowohl für DoubleClick Search-Spalten als auch für gespeicherte Spalten. Für DoubleClick Search-Spalten ist nur der Parameter `columnName` erforderlich. Für gespeicherte 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.
`request.columns[].columnName`	`string`	Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll.
`request.columns[].customDimensionName`	`string`	Segmentiert einen Bericht nach einer benutzerdefinierten Dimension. Der Bericht muss sich auf einen Werbetreibenden oder eine niedrigere Ebene beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Beim Namen der benutzerdefinierten Dimension, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden. Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die entsprechende Conversion zurückgegeben (falls festgelegt). Der Conversion-Bericht wird in dieser Spalte nicht segmentiert.
`request.columns[].customMetricName`	`string`	Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss einem Werbetreibenden oder einer niedrigeren Ebene zugeordnet werden und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Beim Namen des benutzerdefinierten Messwerts, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden.
`request.columns[].endDate`	`string`	Tag der Inklusion im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `startDate` angegeben werden.
`request.columns[].groupByColumn`	`boolean`	Nur synchroner Bericht. Legen Sie `true` fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist `false`.
`request.columns[].headerText`	`string`	Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird wird standardmäßig `columnName` oder `savedColumnName` verwendet, wenn kein Wert angegeben ist. Dies kann verwendet werden, um Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen zu vermeiden.
`request.columns[].platformSource`	`string`	Die Plattform, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight".
`request.columns[].productReportPerspective`	`string`	Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte: „`sold`“: gibt Messwerte nur für verkaufte Produkte zurück "`advertised`": gibt Messwerte nur für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden oder nicht
`request.columns[].savedColumnName`	`string`	Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
`request.columns[].startDate`	`string`	Datum der Einbeziehung im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `endDate` angegeben werden.
`request.downloadFormat`	`string`	Format, in dem der Bericht zurückgegeben werden soll. Derzeit wird `csv` oder `tsv` unterstützt.
`request.filters[]`	`list`	Eine Liste der Filter, die auf den Bericht angewendet werden sollen. Pro Anfrage sind maximal 300 Filter zulässig.
`request.filters[].column`	`nested object`	Spalte, für die der Filter ausgeführt werden soll. Dies kann eine DoubleClick Search-Spalte oder eine gespeicherte Spalte sein.
`request.filters[].column.columnName`	`string`	Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll.
`request.filters[].column.customDimensionName`	`string`	Segmentiert einen Bericht nach einer benutzerdefinierten Dimension. Der Bericht muss sich auf einen Werbetreibenden oder eine niedrigere Ebene beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Beim Namen der benutzerdefinierten Dimension, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden. Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die entsprechende Conversion zurückgegeben (falls festgelegt). Der Conversion-Bericht wird in dieser Spalte nicht segmentiert.
`request.filters[].column.customMetricName`	`string`	Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss einem Werbetreibenden oder einer niedrigeren Ebene zugeordnet werden und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Beim Namen des benutzerdefinierten Messwerts, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden.
`request.filters[].column.endDate`	`string`	Tag der Inklusion im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `startDate` angegeben werden.
`request.filters[].column.groupByColumn`	`boolean`	Nur synchroner Bericht. Legen Sie `true` fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist `false`.
`request.filters[].column.headerText`	`string`	Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird wird standardmäßig `columnName` oder `savedColumnName` verwendet, wenn kein Wert angegeben ist. Dies kann verwendet werden, um Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen zu vermeiden.
`request.filters[].column.platformSource`	`string`	Die Plattform, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight".
`request.filters[].column.productReportPerspective`	`string`	Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte: „`sold`“: gibt Messwerte nur für verkaufte Produkte zurück "`advertised`": gibt Messwerte nur für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden oder nicht
`request.filters[].column.savedColumnName`	`string`	Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
`request.filters[].column.startDate`	`string`	Datum der Einbeziehung im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `endDate` angegeben werden.
`request.filters[].operator`	`string`	Operator, der im Filter verwendet werden soll. Eine Liste der verfügbaren Operatoren finden Sie in der Filterreferenz.
`request.filters[].values[]`	`list`	Eine Liste der Werte, nach denen der Spaltenwert gefiltert werden soll. Die maximale Anzahl von Filterwerten pro Anfrage beträgt 300.
`request.includeDeletedEntities`	`boolean`	Legt fest, ob entfernte Entitäten in den Bericht aufgenommen werden sollen. Die Standardeinstellung ist `false`. Eingestellt. Verwende stattdessen `includeRemovedEntities`.
`request.includeRemovedEntities`	`boolean`	Legt fest, ob entfernte Entitäten in den Bericht aufgenommen werden sollen. Die Standardeinstellung ist `false`.
`request.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`.
`request.orderBy[]`	`list`	Nur synchroner Bericht. Eine Liste der Spalten und Richtungen, mit denen die Sortierung der Berichtzeilen definiert wird. Die maximale Anzahl von Bestellungen pro Anfrage beträgt 300.
`request.orderBy[].column`	`nested object`	Spalte, für die die Sortierung durchgeführt werden soll. Dies kann eine von DoubleClick Search definierte oder eine gespeicherte Spalte sein.
`request.orderBy[].column.columnName`	`string`	Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll.
`request.orderBy[].column.customDimensionName`	`string`	Segmentiert einen Bericht nach einer benutzerdefinierten Dimension. Der Bericht muss sich auf einen Werbetreibenden oder eine niedrigere Ebene beziehen und die benutzerdefinierte Dimension muss bereits in DoubleClick Search eingerichtet sein. Beim Namen der benutzerdefinierten Dimension, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden. Bei Verwendung in einem Conversion-Bericht wird der Wert der angegebenen benutzerdefinierten Dimension für die entsprechende Conversion zurückgegeben (falls festgelegt). Der Conversion-Bericht wird in dieser Spalte nicht segmentiert.
`request.orderBy[].column.customMetricName`	`string`	Name eines benutzerdefinierten Messwerts, der in den Bericht aufgenommen werden soll. Der Bericht muss einem Werbetreibenden oder einer niedrigeren Ebene zugeordnet werden und der benutzerdefinierte Messwert muss bereits in DoubleClick Search eingerichtet sein. Beim Namen des benutzerdefinierten Messwerts, der in DoubleClick Search angezeigt wird, wird zwischen Groß- und Kleinschreibung unterschieden.
`request.orderBy[].column.endDate`	`string`	Tag der Inklusion im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `startDate` angegeben werden.
`request.orderBy[].column.groupByColumn`	`boolean`	Nur synchroner Bericht. Legen Sie `true` fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist `false`.
`request.orderBy[].column.headerText`	`string`	Text, mit dem diese Spalte in der Berichtsausgabe identifiziert wird wird standardmäßig `columnName` oder `savedColumnName` verwendet, wenn kein Wert angegeben ist. Dies kann verwendet werden, um Konflikte zwischen DoubleClick Search-Spalten und gespeicherten Spalten mit demselben Namen zu vermeiden.
`request.orderBy[].column.platformSource`	`string`	Die Plattform, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight".
`request.orderBy[].column.productReportPerspective`	`string`	Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte: „`sold`“: gibt Messwerte nur für verkaufte Produkte zurück "`advertised`": gibt Messwerte nur für Produkte zurück, die in einer Shopping-Kampagne beworben wurden und die möglicherweise verkauft wurden oder nicht
`request.orderBy[].column.savedColumnName`	`string`	Name einer gespeicherten Spalte, die in den Bericht aufgenommen werden soll. Der Bericht muss dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein und diese gespeicherte Spalte muss bereits in der DoubleClick Search-Benutzeroberfläche erstellt worden sein.
`request.orderBy[].column.startDate`	`string`	Datum der Einbeziehung im Format JJJJ-MM-TT. Sofern angegeben, wird damit der Gesamtzeitraum des Berichts für diese Spalte überschrieben. Muss zusammen mit `endDate` angegeben werden.
`request.orderBy[].sortOrder`	`string`	Die Sortierrichtung, entweder `ascending` oder `descending`.
`request.reportScope`	`object`	Der ReportScope besteht aus einer Reihe von IDs, mit denen festgelegt wird, welche Untergruppe von Entitäten im Bericht zurückgegeben wird. Es ist die vollständige Herkunft der IDs von der niedrigsten gewünschten Gültigkeitsebene bis zu der Agentur erforderlich.
`request.reportScope.adGroupId`	`long`	DS-Anzeigengruppen-ID.
`request.reportScope.adId`	`long`	DS-Anzeigen-ID.
`request.reportScope.advertiserId`	`long`	DS-Werbetreibenden-ID.
`request.reportScope.agencyId`	`long`	DS-Agentur-ID.
`request.reportScope.campaignId`	`long`	DS-Kampagnen-ID.
`request.reportScope.engineAccountId`	`long`	DS-Engine-Konto-ID.
`request.reportScope.keywordId`	`long`	DS-Keyword-ID.
`request.reportType`	`string`	Bestimmt die Art der Zeilen, 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 Spalten, die für die einzelnen Typen verfügbar sind.
`request.rowCount`	`integer`	Nur synchroner Bericht. Die maximale Anzahl der zurückzugebenden Zeilen; werden zusätzliche Zeilen entfernt. Zulässige Werte: `0` bis `10000`. Die Standardeinstellung ist `10000`.
`request.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`.
`request.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 für eine Agentur oder einen kleineren Bereich gilt), `advertiser` (gültig, wenn der Bericht für * Werbetreibenden oder einen kleineren Gültigkeitsbereich gilt) oder `account` (gültig, wenn der Bericht für ein Suchmaschinenkonto oder einen kleineren Gültigkeitsbereich gilt).
`request.timeRange`	`object`	Wenn in einem Bericht Messwerte angefordert werden, werden die Messwerte mit diesem Argument auf einen bestimmten Zeitraum beschränkt.
`request.timeRange.changedAttributesSinceTimestamp`	`datetime`	Eingeschlossener UTC-Zeitstempel im RFC-Format, z.B. `2013-07-16T10:16:23.555Z`. Hier finden Sie weitere Referenzen zur Funktionsweise von Berichten zu geänderten Attributen.
`request.timeRange.changedMetricsSinceTimestamp`	`datetime`	Eingeschlossener UTC-Zeitstempel im RFC-Format, z.B. `2013-07-16T10:16:23.555Z`. Hier finden Sie weitere Referenzen zur Funktionsweise von Berichten zu geänderten Messwerten.
`request.timeRange.endDate`	`string`	Datum der Einbeziehung im Format JJJJ-MM-TT.
`request.timeRange.startDate`	`string`	Datum der Einbeziehung im Format JJJJ-MM-TT.
`request.verifySingleTimeZone`	`boolean`	Bei `true` wird der Bericht nur erstellt, wenn alle angeforderten Statistikdaten aus derselben Zeitzone stammen. Die Standardeinstellung ist `false`.
`rowCount`	`integer`	Die Anzahl der vom Bericht generierten Berichtszeilen ohne Kopfzeilen.
`rows[]`	`list`	Nur synchroner Bericht. Generierte Berichtszeilen
`rows[].(key)`	`any value`	Gibt die Spalten an, die in dieser Zeile dargestellt werden. Das heißt, jeder Schlüssel entspricht einer Spalte mit einer nicht leeren Zelle in dieser Zeile.
`statisticsCurrencyCode`	`string`	Der Währungscode aller im Bericht erzeugten Geldwerte, einschließlich der von Nutzern festgelegten Werte (z.B. Einstellungen für Keyword-Gebote) und von Messwerten (z.B. Kosten und Umsatz). Der Währungscode eines Berichts wird im Feld `statisticsCurrency` der Berichtsanfrage festgelegt.
`statisticsTimeZone`	`string`	Wenn alle Statistiken des Berichts aus derselben Zeitzone stammen, wäre dies der Fall. Andernfalls wird das Feld nicht festgelegt.

Methoden

generieren: Es wird sofort ein Bericht erstellt und zurückgegeben.
get: Status einer Berichtsanfrage wird abgefragt.
getFile: Es wird eine Berichtsdatei mit UTF-8-Codierung heruntergeladen.
getIdMappingFile: Es wird eine in UTF-8 codierte CSV-Datei heruntergeladen, die ID-Zuordnungen zwischen der vorherigen und der neuen Search Ads 360-Version enthält. Für den angeforderten Werbetreibenden enthält die Datei alle untergeordneten Entitäten (z.B. Engine-Konten, Kampagnen, Anzeigengruppen usw.), die sowohl in der vorherigen als auch in der neuen Search Ads 360-Version vorhanden sind.
Anfrage: Fügt eine Berichtsanfrage in das Berichtssystem ein.