Operación de servicio GetBulkUploadStatus: masiva
Obtiene el estado y el progreso de finalización de una solicitud de carga masiva.
Elementos Request
El objeto GetBulkUploadStatusRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elementos de encabezado de solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| AuthenticationToken | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth. |
string |
| CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
| Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
| UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetBulkUploadStatusResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.
Elementos del cuerpo de la respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Errores | Matriz de objetos OperationError correspondientes a los errores detectados durante el procesamiento del sistema del archivo masivo una vez completada la carga HTTP POST. Por ejemplo, OperationError incluiría el código de error BulkServiceFormatVersionNotSupported si el archivo cargado contiene uno o más registros masivos que no se admiten con la versión de formato de archivo correspondiente. |
Matriz OperationError |
| ForwardCompatibilityMap | Lista de cadenas de clave y valor para la compatibilidad con reenvíos para evitar cambios importantes en caso contrario cuando se agregan nuevos elementos en la versión actual de la API. Los cambios de compatibilidad de reenvío se anotarán aquí en futuras versiones. Actualmente no hay cambios de compatibilidad de reenvío para esta operación. |
Matriz KeyValuePairOfstringstring |
| PercentComplete | Porcentaje de finalización del progreso para el procesamiento del sistema del archivo masivo cargado. El intervalo de valores está comprendido entre 0 y 100. También debe comparar el estado de carga. Si se produce un error en la carga, el porcentaje completado se restablecerá a cero (0). |
int |
| RequestStatus | Estado de la carga. A continuación se muestran los posibles valores de estado devueltos. Completado: el archivo de carga se aceptó y procesó correctamente sin errores. CompletedWithErrors: la carga se completó con uno o varios errores. Aunque la carga general se realizó correctamente, se podrían haber producido uno o varios errores de adición o actualización. Como procedimiento recomendado, debe solicitar información de error a través del elemento ResponseMode al llamar a GetBulkUploadUrl y comprobar resultFileUrl si hay errores. Error: se produjo un error en toda la carga debido a un error inesperado. Puede enviar una nueva carga con menos entidades o volver a intentar enviar la misma carga más adelante. FileUploaded: la solicitud de carga se ha recibido y está en la cola para su procesamiento. InProgress: se ha aceptado el archivo de carga y la carga está en curso. PendingFileUpload: el archivo de carga no se ha recibido para el RequestId correspondiente. UploadFileRowCountExceeded: se ha superado el límite de registros masivos en el archivo de carga. Para obtener más información sobre los límites y los procedimientos recomendados de carga, consulte Carga masiva. UploadFileFormatNotSupported: el campo Nombre de versión de formato especificado en la carga no es compatible con esta versión de la API masiva. |
string |
| ResultFileUrl | Dirección URL del archivo que contiene los resultados solicitados, por ejemplo, cargar información de error. La dirección URL debe usarse en un plazo de cinco minutos desde el momento en que la operación GetBulkUploadStatus devuelve la cadena de respuesta de estado Completed o CompletedWithErrors . Si no inicia la descarga dentro de este período de tiempo, tendrá que llamar a GetBulkUploadStatus de nuevo para obtener una nueva dirección URL. No debe depender del dominio de la dirección URL de descarga, ya que está sujeto a cambios. |
string |
Elementos de encabezado de respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de SOAP
Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
<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 de respuesta
Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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:e463="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e463:KeyValuePairOfstringstring>
<e463:key d4p1:nil="false">ValueHere</e463:key>
<e463:value d4p1:nil="false">ValueHere</e463:value>
</e463: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>
Sintaxis de código
La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
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)
Requisitos
Servicio: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Dirección URL de solicitud
https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkUploadStatus/Query
Elementos Request
El objeto GetBulkUploadStatusRequest define los elementos body y header de la solicitud de operación de servicio.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
Elementos de encabezado de solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Autorización | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. Para obtener más información, consulte Autenticación con OAuth. |
string |
| CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
| Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
| UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetBulkUploadStatusResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.
Elementos del cuerpo de la respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Errores | Matriz de objetos OperationError correspondientes a los errores detectados durante el procesamiento del sistema del archivo masivo una vez completada la carga HTTP POST. Por ejemplo, OperationError incluiría el código de error BulkServiceFormatVersionNotSupported si el archivo cargado contiene uno o más registros masivos que no se admiten con la versión de formato de archivo correspondiente. |
Matriz OperationError |
| ForwardCompatibilityMap | Lista de cadenas de clave y valor para la compatibilidad con reenvíos para evitar cambios importantes en caso contrario cuando se agregan nuevos elementos en la versión actual de la API. Los cambios de compatibilidad de reenvío se anotarán aquí en futuras versiones. Actualmente no hay cambios de compatibilidad de reenvío para esta operación. |
Matriz KeyValuePairOfstringstring |
| PercentComplete | Porcentaje de finalización del progreso para el procesamiento del sistema del archivo masivo cargado. El intervalo de valores está comprendido entre 0 y 100. También debe comparar el estado de carga. Si se produce un error en la carga, el porcentaje completado se restablecerá a cero (0). |
int |
| RequestStatus | Estado de la carga. A continuación se muestran los posibles valores de estado devueltos. Completado: el archivo de carga se aceptó y procesó correctamente sin errores. CompletedWithErrors: la carga se completó con uno o varios errores. Aunque la carga general se realizó correctamente, se podrían haber producido uno o varios errores de adición o actualización. Como procedimiento recomendado, debe solicitar información de error a través del elemento ResponseMode al llamar a GetBulkUploadUrl y comprobar resultFileUrl si hay errores. Error: se produjo un error en toda la carga debido a un error inesperado. Puede enviar una nueva carga con menos entidades o volver a intentar enviar la misma carga más adelante. FileUploaded: la solicitud de carga se ha recibido y está en la cola para su procesamiento. InProgress: se ha aceptado el archivo de carga y la carga está en curso. PendingFileUpload: el archivo de carga no se ha recibido para el RequestId correspondiente. UploadFileRowCountExceeded: se ha superado el límite de registros masivos en el archivo de carga. Para obtener más información sobre los límites y los procedimientos recomendados de carga, consulte Carga masiva. UploadFileFormatNotSupported: el campo Nombre de versión de formato especificado en la carga no es compatible con esta versión de la API masiva. |
string |
| ResultFileUrl | Dirección URL del archivo que contiene los resultados solicitados, por ejemplo, cargar información de error. La dirección URL debe usarse en un plazo de cinco minutos desde el momento en que la operación GetBulkUploadStatus devuelve la cadena de respuesta de estado Completed o CompletedWithErrors . Si no inicia la descarga dentro de este período de tiempo, tendrá que llamar a GetBulkUploadStatus de nuevo para obtener una nueva dirección URL. No debe depender del dominio de la dirección URL de descarga, ya que está sujeto a cambios. |
string |
Elementos de encabezado de respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de JSON
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
{
"RequestId": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"Errors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"Message": "ValueHere"
}
],
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"PercentComplete": IntValueHere,
"RequestStatus": "ValueHere",
"ResultFileUrl": "ValueHere"
}
Sintaxis de código
Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
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)