Reports

Para obtener una lista de métodos para este recurso, consulta al final de esta página.

Representaciones de recursos

Un informe de DoubleClick Search Este objeto contiene la solicitud del informe, algunos metadatos del informe, como el código de moneda, y las filas o los archivos del informe generados.

{
  "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)
    }
  ]
}
Nombre de la propiedad Valor Descripción Notas
files[] list Solo informe asíncrono. Contiene una lista de los archivos de informe generados una vez que el informe se completa correctamente.
files[].byteCount long El tamaño de este archivo de informe en bytes.
files[].url string Use esta URL para descargar el archivo del informe.
id string Solo informe asíncrono. Es el ID del informe.
isReportReady boolean Solo informe asíncrono. Verdadero solo si el informe se completó correctamente y los archivos del informe están listos para descargarse.
kind string Lo identifica como recurso de informes. Valor: la cadena fija doubleclicksearch#report
request nested object La solicitud que creó el informe. Los campos opcionales no especificados en la solicitud original se completan con valores predeterminados.
request.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.
request.columns[].columnName string Es el nombre de la columna de DoubleClick Search que se incluirá en el informe.
request.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.
request.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.
request.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.
request.columns[].groupByColumn boolean Solo informe síncrono. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
request.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.
request.columns[].platformSource string Es la plataforma que se usa para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
request.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.
request.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.
request.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.
request.downloadFormat string Formato en el que se debe devolver el informe Actualmente, se admite csv o tsv.
request.filters[] list Una lista de los filtros que se aplicarán al informe.

La cantidad máxima de filtros por solicitud es 300.
request.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.
request.filters[].column.columnName string Es el nombre de una columna de DoubleClick Search que se incluirá en el informe.
request.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.
request.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.
request.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.
request.filters[].column.groupByColumn boolean Solo informe síncrono. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
request.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.
request.filters[].column.platformSource string Es la plataforma que se usa para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
request.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.
request.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.
request.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.
request.filters[].operator string Operador para usar en el filtro. Consulta la referencia de filtros para ver una lista de los operadores disponibles.
request.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.
request.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.
request.includeRemovedEntities boolean Determina si se deben incluir las entidades quitadas en el informe. La configuración predeterminada es false.
request.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.
request.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.
request.orderBy[].column nested object La columna en la que se ordenará. Puede ser una columna definida por DoubleClick Search o una columna guardada.
request.orderBy[].column.columnName string Es el nombre de una columna de DoubleClick Search que se incluirá en el informe.
request.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.
request.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.
request.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.
request.orderBy[].column.groupByColumn boolean Solo informe síncrono. Configúralo en true para agrupar según esta columna. La configuración predeterminada es false.
request.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.
request.orderBy[].column.platformSource string Es la plataforma que se usa para proporcionar datos para la dimensión personalizada. Los valores aceptables son "floodlight".
request.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.
request.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.
request.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.
request.orderBy[].sortOrder string La dirección de orden, que es ascending o descending.
request.reportScope object El reportScope es un conjunto de IDs que se usan para determinar qué subconjunto de entidades se mostrarán en el informe. Se requiere el linaje completo de IDs desde el nivel de alcance más bajo deseado hasta la agencia.
request.reportScope.adGroupId long ID del grupo de anuncios de DS.
request.reportScope.adId long ID del anuncio de DS.
request.reportScope.advertiserId long ID del anunciante de DS.
request.reportScope.agencyId long Es el ID de la agencia de DS.
request.reportScope.campaignId long ID de la campaña de DS.
request.reportScope.engineAccountId long ID de la cuenta de motor de DS.
request.reportScope.keywordId long ID de palabra clave de DS.
request.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 para conocer las columnas que están disponibles para cada tipo.
request.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.
request.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.
request.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 en relación con la 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).
request.timeRange object Si se solicitan métricas en un informe, este argumento se usa para restringirlas a un intervalo de tiempo específico.
request.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.
request.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.
request.timeRange.endDate string Es la fecha inclusiva en formato AAAA-MM-DD.
request.timeRange.startDate string Es la fecha inclusiva en formato AAAA-MM-DD.
request.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.
rowCount integer La cantidad de filas del informe que generó el informe, sin incluir los encabezados.
rows[] list Solo informe síncrono. Filas del informe generadas.
rows[].(key) any value Indica las columnas que están representadas en esta fila. Es decir, cada clave corresponde a una columna con una celda no vacía en esta fila.
statisticsCurrencyCode string Es el código de moneda de todos los valores monetarios del informe, incluidos los valores establecidos por los usuarios (p.ej., la configuración de la oferta de palabra clave) y las métricas (p.ej., ingresos y costos). El código de moneda de un informe se determina según el campo statisticsCurrency de la solicitud de informe.
statisticsTimeZone string Si todas las estadísticas del informe provienen de la misma zona horaria, serán estas. De lo contrario, el campo no se establece.

Métodos

generar
Genera y muestra un informe de inmediato.
get
Consulta el estado de una solicitud de denuncia.
getFile
Descarga un archivo de informe codificado en UTF-8.
getIdMappingFile
Descarga un archivo CSV (codificado en UTF-8) que contiene asignaciones de ID entre la experiencia anterior de Search Ads 360 y la nueva. Para el anunciante solicitado, el archivo incluye todas las entidades secundarias (p.ej., cuentas de motor, campañas, grupos de anuncios, etc.) que existen en la experiencia anterior de Search Ads 360 y en la nueva.
solicitud
Inserta una solicitud de informe en el sistema de informes.