PollGenerateReport サービス操作 - レポート

[アーティクル]
10/04/2023

レポート要求の状態を取得します。

レポートは非同期プロセスです。レポートを要求するための一般的なフローを次に示します。

レポートパラメーターを使用して要求を作成します。 ReportRequest オブジェクトは使用しないでください。代わりに、いずれかの派生レポート要求オブジェクト ( CampaignPerformanceReportRequest など) を使用する必要があります。レポートの一覧については、「レポートの種類」ガイドを参照してください。
SubmitGenerateReport を使用して、レポートサービスに要求を送信します。
サービスは要求を処理できるようになるまでキューに入れます
サービスを定期的にポーリングして、レポートジョブの状態 (PollGenerateReport 経由) を取得します
ポーリングの状態が [成功] の場合は、サービスが提供する URL を使用してレポートをダウンロードします。

詳細については、「レポートの要求とダウンロード」ガイドを参照してください。

注:

SubmitGenerateReport と PollGenerateReport には、同じユーザー資格情報を使用する必要があります。

Request 要素

PollGenerateReportRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
ReportRequestId	レポート要求の識別子。 SubmitGenerateReport 操作は識別子を返します。識別子は最大 1 日有効です。この期間内にファイルが正常にダウンロードされていない場合は、ダウンロードサイトから削除され、新しいレポート要求識別子を取得する必要があります。文字列の長さは最大 40 で、任意の文字を含めることができます。	string

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
Customerid	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

PollGenerateReportResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
ReportRequestStatus	レポート要求の状態とダウンロード URL が含まれます。	ReportRequestStatus

応答ヘッダー要素

要素	説明	データ型
TrackingId	API 呼び出しの詳細を含むログエントリの識別子。	string

SOAP を要求する

このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。このサービス操作で使用できるサポートされる型については、上記の要求本文要素のリファレンスを参照してください。

<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

このテンプレートは、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>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

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)

要件

サービス: ReportingService.svc v13
名前空間： https://bingads.microsoft.com/Reporting/v13

次の方法で共有