A API Search Ads 360 Reporting anterior será desativada em 30 de junho de 2024. A API Search Ads 360 Conversion não foi afetada e vai continuar compatível. Todo novo desenvolvimento de relatórios precisa usar a nova API Search Ads 360 Reporting.

A partir de abril de 2024, um erro supportedApiVersion será retornado ao solicitar um relatório. Veja os detalhes aqui.

Também é altamente recomendável migrar as implementações atuais do Search Ads 360 para a nova API. Consulte o Guia de introdução e o Guia de migração da nova API Search Ads 360 Reporting para saber mais informações.

Esta página foi traduzida pela API Cloud Translation.

Reports

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Um relatório do DoubleClick Search. Esse objeto contém a solicitação de relatório, alguns metadados de relatório, como o código da moeda, e as linhas ou arquivos de relatório gerados.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "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
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}

Nome da propriedade	Valor	Descrição
`files[]`	`list`	Somente relatórios assíncronos. Contém uma lista de arquivos de relatório gerados após a conclusão do relatório.
`files[].byteCount`	`long`	O tamanho desse arquivo de relatório em bytes.
`files[].url`	`string`	Use esse URL para fazer o download do arquivo de relatório.
`id`	`string`	Somente relatórios assíncronos. ID do relatório.
`isReportReady`	`boolean`	Somente relatórios assíncronos. Verdadeiro se, e somente se, o relatório for concluído e os arquivos estiverem prontos para download.
`kind`	`string`	Identifica isso como um recurso Relatório. Valor: a string fixa `doubleclicksearch#report`.
`request`	`nested object`	A solicitação que criou o relatório. Os campos opcionais não especificados na solicitação original são preenchidos com valores padrão.
`request.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 usados na mesma estrofe. O número máximo de colunas por solicitação é 300.
`request.columns[].columnName`	`string`	Nome de uma coluna do DoubleClick Search a ser incluída no relatório.
`request.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.
`request.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 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.
`request.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`.
`request.columns[].groupByColumn`	`boolean`	Somente relatório síncrono. Defina como `true` para agrupar por esta coluna. O padrão é `false`.
`request.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.
`request.columns[].platformSource`	`string`	A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight".
`request.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.
`request.columns[].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.
`request.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`.
`request.downloadFormat`	`string`	Formato em que o relatório deve ser retornado. Atualmente, há suporte para `csv` ou `tsv`.
`request.filters[]`	`list`	Uma lista dos filtros a serem aplicados ao relatório. O número máximo de filtros por solicitação é 300.
`request.filters[].column`	`nested object`	Coluna na qual executar o filtro. Pode ser uma coluna do DoubleClick Search ou uma coluna salva.
`request.filters[].column.columnName`	`string`	Nome de uma coluna do DoubleClick Search a ser incluída no relatório.
`request.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.
`request.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 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.
`request.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`.
`request.filters[].column.groupByColumn`	`boolean`	Somente relatório síncrono. Defina como `true` para agrupar por esta coluna. O padrão é `false`.
`request.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.
`request.filters[].column.platformSource`	`string`	A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight".
`request.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.
`request.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.
`request.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`.
`request.filters[].operator`	`string`	Operador a ser usado no filtro. Consulte a referência de filtro para ver uma lista de operadores disponíveis.
`request.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.
`request.includeDeletedEntities`	`boolean`	Determina se entidades removidas devem ser incluídas no relatório. O valor padrão é `false`. Obsoleto. Use `includeRemovedEntities`.
`request.includeRemovedEntities`	`boolean`	Determina se entidades removidas devem ser incluídas no relatório. O valor padrão é `false`.
`request.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.
`request.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.
`request.orderBy[].column`	`nested object`	Coluna na qual fazer a classificação. Pode ser uma coluna definida pelo DoubleClick Search ou salva.
`request.orderBy[].column.columnName`	`string`	Nome de uma coluna do DoubleClick Search a ser incluída no relatório.
`request.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.
`request.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.
`request.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`.
`request.orderBy[].column.groupByColumn`	`boolean`	Somente relatório síncrono. Defina como `true` para agrupar por esta coluna. O padrão é `false`.
`request.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.
`request.orderBy[].column.platformSource`	`string`	A plataforma usada para fornecer dados para a dimensão personalizada. Os valores aceitáveis são "Floodlight".
`request.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.
`request.orderBy[].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.
`request.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`.
`request.orderBy[].sortOrder`	`string`	A direção de classificação, que é `ascending` ou `descending`.
`request.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.
`request.reportScope.adGroupId`	`long`	ID do grupo de anúncios do DS.
`request.reportScope.adId`	`long`	ID do anúncio do DS.
`request.reportScope.advertiserId`	`long`	ID do anunciante do DS.
`request.reportScope.agencyId`	`long`	ID da agência do DS.
`request.reportScope.campaignId`	`long`	ID da campanha do DS.
`request.reportScope.engineAccountId`	`long`	ID da conta de mecanismo do DS.
`request.reportScope.keywordId`	`long`	ID de palavra-chave do DS.
`request.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.
`request.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`.
`request.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`.
`request.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).
`request.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.
`request.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.
`request.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.
`request.timeRange.endDate`	`string`	Data inclusiva no formato AAAA-MM-DD.
`request.timeRange.startDate`	`string`	Data inclusiva no formato AAAA-MM-DD.
`request.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`.
`rowCount`	`integer`	É o número de linhas geradas pelo relatório, sem incluir cabeçalhos.
`rows[]`	`list`	Somente relatório síncrono. Linhas geradas do relatório.
`rows[].(key)`	`any value`	Indica as colunas representadas nessa linha. Ou seja, cada chave corresponde a uma coluna com uma célula não vazia nessa linha.
`statisticsCurrencyCode`	`string`	O código de moeda de todos os valores monetários produzidos no relatório, incluindo valores que são definidos pelos usuários (por exemplo, configurações de lance de palavra-chave) e métricas (por exemplo, custo e receita). O código da moeda de um relatório é determinado pelo campo `statisticsCurrency` da solicitação de relatório.
`statisticsTimeZone`	`string`	Se todas as estatísticas do relatório provêm do mesmo fuso horário, essa é a fonte. Caso contrário, o campo não será definido.

Métodos

gerar: Gera e retorna um relatório imediatamente.
get: Pesquisas sobre o status de uma solicitação de relatório.
getFile: Faz o download de um arquivo de relatório codificado em UTF-8.
getIdMappingFile: Faz o download de um arquivo CSV (codificado em UTF-8) com mapeamentos de ID entre o antigo e o novo Search Ads 360. Para o anunciante solicitado, o arquivo inclui todas as entidades filhas (por exemplo, contas de mecanismo, campanhas, grupos de anúncios etc.) que existem no antigo e no novo Search Ads 360.
solicitação: Insere uma solicitação de relatório no sistema de relatórios.