Genera y muestra un informe de inmediato. Pruébalo ahora.
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Autorización
Esta solicitud requiere una autorización con el siguiente alcance:
Alcance |
---|
https://www.googleapis.com/auth/doubleclicksearch |
Para obtener más información, consulta la página de autenticación y autorización.
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporciona datos con la siguiente estructura:
{ "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 }
Nombre de la propiedad | Valor | Descripción | Notas |
---|---|---|---|
reportScope |
object |
El reportScope es un conjunto de ID que se usa para determinar qué subconjunto de entidades se mostrarán en el informe. Se requiere el linaje completo de los ID del nivel más bajo que se desee a través de la agencia. | |
reportScope.agencyId |
long |
ID de agencia de DS. | |
reportScope.advertiserId |
long |
ID del anunciante de DS. | |
reportScope.engineAccountId |
long |
ID de cuenta de motor de DS. | |
reportScope.campaignId |
long |
ID de campaña de DS. | |
reportScope.adGroupId |
long |
ID del grupo de anuncios de DS. | |
reportScope.keywordId |
long |
ID de palabra clave de DS. | |
reportScope.adId |
long |
ID del anuncio de DS. | |
reportType |
string |
Determina el tipo de filas que se muestran en el informe. Por ejemplo, si especificas reportType: keyword , cada fila del informe incluirá datos sobre una palabra clave. Consulta la referencia Tipos de informes para ver las columnas que están disponibles para cada tipo. |
|
columns[] |
list |
Las columnas que se incluirán en el informe. Esto incluye las columnas de DoubleClick Search y las columnas guardadas. Para las columnas de DoubleClick Search, solo se requiere el parámetro columnName . Para las columnas guardadas, solo se requiere el parámetro savedColumnName . columnName y savedColumnName no se pueden configurar en la misma estrofa. La cantidad máxima de columnas por solicitud es 300. |
|
columns[].columnName |
string |
Nombre de una columna de DoubleClick Search que se incluirá en el informe. | |
columns[].savedColumnName |
string |
Es el nombre de una columna guardada que se incluirá en el informe. El informe debe estar definido en el anunciante o en un nivel inferior, y esta columna guardada ya debe estar creada en la IU de DoubleClick Search. | |
columns[].headerText |
string |
Texto que se usa para identificar esta columna en el resultado del informe. Cuando no se especifica, el valor predeterminado es columnName o savedColumnName . Esto se puede utilizar para evitar conflictos entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre. |
|
columns[].startDate |
string |
Fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con endDate . |
|
columns[].endDate |
string |
Día inclusivo en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con startDate . |
|
columns[].groupByColumn |
boolean |
Solo informe síncrono Establécela en true para agrupar por esta columna. La configuración predeterminada es false . |
|
timeRange |
object |
Si se solicitan métricas en un informe, se usará este argumento para restringir las métricas a un intervalo de tiempo específico. | |
timeRange.startDate |
string |
Fecha inclusiva en formato AAAA-MM-DD. | |
timeRange.endDate |
string |
Fecha inclusiva en formato AAAA-MM-DD. | |
timeRange.changedMetricsSinceTimestamp |
datetime |
Marca de tiempo inclusiva en formato RFC (p.ej., 2013-07-16T10:16:23.555Z . Consulta referencias adicionales sobre cómo funcionan los informes de métricas modificadas. |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
Marca de tiempo inclusiva en formato RFC (p.ej., 2013-07-16T10:16:23.555Z . Consulte referencias adicionales sobre cómo funcionan los informes de atributos modificados. |
|
filters[] |
list |
Una lista de filtros que se aplicarán al informe. La cantidad máxima de filtros por solicitud es 300. |
|
filters[].column |
nested object |
Columna para realizar el filtro. Puede ser una columna de DoubleClick Search o una columna guardada. | |
filters[].column.columnName |
string |
Nombre de una columna de DoubleClick Search que se incluirá en el informe. | |
filters[].column.savedColumnName |
string |
Es el nombre de una columna guardada que se incluirá en el informe. El informe debe estar definido en el anunciante o en un nivel inferior, y esta columna guardada ya debe estar creada en la IU de DoubleClick Search. | |
filters[].operator |
string |
Operador que se usará en el filtro. Consulta la referencia de filtros para obtener una lista de los operadores disponibles. | |
filters[].values[] |
list |
Una lista de valores para filtrar el valor de la columna. La cantidad máxima de valores de filtro por solicitud es 300. |
|
orderBy[] |
list |
Solo informe síncrono Lista de columnas con instrucciones sobre cómo llegar que definen el orden que se realizará en las filas del informe. La cantidad máxima de pedidos por solicitud es de 300. |
|
orderBy[].column |
nested object |
Columna para realizar el ordenamiento. Puede ser una columna definida por DoubleClick Search o una columna guardada. | |
orderBy[].column.columnName |
string |
Nombre de una columna de DoubleClick Search que se incluirá en el informe. | |
orderBy[].column.savedColumnName |
string |
Es el nombre de una columna guardada que se incluirá en el informe. El informe debe estar definido en el anunciante o en un nivel inferior, y esta columna guardada ya debe estar creada en la IU de DoubleClick Search. | |
orderBy[].sortOrder |
string |
La dirección de orden, que es ascending o descending . |
|
includeDeletedEntities |
boolean |
Determina si se deben incluir las entidades quitadas en el informe. La configuración predeterminada es false . Este campo es obsoleto; utiliza includeRemovedEntities en su lugar. |
|
verifySingleTimeZone |
boolean |
Si es true , el informe solo se creará si todos los datos de estadísticas solicitados provienen de una sola zona horaria. La configuración predeterminada es false . |
|
downloadFormat |
string |
Formato en el que se debe mostrar el informe. Actualmente, se admite csv o tsv . |
|
statisticsCurrency |
string |
Especifica la moneda en la que se mostrará la moneda. Los valores posibles son: usd , agency (válido si el informe se limita a la agencia o a un nivel inferior), advertiser (válido si el alcance del informe es * anunciante o inferior) o account (válido si el informe tiene alcance en la cuenta del motor o inferior). |
|
startRow |
integer |
Solo informe síncrono Índice basado en cero de la primera fila que se mostrará. Los valores aceptables son 0 a 50000 , ambos inclusive. La configuración predeterminada es 0 . |
|
rowCount |
integer |
Solo informe síncrono La cantidad máxima de filas que se muestran; se quitan las filas adicionales. Los valores aceptables son 0 a 10000 , ambos inclusive. La configuración predeterminada es 10000 . |
|
maxRowsPerFile |
integer |
Solo informe asíncrono La cantidad máxima de filas por archivo de informe. Un informe de gran tamaño se divide en muchos archivos según este campo. Los valores aceptables son 1000000 a 100000000 , ambos inclusive. |
|
includeRemovedEntities |
boolean |
Determina si se deben incluir las entidades quitadas en el informe. La configuración predeterminada es false . |
|
columns[].customDimensionName |
string |
Segmente un informe por una dimensión personalizada. El informe debe estar definido para un anunciante o menos, y la dimensión personalizada ya debe estar configurada en DoubleClick Search. El nombre de la dimensión personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. Si se utiliza en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se establece. Esta columna no segmenta el informe de conversiones. |
|
columns[].platformSource |
string |
Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight". | |
filters[].column.customDimensionName |
string |
Segmente un informe por una dimensión personalizada. El informe debe estar definido para un anunciante o menos, y la dimensión personalizada ya debe estar configurada en DoubleClick Search. El nombre de la dimensión personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. Si se utiliza en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se establece. Esta columna no segmenta el informe de conversiones. |
|
filters[].column.headerText |
string |
Texto que se usa para identificar esta columna en el resultado del informe. Cuando no se especifica, el valor predeterminado es columnName o savedColumnName . Esto se puede utilizar para evitar conflictos entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre. |
|
filters[].column.startDate |
string |
Fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con endDate . |
|
filters[].column.endDate |
string |
Día inclusivo en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con startDate . |
|
filters[].column.groupByColumn |
boolean |
Solo informe síncrono Establécela en true para agrupar por esta columna. La configuración predeterminada es false . |
|
filters[].column.platformSource |
string |
Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight". | |
orderBy[].column.customDimensionName |
string |
Segmente un informe por una dimensión personalizada. El informe debe estar definido para un anunciante o menos, y la dimensión personalizada ya debe estar configurada en DoubleClick Search. El nombre de la dimensión personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. Si se utiliza en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se establece. Esta columna no segmenta el informe de conversiones. |
|
orderBy[].column.headerText |
string |
Texto que se usa para identificar esta columna en el resultado del informe. Cuando no se especifica, el valor predeterminado es columnName o savedColumnName . Esto se puede utilizar para evitar conflictos entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre. |
|
orderBy[].column.startDate |
string |
Fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con endDate . |
|
orderBy[].column.endDate |
string |
Día inclusivo en formato AAAA-MM-DD. Cuando se proporciona, anula el intervalo de tiempo general del informe solo para esta columna. Se debe proporcionar junto con startDate . |
|
orderBy[].column.groupByColumn |
boolean |
Solo informe síncrono Establécela en true para agrupar por esta columna. La configuración predeterminada es false . |
|
orderBy[].column.platformSource |
string |
Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight". | |
columns[].customMetricName |
string |
Nombre de una métrica personalizada que se incluirá en el informe. El informe debe estar definido en el alcance de un anunciante o un nivel inferior, y la métrica personalizada ya debe estar configurada en DoubleClick Search. El nombre de la métrica personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. | |
filters[].column.customMetricName |
string |
Nombre de una métrica personalizada que se incluirá en el informe. El informe debe estar definido en el alcance de un anunciante o un nivel inferior, y la métrica personalizada ya debe estar configurada en DoubleClick Search. El nombre de la métrica personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. | |
orderBy[].column.customMetricName |
string |
Nombre de una métrica personalizada que se incluirá en el informe. El informe debe estar definido en el alcance de un anunciante o un nivel inferior, y la métrica personalizada ya debe estar configurada en DoubleClick Search. El nombre de la métrica personalizada, que aparece en DoubleClick Search, distingue entre mayúsculas y minúsculas. | |
columns[].productReportPerspective |
string |
Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores:
|
|
filters[].column.productReportPerspective |
string |
Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores:
|
|
orderBy[].column.productReportPerspective |
string |
Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores:
|
Respuesta
Si se aplica correctamente, este método muestra un recurso de informes en el cuerpo de la respuesta.
Pruébela.
Usa el Explorador de API que aparece a continuación para llamar a este método en datos en vivo y ver la respuesta. También puedes probar el Explorador independiente.