Reports: generate

Requiere autorización

Genera un informe de AdSense basado en la solicitud de informe enviada en los parámetros de consulta. Devuelve el resultado como JSON; para recuperar la salida en formato CSV, especifique "alt=csv" como parámetro de consulta. Pruébelo ahora.

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/adsensehost/v4.1/reports

Parámetros

Nombre del parámetro Valor Descripción
Parámetros obligatorios
endDate string Final del periodo de informe, con el formato "AAAA-MM-DD", incluido.
startDate string Inicio del periodo de informe, con el formato "AAAA-MM-DD", incluido.
Parámetros opcionales
dimension string

Dimensiones en las que se basará el informe. Los parámetros disponibles son:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string Filtros que se van a ejecutar en el informe.
locale string Configuración regional opcional para traducir la salida del informe a un idioma local. Si no se especifica, se establecerá en en_US de forma predeterminada.
maxResults unsigned integer

Número máximo de filas de los datos de informe que se devolverán.

Si no se ha establecido startIndex o el valor es cero, la API devolverá tantas filas como se especifique mediante el valor maxResults. Si no se ha establecido maxResults, la API devolverá tantas filas como sea posible, hasta 50.000.

Si startIndex se ha establecido con un valor distinto de cero, la suma de startIndex y maxResults no puede ser mayor que 5.000; de lo contrario, se devolverá un error: no se admite la paginación después de la fila 5.000.

Los valores aceptables son de 0 a 50.000, ambos incluidos.
metric string Columnas numéricas que se incluirán en el informe. Las métricas disponibles son:
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

Nombre de una dimensión o métrica por el que se ordenará el informe resultante. Si se desea, se puede anteponer "+" para el orden ascendente o "-" para el orden descendente. Si no se especifica ningún prefijo, la columna se clasifica en orden ascendente.

Esta es la unión de los parámetros y los valores:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

Índice de la primera fila de los datos de informe que se devolverán.

Si no se ha establecido startIndex o el valor es cero, la API devolverá tantas filas como se especifique mediante el valor maxResults. Si no se ha establecido maxResults, la API devolverá tantas filas como sea posible, hasta 50.000.

Si startIndex se ha establecido con un valor distinto de cero, la suma de startIndex y maxResults no puede ser mayor que 5.000; de lo contrario, se devolverá un error: no se admite la paginación después de la fila 5.000.

Los valores aceptables son de 0 a 5.000, ambos incluidos.

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (más información sobre la autenticación y la autorización).

Alcance
https://www.googleapis.com/auth/adsensehost

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud con este método.

Respuesta

Si se realiza correctamente, este método devuelve un cuerpo de respuesta con la siguiente estructura:

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
Nombre de propiedad Valor Descripción Notas
kind string Indica el tipo, en este caso adsensehost#report.
totalMatchedRows long Número total de filas que coinciden con la solicitud del informe. Se pueden devolver menos filas en la respuesta debido a que están limitadas por el número de filas solicitadas en el límite de filas de informe.
headers[] list Información de encabezado de las columnas solicitadas en el informe. Se trata de una lista de encabezados; uno por cada parámetro de la solicitud, seguido por cada uno de los valores de la solicitud.
headers[].name string Nombre del encabezado.
headers[].type string Tipo del encabezado: DIMENSION, METRIC_TALLY, METRIC_RATIO o METRIC_CURRENCY.
headers[].currency string Moneda de esta columna. Solo aparece si el tipo de encabezado es METRIC_CURRENCY.
rows[] list Filas de salida del informe. Cada fila es una lista de las celdas, una para cada dimensión de la solicitud, seguida de una para cada métrica de la solicitud. Las celdas de la dimensión contienen cadenas, y las celdas de la métrica contienen números.
totals[] list Totales del informe. Tiene la misma longitud que cualquier otra fila del informe; las celdas correspondientes a las columnas de parámetro están vacías.
averages[] list Medias del informe. Tiene la misma longitud que cualquier otra fila del informe; las celdas correspondientes a las columnas de parámetro están vacías.
warnings[] list Advertencias asociadas a la generación del informe.

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
Nombre de propiedad Valor Descripción Notas
(dynamic)"> (dynamic) (any)

Pruébelo

Utilice el explorador de las API para llamar a este método con datos en tiempo real y ver la respuesta.