BudgetSummaryReportRequest Data Object - Reporting

Artigo
12/21/2023

Define um pedido de relatório de resumo do orçamento. Utilize este relatório para descobrir o desempenho do orçamento da sua campanha para o mês. Por exemplo, o relatório mostra o seu orçamento mensal, quanto gastou até à data e se está na meta de gastar o seu orçamento mensal.

Pode pedir o seu orçamento mensal, quanto gastou até à data e se está no objetivo de gastar o seu orçamento mensal.

Para pedir um relatório deste tipo, transmita este objeto para a operação SubmitGenerateReport .

Sintaxe

<xs:complexType name="BudgetSummaryReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfBudgetSummaryReportColumn" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughCampaignReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elementos

O objeto BudgetSummaryReportRequest tem os seguintes elementos: Colunas, Âmbito, Tempo.

Elemento	Descrição	Tipo de Dados
Colunas	A lista de atributos e estatísticas de desempenho a incluir no relatório. O relatório incluirá as colunas pela ordem em que as especificar.	BudgetSummaryReportColumn array (Matriz BudgetSummaryReportColumn )
Âmbito	O âmbito da entidade do relatório. Utilize este elemento para limitar os dados do relatório a contas ou campanhas específicas.	AccountThroughCampaignReportScope
Hora	O período de tempo a utilizar para o relatório. Pode especificar um intervalo de datas personalizado ou selecionar um intervalo de datas predefinido, por exemplo, Hoje ou Este Mês. O relatório de resumo do orçamento é sempre agregado por dia. Pode definir o fuso horário no objeto ReportTime , o que o ajuda a definir com precisão os dados para o período de tempo pedido. Se não escolher um fuso horário, o serviço de Relatórios utiliza PacificTimeUSCanadaT cache por predefinição.	ReportTime

O objeto BudgetSummaryReportRequest tem Elementos Herdados.

Elementos Herdados

Elementos Herdados do ReportRequest

O objeto BudgetSummaryReportRequest deriva do objeto ReportRequest e herda os seguintes elementos: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. As descrições abaixo são específicas de BudgetSummaryReportRequest e podem não se aplicar a outros objetos que herdam os mesmos elementos do objeto ReportRequest .

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 estiver definido como verdadeiro e se o sistema não tiver concluído o processamento de todos os dados com base no Âmbito e Hora 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 (quer seja uma data personalizada ou predefinida) 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

Partilhar via