DownloadCampaignsByAccountIds 服務作業 - 大量

下載所有帳戶行銷活動的設定和效能數據。 您可以要求所有行銷活動數據，或只要求自您上次下載帳戶以來已變更的數據。

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

提示

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

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
AccountIds	包含要下載之營銷活動數據的帳戶標識碼。 您可以指定的帳戶數目上限為一個。 您可以下載的帳戶大小限制為 400 萬個關鍵字。 如果您嘗試下載包含超過 4 百萬個關鍵詞的帳戶，呼叫將會失敗，並出現錯誤 3207 (AccountTooBigToDownload) 。 如果呼叫失敗，請呼叫 DownloadCampaignsByCampaignIds 作業，依行銷活動下載帳戶。 錯誤的 Details 元素包含帳戶擁有之行銷活動識別碼的逗號分隔清單。	long 陣列
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 元素

DownloadCampaignsByAccountIdsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應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">DownloadCampaignsByAccountIds</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>
    <DownloadCampaignsByAccountIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <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>
    </DownloadCampaignsByAccountIdsRequest>
  </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>
    <DownloadCampaignsByAccountIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByAccountIdsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<DownloadCampaignsByAccountIdsResponse> DownloadCampaignsByAccountIdsAsync(
	IList<long> accountIds,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByAccountIdsRequest
	{
		AccountIds = accountIds,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

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

static DownloadCampaignsByAccountIdsResponse downloadCampaignsByAccountIds(
	ArrayOflong accountIds,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByAccountIdsRequest request = new DownloadCampaignsByAccountIdsRequest();

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

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

static function DownloadCampaignsByAccountIds(
	$accountIds,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByAccountIdsRequest();

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

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

response=bulk_service.DownloadCampaignsByAccountIds(
	AccountIds=AccountIds,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

需求

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

要求 URL

生產URL

https://bulk.api.bingads.microsoft.com/Bulk/v13/Campaigns/DownloadByAccountIds

沙箱 URL

https://bulk.api.sandbox.bingads.microsoft.com/Bulk/v13/Campaigns/DownloadByAccountIds

要求專案

DownloadCampaignsByAccountIdsRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

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

要求本文專案

元素	描述	資料類型
AccountIds	包含要下載之營銷活動數據的帳戶標識碼。 您可以指定的帳戶數目上限為一個。 您可以下載的帳戶大小限制為 400 萬個關鍵字。 如果您嘗試下載包含超過 4 百萬個關鍵詞的帳戶，呼叫將會失敗，並出現錯誤 3207 (AccountTooBigToDownload) 。 如果呼叫失敗，請呼叫 DownloadCampaignsByCampaignIds 作業，依行銷活動下載帳戶。 錯誤的 Details 元素包含帳戶擁有之行銷活動識別碼的逗號分隔清單。	long 陣列
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

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
DownloadRequestId	下載要求的標識碼。 您可以使用識別碼來呼叫 GetBulkDownloadStatus 作業來檢查下載狀態。 標識碼的有效期上限為兩天。 如果您尚未在此期間內成功下載檔案，則會從下載網站中移除該檔案，而且您必須取得新的下載要求標識符。 字串的長度上限為 40，而且可以包含任何字元。	string

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "AccountIds": [
    "LongValueHere"
  ],
  "CompressionType": "ValueHere",
  "DataScope": "ValueHere",
  "DownloadEntities": [
    "ValueHere"
  ],
  "DownloadFileType": "ValueHere",
  "FormatVersion": "ValueHere",
  "LastSyncTimeInUTC": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "DownloadRequestId": "ValueHere"
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<DownloadCampaignsByAccountIdsResponse> DownloadCampaignsByAccountIdsAsync(
	IList<long> accountIds,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByAccountIdsRequest
	{
		AccountIds = accountIds,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

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

static DownloadCampaignsByAccountIdsResponse downloadCampaignsByAccountIds(
	ArrayOflong accountIds,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByAccountIdsRequest request = new DownloadCampaignsByAccountIdsRequest();

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

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

static function DownloadCampaignsByAccountIds(
	$accountIds,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByAccountIdsRequest();

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

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

response=bulk_service.DownloadCampaignsByAccountIds(
	AccountIds=AccountIds,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)