Requer autorização
Gere um relatório do Google AdSense com base na solicitação de relatório enviada nos parâmetros da consulta. Retorna o resultado como JSON. Para recuperar a saída em formato CSV, especifique "alt=csv" como um parâmetro de consulta. Faça uma experiência.
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/adsensehost/v4.1/reports
Parâmetros
Nome do parâmetro | Valor | Descrição | ||
---|---|---|---|---|
Parâmetros exigidos | ||||
endDate |
string |
Fim do período do relatório no formato "AAAA-MM-DD", inclusive. | ||
startDate |
string |
Início do período do relatório no formato "AAAA-MM-DD", inclusive. | ||
Parâmetros opcionais | ||||
dimension |
string |
Dimensões que devem servir como base para o relatório. As dimensões disponíveis são:
|
||
filter |
string |
Filtros a serem aplicados ao relatório. | ||
locale |
string |
Localidade opcional a ser usada para traduzir a saída do relatório para um idioma local. O padrão será "en_US" se nada for especificado. | ||
maxResults |
unsigned integer |
O número máximo de linhas de dados do relatório a serem exibidas. Se Se 0 a 50.000 , inclusive.
|
||
metric |
string |
Colunas numéricas a serem incluídas no relatório. As métricas disponíveis são:
|
||
sort |
string |
O nome de uma dimensão ou métrica para classificação do relatório resultante, com a opção de ter o prefixo "+" para classificação em ordem crescente ou "-" para classificação em ordem decrescente. Se nenhum prefixo for especificado, a coluna será classificada na ordem crescente. Esta é a união de dimensões e métricas:
|
||
startIndex |
unsigned integer |
Índice da primeira linha dos dados do relatório a serem exibidos. Se Se 0 a 5.000 , inclusive.
|
Autorização
Essa solicitação requer autorização com pelo menos um dos seguintes escopos (mais informações sobre autenticação e autorização).
Escopo |
---|
https://www.googleapis.com/auth/adsensehost |
Corpo da solicitação
Não forneça um corpo de solicitação com esse método.
Resposta
Se bem sucedido, esse método retorna um corpo de resposta com a estrutura a seguir:
JSON
{ "kind": "adsensehost#report", "totalMatchedRows": long, "headers": [ { "name": string, "type": string, "currency": string } ], "rows": [ [ string ] ] "totals": [ string ] "averages": [ string ] "warnings": [ string ] }
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
kind |
string |
Tipo em questão, neste caso, adsensehost#report. | |
totalMatchedRows |
long |
O número total de linhas correspondidas pela solicitação de relatório. É possível que um número menor de linhas seja exibido na resposta devido à limitação imposta pela contagem de linhas solicitada ou pelo limite de linhas do relatório. | |
headers[] |
list |
As informações do cabeçalho das colunas solicitadas no relatório. Isso é uma lista de cabeçalhos. Um para cada dimensão na solicitação, seguido de um para cada métrica na solicitação. | |
headers[].name |
string |
O nome do cabeçalho. | |
headers[].type |
string |
O tipo do cabeçalho. Um entre DIMENSION, METRIC_TALLY, METRIC_RATIO ou METRIC_CURRENCY. | |
headers[].currency |
string |
A moeda dessa coluna. Só estará presente de o tipo de cabeçalho for METRIC_CURRENCY. | |
rows[] |
list |
As linhas de saída do relatório. Cada linha é uma lista de células, uma para cada dimensão da solicitação, seguida de uma para cada métrica da solicitação. As células de dimensão contêm strings, e as células de métrica contêm números. | |
totals[] |
list |
Os totais do relatório. Possui o mesmo tamanho que qualquer outra linha no relatório. As células correspondentes a colunas de dimensões ficam vazias. | |
averages[] |
list |
As médias do relatório. Possui o mesmo tamanho que qualquer outra linha no relatório. As células correspondentes a colunas de dimensões ficam vazias. | |
warnings[] |
list |
Quaisquer avisos associados à geração do relatório. |
CSV
"(dynamic)" (foreach) (value) (/foreach)
Nome da propriedade | Valor | Descrição | Observações | |
---|---|---|---|---|
(dynamic)"> | (dynamic) |
(any) |
Faça uma experiência.
Use o Explorador de APIs abaixo para chamar esse método em dados em tempo real e ver a resposta.