Modelo de Serviço de Relatório

O serviço de relatório contém as operações que você usa para enviar solicitações de relatório e consultar seu status. Os relatórios fornecem estatísticas detalhadas sobre contas, campanhas e grupos de anúncios do Microsoft Advertising. As informações podem ajudá-lo a controlar as finanças, medir o desempenho do anúncio e ajustar as configurações para otimizar seu orçamento ou campanha. Por exemplo, pode utilizar o relatório de desempenho de palavras-chave para ver quais as palavras-chave com um bom desempenho e as que não têm.

Visão geral do Reporting Service

Ao enviar uma solicitação de relatório, você escolhe os Atributos do Relatório e as Estatísticas de Desempenho para determinar o conteúdo do relatório. Por exemplo, pode querer incluir impressões, cliques e taxa de cliques. O relatório utiliza os nomes das colunas como os cabeçalhos das colunas. O relatório inclui as colunas na mesma ordem em que você as inclui no elemento Colunas da solicitação de relatório. Para obter informações sobre como as colunas afetam a saída de dados, consulte Colunas que agrupam os dados abaixo. Para obter informações sobre restrições em combinações de colunas na mesma solicitação de relatório, consulte Restrições de coluna abaixo.

Você também especificará os parâmetros de relatório que restringem ou limitam o conjunto de dados retornado. Por exemplo, você pode definir o nível de agregação para agrupar os dados por dia ou mês; Especificar o período de tempo dos dados a incluir no relatório utilizando datas específicas ou intervalos de datas predefinidos, como hoje ou os últimos sete dias; especificar o escopo dos dados, identificando as contas, campanhas e grupos de anúncios a serem incluídos no relatório; e definir critérios de filtragem para filtrar os dados do relatório. Para obter informações sobre períodos de tempo que você pode especificar para cada valor de agregação, consulte Agregação e Tempo abaixo.

Para obter uma lista de relatórios que você pode solicitar, consulte Tipos de relatório. Para obter uma lista completa dos parâmetros de relatório que você pode definir, consulte cada objeto de solicitação de relatório e o objeto base ReportRequest .

Para obter informações sobre como solicitar e baixar um relatório, consulte Solicitar e baixar um relatórioQuando o relatório for concluído com êxito, você poderá baixá-lo da URL retornada pelo serviço. O ficheiro de relatório é comprimido, pelo que tem de deszipar o ficheiro para ler o relatório. Não há limite para o número de relatórios que o sistema pode armazenar; No entanto, o período de tempo em que os relatórios são armazenados é indefinido. O serviço não verifica solicitações de relatório duplicadas.

Para obter informações sobre como o fuso horário afeta a disponibilidade do relatório, consulte Fusos horários em Relatório abaixo.

Report File Schema

Pode pedir dados de relatório Csv, Tsv ou Xml. Por padrão, se você não escolher outro formato , os dados baixados são separados por vírgulas (Csv).

"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 10:15:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 10:15:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 5"

"AccountId","CampaignId","Keyword","KeywordId","DeviceType","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","Computer","35"
"YourAccountId","YourCampaignId","red shoes","123","Smartphone","50"
"YourAccountId","YourCampaignId","shoes delivered","234","Computer","1"
"YourAccountId","YourCampaignId","shoe sale","345","Computer","80"
"YourAccountId","YourCampaignId","shoe sale","345","Smartphone","5"

"@2020 Microsoft Corporation. All rights reserved. "

Os seguintes metadados de cabeçalho do relatório são incluídos por predefinição. Se não quiser que o conjunto de metadados de cabeçalho, ExcludeReportHeader afirme verdadeiro.

Os nomes de coluna do relatório, por exemplo, "AccountId","CampaignId","Keyword","KeywordId","DeviceType","Clicks" são incluídos por predefinição. Se não quiser que as colunas do relatório definam ExcludeColumnHeaders para verdadeiro.

Os metadados do rodapé do relatório, por exemplo, @2020 Microsoft Corporation. Todos os direitos reservados. está incluído por predefinição. Se não quiser que os metadados de rodapé definam ExcludeReportFooter como verdadeiro.

Versão em formato de relatório

