title | ms.service | ms.subservice | ms.topic | author | ms.author | description | dev_langs | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
PollGenerateReport Service Operation - Reporting |
bing-ads |
reporting-api |
article |
jonmeyers |
jonmeyers |
Gets the status of a report request. |
|
Gets the status of a report request.
Reporting is an asynchronous process. The following is the general flow for requesting a report.
- Create a request with the report parameters. Do not use the ReportRequest object. Instead, you must use one of the derived report request objects, for example the CampaignPerformanceReportRequest. For a list of reports, see the Report Types guide.
- Send a request to the reporting service i.e., via SubmitGenerateReport.
- The service queues the request until it's able to process it
- Poll the service periodically to get the status of the report job i.e., via PollGenerateReport
- When the poll status is Success, use the URL that the service provides to download the report.
For more information, see the Request and Download a Report guide.
Note
You must use the same user credentials for the SubmitGenerateReport and PollGenerateReport.
The PollGenerateReportRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Element | Description | Data Type |
---|---|---|
ReportRequestId | The identifier of the report request. The SubmitGenerateReport operation returns the identifier. The identifier is valid for a maximum of one day. If you have not successfully downloaded the file within this period, it is removed from the download site and you will need to get a new report request identifier. The string has a length up to 40 and can contain any character. |
string |
[!INCLUDErequest-header]
The PollGenerateReportResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Element | Description | Data Type |
---|---|---|
ReportRequestStatus | Contains the status of the report request and the download URL. | ReportRequestStatus |
[!INCLUDEresponse-header]
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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>
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<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>
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)
Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13