Condividi tramite

Operazione del servizio GetBulkUploadStatus - Bulk

  • Articolo

Ottiene lo stato e lo stato di completamento di una richiesta di caricamento bulk.

Elementi della richiesta

L'oggetto GetBulkUploadStatusRequest definisce il corpo e gli elementi dell'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 caricamento.

L'identificatore è valido per un massimo di 15 minuti. Se il file non è stato caricato correttamente entro questo periodo, sarà necessario ottenere un nuovo identificatore della richiesta e caricare l'URL.		 corda

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.		 corda
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.		 corda
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.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
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. corda
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. corda

Elementi di risposta

L'oggetto GetBulkUploadStatusResponse 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 il completamento del caricamento di HTTP POST.

Ad esempio, un elemento OperationError includerà il codice di errore BulkServiceFormatVersionNotSupported se il file caricato contiene uno o più record bulk non supportati con la versione del formato di file corrispondente.		 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 bulk caricato. L'intervallo di valori è compreso tra 0 e 100.

È anche consigliabile confrontare lo stato di caricamento. Se il caricamento non riesce, la percentuale di completamento verrà reimpostata su zero (0).		 int
RequestStatus Stato del caricamento. Di seguito sono riportati i possibili valori di stato restituiti.

Completato: il file di caricamento è stato accettato ed elaborato correttamente senza errori.

CompletedWithErrors: caricamento completato con uno o più errori. Mentre il caricamento complessivo ha avuto esito positivo, potrebbero essersi verificati uno o più errori di aggiunta o aggiornamento. Come procedura consigliata, è consigliabile richiedere informazioni sugli errori tramite l'elemento ResponseMode quando si chiama GetBulkUploadUrl e verificare se sono presenti errori in ResultFileUrl .

Non riuscito: l'intero caricamento non è riuscito a causa di un errore imprevisto. È possibile inviare un nuovo caricamento con meno entità o riprovare a inviare lo stesso caricamento in un secondo momento.

FileUploaded: la richiesta di caricamento è stata ricevuta ed è nella coda per l'elaborazione.

InProgress: il file di caricamento è stato accettato e il caricamento è in corso.

PendingFileUpload: il file di caricamento non è stato ricevuto per il valore RequestId corrispondente.

UploadFileRowCountExceeded: il limite di record bulk nel file di caricamento è stato superato. Per altre informazioni sui limiti e sulle procedure consigliate per il caricamento, vedere Caricamento in blocco.

UploadFileFormatNotSupported: il campo Formato nomeversione specificato nel caricamento non è supportato per questa versione dell'API bulk.		 corda
ResultFileUrl URL del file che contiene i risultati richiesti, ad esempio le informazioni sull'errore di caricamento.

L'URL deve essere usato entro cinque minuti dal momento in cui l'operazione GetBulkUploadStatus restituisce la stringa di risposta di stato Completed o CompletedWithErrors . Se non si avvia il download entro questo periodo di tempo, sarà necessario chiamare nuovamente GetBulkUploadStatus per ottenere un nuovo URL. Non è consigliabile assumere una dipendenza dal dominio dell'URL di download, perché è soggetto a modifiche.		 corda

Elementi dell'intestazione della risposta

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

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">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 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>
    <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:e216="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e216:KeyValuePairOfstringstring>
          <e216:key d4p1:nil="false">ValueHere</e216:key>
          <e216:value d4p1:nil="false">ValueHere</e216:value>
        </e216: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>

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<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)

Requisiti

Servizio: BulkService.svc v13
Spazio dei nomi: https://bingads.microsoft.com/CampaignManagement/v13