次の方法で共有

GetBulkDownloadStatus サービス操作 - 一括

  • [アーティクル]

一括ダウンロード要求の状態を取得します。

注:

ダウンロード要求操作 ( DownloadCampaignsByAccountIds または DownloadCampaignsByCampaignIds) と GetBulkDownloadStatus ポーリング操作に同じユーザー資格情報を使用する必要があります。

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
RequestId ダウンロード要求の識別子。

DownloadCampaignsByAccountIds および DownloadCampaignsByCampaignIds 操作は、この要素を DownloadRequestId として返します。

識別子は最大 2 日間有効です。 この期間内にファイルが正常にダウンロードされていない場合は、ダウンロード サイトから削除され、新しいダウンロード要求識別子を取得する必要があります。

文字列の長さは最大 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 要素

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

応答本文の要素

要素 説明 データ型
エラー ダウンロード要求の送信後に一括ファイルのシステム処理中に発生したエラーに対応する OperationError オブジェクトの配列。 OperationError 配列
ForwardCompatibilityMap 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。

今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、この操作の前方互換性の変更はありません。		 KeyValuePairOfstring 配列
PercentComplete 一括ダウンロード ファイルのシステム処理の進行状況の完了率。 int
RequestStatus ダウンロードの状態。 使用できる値は次のとおりです。

完了 - ダウンロードが正常に完了しました。

InProgress - ダウンロードが進行中です。

失敗 - ダウンロードに失敗しました。 品質スコアと入札候補のデータを含まない、少ないエンティティを含む新しいダウンロードを送信するか、後で同じダウンロードを送信してもう一度試すことができます。

FailedFullSyncRequired - 指定したアカウントがデータ移行に含まれていた場合など、要求の LastSyncTimeInUTC 要素を null に設定する必要があります。 完全なダウンロードを要求した後、差分ダウンロードの要求をもう一度開始できます。		 string
ResultFileUrl RequestStatus 値が Completed のときにダウンロード データを含む URL。

この URL が返された時点から 5 分後にファイルをダウンロードできます。 この期間内にダウンロードを開始しない場合は、 GetBulkDownloadStatus をもう一度呼び出して新しい URL を取得する必要があります。 変更される可能性があるため、ダウンロード URL のドメインに依存しないでください。

ダウンロード ファイルは圧縮 (zip 形式) であるため、データにアクセスするにはファイルを解凍する必要があります。

一括ファイル形式の詳細については、「 一括ファイル スキーマ」を参照してください。		 string

応答ヘッダー要素

要素 説明 データ型
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/CampaignManagement/v13">
    <Action mustUnderstand="1">GetBulkDownloadStatus</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>
    <GetBulkDownloadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RequestId i:nil="false">ValueHere</RequestId>
    </GetBulkDownloadStatusRequest>
  </s:Body>
</s:Envelope>

応答 SOAP

このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBulkDownloadStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Errors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <OperationError>
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <Message d4p1:nil="false">ValueHere</Message>
        </OperationError>
      </Errors>
      <ForwardCompatibilityMap xmlns:e143="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e143:KeyValuePairOfstringstring>
          <e143:key d4p1:nil="false">ValueHere</e143:key>
          <e143:value d4p1:nil="false">ValueHere</e143:value>
        </e143:KeyValuePairOfstringstring>
      </ForwardCompatibilityMap>
      <PercentComplete>ValueHere</PercentComplete>
      <RequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</RequestStatus>
      <ResultFileUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</ResultFileUrl>
    </GetBulkDownloadStatusResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetBulkDownloadStatusResponse> GetBulkDownloadStatusAsync(
	string requestId)
{
	var request = new GetBulkDownloadStatusRequest
	{
		RequestId = requestId
	};

	return (await BulkService.CallAsync((s, r) => s.GetBulkDownloadStatusAsync(r), request));
}

static GetBulkDownloadStatusResponse getBulkDownloadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkDownloadStatusRequest request = new GetBulkDownloadStatusRequest();

	request.setRequestId(requestId);

	return BulkService.getService().getBulkDownloadStatus(request);
}

