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 mit folgendem Bereich 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 }
Name der Eigenschaft | Wert | Beschreibung | Hinweise |
---|---|---|---|
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. | |
reportScope.agencyId |
long |
DS-Agentur-ID. | |
reportScope.advertiserId |
long |
DS-Werbetreibenden-ID. | |
reportScope.engineAccountId |
long |
DS-Engine-Konto-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 |
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. |
|
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. |
|
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 dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein 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 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. |
|
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. |
|
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. |
|
columns[].groupByColumn |
boolean |
Nur synchroner Bericht. Legen Sie true fest, um nach dieser Spalte zu gruppieren. Die Standardeinstellung ist false . |
|
timeRange |
object |
Wenn in einem Bericht Messwerte angefordert werden, werden die Messwerte mit diesem Argument auf einen bestimmten Zeitraum beschränkt. | |
timeRange.startDate |
string |
Datum der Einbeziehung im Format JJJJ-MM-TT. | |
timeRange.endDate |
string |
Datum der Einbeziehung im Format JJJJ-MM-TT. | |
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. |
|
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. |
|
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, für die der Filter ausgeführt 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 dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein 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 der Werte, nach denen der Spaltenwert gefiltert werden soll. Die maximale Anzahl von Filterwerten pro Anfrage beträgt 300. |
|
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. |
|
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. | |
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 dem Werbetreibenden oder einem kleineren Gültigkeitsbereich zugeordnet sein 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 in den Bericht aufgenommen werden sollen. Die Standardeinstellung ist false . Eingestellt. Verwende stattdessen includeRemovedEntities . |
|
verifySingleTimeZone |
boolean |
Bei true wird der Bericht nur erstellt, wenn alle angeforderten Statistikdaten aus derselben Zeitzone stammen. Die Standardeinstellung ist false . |
|
downloadFormat |
string |
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 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). |
|
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 der zurückzugebenden Zeilen; werden zusätzliche Zeilen entfernt. 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 in den Bericht aufgenommen werden sollen. Die Standardeinstellung ist false . |
|
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. |
|
columns[].platformSource |
string |
Die Plattform, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight". | |
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. |
|
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. |
|
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. |
|
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. |
|
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, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight". | |
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. |
|
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. |
|
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. |
|
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. |
|
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, über die Daten für die benutzerdefinierte Dimension bereitgestellt werden. Zulässige Werte sind "Flutlight". | |
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. | |
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. | |
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. | |
columns[].productReportPerspective |
string |
Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte:
|
|
filters[].column.productReportPerspective |
string |
Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte:
|
|
orderBy[].column.productReportPerspective |
string |
Gibt nur Messwerte für einen bestimmten Typ von Produktaktivität zurück. Zulässige Werte:
|
Antwort
Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine Ressource vom Typ „Berichte“ 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ändig Explorer: