La API anterior de Search Ads 360 Reporting dejará de estar disponible y se retirará el 30 de junio de 2024. Ten en cuenta que la API de conversiones de Search Ads 360 no se ve afectada y seguirá siendo compatible. Todo el desarrollo de informes nuevo debe usar la nueva API de Search Ads 360 Reporting.

A partir de abril de 2024, se mostrará un error supportedApiVersion cuando se solicite un informe. Consulte los detalles aquí.

También te recomendamos que migres todas las implementaciones existentes de Search Ads 360 a la nueva API. Consulta la introducción y la guía de migración de la nueva API de Search Ads 360 Reporting para obtener más información.

Se usó la API de Cloud Translation para traducir esta página.

Reports

Si quieres obtener una lista de métodos para este recurso, consulta el final de esta página.

Representaciones de recursos

Un informe de DoubleClick Search Este objeto contiene la solicitud de informe, algunos metadatos del informe, como el código de la moneda, y las filas o informes del archivo que se generaron.

{
  "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
`files[]`	`list`	Solo informe asíncrono Contiene una lista de los archivos de informes generados una vez que el informe se completa correctamente.
`files[].byteCount`	`long`	El tamaño en bytes de este archivo de informe.
`files[].url`	`string`	Usa esta URL para descargar el archivo de informes.
`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 están listos para descargar.
`kind`	`string`	Se identifica como recurso de informe. Valor: la string fijada `doubleclicksearch#report`.
`request`	`nested object`	Es la solicitud que creó el informe. Los campos opcionales que no se especifican 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. 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.
`request.columns[].columnName`	`string`	Nombre de una columna de DoubleClick Search que se incluirá en el informe.
`request.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.
`request.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.
`request.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`.
`request.columns[].groupByColumn`	`boolean`	Solo informe síncrono Establécela en `true` para agrupar por esta columna. La configuración predeterminada es `false`.
`request.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.
`request.columns[].platformSource`	`string`	Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight".
`request.columns[].productReportPerspective`	`string`	Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores: "`sold`": Muestra métricas únicamente de los productos que se vendieron. "`advertised`": Muestra las métricas solo para los productos que se anunciaron en una campaña de Shopping y que se pueden haber vendido o no.
`request.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.
`request.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`.
`request.downloadFormat`	`string`	Formato en el que se debe mostrar el informe. Actualmente, se admite `csv` o `tsv`.
`request.filters[]`	`list`	Una lista de filtros que se aplicarán al informe. La cantidad máxima de filtros por solicitud es 300.
`request.filters[].column`	`nested object`	Columna para realizar el filtro. Puede ser una columna de DoubleClick Search o una columna guardada.
`request.filters[].column.columnName`	`string`	Nombre de una columna de DoubleClick Search que se incluirá en el informe.
`request.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.
`request.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.
`request.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`.
`request.filters[].column.groupByColumn`	`boolean`	Solo informe síncrono Establécela en `true` para agrupar por esta columna. La configuración predeterminada es `false`.
`request.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.
`request.filters[].column.platformSource`	`string`	Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight".
`request.filters[].column.productReportPerspective`	`string`	Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores: "`sold`": Muestra métricas únicamente de los productos que se vendieron. "`advertised`": Muestra las métricas solo para los productos que se anunciaron en una campaña de Shopping y que se pueden haber vendido o no.
`request.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.
`request.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`.
`request.filters[].operator`	`string`	Operador que se usará en el filtro. Consulta la referencia de filtros para obtener 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 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.
`request.orderBy[].column`	`nested object`	Columna para realizar el ordenamiento. Puede ser una columna definida por DoubleClick Search o una columna guardada.
`request.orderBy[].column.columnName`	`string`	Nombre de una columna de DoubleClick Search que se incluirá en el informe.
`request.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.
`request.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.
`request.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`.
`request.orderBy[].column.groupByColumn`	`boolean`	Solo informe síncrono Establécela en `true` para agrupar por esta columna. La configuración predeterminada es `false`.
`request.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.
`request.orderBy[].column.platformSource`	`string`	Es la plataforma que se usa para proporcionar datos de la dimensión personalizada. Los valores aceptables son "lightlight".
`request.orderBy[].column.productReportPerspective`	`string`	Muestra las métricas solo para un tipo específico de actividad del producto. Se aceptan estos valores: "`sold`": Muestra métricas únicamente de los productos que se vendieron. "`advertised`": Muestra las métricas solo para los productos que se anunciaron en una campaña de Shopping y que se pueden haber vendido o no.
`request.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.
`request.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`.
`request.orderBy[].sortOrder`	`string`	La dirección de orden, que es `ascending` o `descending`.
`request.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.
`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`	ID de agencia de DS.
`request.reportScope.campaignId`	`long`	ID de campaña de DS.
`request.reportScope.engineAccountId`	`long`	ID de 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 incluirá datos sobre una palabra clave. Consulta la referencia Tipos de informes para ver las columnas que están disponibles para cada tipo.
`request.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`.
`request.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`.
`request.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).
`request.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.
`request.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.
`request.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.
`request.timeRange.endDate`	`string`	Fecha inclusiva en formato AAAA-MM-DD.
`request.timeRange.startDate`	`string`	Fecha inclusiva en formato AAAA-MM-DD.
`request.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`.
`rowCount`	`integer`	Es la cantidad de filas de informes que genera el informe, sin incluir los encabezados.
`rows[]`	`list`	Solo informe síncrono Se generaron filas de informes.
`rows[].(key)`	`any value`	Indica las columnas que se representan 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 producidos en el informe, incluidos los valores que establecen los usuarios (p.ej., la configuración de las ofertas de palabra clave) y las métricas (p.ej., ingresos y costos). El campo `statisticsCurrency` de la solicitud de informe determina el código de moneda del informe.
`statisticsTimeZone`	`string`	Si todas las estadísticas del informe provienen de la misma zona horaria, esa sería la fuente. De lo contrario, no se configura el campo.

Métodos

generar: Genera y muestra un informe de inmediato.
obtener: Son encuestas sobre el estado de una solicitud de informe.
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.