static function GetBulkDownloadStatus(
	$requestId)
{

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

	$request = new GetBulkDownloadStatusRequest();

	$request->RequestId = $requestId;

	return $GLOBALS['BulkProxy']->GetService()->GetBulkDownloadStatus($request);
}

response=bulk_service.GetBulkDownloadStatus(
	RequestId=RequestId)

要件

サービス: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkDownloadStatus/Query

Request 要素

GetBulkDownloadStatusRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

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

要求本文要素

要素 説明 データ型
RequestId ダウンロード要求の識別子。

DownloadCampaignsByAccountIds および DownloadCampaignsByCampaignIds 操作は、この要素を DownloadRequestId として返します。

識別子は最大 2 日間有効です。 この期間内にファイルが正常にダウンロードされていない場合は、ダウンロード サイトから削除され、新しいダウンロード要求識別子を取得する必要があります。

文字列の長さは最大 40 で、任意の文字を含めることができます。		 string

要求ヘッダー要素

要素 説明 データ型
Authorization Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。

詳細については、「 OAuth による認証」を参照してください。		 string
CustomerAccountId 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。

詳細については、「 アカウントと顧客 ID を取得する」を参照してください。		 string
CustomerId ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。

詳細については、「 アカウントと顧客 ID を取得する」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
エラー ダウンロード要求の送信後に一括ファイルのシステム処理中に発生したエラーに対応する OperationError オブジェクトの配列。 OperationError 配列
ForwardCompatibilityMap 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。

今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、この操作の前方互換性の変更はありません。		 KeyValuePairOfstring 配列
PercentComplete 一括ダウンロード ファイルのシステム処理の進行状況の完了率。 int
RequestStatus ダウンロードの状態。 使用できる値は次のとおりです。

完了 - ダウンロードが正常に完了しました。

InProgress - ダウンロードが進行中です。

失敗 - ダウンロードに失敗しました。 品質スコアと入札候補のデータを含まない、少ないエンティティを含む新しいダウンロードを送信するか、後で同じダウンロードを送信してもう一度試すことができます。

FailedFullSyncRequired - 指定したアカウントがデータ移行に含まれていた場合など、要求の LastSyncTimeInUTC 要素を null に設定する必要があります。 完全なダウンロードを要求した後、差分ダウンロードの要求をもう一度開始できます。		 string
ResultFileUrl RequestStatus 値が Completed のときにダウンロード データを含む URL。

この URL が返された時点から 5 分後にファイルをダウンロードできます。 この期間内にダウンロードを開始しない場合は、 GetBulkDownloadStatus をもう一度呼び出して新しい URL を取得する必要があります。 変更される可能性があるため、ダウンロード URL のドメインに依存しないでください。

ダウンロード ファイルは圧縮 (zip 形式) であるため、データにアクセスするにはファイルを解凍する必要があります。

一括ファイル形式の詳細については、「 一括ファイル スキーマ」を参照してください。		 string

応答ヘッダー要素

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

JSON を要求する

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

{
  "RequestId": "ValueHere"
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

{
  "Errors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "Message": "ValueHere"
    }
  ],
  "ForwardCompatibilityMap": [
    {
      "key": "ValueHere",
      "value": "ValueHere"
    }
  ],
  "PercentComplete": IntValueHere,
  "RequestStatus": "ValueHere",
  "ResultFileUrl": "ValueHere"
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetBulkDownloadStatusResponse> GetBulkDownloadStatusAsync(
	string requestId)
{
	var request = new GetBulkDownloadStatusRequest
	{
		RequestId = requestId
	};

	return (await BulkService.CallAsync((s, r) => s.GetBulkDownloadStatusAsync(r), request));
}

static GetBulkDownloadStatusResponse getBulkDownloadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkDownloadStatusRequest request = new GetBulkDownloadStatusRequest();

	request.setRequestId(requestId);

	return BulkService.getService().getBulkDownloadStatus(request);
}

static function GetBulkDownloadStatus(
	$requestId)
{

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

	$request = new GetBulkDownloadStatusRequest();

	$request->RequestId = $requestId;

	return $GLOBALS['BulkProxy']->GetService()->GetBulkDownloadStatus($request);
}

response=bulk_service.GetBulkDownloadStatus(
	RequestId=RequestId)