Reports: request

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, desde o menor escopo desejado até a agência, é necessá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 retornadas no relatório. Por exemplo, se você especificar reportType: keyword, cada linha no relatório terá dados sobre uma palavra-chave. Consulte a referência Tipos de relatório para ver as colunas disponíveis para cada tipo.
columns[] list As colunas a serem incluídas no relatório. Isso inclui as colunas do DoubleClick Search e as colunas salvas. Para as colunas do DoubleClick Search, somente o parâmetro columnName é obrigatório. Para colunas salvas, apenas o parâmetro savedColumnName é obrigatório. columnName e savedColumnName não podem ser inseridos na mesma estrofe.

O número máximo de colunas por solicitação é 300.
columns[].columnName string Nome de uma coluna do DoubleClick Search a ser incluída no relatório.
columns[].savedColumnName string Nome de uma coluna salva para incluir no relatório. O relatório precisa ter o escopo do anunciante ou inferior, e essa coluna salva já precisa ter sido criada na interface do DoubleClick Search.
columns[].headerText string Texto usado para identificar essa coluna na saída do relatório. o padrão é columnName ou savedColumnName quando não é especificado. Isso pode ser usado para evitar colisões entre as colunas do DoubleClick Search e as colunas salvas com o mesmo nome.
columns[].startDate string Data inclusiva no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com endDate.
columns[].endDate string Dia inclusivo no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com startDate.
columns[].groupByColumn boolean Somente relatório síncrono. Defina como true para agrupar por esta 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 do UTC no formato RFC, por exemplo, 2013-07-16T10:16:23.555Z. Consulte outras referências sobre como os relatórios de métricas alteradas funcionam.
timeRange.changedAttributesSinceTimestamp datetime Carimbo de data/hora inclusivo do UTC no formato RFC, por exemplo, 2013-07-16T10:16:23.555Z. Confira outras referências sobre como os relatórios de atributos alterados funcionam.
filters[] list Uma lista dos filtros a serem aplicados ao relatório.

O número máximo de filtros por solicitação é 300.
filters[].column nested object Coluna na qual 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 a ser incluída no relatório.
filters[].column.savedColumnName string Nome de uma coluna salva para incluir no relatório. O relatório deve ter o escopo do anunciante ou inferior, e essa coluna salva já deve ter sido criada na interface 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 Somente relatório síncrono. Uma lista de colunas e direções que define a classificação a ser executada nas linhas do relatório.

O número máximo de ordenações por solicitação é 300.
orderBy[].column nested object Coluna na qual fazer a classificação. Pode ser uma coluna definida pelo DoubleClick Search ou salva.
orderBy[].column.columnName string Nome de uma coluna do DoubleClick Search a ser incluída no relatório.
orderBy[].column.savedColumnName string Nome de uma coluna salva para incluir no relatório. O relatório precisa ter o escopo do anunciante ou inferior, e essa coluna salva já precisa ter sido criada na interface do DoubleClick Search.
orderBy[].sortOrder string A direção de classificação, que é ascending ou descending.
includeDeletedEntities boolean Determina se entidades removidas devem ser incluídas no relatório. O valor padrão é false. Obsoleto. Use includeRemovedEntities.
verifySingleTimeZone boolean Se definido como true, o relatório só será criado se todos os dados estatísticos solicitados tiverem origem em um único fuso horário. O padrão é false.
downloadFormat string Formato em que o relatório deve ser retornado. Atualmente, há suporte para csv ou tsv.
statisticsCurrency string Especifica a moeda em que o valor monetário será retornado. Os valores possíveis são: usd, agency (válida se o relatório estiver no escopo da agência ou de um nível inferior), advertiser (válido se o escopo do relatório for * anunciante ou inferior) ou account (válido se o escopo do relatório for uma conta de mecanismo ou um nível inferior).
startRow integer Somente relatório síncrono. Índice baseado em zero da primeira linha a ser retornada. Os valores aceitos vão de 0 a 50000, inclusive. O valor padrão é 0.
rowCount integer Somente relatório síncrono. O número máximo de linhas a serem retornadas. linhas extras são descartadas. Os valores aceitos vão de 0 a 10000, inclusive. O valor padrão é 10000.
maxRowsPerFile integer Somente relatório assíncrono. O número máximo de linhas por arquivo de relatório. Um relatório grande é dividido em muitos arquivos com base nesse campo. Os valores aceitos vão de 1000000 a 100000000, inclusive.
includeRemovedEntities boolean Determina se 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. O relatório precisa ter um anunciante ou um escopo inferior, 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 usado em um relatório de conversões, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definida. Essa coluna não segmenta o relatório de conversões.
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. O relatório precisa ter um anunciante ou um escopo inferior, 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 usado em um relatório de conversões, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definida. Essa coluna não segmenta o relatório de conversões.
filters[].column.headerText string Texto usado para identificar essa coluna na saída do relatório. o padrão é columnName ou savedColumnName quando não é especificado. Isso pode ser usado para evitar colisões entre as colunas do DoubleClick Search e as colunas salvas com o mesmo nome.
filters[].column.startDate string Data inclusiva no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com endDate.
filters[].column.endDate string Dia inclusivo no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com startDate.
filters[].column.groupByColumn boolean Somente relatório síncrono. Defina como true para agrupar por esta 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. O relatório precisa ter um anunciante ou um escopo inferior, 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 usado em um relatório de conversões, retorna o valor da dimensão personalizada especificada para a conversão especificada, se definida. Essa coluna não segmenta o relatório de conversões.
orderBy[].column.headerText string Texto usado para identificar essa coluna na saída do relatório. o padrão é columnName ou savedColumnName quando não é especificado. Isso pode ser usado para evitar colisões entre as colunas do DoubleClick Search e as colunas salvas com o mesmo nome.
orderBy[].column.startDate string Data inclusiva no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com endDate.
orderBy[].column.endDate string Dia inclusivo no formato AAAA-MM-DD. Quando fornecido, substitui o intervalo de tempo geral do relatório somente para esta coluna. Precisa ser fornecido com startDate.
orderBy[].column.groupByColumn boolean Somente relatório síncrono. Defina como true para agrupar por esta 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. O relatório precisa ter como escopo 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. O relatório precisa ter como escopo 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. O relatório precisa ter como escopo um anunciante ou um escopo 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 somente para um tipo específico de atividade do produto. Os valores aceitos são:
  • "sold": retorna métricas apenas para os produtos que foram vendidos
  • "advertised": retorna métricas somente para produtos que foram anunciados em uma campanha do Shopping e que podem ou não ter sido vendidos.
filters[].column.productReportPerspective string Retorna métricas somente para um tipo específico de atividade do produto. Os valores aceitos são:
  • "sold": retorna métricas apenas para os produtos que foram vendidos
  • "advertised": retorna métricas somente para produtos que foram anunciados em uma campanha do Shopping e que podem ou não ter sido vendidos.
orderBy[].column.productReportPerspective string Retorna métricas somente para um tipo específico de atividade do produto. Os valores aceitos são:
  • "sold": retorna métricas apenas para os produtos que foram vendidos
  • "advertised": retorna métricas somente para produtos que foram anunciados em uma campanha do Shopping e que podem ou não ter sido vendidos.

Resposta

Se for bem-sucedido, esse 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. Como alternativa, teste o Explorador independente.