GetBulkUploadStatus 服务操作 - 批量

获取批量上传请求的状态和完成进度。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
请求 ID	上传请求的标识符。 标识符的有效期最长为 15 分钟。 如果在此时间段内未成功上传文件，则需要获取新的请求标识符和上传 URL。	string

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
错误	一个 OperationError 对象数组，这些对象对应于在 HTTP POST 上传完成后系统处理大容量文件时遇到的错误。 例如，如果上传的文件包含一个或多个不受相应文件格式版本支持的批量记录， OperationError 将包含 BulkServiceFormatVersionNotSupported 错误代码。	OperationError 数组
ForwardCompatibilityMap	用于向前兼容性的键和值字符串列表，以避免在当前 API 版本中添加新元素时发生重大更改。 将来的版本中将在此处记录向前兼容性更改。 此操作当前没有向前兼容性更改。	KeyValuePairOfstringstring 数组
PercentComplete	系统处理已上传的批量文件的进度完成百分比。 值范围介于 0 和 100 之间。 还应比较上传状态。 如果上传失败，完成百分比将重置为零 (0) 。	int
RequestStatus	上传状态。 下面是可能返回的状态值。 已完成 - 上传文件已接受并成功处理，没有错误。 CompletedWithErrors - 上传已完成，但出现一个或多个错误。 当整体上传成功时，可能会发生一个或多个添加或更新错误。 作为最佳做法，应在调用 GetBulkUploadUrl 时通过 ResponseMode 元素请求错误信息，并检查 ResultFileUrl 以了解任何错误。 失败 - 由于意外错误，整个上传失败。 可以提交包含较少实体的新上传，或稍后重试提交相同的上传。 FileUploaded - 上传请求已收到，正在队列中进行处理。 InProgress - 上传文件已被接受，上传正在进行中。 PendingFileUpload - 尚未收到相应 RequestId 的上传文件。 UploadFileRowCountExceeded - 已超出上传文件中批量记录的限制。 有关限制和上传最佳做法的详细信息，请参阅 批量上传。 UploadFileFormatNotSupported - 此批量 API 版本不支持在上传中指定的 格式版本名称 字段。	string
ResultFileUrl	包含请求的结果的文件的 URL，例如上传错误信息。 URL 必须在 GetBulkUploadStatus 操作返回 Completed 或 CompletedWithErrors 状态响应字符串的五分钟内使用。 如果未在此时间段内开始下载，则需要再次调用 GetBulkUploadStatus 以获取新 URL。 不应依赖下载 URL 的域，因为它可能会更改。	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">GetBulkUploadStatus</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>
    <GetBulkUploadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RequestId i:nil="false">ValueHere</RequestId>
    </GetBulkUploadStatusRequest>
  </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>
    <GetBulkUploadStatusResponse 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:e145="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e145:KeyValuePairOfstringstring>
          <e145:key d4p1:nil="false">ValueHere</e145:key>
          <e145:value d4p1:nil="false">ValueHere</e145:value>
        </e145: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>
    </GetBulkUploadStatusResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
	string requestId)
{
	var request = new GetBulkUploadStatusRequest
	{
		RequestId = requestId
	};

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

static GetBulkUploadStatusResponse getBulkUploadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();

	request.setRequestId(requestId);

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

static function GetBulkUploadStatus(
	$requestId)
{

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

	$request = new GetBulkUploadStatusRequest();

	$request->RequestId = $requestId;

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

response=bulk_service.GetBulkUploadStatus(
	RequestId=RequestId)

要求

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

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
请求 ID	上传请求的标识符。 标识符的有效期最长为 15 分钟。 如果在此时间段内未成功上传文件，则需要获取新的请求标识符和上传 URL。	string

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
错误	一个 OperationError 对象数组，这些对象对应于在 HTTP POST 上传完成后系统处理大容量文件时遇到的错误。 例如，如果上传的文件包含一个或多个不受相应文件格式版本支持的批量记录， OperationError 将包含 BulkServiceFormatVersionNotSupported 错误代码。	OperationError 数组
ForwardCompatibilityMap	用于向前兼容性的键和值字符串列表，以避免在当前 API 版本中添加新元素时发生重大更改。 将来的版本中将在此处记录向前兼容性更改。 此操作当前没有向前兼容性更改。	KeyValuePairOfstringstring 数组
PercentComplete	系统处理已上传的批量文件的进度完成百分比。 值范围介于 0 和 100 之间。 还应比较上传状态。 如果上传失败，完成百分比将重置为零 (0) 。	int
RequestStatus	上传状态。 下面是可能返回的状态值。 已完成 - 上传文件已接受并成功处理，没有错误。 CompletedWithErrors - 上传已完成，但出现一个或多个错误。 当整体上传成功时，可能会发生一个或多个添加或更新错误。 作为最佳做法，应在调用 GetBulkUploadUrl 时通过 ResponseMode 元素请求错误信息，并检查 ResultFileUrl 以了解任何错误。 失败 - 由于意外错误，整个上传失败。 可以提交包含较少实体的新上传，或稍后重试提交相同的上传。 FileUploaded - 上传请求已收到，正在队列中进行处理。 InProgress - 上传文件已被接受，上传正在进行中。 PendingFileUpload - 尚未收到相应 RequestId 的上传文件。 UploadFileRowCountExceeded - 已超出上传文件中批量记录的限制。 有关限制和上传最佳做法的详细信息，请参阅 批量上传。 UploadFileFormatNotSupported - 此批量 API 版本不支持在上传中指定的 格式版本名称 字段。	string
ResultFileUrl	包含请求的结果的文件的 URL，例如上传错误信息。 URL 必须在 GetBulkUploadStatus 操作返回 Completed 或 CompletedWithErrors 状态响应字符串的五分钟内使用。 如果未在此时间段内开始下载，则需要再次调用 GetBulkUploadStatus 以获取新 URL。 不应依赖下载 URL 的域，因为它可能会更改。	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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
	string requestId)
{
	var request = new GetBulkUploadStatusRequest
	{
		RequestId = requestId
	};

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

static GetBulkUploadStatusResponse getBulkUploadStatus(
	java.lang.String requestId) throws RemoteException, Exception
{
	GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();

	request.setRequestId(requestId);

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

static function GetBulkUploadStatus(
	$requestId)
{

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

	$request = new GetBulkUploadStatusRequest();

	$request->RequestId = $requestId;

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

response=bulk_service.GetBulkUploadStatus(
	RequestId=RequestId)