Reporting PollGenerateReport Service Operation

Switch on low bandwidth view

Collapse All

Language Filter

Microsoft Advertising APIs

Gets the status of a report request.

Syntax

<wsdl:operation name="PollGenerateReport">
  <soap:operation soapAction="PollGenerateReport" style="document"/>
  <wsdl:input name="PollGenerateReportRequest">
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="ApplicationToken" use="literal"/>
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="CustomerAccountId" use="literal"/>
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="CustomerId" use="literal"/>
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="DeveloperToken" use="literal"/>
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="Password" use="literal"/>
    <soap:header message="tns:PollGenerateReportRequest_Headers" part="UserName" use="literal"/>
    <soap:body use="literal"/>
  </wsdl:input>
  <wsdl:output name="PollGenerateReportResponse">
    <soap:header message="tns:PollGenerateReportResponse_Headers" part="TrackingId" use="literal"/>
    <soap:body use="literal"/>
  </wsdl:output>
  <wsdl:fault name="ApiFaultDetailFault">
    <soap:fault name="ApiFaultDetailFault" use="literal"/>
  </wsdl:fault>
  <wsdl:fault name="AdApiFaultDetailFault">
    <soap:fault name="AdApiFaultDetailFault" use="literal"/>
  </wsdl:fault>
</wsdl:operation>

Request

A PollGenerateReportRequest object that contains the header and parameter information for the service operation.

Response

A PollGenerateReportResponse object that contains the response information for the service request.

Fault

If a Microsoft adCenter API error occurs, a FaultException exception is thrown. It contains one of the following objects:

For more information about fault detail objects, see Microsoft adCenter API Error Handling. For a list of reporting-specific error codes, see Reporting Error Codes. For a list of generic error codes, see Common Error Codes.

Example SOAP Request

The following is a fictitious example of a PollGenerateReportStatus request.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:AccountId xmlns:h="https://adcenter.microsoft.com/v6">accountid</h:AccountId>
    <h:ApplicationToken xmlns:h="https://adcenter.microsoft.com/v6">apptoken</h:ApplicationToken>
    <h:CustomerId xmlns:h="https://adcenter.microsoft.com/v6">customerid</h:CustomerId>
    <h:DeveloperToken xmlns:h="https://adcenter.microsoft.com/v6">devtoken</h:DeveloperToken>
    <h:Password xmlns:h="https://adcenter.microsoft.com/v6">password</h:Password>
    <h:UserName xmlns:h="https://adcenter.microsoft.com/v6">username</h:UserName>
  </s:Header>
  <s:Body>
    <PollGenerateReportRequest xmlns="https://adcenter.microsoft.com/v6">
      <ReportRequestId>XXXXX</ReportRequestId>
    </PollGenerateReportRequest>
  </s:Body>
</s:Envelope>

Example SOAP Response

The following is a fictitious example of a PollGenerateReportStatus response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:TrackingId xmlns:h="https://adcenter.microsoft.com/v6">XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</h:TrackingId>
  </s:Header>
  <s:Body>
    <PollGenerateReportResponse xmlns="https://adcenter.microsoft.com/v6">
      <ReportRequestStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <ReportDownloadUrl>XXXXX</ReportDownloadUrl>
        <Status>Success</Status>
      </ReportRequestStatus>
    </PollGenerateReportResponse>
  </s:Body>
</s:Envelope>

Remarks

Your API quota is affected by each call to this service operation, so you shouldn't call it very often. Depending on the expected size of the report and your own requirements, you should call this service operation in intervals as short as every few minutes to as long as once every hour. Use your own requirements and API quota allowance to determine how often you should call this service operation.

The downloaded report is compressed by using zip compression. You must unzip the report before you can use its contents.

For more information, see Request and Download a Report.

Requirements

WSDL: ReportingService.svc in version 6.

Reference

Reporting SubmitGenerateReport Service Operation

Concepts

Request and Download a Report
XML Report Examples