GetBulkUploadStatus サービス操作 - 一括

[アーティクル]
11/14/2024

一括アップロード要求の状態と完了の進行状況を取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
RequestId	アップロード要求の識別子。識別子は最大 15 分間有効です。この期間内にファイルが正常にアップロードされていない場合は、新しい要求識別子とアップロード URL を取得する必要があります。	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 要素

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

応答本文の要素

要素	説明	データ型
エラー	HTTP POST のアップロードが完了した後、一括ファイルのシステム処理中に発生したエラーに対応する OperationError オブジェクトの配列。たとえば、アップロードされたファイルに対応するファイル形式バージョンでサポートされていない 1 つ以上の一括レコードが含まれている場合、 OperationError には BulkServiceFormatVersionNotSupported エラーコードが含まれます。	OperationError 配列
ForwardCompatibilityMap	現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。今後のリリースでは、今後の互換性の変更に関するページを参照してください。現在、この操作の前方互換性の変更はありません。	KeyValuePairOfstring 配列
PercentComplete	アップロードされた一括ファイルのシステム処理の進行状況完了率。値の範囲は 0 ~ 100 です。アップロードの状態も比較する必要があります。アップロードが失敗した場合、完了率はゼロ (0) にリセットされます。	int
RequestStatus	アップロードの状態。返される可能性のある状態値を次に示します。完了 - アップロードファイルが受け入れられ、エラーなしで正常に処理されました。 CompletedWithErrors - 1 つ以上のエラーでアップロードが完了しました。全体的なアップロードが成功した間に、1 つ以上の追加または更新エラーが発生した可能性があります。ベストプラクティスとして、GetBulkUploadUrl を呼び出すときに ResponseMode 要素を介してエラー情報を要求し、エラーに対して ResultFileUrl をチェックする必要があります。失敗 - 予期しないエラーが発生したため、アップロード全体が失敗しました。エンティティ数が少ない新しいアップロードを送信するか、後で同じアップロードを再送信してみてください。 FileUploaded - アップロード要求が受信され、処理のためにキューに入っています。 InProgress - アップロードファイルが受け入れられ、アップロードが進行中です。 PendingFileUpload - 対応する RequestId のアップロードファイルが受信されていません。 UploadFileRowCountExceeded - アップロードファイル内の一括レコードの制限を超えました。制限とアップロードのベストプラクティスの詳細については、「一括アップロード」を参照してください。 UploadFileFormatNotSupported - アップロードで指定された [バージョン名の書式設定] フィールドは、このバージョンの Bulk API ではサポートされていません。	string
ResultFileUrl	アップロードエラー情報など、要求された結果を含むファイルの URL。この URL は、GetBulkUploadStatus 操作が Completed または CompletedWithErrors 状態の応答文字列を返す 5 分以内に使用する必要があります。この期間内にダウンロードを開始しない場合は、 GetBulkUploadStatus をもう一度呼び出して新しい URL を取得する必要があります。変更される可能性があるため、ダウンロード URL のドメインに依存しないでください。	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">GetBulkUploadStatus</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>
    <GetBulkUploadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RequestId i:nil="false">ValueHere</RequestId>
    </GetBulkUploadStatusRequest>
  </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>
    <GetBulkUploadStatusResponse 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:e145="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e145:KeyValuePairOfstringstring>
          <e145:key d4p1:nil="false">ValueHere</e145:key>
          <e145:value d4p1:nil="false">ValueHere</e145:value>
        </e145: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>
    </GetBulkUploadStatusResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
	string requestId)
{
	var request = new GetBulkUploadStatusRequest
	{
		RequestId = requestId
	};

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

static GetBulkUploadStatusResponse getBulkUploadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();

	request.setRequestId(requestId);

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

static function GetBulkUploadStatus(
	$requestId)
{

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

	$request = new GetBulkUploadStatusRequest();

	$request->RequestId = $requestId;

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

response=bulk_service.GetBulkUploadStatus(
	RequestId=RequestId)

要件

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

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

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

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
RequestId	アップロード要求の識別子。識別子は最大 15 分間有効です。この期間内にファイルが正常にアップロードされていない場合は、新しい要求識別子とアップロード URL を取得する必要があります。	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 要素

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

応答本文の要素

要素	説明	データ型
エラー	HTTP POST のアップロードが完了した後、一括ファイルのシステム処理中に発生したエラーに対応する OperationError オブジェクトの配列。たとえば、アップロードされたファイルに対応するファイル形式バージョンでサポートされていない 1 つ以上の一括レコードが含まれている場合、 OperationError には BulkServiceFormatVersionNotSupported エラーコードが含まれます。	OperationError 配列
ForwardCompatibilityMap	現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。今後のリリースでは、今後の互換性の変更に関するページを参照してください。現在、この操作の前方互換性の変更はありません。	KeyValuePairOfstring 配列
PercentComplete	アップロードされた一括ファイルのシステム処理の進行状況完了率。値の範囲は 0 ~ 100 です。アップロードの状態も比較する必要があります。アップロードが失敗した場合、完了率はゼロ (0) にリセットされます。	int
RequestStatus	アップロードの状態。返される可能性のある状態値を次に示します。完了 - アップロードファイルが受け入れられ、エラーなしで正常に処理されました。 CompletedWithErrors - 1 つ以上のエラーでアップロードが完了しました。全体的なアップロードが成功した間に、1 つ以上の追加または更新エラーが発生した可能性があります。ベストプラクティスとして、GetBulkUploadUrl を呼び出すときに ResponseMode 要素を介してエラー情報を要求し、エラーに対して ResultFileUrl をチェックする必要があります。失敗 - 予期しないエラーが発生したため、アップロード全体が失敗しました。エンティティ数が少ない新しいアップロードを送信するか、後で同じアップロードを再送信してみてください。 FileUploaded - アップロード要求が受信され、処理のためにキューに入っています。 InProgress - アップロードファイルが受け入れられ、アップロードが進行中です。 PendingFileUpload - 対応する RequestId のアップロードファイルが受信されていません。 UploadFileRowCountExceeded - アップロードファイル内の一括レコードの制限を超えました。制限とアップロードのベストプラクティスの詳細については、「一括アップロード」を参照してください。 UploadFileFormatNotSupported - アップロードで指定された [バージョン名の書式設定] フィールドは、このバージョンの Bulk API ではサポートされていません。	string
ResultFileUrl	アップロードエラー情報など、要求された結果を含むファイルの URL。この URL は、GetBulkUploadStatus 操作が Completed または CompletedWithErrors 状態の応答文字列を返す 5 分以内に使用する必要があります。この期間内にダウンロードを開始しない場合は、 GetBulkUploadStatus をもう一度呼び出して新しい URL を取得する必要があります。変更される可能性があるため、ダウンロード URL のドメインに依存しないでください。	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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
	string requestId)
{
	var request = new GetBulkUploadStatusRequest
	{
		RequestId = requestId
	};

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

static GetBulkUploadStatusResponse getBulkUploadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();

	request.setRequestId(requestId);

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

static function GetBulkUploadStatus(
	$requestId)
{

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

	$request = new GetBulkUploadStatusRequest();

	$request->RequestId = $requestId;

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

response=bulk_service.GetBulkUploadStatus(
	RequestId=RequestId)

次の方法で共有

GetBulkUploadStatus サービス操作 - 一括

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

SOAP を要求する

応答 SOAP

コード構文

要件

要求 URL

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

JSON を要求する

応答 JSON

コード構文

フィードバック

その他のリソース