Operación de servicio GetBulkDownloadStatus: masiva
Obtiene el estado de una solicitud de descarga masiva.
Nota:
Debe usar las mismas credenciales de usuario para la operación de solicitud de descarga ( DownloadCampaignsByAccountIds o DownloadCampaignsByCampaignIds) y la operación de sondeo GetBulkDownloadStatus .
Elementos Request
El objeto GetBulkDownloadStatusRequest 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
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Id. de solicitud | Identificador de la solicitud de descarga. Las operaciones DownloadCampaignsByAccountIds y DownloadCampaignsByCampaignIds devuelven este elemento como DownloadRequestId. El identificador es válido durante un máximo de dos días. Si no ha descargado correctamente el archivo dentro de este período, se quita del sitio de descarga y tendrá que obtener un nuevo identificador de solicitud de descarga. La cadena tiene una longitud de hasta 40 y puede contener cualquier carácter. |
string |
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 GetBulkDownloadStatusResponse 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 errores detectados durante el procesamiento del sistema del archivo masivo después de enviar la solicitud de descarga. | 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 de descarga masiva. | int |
| RequestStatus | Estado de la descarga. Los valores posibles son los siguientes. Completado: la descarga se completó correctamente. InProgress: la descarga está en curso. Error: error de descarga. Puede enviar una nueva descarga con menos entidades, sin datos de puntuación de calidad y sugerencias de puja, o bien volver a intentarlo para enviar la misma descarga más adelante. FailedFullSyncRequired: el elemento LastSyncTimeInUTC de la solicitud debe establecerse en null, por ejemplo, si la cuenta especificada se incluyó en una migración de datos. Después de solicitar una descarga completa, puede empezar a solicitar descargas delta de nuevo. |
string |
| ResultFileUrl | Dirección URL que contiene los datos de descarga cuando el valor RequestStatus es Completed. Tiene cinco minutos desde el momento en que se devuelve esta dirección URL para descargar el archivo. Si no inicia la descarga dentro de este período de tiempo, tendrá que llamar a GetBulkDownloadStatus 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. El archivo de descarga está comprimido (en formato zip), por lo que debe descomprimir el archivo para acceder a los datos. Para obtener información sobre el formato de archivo masivo, vea Esquema de archivos masivos. |
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">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 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>
<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:e461="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e461:KeyValuePairOfstringstring>
<e461:key d4p1:nil="false">ValueHere</e461:key>
<e461:value d4p1:nil="false">ValueHere</e461:value>
</e461: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>
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<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)
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/BulkDownloadStatus/Query
Elementos Request
El objeto GetBulkDownloadStatusRequest 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
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Id. de solicitud | Identificador de la solicitud de descarga. Las operaciones DownloadCampaignsByAccountIds y DownloadCampaignsByCampaignIds devuelven este elemento como DownloadRequestId. El identificador es válido durante un máximo de dos días. Si no ha descargado correctamente el archivo dentro de este período, se quita del sitio de descarga y tendrá que obtener un nuevo identificador de solicitud de descarga. La cadena tiene una longitud de hasta 40 y puede contener cualquier carácter. |
string |
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 GetBulkDownloadStatusResponse 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 errores detectados durante el procesamiento del sistema del archivo masivo después de enviar la solicitud de descarga. | 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 de descarga masiva. | int |
| RequestStatus | Estado de la descarga. Los valores posibles son los siguientes. Completado: la descarga se completó correctamente. InProgress: la descarga está en curso. Error: error de descarga. Puede enviar una nueva descarga con menos entidades, sin datos de puntuación de calidad y sugerencias de puja, o bien volver a intentarlo para enviar la misma descarga más adelante. FailedFullSyncRequired: el elemento LastSyncTimeInUTC de la solicitud debe establecerse en null, por ejemplo, si la cuenta especificada se incluyó en una migración de datos. Después de solicitar una descarga completa, puede empezar a solicitar descargas delta de nuevo. |
string |
| ResultFileUrl | Dirección URL que contiene los datos de descarga cuando el valor RequestStatus es Completed. Tiene cinco minutos desde el momento en que se devuelve esta dirección URL para descargar el archivo. Si no inicia la descarga dentro de este período de tiempo, tendrá que llamar a GetBulkDownloadStatus 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. El archivo de descarga está comprimido (en formato zip), por lo que debe descomprimir el archivo para acceder a los datos. Para obtener información sobre el formato de archivo masivo, vea Esquema de archivos masivos. |
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<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)