DownloadCampaignsByCampaignIds 服務作業 - 大量

發行項
12/21/2023

下載指定之活動的設定和效能資料。您可以要求所有行銷活動資料，或只要求自上次下載行銷活動以來已變更的資料。

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

提示

大量檔案架構提供您可以下載和上傳之記錄的詳細資料。請遵循最佳做法，以確保您自己和所有 Microsoft Advertising 用戶端都能夠公平使用。如需詳細資訊，請參閱大量下載最佳做法和大量上傳最佳做法。

要求專案

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

注意事項

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

要求本文專案

元素	說明	資料類型
活動	要下載的活動。您可以指定最多 1,000 個活動。您指定的活動必須屬於相同的帳戶。	CampaignScope 數組
CompressionType	下載檔案的壓縮類型。如需可能的值，請參閱 CompressionType。預設壓縮類型為 Zip。	CompressionType
DataScope	除了活動設定等實體資料之外，您也可以包含品質分數資料，例如廣告相關性。預設值為 EntityData。您可以將多個值包含為旗標。指定多個旗標的方式取決於您使用的程式設計語言。例如，C# 會將這些值視為旗標值，而 JAVA 會將它們視為字串陣列。 SOAP 應該包含字串，其中包含以空格分隔的值清單， `<DataScope>EntityData QualityScoreData</DataScope>` 例如。如果包含 BidSuggestionsData 或 QualityScoreData ，您必須要求完整同步處理。若要執行完整同步處理，請勿設定 LastSyncTimeInUTC ，也就是將它保留為 nil。	DataScope
DownloadEntities	要包含在下載中的實體。如需您可以下載的實體清單，請參閱 DownloadEntity 值集。您必須指定至少一個下載實體，否則作業將會發生錯誤。	DownloadEntity 數組
DownloadFileType	下載檔案的格式。如需可能的值，請參閱 DownloadFileType。預設值為 CSV。	DownloadFileType
FormatVersion	下載檔案記錄的格式。最佳做法是一律指定最新的格式版本。 Bing 廣告 API 版本 13 目前唯一支援的格式版本是 6.0。您應該根據對應格式版本的大量檔案架構來記錄管理。	string
LastSyncTimeInUTC	您上次要求下載的時間。日期和時間是以國際標準時間 (UTC) 表示。如果您指定上次同步處理時間，則只會下載自指定日期和時間起 (新增、更新或刪除) 的實體。如果父活動或廣告群組自指定的上次同步處理時間後已刪除，您只會看到已刪除父活動或廣告群組的已刪除記錄。例如，如果已刪除行銷活動，則大量檔案將不會包含廣告群組、準則、廣告和行銷活動中關鍵字的已刪除記錄。目標準則會與其他實體稍微不同，而且不會傳回已刪除的記錄。如果已對行銷活動或廣告群組的目標進行任何變更，則會傳回所有目前作用中的子目標準則記錄。一般而言，您會在第一次呼叫作業時要求完整下載，方法是將此元素設定為 null。在所有後續呼叫中，您會將上次同步時間設定為上一個下載的時間戳記。下載檔案包含在帳戶記錄的[同步時間] 資料行中下載的時間戳記。您應該使用帳戶同步時間，在下次要求下載時設定此元素。如果您設定的日期和時間超過 30 天，則會傳回錯誤。	Datetime

要求標頭元素

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

Response 元素

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

回應本文專案

元素	說明	資料類型
DownloadRequestId	下載要求的識別碼。您可以使用識別碼來呼叫 GetBulkDownloadStatus 作業來檢查下載狀態。識別碼的有效期上限為兩天。如果您尚未在此期間內成功下載檔案，則會從下載網站中移除該檔案，而且您必須取得新的下載要求識別碼。字串的長度上限為 40，而且可以包含任何字元。	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">DownloadCampaignsByCampaignIds</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>
    <DownloadCampaignsByCampaignIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Campaigns i:nil="false">
        <CampaignScope>
          <CampaignId>ValueHere</CampaignId>
          <ParentAccountId>ValueHere</ParentAccountId>
        </CampaignScope>
      </Campaigns>
      <CompressionType i:nil="false">ValueHere</CompressionType>
      <DataScope>ValueHere</DataScope>
      <DownloadEntities i:nil="false">
        <DownloadEntity>ValueHere</DownloadEntity>
      </DownloadEntities>
      <DownloadFileType i:nil="false">ValueHere</DownloadFileType>
      <FormatVersion i:nil="false">ValueHere</FormatVersion>
      <LastSyncTimeInUTC i:nil="false">ValueHere</LastSyncTimeInUTC>
    </DownloadCampaignsByCampaignIdsRequest>
  </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>
    <DownloadCampaignsByCampaignIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByCampaignIdsResponse>
  </s:Body>
</s:Envelope>

程式碼語法

範例語法可以與 Bing 廣告 SDK搭配使用。如需更多範例，請參閱 Bing 廣告 API 程式碼范例。

public async Task<DownloadCampaignsByCampaignIdsResponse> DownloadCampaignsByCampaignIdsAsync(
	IList<CampaignScope> campaigns,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByCampaignIdsRequest
	{
		Campaigns = campaigns,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

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

static DownloadCampaignsByCampaignIdsResponse downloadCampaignsByCampaignIds(
	ArrayOfCampaignScope campaigns,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByCampaignIdsRequest request = new DownloadCampaignsByCampaignIdsRequest();

	request.setCampaigns(campaigns);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

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

static function DownloadCampaignsByCampaignIds(
	$campaigns,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByCampaignIdsRequest();

	$request->Campaigns = $campaigns;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

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

response=bulk_service.DownloadCampaignsByCampaignIds(
	Campaigns=Campaigns,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

需求

服務： BulkService.svc v13
命名空間： https://bingads.microsoft.com/CampaignManagement/v13

共用方式為