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, especifica "alt=csv" como parámetro de consulta. Pruébalo ahora.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/adsense/v1.4/reports
Parámetros
Nombre de parámetro | Valor | Descripción |
---|---|---|
Parámetros de consulta 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 de consulta opcionales | ||
accountId | string | Cuentas de las que se generará el informe. |
currency | string | Moneda opcional que se usará al informar de métricas monetarias. Se utiliza la moneda de la cuenta de forma predeterminada si no se ha configurado. |
dimension | string | Dimensiones en las que se basará el informe. Las dimensiones disponibles se describen en Métricas y dimensiones. Para obtener más detalles de cada una de las dimensiones, consulta el glosario de AdSense. |
filter | string | Filtros que se aplicarán al 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 | 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 que indica que no se admite la paginación después de la fila 5.000. Los valores aceptables son de 0 a 50000 , ambos incluidos. |
metric | string | Métricas en las que se basará el informe. Las métricas disponibles se describen en Métricas y dimensiones. Para obtener más detalles de cada una de las métricas, consulta el glosario de AdSense. |
sort | string | Nombre opcional de una dimensión o métrica por el que se ordenará el informe resultante. Opcionalmente, se puede anteponer "+" para clasificar en orden ascendente o "-" para clasificar en orden descendente. Si no se especifica ningún prefijo, la columna se clasifica en orden ascendente. |
startIndex | 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 que indica que no se admite la paginación después de la fila 5.000. Los valores aceptables son de 0 a 5000 , ambos incluidos. |
useTimezoneReporting | boolean | Especifica si el informe se debe generar en la zona horaria local de la cuenta de AdSense. Si es false, se usará la zona horaria PST/PDT predeterminada. |
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/adsense |
https://www.googleapis.com/auth/adsense.readonly |
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud con este método.
Respuesta
Si este método se realiza correctamente, el cuerpo de respuesta tendrá la siguiente estructura:
JSON
{ "kind": "adsense#report", "totalMatchedRows": long, "headers": [ { "name": string, "type": string, "currency": string } ], "rows": [ [ cadena ] ], "totals": [ cadena ], "averages": [ cadena ], "warnings": [ string ], "startDate": string, "endDate": string }
Nombre de propiedad | Valor | Descripción | Notas |
---|---|---|---|
kind | string | Indica el tipo, en este caso adsense#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: uno de DIMENSION, METRIC_TALLY, METRIC_RATIO o METRIC_CURRENCY. Los valores posibles son:
| |
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. | |
startDate | string | Fecha de inicio solicitada con el formato aaaa-mm-dd. | |
endDate | string | Fecha de finalización solicitada con el formato aaaa-mm-dd. |
CSV
"(dynamic)" (foreach) cadena (/foreach)
Nombre de propiedad | Valor | Descripción | Notas |
---|---|---|---|
(dynamic) | string |
Pruébalo
Utiliza el siguiente explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.