O formato de dados para determinados campos pode ser atualizado na versão atual da API sem interromper os aplicativos clientes existentes. Pode obter o formato de dados mais recente ao definir o campo de pedido opcional FormatVersion . A tabela abaixo resume a diferença entre o formato versão 1.0 e 2.0.

Colunas que agrupam os dados

As colunas de atributos incluídas num relatório afetam os valores nas colunas de estatística, bem como o número ou as linhas. Por exemplo, se você solicitar um relatório de resumo que inclua apenas AccountId, CampaignId, Keyword, KeywordId e Clicks, a coluna clicks conterá o número de cliques para a palavra-chave, independentemente dos atributos excluídos, como dispositivo, tipo de correspondência e rede.

"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 2:55:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 2:55:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 3"

"AccountId","CampaignId","Keyword","KeywordId","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","95"
"YourAccountId","YourCampaignId","shoes delivered","234","1"
"YourAccountId","YourCampaignId","shoe sale","345","98"

"@2020 Microsoft Corporation. All rights reserved. "

Se incluir a coluna DeviceType , o relatório conterá uma linha para cada combinação exclusiva de valores de palavra-chave e tipo de dispositivo e o valor na coluna de cliques de cada linha será dividido em conformidade.

"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 2:55:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 2:55:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 7"

"AccountId","CampaignId","Keyword","KeywordId","DeviceType","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","Computer","35"
"YourAccountId","YourCampaignId","red shoes","123","Smartphone","50"
"YourAccountId","YourCampaignId","red shoes","123","Tablet","10"
"YourAccountId","YourCampaignId","shoes delivered","234","Computer","1"
"YourAccountId","YourCampaignId","shoe sale","345","Computer","80"
"YourAccountId","YourCampaignId","shoe sale","345","Smartphone","5"
"YourAccountId","YourCampaignId","shoe sale","345","Tablet","13"

"@2020 Microsoft Corporation. All rights reserved. "

Para obter mais informações sobre cada tipo de coluna disponível, consulte Atributos de relatório e estatísticas de desempenho.

O atributo TimePeriod é necessário para a maioria dos relatórios, portanto, você também deve considerar que especificar um período de agregação mais granular, por exemplo, mensalmente no elemento de agregação da solicitação de relatório, dividiria ainda mais os dados de clique por mês. Por exemplo, o relatório conteria uma linha para cada combinação exclusiva de palavra-chave, dispositivo e mês. A linha só é incluída para os meses que contêm cliques.

Restrições de Coluna

Para relatórios que incluem colunas de estatísticas de desempenho de compartilhamento de impressões, não é possível incluir atributos restritos na mesma solicitação de relatório. Se você incluir qualquer uma das colunas de estatísticas de desempenho de compartilhamento de impressões, deverá excluir todas as colunas de atributo abaixo. Da mesma forma, se você incluir qualquer uma das colunas de atributo abaixo, deverá excluir todas as colunas de estatísticas de desempenho de compartilhamento de impressões.

As seguintes colunas de estatísticas de desempenho de compartilhamento de atributos e impressões são mutuamente exclusivas ao enviar AccountPerformanceReportRequest e AdGroupPerformanceReportRequest.

As seguintes colunas de estatísticas de desempenho de compartilhamento de atributos e impressões são mutuamente exclusivas ao enviar o CampaignPerformanceReportRequest.

Os seguintes atributos são restritos ao enviar o HotelDimensionPerformanceReportRequest.

Os seguintes atributos são restritos ao enviar o HotelGroupPerformanceReportRequest.

As seguintes colunas de estatísticas de desempenho de compartilhamento de atributos e impressões são mutuamente exclusivas ao enviar o ProductDimensionPerformanceReportRequest.

As seguintes colunas de estatísticas de desempenho de compartilhamento de atributos e impressões são mutuamente exclusivas ao enviar o ProductPartitionPerformanceReportRequest.

Coluna Período de Tempo

Se incluir a coluna PeríodoDeTempo , o formato dos valores no relatório transferido irá variar consoante o nível de agregação do relatório especificado no pedido de relatório. Por exemplo, se o nível de agregação for Diário, cada campo na coluna PeríodoDeTempo irá conter o dia formatado como aaaa-mm-dd.

