Partilhar via


Objeto de Dados ReportRequest - Relatórios

Define o objeto base para todos os pedidos de relatório.

Não instanciar este objeto. Em vez disso, pode instanciar um dos objetos de pedido de relatório que derivam deste objeto, por exemplo CampaignPerformanceReportRequest. Para obter uma lista de relatórios, veja o guia Tipos de Relatório .

Sintaxe

<xs:complexType name="ReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ExcludeColumnHeaders" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportFooter" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportHeader" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
    <xs:element minOccurs="0" name="FormatVersion" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>

Elementos

O objeto ReportRequest tem os seguintes elementos: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData.

Elemento Descrição Tipo de Dados
ExcludeColumnHeaders Determina se o relatório transferido deve ou não conter descrições de cabeçalho para cada coluna. O cabeçalho da coluna do relatório corresponde ao nome da coluna pedido, por exemplo , Impressões e Cliques.

Defina esta propriedade como true se pretender que os cabeçalhos das colunas do relatório sejam excluídos do relatório transferido. O valor predefinido é falso.
booleano
ExcludeReportFooter Determina se o relatório transferido deve ou não conter metadados de rodapé, como direitos de autor da Microsoft (@2020 Microsoft Corporation. Todos os direitos reservados.).

Defina esta propriedade como verdadeira se pretender que os metadados do rodapé do relatório sejam excluídos do relatório transferido. O valor predefinido é falso.
booleano
ExcludeReportHeader Determina se o relatório transferido deve ou não conter metadados de cabeçalho, como o nome do relatório, o intervalo de datas e a agregação.

Defina esta propriedade como verdadeira se pretender que os metadados do cabeçalho do relatório sejam excluídos do relatório transferido. O valor predefinido é falso.
booleano
Formatar O formato dos dados do relatório. Por exemplo, pode pedir os dados no formato de valores separados por vírgulas (Csv) ou no formato de valores separados por tabulações (Tsv).

O valor predefinido é Csv.

Todos os ficheiros transferidos são comprimidos por ZIP.
Formatar Relatório
FormatVersion Determina o formato de determinados campos no ficheiro de relatório transferido.

O formato de dados para determinados campos pode ser atualizado na versão atual da API sem interromper as aplicações cliente existentes. Pode obter o formato de dados mais recente ao definir este campo de pedido opcional como 2.0. Se não definir este campo, o serviço é predefinido para a versão 1.0.

Para obter detalhes sobre as alterações entre versões de formato, veja Versão do Formato do Relatório.
cadeia
ReportName O nome do relatório. O nome está incluído no cabeçalho do relatório. Se não especificar um nome de relatório, o sistema gera um nome no formulário ReportType-ReportDateTime.

O comprimento máximo do nome do relatório é 200.
cadeia
ReturnOnlyCompleteData Determina se o serviço tem ou não de garantir que todos os dados foram processados e estão disponíveis.

Se definido como verdadeiro e se o sistema não tiver concluído o processamento de todos os dados com base na agregação, no âmbito e no tempo pedidos, o serviço devolve o código de erro NoCompleteDataAvaliable (2004). Caso contrário, por predefinição, o pedido pode ser bem-sucedido, não existe nenhuma indicação sobre se os dados estão concluídos e o relatório conterá apenas os dados que o sistema concluiu o processamento no momento do pedido.

Tenha em atenção que, uma vez que hoje ainda está em curso e os dados não estão concluídos, não pode definir este elemento como verdadeiro se o período de tempo (seja personalizado ou predefinido) incluir a data atual. Para obter mais informações, veja Fusos Horários em Relatórios.
booleano

Requisitos

Serviço: ReportingService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Reporting/v13

Utilizado Por

SubmitGenerateReport