ProductMatchCountReportRequest Data Object - Reporting

Artigo
12/21/2023

Define um pedido de relatório de contagem de correspondências de produtos que agrega os dados de desempenho por grupo de produtos durante um período de tempo especificado.

Pode incluir detalhes no relatório, tais como impressões, cliques e gastos que pode utilizar para ver se está a cobrir e a licitar no inventário de Campanhas comerciais da Microsoft. Tenha em atenção que isto apenas fornece os dados correspondentes para o nível atual do Grupo de Produtos e não pode obter vistas históricas.

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

Nota

Só deve utilizar este relatório para obter dados de desempenho das Campanhas comerciais da Microsoft. Não é aplicável a outros tipos de campanha.

Nota

Os dados de campanha máximos de desempenho não serão devolvidos se as colunas AdGroupName, AdGroupId, AdGroupStatus, AdId, AdStatus estiverem selecionadas e as colunas AssetGroupId, AssetGroupName, AssetGroupStatus, CampaignType não estiverem selecionadas.

Se as colunas AssetGroupId, AssetGroupName, AssetGroupStatus, CampaignType estiverem selecionadas, as colunas AdGroupName, AdGroupId, AdGroupStatus, AdId, AdStatus podem ser nulas para os dados da campanha Performance max.

Sintaxe

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

Elementos

O objeto ProductMatchCountReportRequest tem os seguintes elementos: Agregação, Colunas, Âmbito, Hora.

Elemento	Descrição	Tipo de Dados
Agregação	O tipo de agregação a utilizar para agregar os dados do relatório. Por exemplo, pode agregar os dados do relatório por dia ou semana ou pedir um relatório de resumo. A agregação predefinida é Resumo. É importante ter em atenção que, se não incluir o TimePeriod na lista de Colunas, a agregação que escolheu será ignorada e a Agregação de resumo será utilizada independentemente.	Agregação de Relatórios
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.	Matriz ProductMatchCountReportColumn
Âmbito	O âmbito da entidade do relatório. Utilize este elemento para limitar os dados do relatório a contas, grupos de anúncios ou campanhas específicas.	AccountThroughAdGroupReportScope
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 EstaSemana. Para obter uma lista dos períodos de tempo que pode especificar para cada tipo de agregação, veja Agregação e Hora.	ReportTime

O objeto ProductMatchCountReportRequest tem Elementos Herdados.

Elementos Herdados

Elementos Herdados do ReportRequest

O objeto ProductMatchCountReportRequest 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 ProductMatchCountReportRequest 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 na Agregação, Âmbito e Hora pedidas, 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