Insere uma solicitação de relatório no sistema de relatórios. Faça o teste agora.
Solicitação
Solicitação HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports
Autorização
Esta solicitação requer autorização com o seguinte escopo:
Escopo |
---|
https://www.googleapis.com/auth/doubleclicksearch |
Para mais informações, consulte a página de autenticação e autorização.
Corpo da solicitação
No corpo da solicitação, forneça os dados com a seguinte estrutura:
{ "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 }
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
reportScope |
object |
O reportScope é um conjunto de IDs usados para determinar qual subconjunto de entidades será retornado no relatório. A linhagem completa de IDs do menor nível com escopo desejado pela agência é obrigatória. | |
reportScope.agencyId |
long |
ID da agência do DS. | |
reportScope.advertiserId |
long |
ID do anunciante do DS. | |
reportScope.engineAccountId |
long |
ID da conta de mecanismo do DS. | |
reportScope.campaignId |
long |
ID da campanha do DS. | |
reportScope.adGroupId |
long |
ID do grupo de anúncios do DS. | |
reportScope.keywordId |
long |
ID de palavra-chave do DS | |
reportScope.adId |
long |
ID do anúncio do DS. | |
reportType |
string |
Determina o tipo de linhas que são retornadas no relatório. Por exemplo, se você especificar reportType: keyword , cada linha do relatório terá dados sobre uma palavra-chave. Consulte a referência Tipos de relatórios para ver as colunas disponíveis para cada tipo. |
|
columns[] |
list |
As colunas a serem incluídas no relatório. Isso inclui colunas do DoubleClick Search e colunas salvas. Para colunas do DoubleClick Search, somente o parâmetro columnName é obrigatório. Para colunas salvas, apenas o parâmetro savedColumnName é obrigatório. Tanto columnName quanto savedColumnName não podem ser definidos na mesma estrofe. O número máximo de colunas por solicitação é 300. |
|
columns[].columnName |
string |
Nome de uma coluna do DoubleClick Search para incluir no relatório. | |
columns[].savedColumnName |
string |
Nome de uma coluna salva a ser incluída no relatório. O relatório precisa ter o escopo definido para o anunciante ou menos, e essa coluna salva já precisa ter sido criada na IU do DoubleClick Search. | |
columns[].headerText |
string |
Texto usado para identificar essa coluna na saída do relatório. Quando não especificado, o padrão é columnName ou savedColumnName . Isso pode ser usado para evitar colisões entre colunas do DoubleClick Search e colunas salvas com o mesmo nome. |
|
columns[].startDate |
string |
Data inclusiva no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com endDate . |
|
columns[].endDate |
string |
Dia inclusivo no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com startDate . |
|
columns[].groupByColumn |
boolean |
Apenas relatório síncrono. Defina como true para agrupar por essa coluna. O padrão é false . |
|
timeRange |
object |
Se as métricas forem solicitadas em um relatório, esse argumento será usado para restringir as métricas a um período específico. | |
timeRange.startDate |
string |
Data inclusiva no formato AAAA-MM-DD. | |
timeRange.endDate |
string |
Data inclusiva no formato AAAA-MM-DD. | |
timeRange.changedMetricsSinceTimestamp |
datetime |
Carimbo de data/hora inclusivo de UTC no formato RFC, por exemplo, 2013-07-16T10:16:23.555Z . Veja mais referências sobre como os relatórios de métricas alteradas funcionam. |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
Carimbo de data/hora inclusivo de UTC no formato RFC, por exemplo, 2013-07-16T10:16:23.555Z . Veja referências adicionais sobre como funcionam os relatórios de atributos alterados. |
|
filters[] |
list |
Uma lista de filtros a serem aplicados ao relatório. O número máximo de filtros por solicitação é 300. |
|
filters[].column |
nested object |
Coluna para executar o filtro. Pode ser uma coluna do DoubleClick Search ou uma coluna salva. | |
filters[].column.columnName |
string |
Nome de uma coluna do DoubleClick Search para incluir no relatório. | |
filters[].column.savedColumnName |
string |
Nome de uma coluna salva a ser incluída no relatório. O relatório precisa ter o escopo definido para o anunciante ou menos, e essa coluna salva já precisa ter sido criada na IU do DoubleClick Search. | |
filters[].operator |
string |
Operador a ser usado no filtro. Consulte a referência de filtro para ver uma lista de operadores disponíveis. | |
filters[].values[] |
list |
Uma lista de valores para filtrar o valor da coluna. O número máximo de valores de filtro por solicitação é 300. |
|
orderBy[] |
list |
Apenas relatório síncrono. Uma lista de colunas e rotas que definem a classificação a ser realizada nas linhas do relatório. O número máximo de pedidos por solicitação é 300. |
|
orderBy[].column |
nested object |
Coluna para realizar a classificação. Ela pode ser uma coluna definida pelo DoubleClick Search ou uma coluna salva. | |
orderBy[].column.columnName |
string |
Nome de uma coluna do DoubleClick Search para incluir no relatório. | |
orderBy[].column.savedColumnName |
string |
Nome de uma coluna salva a ser incluída no relatório. O relatório precisa ter o escopo definido para o anunciante ou menos, e essa coluna salva já precisa ter sido criada na IU do DoubleClick Search. | |
orderBy[].sortOrder |
string |
A direção da classificação, que é ascending ou descending . |
|
includeDeletedEntities |
boolean |
Determina se as entidades removidas devem ser incluídas no relatório. O valor padrão é false . Obsoleto. Use includeRemovedEntities . |
|
verifySingleTimeZone |
boolean |
Se for true , o relatório só será criado se todos os dados de estatísticas solicitados forem provenientes de um único fuso horário. O padrão é false . |
|
downloadFormat |
string |
Formato em que o relatório será retornado. Atualmente, há suporte para csv ou tsv . |
|
statisticsCurrency |
string |
Especifica a moeda em que o dinheiro será retornado. Os valores possíveis são: usd , agency (válido se o relatório estiver no escopo da agência ou inferior), advertiser (válido se o relatório estiver no escopo de * anunciante ou mais baixo) ou account (válido se o relatório estiver no escopo da conta de mecanismo ou inferior). |
|
startRow |
integer |
Apenas relatório síncrono. Índice baseado em zero da primeira linha a ser retornada. Os valores aceitáveis são de 0 a 50000 , inclusive. O valor padrão é 0 . |
|
rowCount |
integer |
Apenas relatório síncrono. O número máximo de linhas a serem retornadas. Outras linhas são descartadas. Os valores aceitáveis são de 0 a 10000 , inclusive. O valor padrão é 10000 . |
|
maxRowsPerFile |
integer |
Apenas para relatórios assíncronos. O número máximo de linhas por arquivo de relatório. Um relatório grande é dividido em vários arquivos com base nesse campo. Os valores aceitáveis são de 1000000 a 100000000 , inclusive. |
|
includeRemovedEntities |
boolean |
Determina se as entidades removidas devem ser incluídas no relatório. O valor padrão é false . |
|
columns[].customDimensionName |
string |
Segmenta um relatório por uma dimensão personalizada. É necessário definir o escopo do relatório para um anunciante ou menos, e a dimensão personalizada já precisa estar configurada no DoubleClick Search. O nome da dimensão personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. Se usada em um relatório de conversão, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definido. Esta coluna não segmenta o relatório de conversão. |
|
columns[].platformSource |
string |
A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight". | |
filters[].column.customDimensionName |
string |
Segmenta um relatório por uma dimensão personalizada. É necessário definir o escopo do relatório para um anunciante ou menos, e a dimensão personalizada já precisa estar configurada no DoubleClick Search. O nome da dimensão personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. Se usada em um relatório de conversão, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definido. Esta coluna não segmenta o relatório de conversão. |
|
filters[].column.headerText |
string |
Texto usado para identificar essa coluna na saída do relatório. Quando não especificado, o padrão é columnName ou savedColumnName . Isso pode ser usado para evitar colisões entre colunas do DoubleClick Search e colunas salvas com o mesmo nome. |
|
filters[].column.startDate |
string |
Data inclusiva no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com endDate . |
|
filters[].column.endDate |
string |
Dia inclusivo no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com startDate . |
|
filters[].column.groupByColumn |
boolean |
Apenas relatório síncrono. Defina como true para agrupar por essa coluna. O padrão é false . |
|
filters[].column.platformSource |
string |
A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight". | |
orderBy[].column.customDimensionName |
string |
Segmenta um relatório por uma dimensão personalizada. É necessário definir o escopo do relatório para um anunciante ou menos, e a dimensão personalizada já precisa estar configurada no DoubleClick Search. O nome da dimensão personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. Se usada em um relatório de conversão, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definido. Esta coluna não segmenta o relatório de conversão. |
|
orderBy[].column.headerText |
string |
Texto usado para identificar essa coluna na saída do relatório. Quando não especificado, o padrão é columnName ou savedColumnName . Isso pode ser usado para evitar colisões entre colunas do DoubleClick Search e colunas salvas com o mesmo nome. |
|
orderBy[].column.startDate |
string |
Data inclusiva no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com endDate . |
|
orderBy[].column.endDate |
string |
Dia inclusivo no formato AAAA-MM-DD. Quando fornecidas, elas substituem o período geral do relatório somente para essa coluna. Precisa ser fornecido com startDate . |
|
orderBy[].column.groupByColumn |
boolean |
Apenas relatório síncrono. Defina como true para agrupar por essa coluna. O padrão é false . |
|
orderBy[].column.platformSource |
string |
A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight". | |
columns[].customMetricName |
string |
Nome de uma métrica personalizada a ser incluída no relatório. É necessário definir o escopo do relatório para um anunciante ou um nível inferior, e a métrica personalizada já precisa estar configurada no DoubleClick Search. O nome da métrica personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. | |
filters[].column.customMetricName |
string |
Nome de uma métrica personalizada a ser incluída no relatório. É necessário definir o escopo do relatório para um anunciante ou um nível inferior, e a métrica personalizada já precisa estar configurada no DoubleClick Search. O nome da métrica personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. | |
orderBy[].column.customMetricName |
string |
Nome de uma métrica personalizada a ser incluída no relatório. É necessário definir o escopo do relatório para um anunciante ou um nível inferior, e a métrica personalizada já precisa estar configurada no DoubleClick Search. O nome da métrica personalizada, que aparece no DoubleClick Search, diferencia maiúsculas de minúsculas. | |
columns[].productReportPerspective |
string |
Retorna métricas apenas para um tipo específico de atividade de produto. Os valores aceitos são:
|
|
filters[].column.productReportPerspective |
string |
Retorna métricas apenas para um tipo específico de atividade de produto. Os valores aceitos são:
|
|
orderBy[].column.productReportPerspective |
string |
Retorna métricas apenas para um tipo específico de atividade de produto. Os valores aceitos são:
|
Resposta
Se for bem-sucedido, este método retornará um recurso Reports no corpo da resposta.
Confira!
Use o APIs Explorer abaixo para chamar esse método para dados ativos e ver a resposta. Se você preferir, teste o Explorador independente.