Reports: request

Inserta una solicitud de informe en el sistema de informes. Pruébalo ahora.

Solicitud

Solicitud HTTP

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

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 los 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 IDs que se usan para determinar qué subconjunto de entidades se mostrarán en el informe. El linaje completo de los IDs, desde el nivel de alcance más bajo deseado hasta la agencia, es obligatorio.
reportScope.agencyId long Es el ID de la agencia de DS.
reportScope.advertiserId long ID del anunciante de DS.
reportScope.engineAccountId long ID de la cuenta de motor de DS.
reportScope.campaignId long ID de la 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 contendrá datos sobre una palabra clave. Consulta la referencia de los tipos de informes a fin de conocer 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. En 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 establecer en la misma estrofa.

La cantidad máxima de columnas por solicitud es 300.

columns[].columnName string Es el nombre de la 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 limitarse al anunciante o a un nivel inferior, y esta columna guardada ya debe crearse en la IU de DoubleClick Search.
columns[].headerText string Texto que se utiliza para identificar esta columna en los resultados del informe El valor predeterminado es columnName o savedColumnName cuando no se especifica. Se puede utilizar para evitar colisiones entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre.
columns[].startDate string Es la fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, esto 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, esto 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. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
timeRange object Si se solicitan métricas en un informe, este argumento se usará para restringirlas a un intervalo de tiempo específico.
timeRange.startDate string Es la fecha inclusiva en formato AAAA-MM-DD.
timeRange.endDate string Es la fecha inclusiva en formato AAAA-MM-DD.
timeRange.changedMetricsSinceTimestamp datetime Marca de tiempo UTC inclusiva en formato RFC, p.ej., 2013-07-16T10:16:23.555Z. Consulta referencias adicionales sobre cómo funcionan los informes de métricas modificados.
timeRange.changedAttributesSinceTimestamp datetime Marca de tiempo UTC inclusiva en formato RFC, p.ej., 2013-07-16T10:16:23.555Z. Consulta referencias adicionales sobre el funcionamiento de los informes de atributos modificados.
filters[] list Una lista de los filtros que se aplicarán al informe.

La cantidad máxima de filtros por solicitud es 300.

filters[].column nested object La columna en la que se debe aplicar el filtro. Puede ser una columna de DoubleClick Search o una columna guardada.
filters[].column.columnName string Es el 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 limitarse al anunciante o a un nivel inferior, y esta columna guardada ya debe crearse en la IU de DoubleClick Search.
filters[].operator string Operador para usar en el filtro. Consulta la referencia de filtros para ver 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. Una lista de columnas y direcciones que definen la ordenación que se realizará en las filas del informe.

La cantidad máxima de pedidos por solicitud es 300.

orderBy[].column nested object La columna en la que se ordenará. Puede ser una columna definida por DoubleClick Search o una columna guardada.
orderBy[].column.columnName string Es el nombre de la 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 limitarse al anunciante o a un nivel inferior, y esta columna guardada ya debe crearse 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 estadísticos solicitados provienen de una única zona horaria. La configuración predeterminada es false.
downloadFormat string Formato en el que se debe devolver el informe Actualmente, se admite csv o tsv.
statisticsCurrency string Especifica la moneda en la que se devolverá el valor monetario. Los valores posibles son los siguientes: usd, agency (válido si el informe tiene alcance de agencia o un nivel inferior), advertiser (válido si el informe tiene alcance de * anunciante o un nivel inferior) o account (válido si el informe se aplica a la cuenta de motor o a un nivel inferior).
startRow integer Solo informe síncrono. Índice basado en cero de la primera fila que se muestra. 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 mostrarán; se descartan 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 Segmenta un informe según una dimensión personalizada. El informe debe limitarse a un anunciante o un nivel inferior, 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 mayúsculas de minúsculas.

Si se usa en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se configuró. Esta columna no segmenta el informe de conversiones.

columns[].platformSource string Es la plataforma que se usa para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
filters[].column.customDimensionName string Segmenta un informe según una dimensión personalizada. El informe debe limitarse a un anunciante o un nivel inferior, 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 mayúsculas de minúsculas.

Si se usa en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se configuró. Esta columna no segmenta el informe de conversiones.

filters[].column.headerText string Texto que se utiliza para identificar esta columna en los resultados del informe El valor predeterminado es columnName o savedColumnName cuando no se especifica. Se puede utilizar para evitar colisiones entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre.
filters[].column.startDate string Es la fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, esto 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, esto 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. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
filters[].column.platformSource string Es la plataforma que se utiliza para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
orderBy[].column.customDimensionName string Segmenta un informe según una dimensión personalizada. El informe debe limitarse a un anunciante o un nivel inferior, 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 mayúsculas de minúsculas.

Si se usa en un informe de conversiones, muestra el valor de la dimensión personalizada especificada para la conversión determinada, si se configuró. Esta columna no segmenta el informe de conversiones.

orderBy[].column.headerText string Texto que se utiliza para identificar esta columna en los resultados del informe El valor predeterminado es columnName o savedColumnName cuando no se especifica. Se puede utilizar para evitar colisiones entre las columnas de DoubleClick Search y las columnas guardadas con el mismo nombre.
orderBy[].column.startDate string Es la fecha inclusiva en formato AAAA-MM-DD. Cuando se proporciona, esto 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, esto 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. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
orderBy[].column.platformSource string Es la plataforma que se utiliza para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
columns[].customMetricName string Es el nombre de una métrica personalizada que se incluirá en el informe. El informe debe limitarse a 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 mayúsculas de minúsculas.
filters[].column.customMetricName string Es el nombre de una métrica personalizada que se incluirá en el informe. El informe debe limitarse a 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 mayúsculas de minúsculas.
orderBy[].column.customMetricName string Es el nombre de una métrica personalizada que se incluirá en el informe. El informe debe limitarse a 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 mayúsculas de minúsculas.
columns[].productReportPerspective string Devuelve métricas solo para un tipo específico de actividad de productos. Valores aceptados:
  • "sold": Devuelve métricas solo para los productos que se vendieron.
  • "advertised": Devuelve métricas solo para productos que se anunciaron en una campaña de Shopping y que podrían haberse vendido o no.
filters[].column.productReportPerspective string Devuelve métricas solo para un tipo específico de actividad de productos. Valores aceptados:
  • "sold": Devuelve métricas solo para los productos que se vendieron.
  • "advertised": Devuelve métricas solo para productos que se anunciaron en una campaña de Shopping y que podrían haberse vendido o no.
orderBy[].column.productReportPerspective string Devuelve métricas solo para un tipo específico de actividad de productos. Valores aceptados:
  • "sold": Devuelve métricas solo para los productos que se vendieron.
  • "advertised": Devuelve métricas solo para productos que se anunciaron en una campaña de Shopping y que podrían haberse vendido o no.

Respuesta

Si se aplica correctamente, este método muestra un recurso de informes en el cuerpo de la respuesta.

Pruébalo

Usa el Explorador de APIs que se muestra a continuación para llamar a este método en datos en vivo y ver la respuesta. También puedes probar la independiente del navegador.