GetBulkDownloadStatus 服務作業 - 大量

發行項
12/21/2023

取得大量下載要求的狀態。

注意事項

您必須針對下載要求作業使用相同的使用者認證， (DownloadCampaignsByAccountIds 或 DownloadCampaignsByCampaignIds) 和 GetBulkDownloadStatus 輪詢作業。

要求專案

GetBulkDownloadStatusRequest物件會定義服務作業要求的主體和標頭元素。元素的順序必須與要求 SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	說明	資料類型
RequestId	下載要求的識別碼。 DownloadCampaignsByAccountIds和DownloadCampaignsByCampaignIds作業會以DownloadRequestId傳回此元素。識別碼的有效期上限為兩天。如果您尚未在此期間內成功下載檔案，則會從下載網站中移除該檔案，而且您必須取得新的下載要求識別碼。字串的長度上限為 40，而且可以包含任何字元。	string

要求標頭元素

元素	說明	資料類型
AuthenticationToken	OAuth 存取權杖，代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。如需詳細資訊，請參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的識別碼。當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。如需詳細資訊，請參閱取得您的帳戶和客戶識別碼。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。使用者可以存取多個管理員帳戶。此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。如需詳細資訊，請參閱取得您的帳戶和客戶識別碼。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員權杖。如需詳細資訊，請參閱取得開發人員權杖。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。您必須使用 AuthenticationToken 元素來設定使用者認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。您必須使用 AuthenticationToken 元素來設定使用者認證。	string

Response 元素

GetBulkDownloadStatusResponse物件會定義服務作業回應的主體和標頭元素。這些元素的傳回順序與回應 SOAP中所示的順序相同。

回應本文專案

元素	說明	資料類型
錯誤	OperationError物件的陣列，對應至提交下載要求之後，大量檔案系統處理期間所發生的錯誤。	OperationError 數組
ForwardCompatibilityMap	用於向前相容性的索引鍵和值字串清單，以避免在目前 API 版本中新增新元素時中斷變更。未來的版本中將會記下向前相容性變更。此作業目前沒有向前相容性變更。	KeyValuePairOfstringstring 數組
PercentComplete	大容量下載檔案系統處理的進度完成百分比。	int
RequestStatus	下載的狀態。可能的值如下所示。已完成 - 下載成功完成。 InProgress - 下載正在進行中。失敗 - 下載失敗。您可以提交實體較少的新下載，而不需要品質分數和申請建議資料，或稍後再試一次提交相同的下載。 FailedFullSyncRequired - 要求的 LastSyncTimeInUTC 元素必須設定為 null，例如，如果指定的帳號包含在資料移轉中。要求完整下載之後，您可以再次開始要求差異下載。	string
ResultFileUrl	當 RequestStatus值為 Completed時，包含下載資料的 URL。從傳回此 URL 開始，您有五分鐘的時間可以下載檔案。如果您未在此期間內開始下載，則必須再次呼叫 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:e215="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e215:KeyValuePairOfstringstring>
          <e215:key d4p1:nil="false">ValueHere</e215:key>
          <e215:value d4p1:nil="false">ValueHere</e215:value>
        </e215: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
命名空間： https://bingads.microsoft.com/CampaignManagement/v13

共用方式為