Operação de Serviço PollGenerateReport - Relatórios

Artigo
12/21/2023

Obtém o estado de um pedido de relatório.

Os relatórios são um processo assíncrono. Segue-se o fluxo geral para pedir um relatório.

Crie um pedido com os parâmetros do relatório. Não utilize o objeto ReportRequest . Em vez disso, tem de utilizar um dos objetos de pedido de relatório derivados, por exemplo CampaignPerformanceReportRequest. Para obter uma lista de relatórios, veja o guia Tipos de Relatório .
Envie um pedido para o serviço de relatórios, ou seja, através de SubmitGenerateReport.
O serviço coloca o pedido em fila até conseguir processá-lo
Consulte o serviço periodicamente para obter o estado da tarefa de relatório, ou seja, através de PollGenerateReport
Quando o estado do inquérito for Êxito, utilize o URL que o serviço fornece para transferir o relatório.

Para obter mais informações, veja o guia Pedir e Transferir um Relatório .

Nota

Tem de utilizar as mesmas credenciais de utilizador para SubmitGenerateReport e PollGenerateReport.

Elementos do Pedido

O objeto PollGenerateReportRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento	Descrição	Tipo de Dados
ReportRequestId	O identificador do pedido de relatório. A operação SubmitGenerateReport devolve o identificador. O identificador é válido durante um máximo de um dia. Se não tiver transferido o ficheiro com êxito neste período, este será removido do site de transferência e terá de obter um novo identificador de pedido de relatório. A cadeia tem um comprimento até 40 e pode conter qualquer caráter.	cadeia

Elementos do Cabeçalho do Pedido

Elemento	Descrição	Tipo de Dados
AuthenticationToken	O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).	cadeia
CustomerAccountId	O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
CustomerId	O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
DeveloperToken	O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador.	cadeia
Palavra-passe	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia
Nome de Utilizador	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia

Elementos de Resposta

O objeto PollGenerateReportResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento	Descrição	Tipo de Dados
ReportRequestStatus	Contém o estado do pedido de relatório e o URL de transferência.	ReportRequestStatus

Elementos do Cabeçalho de Resposta

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
    <Action mustUnderstand="1">PollGenerateReport</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <PollGenerateReportRequest xmlns="https://bingads.microsoft.com/Reporting/v13">
      <ReportRequestId i:nil="false">ValueHere</ReportRequestId>
    </PollGenerateReportRequest>
  </s:Body>
</s:Envelope>

Soap de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta SOAP.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <PollGenerateReportResponse xmlns="https://bingads.microsoft.com/Reporting/v13">
      <ReportRequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ReportDownloadUrl d4p1:nil="false">ValueHere</ReportDownloadUrl>
        <Status>ValueHere</Status>
      </ReportRequestStatus>
    </PollGenerateReportResponse>
  </s:Body>
</s:Envelope>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

public async Task<PollGenerateReportResponse> PollGenerateReportAsync(
	string reportRequestId)
{
	var request = new PollGenerateReportRequest
	{
		ReportRequestId = reportRequestId
	};

	return (await ReportingService.CallAsync((s, r) => s.PollGenerateReportAsync(r), request));
}

static PollGenerateReportResponse pollGenerateReport(
	java.lang.String reportRequestId) throws RemoteException, Exception
{
	PollGenerateReportRequest request = new PollGenerateReportRequest();

	request.setReportRequestId(reportRequestId);

	return ReportingService.getService().pollGenerateReport(request);
}

static function PollGenerateReport(
	$reportRequestId)
{

	$GLOBALS['Proxy'] = $GLOBALS['ReportingProxy'];

	$request = new PollGenerateReportRequest();

	$request->ReportRequestId = $reportRequestId;

	return $GLOBALS['ReportingProxy']->GetService()->PollGenerateReport($request);
}

response=reporting_service.PollGenerateReport(
	ReportRequestId=ReportRequestId)

Requisitos

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

Partilhar via