Agregação e Tempo

Para a maioria dos pedidos de relatório, tem de definir os elementos Agregação e Tempo . Seguem-se os períodos de tempo que pode especificar para cada valor de agregação.

zero impressões

Os dados do relatório podem incluir linhas com zero impressões, caso a impressão tenha ocorrido antes do período de tempo solicitado e, em seguida, uma ação subsequente, como clique, conversão ou chamada telefónica, ocorra durante o período de tempo solicitado. Da mesma forma, mesmo dentro do período de tempo solicitado, se você baixar um relatório diário para desempenho na semana passada, é possível que todas as impressões ocorreram no domingo e, em seguida, cliques ou outro desempenho ocorreu, por exemplo, segunda ou terça-feira. Os dados do relatório de segunda ou terça-feira podem ter cliques com zero impressões. Pode utilizar o Serviço em Massa ou o Serviço de Gestão de Campanhas para obter todas as entidades na sua conta, independentemente de terem ou não dados de desempenho associados.

Fusos horários nos relatórios

Os dados do relatório transferido são sempre relativos à hora UTC. Por exemplo, um relatório de hora a hora pode atribuir 5 cliques a 7 horas. Nesse caso, os 5 cliques ocorreram entre as 07:00 e as 08:00 UTC.

O elemento de solicitação ReportTimeZone determina o fuso horário usado para estabelecer a data de hoje. Quando submete o pedido de relatório, a data de hoje pode variar em todo o mundo, dependendo do fuso horário. O período de tempo do relatório que escolher, por exemplo, "Ontem", é relativo à data de hoje. Se você não escolher um fuso horário, o serviço de relatório usará PacificTimeUSCanadaTijuana por padrão. Por exemplo, um relatório solicitado sem um fuso horário especificado às 2 da manhã EasternTimeUSCanada em 2/2/2020 para 'Ontem' será interpretado como um pedido para 31/01/2020. Um relatório solicitado ao mesmo tempo para 'Ontem' com fuso horário definido como EasternTimeUSCanada será interpretado como um pedido para 01/02/2020.

O elemento de solicitação ReturnOnlyCompleteData determina se o serviço deve ou não garantir que todos os dados foram processados e estão disponíveis. Se definido como true e se o sistema não tiver concluído o processamento de todos os dados com base na agregação, escopo e tempo solicitados, o serviço retornará o código de erro NoCompleteDataAvailable (2004). Caso contrário, por padrão, a solicitação pode ser bem-sucedida, não há indicação se os dados estão completos e o relatório conterá apenas os dados que o sistema terminou de processar no momento da solicitação. Embora o dia de hoje ainda esteja em progresso, pode obter os dados mais atuais ao não solicitar dados completos. Então, depois que os livros fecharem para o dia, você pode querer colocar essa bandeira verdadeira e olhar para trás para o que é agora "Ontem" e obter os dados finais do relatório.

Quando um usuário clica em um anúncio, pode levar até duas horas para que o sistema processe o clique (3 horas para conversões) e o disponibilize para relatórios. Os dados são geralmente considerados completos com livros fechados após 3 horas. Em alguns casos de exceção devido a tráfego inválido, podem ocorrer ajustes inesperados que podem levar uma semana ou mais para resolver. Por exemplo, se uma reclamação do anunciante identificar a atividade de clique inválido que escapou do sistema de filtragem automatizado, as equipes de Qualidade de Tráfego e suporte processarão um crédito para a conta do anunciante e farão parcerias com equipes internas para determinar se podem atualizar os sistemas automatizados para melhorar a detecção no futuro. Para obter mais informações, consulte o Centro de Qualidade de Tráfego.

Métricas Acreditadas MRC

A métrica de cliques em anúncios de busca é credenciada pelo Media Rating Council (MRC); Esta acreditação não se aplica a nenhuma outra métrica. Consulte a descrição da metodologia de medição por clique para obter mais informações.

See Also

Atributos do relatório e estatísticas de desempenho
Tipos de relatório
Pedir e transferir um relatório
Endereços de serviço Web da API Bing Ads