Muokkaa

Jaa

PollGenerateReport Service Operation - Reporting

  • Artikkeli

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.

Request Elements

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.

Request Body Elements

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

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

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.

Response Body Elements

Element Description Data Type
ReportRequestStatus Contains the status of the report request and the download URL. ReportRequestStatus

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

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>

Response SOAP

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>

Code Syntax

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)

Requirements

Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

Request Url

https://reporting.api.bingads.microsoft.com/Reporting/v13/GenerateReport/Poll

Request Elements

The PollGenerateReportRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

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

Request Header Elements

Element Description Data Type
Authorization The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

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 JSON.

Response Body Elements

Element Description Data Type
ReportRequestStatus Contains the status of the report request and the download URL. ReportRequestStatus

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "ReportRequestId": "ValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "ReportRequestStatus": {
    "ReportDownloadUrl": "ValueHere",
    "Status": "ValueHere"
  }
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.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)