GetBulkDownloadStatus 服务操作 - 批量

获取批量下载请求的状态。

注意

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

请求元素

GetBulkDownloadStatusRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

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

请求正文元素

元素	说明	数据类型
请求 ID	下载请求的标识符。 DownloadCampaignsByAccountIds 和 DownloadCampaignsByCampaignIds 操作将此元素返回为 DownloadRequestId。 标识符的有效期最长为两天。 如果在此期限内未成功下载该文件，则会从下载站点中删除该文件，并且需要获取新的下载请求标识符。 字符串的长度最大为 40，可以包含任何字符。	string

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应标头元素

元素	说明	数据类型
跟踪 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">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:e143="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e143:KeyValuePairOfstringstring>
          <e143:key d4p1:nil="false">ValueHere</e143:key>
          <e143:value d4p1:nil="false">ValueHere</e143:value>
        </e143: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>

代码语法

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

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
请求 ID	下载请求的标识符。 DownloadCampaignsByAccountIds 和 DownloadCampaignsByCampaignIds 操作将此元素返回为 DownloadRequestId。 标识符的有效期最长为两天。 如果在此期限内未成功下载该文件，则会从下载站点中删除该文件，并且需要获取新的下载请求标识符。 字符串的长度最大为 40，可以包含任何字符。	string

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应正文元素

元素	说明	数据类型
错误	一个 OperationError 对象数组，这些对象对应于提交下载请求后在系统处理批量文件时遇到的错误。	OperationError 数组
ForwardCompatibilityMap	用于向前兼容性的键和值字符串列表，以避免在当前 API 版本中添加新元素时发生重大更改。 将来的版本中将在此处记录向前兼容性更改。 此操作当前没有向前兼容性更改。	KeyValuePairOfstringstring 数组
PercentComplete	系统处理批量下载文件的进度完成百分比。	int
RequestStatus	下载的状态。 可能的值如下所示。 已完成 - 下载已成功完成。 InProgress - 正在下载。 失败 - 下载失败。 可以提交包含较少实体的新下载，而没有质量分数和投标建议数据，或稍后重试提交相同的下载。 FailedFullSyncRequired - 请求的 LastSyncTimeInUTC 元素必须设置为 null，例如，如果指定的帐户包含在数据迁移中。 请求完全下载后，可以再次开始请求增量下载。	string
ResultFileUrl	当 RequestStatus 值为 Completed 时包含下载数据的 URL。 从返回此 URL 开始，你有五分钟的时间下载文件。 如果未在此时间段内开始下载，则需要再次调用 GetBulkDownloadStatus 以获取新 URL。 不应依赖下载 URL 的域，因为它可能会更改。 下载文件 (压缩为 zip 格式) ，因此必须解压缩文件才能访问数据。 有关大容量文件格式的信息，请参阅 大容量文件架构。	string

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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)