Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.
Ressourcendarstellungen
Ein DoubleClick Search-Bericht. Dieses Objekt enthält die Berichtsanfrage, einige Berichtmetadaten wie den Währungscode sowie 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) } ] }
Attributname | Wert | Beschreibung | Hinweise |
---|---|---|---|
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. 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 sind, werden mit Standardwerten ausgefüllt. | |
request.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. |
|
request.columns[].columnName |
string |
Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll | |
request.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. |
|
request.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. | |
request.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. |
|
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. 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. |
|
request.columns[].platformSource |
string |
Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“. | |
request.columns[].productReportPerspective |
string |
Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
|
|
request.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. | |
request.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. |
|
request.downloadFormat |
string |
Das 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, auf die der Filter angewendet 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 |
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. |
|
request.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. | |
request.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. |
|
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. 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. |
|
request.filters[].column.platformSource |
string |
Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“. | |
request.filters[].column.productReportPerspective |
string |
Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
|
|
request.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. | |
request.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. |
|
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 von Werten, nach denen der Spaltenwert gefiltert werden soll. Die maximale Anzahl von Filterwerten pro Anfrage ist 300. |
|
request.includeDeletedEntities |
boolean |
Legt fest, ob entfernte Entitäten im Bericht enthalten sein sollen. Die Standardeinstellung ist false . Eingestellt. Verwende stattdessen includeRemovedEntities . |
|
request.includeRemovedEntities |
boolean |
Legt fest, ob entfernte Entitäten im Bericht enthalten sein 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 für die Berichtszeilen definiert wird. Die maximale Anzahl von Bestellungen pro Anfrage beträgt 300. |
|
request.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. | |
request.orderBy[].column.columnName |
string |
Name einer DoubleClick Search-Spalte, die in den Bericht aufgenommen werden soll | |
request.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. |
|
request.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. | |
request.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. |
|
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. 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. |
|
request.orderBy[].column.platformSource |
string |
Die Plattform, auf der Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind „Flutlicht“. | |
request.orderBy[].column.productReportPerspective |
string |
Gibt nur Messwerte für eine bestimmte Art von Produktaktivität zurück. Zulässige Werte:
|
|
request.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. | |
request.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. |
|
request.orderBy[].sortOrder |
string |
Die Sortierrichtung, entweder ascending oder descending . |
|
request.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. | |
request.reportScope.adGroupId |
long |
DS-Anzeigengruppen-ID. | |
request.reportScope.adId |
long |
DS-Anzeigen-ID. | |
request.reportScope.advertiserId |
long |
ID des DS-Werbetreibenden | |
request.reportScope.agencyId |
long |
DS-Agentur-ID. | |
request.reportScope.campaignId |
long |
DS-Kampagnen-ID. | |
request.reportScope.engineAccountId |
long |
DS-Suchmaschinenkonto-ID. | |
request.reportScope.keywordId |
long |
DS-Keyword-ID | |
request.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. |
|
request.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 . |
|
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 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). |
|
request.timeRange |
object |
Wenn Messwerte in einem Bericht angefordert werden, wird dieses Argument verwendet, um die Messwerte auf einen bestimmten Zeitraum zu beschränken. | |
request.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 |
|
request.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 |
|
request.timeRange.endDate |
string |
Inklusives Datum im Format JJJJ-MM-TT. | |
request.timeRange.startDate |
string |
Inklusives Datum im Format JJJJ-MM-TT. | |
request.verifySingleTimeZone |
boolean |
Wenn true , wird der Bericht nur erstellt, wenn alle angeforderten Statistikdaten aus einer einzelnen Zeitzone stammen. Die Standardeinstellung ist false . |
|
rowCount |
integer |
Die Anzahl der vom Bericht generierten Berichtszeilen, ohne Header. | |
rows[] |
list |
Nur synchroner Bericht Generierte Berichtszeilen. | |
rows[].(key) |
any value |
Gibt die Spalten an, die in dieser Zeile enthalten sind. Das heißt, jeder Schlüssel entspricht einer Spalte in dieser Zeile, die nicht leer ist. | |
statisticsCurrencyCode |
string |
Der Währungscode aller im Bericht erzeugten Geldwerte, einschließlich von Nutzern festgelegter Werte (z.B. Keyword-Gebotseinstellungen) und Messwerten (z.B. Kosten und Umsatz). Der Währungscode eines Berichts wird durch das Feld statisticsCurrency der Berichtsanfrage bestimmt. |
|
statisticsTimeZone |
string |
Wenn alle Statistiken des Berichts aus derselben Zeitzone stammen, wäre es das. Andernfalls ist das Feld nicht festgelegt. |
Methoden
- Generieren
- Es wird sofort ein Bericht erstellt und zurückgegeben.
- erhalten
- Umfragen zum Status einer Berichtsanfrage
- getFile
- Laden Sie eine in UTF-8 codierte Berichtsdatei herunter.
- getIdMappingFile
- Es wird eine CSV-Datei (in UTF-8 codiert) 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 Elemente (z.B. Engine-Konten, Kampagnen, Anzeigengruppen usw.), die sowohl in der vorherigen Search Ads 360-Version als auch in der neuen Search Ads 360-Version vorhanden sind.
- Anfrage
- Fügt eine Berichtsanfrage in das Berichtssystem ein.