Operazione del servizio GetBulkDownloadStatus - Bulk

Articolo
12/21/2023

Ottiene lo stato di una richiesta di download bulk.

Nota

È necessario usare le stesse credenziali utente per l'operazione di richiesta di download ( DownloadCampaignsByAccountIds o DownloadCampaignsByCampaignIds) e l'operazione di polling GetBulkDownloadStatus .

Elementi della richiesta

L'oggetto GetBulkDownloadStatusRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento	Descrizione	Tipo di dati
RequestId	Identificatore della richiesta di download. Le operazioni DownloadCampaignsByAccountIds e DownloadCampaignsByCampaignIds restituiscono questo elemento come DownloadRequestId. L'identificatore è valido per un massimo di due giorni. Se il file non è stato scaricato correttamente entro questo periodo, viene rimosso dal sito di download e sarà necessario ottenere un nuovo identificatore della richiesta di download. La stringa ha una lunghezza fino a 40 e può contenere qualsiasi carattere.	Stringa

Elementi dell'intestazione della richiesta

Elemento	Descrizione	Tipo di dati
AuthenticationToken	Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth.	Stringa
CustomerAccountId	Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
Customerid	Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
DeveloperToken	Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori.	Stringa
Password	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa
UserName	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa

Elementi di risposta

L'oggetto GetBulkDownloadStatusResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento	Descrizione	Tipo di dati
Errori	Matrice di oggetti OperationError corrispondente agli errori rilevati durante l'elaborazione di sistema del file bulk dopo l'invio della richiesta di download.	Matrice OperationError
ForwardCompatibilityMap	Elenco di stringhe di chiave e valore per la compatibilità con l'inoltro per evitare modifiche che altrimenti causano un'interruzione quando vengono aggiunti nuovi elementi nella versione corrente dell'API. Le modifiche di compatibilità forward verranno annotate qui nelle versioni future. Attualmente non sono presenti modifiche di compatibilità per questa operazione.	Matrice KeyValuePairOfstringstring
PercentComplete	Percentuale di completamento dello stato di avanzamento per l'elaborazione di sistema del file di download bulk.	int
RequestStatus	Stato del download. I valori possibili sono i seguenti. Completato: il download è stato completato correttamente. InProgress: il download è in corso. Non riuscito: il download non è riuscito. È possibile inviare un nuovo download con meno entità, senza punteggio di qualità e dati di suggerimenti per le offerte, oppure riprovare a inviare lo stesso download in un secondo momento. FailedFullSyncRequired: l'elemento LastSyncTimeInUTC della richiesta deve essere impostato su Null, ad esempio se l'account specificato è stato incluso in una migrazione dei dati. Dopo aver richiesto un download completo, è possibile iniziare a richiedere di nuovo i download delta.	Stringa
ResultFileUrl	URL che contiene i dati di download quando il valore RequestStatus è Completed. Sono disponibili cinque minuti dal momento in cui viene restituito l'URL per scaricare il file. Se non si avvia il download entro questo periodo di tempo, sarà necessario chiamare nuovamente GetBulkDownloadStatus per ottenere un nuovo URL. Non è consigliabile assumere una dipendenza dal dominio dell'URL di download, perché è soggetto a modifiche. Il file di download è compresso (in formato ZIP), quindi è necessario decomprimere il file per accedere ai dati. Per informazioni sul formato di file bulk, vedere Schema file bulk.	Stringa

Elementi dell'intestazione della risposta

Elemento	Descrizione	Tipo di dati
TrackingId	Identificatore della voce di log che contiene i dettagli della chiamata API.	Stringa

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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 della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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:e215="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e215:KeyValuePairOfstringstring>
          <e215:key d4p1:nil="false">ValueHere</e215:key>
          <e215:value d4p1:nil="false">ValueHere</e215:value>
        </e215: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>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

Servizio: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Condividi tramite