通过

DownloadCampaignsByCampaignIds 服务操作 - 批量

  • 项目

下载指定市场活动的设置和性能数据。 可以请求所有市场活动数据，也可以仅请求自上次下载市场活动以来已更改的数据。

对于下载请求操作，必须使用相同的用户凭据， (DownloadCampaignsByAccountIds 或 DownloadCampaignsByCampaignIds) 和 GetBulkDownloadStatus 轮询操作。

提示

批量文件架构提供有关可下载和上传的记录的详细信息。 请遵循最佳做法，确保为自己和所有Microsoft广告客户公平使用。 有关详细信息，请参阅 批量下载最佳做法 和 批量上传最佳做法。

请求元素

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 下载文件的记录的格式。

最佳做法应始终指定最新的格式版本。 目前，必应广告 API 版本 13 唯一受支持的格式版本是 6.0。

应根据相应格式版本的 批量文件架构 管理记录。		 string
LastSyncTimeInUTC 上次请求下载的时间。 日期和时间以协调世界时 (UTC) 表示。

如果指定上次同步时间，则只会下载自指定日期和时间以来已更改 (添加、更新或删除) 的实体。 如果父市场活动或广告组自指定的上次同步时间以来已被删除，则只会看到已删除的父市场活动或广告组的已删除记录。 例如，如果删除了市场活动，批量文件将不会包含市场活动中的广告组、条件、广告和关键字的已删除记录。

目标条件与其他实体略有不同，并且不会返回已删除的记录。 如果对市场活动或广告组的目标进行了任何更改，则返回所有当前处于活动状态的子目标条件记录。

通常，在首次调用操作时，通过将此元素设置为 null 来请求完全下载。 在所有后续调用中，将上次同步时间设置为上一次下载的时间戳。

下载文件包含帐户记录的“同步时间”列中下载的时间戳。 下次请求下载时，应使用帐户 同步时间 设置此元素。

如果设置的日期和时间早于 30 天，将返回错误。		 dateTime

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

DownloadCampaignsByCampaignIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
DownloadRequestId 下载请求的标识符。

使用标识符调用 GetBulkDownloadStatus 操作来检查下载状态。

标识符的有效期最长为两天。 如果在此期限内未成功下载该文件，则会从下载站点中删除该文件，并且需要获取新的下载请求标识符。

字符串的长度最大为 40，可以包含任何字符。		 string

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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

请求 URL

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

请求元素

DownloadCampaignsByCampaignIdsRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素 说明 数据类型
活动 要下载的竞选活动。 最多可以指定 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 下载文件的记录的格式。

最佳做法应始终指定最新的格式版本。 目前，必应广告 API 版本 13 唯一受支持的格式版本是 6.0。

应根据相应格式版本的 批量文件架构 管理记录。		 string
LastSyncTimeInUTC 上次请求下载的时间。 日期和时间以协调世界时 (UTC) 表示。

如果指定上次同步时间，则只会下载自指定日期和时间以来已更改 (添加、更新或删除) 的实体。 如果父市场活动或广告组自指定的上次同步时间以来已被删除，则只会看到已删除的父市场活动或广告组的已删除记录。 例如，如果删除了市场活动，批量文件将不会包含市场活动中的广告组、条件、广告和关键字的已删除记录。

目标条件与其他实体略有不同，并且不会返回已删除的记录。 如果对市场活动或广告组的目标进行了任何更改，则返回所有当前处于活动状态的子目标条件记录。

通常，在首次调用操作时，通过将此元素设置为 null 来请求完全下载。 在所有后续调用中，将上次同步时间设置为上一次下载的时间戳。

下载文件包含帐户记录的“同步时间”列中下载的时间戳。 下次请求下载时，应使用帐户 同步时间 设置此元素。

如果设置的日期和时间早于 30 天，将返回错误。		 dateTime

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

DownloadCampaignsByCampaignIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
DownloadRequestId 下载请求的标识符。

使用标识符调用 GetBulkDownloadStatus 操作来检查下载状态。

标识符的有效期最长为两天。 如果在此期限内未成功下载该文件，则会从下载站点中删除该文件，并且需要获取新的下载请求标识符。

字符串的长度最大为 40，可以包含任何字符。		 string

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "Campaigns": [
    {
      "CampaignId": "LongValueHere",
      "ParentAccountId": "LongValueHere"
    }
  ],
  "CompressionType": "ValueHere",
  "DataScope": "ValueHere",
  "DownloadEntities": [
    "ValueHere"
  ],
  "DownloadFileType": "ValueHere",
  "FormatVersion": "ValueHere",
  "LastSyncTimeInUTC": "ValueHere"
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "DownloadRequestId": "ValueHere"
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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)