Condividi tramite

Operazione del servizio DownloadCampaignsByAccountIds - Bulk

  • Articolo

Scarica le impostazioni e i dati sulle prestazioni per tutte le campagne dell'account. È possibile richiedere tutti i dati della campagna o solo i dati modificati dall'ultima volta che è stato scaricato l'account.

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

Consiglio

Lo schema file bulk fornisce dettagli sui record che è possibile scaricare e caricare. Attenersi alle procedure consigliate per garantire un utilizzo equo per se stessi e per tutti i client Microsoft Advertising. Per informazioni dettagliate, vedere Procedure consigliate per il download bulk e Procedure consigliate per il caricamento bulk.

Elementi della richiesta

L'oggetto DownloadCampaignsByAccountIdsRequest 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
AccountIds Identificatore dell'account che contiene i dati della campagna da scaricare. Il numero massimo di account che è possibile specificare è uno.

Le dimensioni dell'account che è possibile scaricare sono limitate a quattro milioni di parole chiave. Se si tenta di scaricare un account che contiene più di 4 milioni di parole chiave, la chiamata avrà esito negativo con l'errore 3207 (AccountTooBigToDownload). Se la chiamata non riesce, chiamare l'operazione DownloadCampaignsByCampaignIds per scaricare l'account in base alle campagne. L'elemento Details dell'errore include un elenco delimitato da virgole degli ID campagna di cui è proprietario l'account.		 matrice long
CompressionType Tipo di compressione del file di download. Per i valori possibili, vedere CompressionType. Il tipo di compressione predefinito è Zip. CompressionType
DataScope Puoi includere dati sul punteggio di qualità, ad esempio la rilevanza degli annunci, oltre ai dati delle entità, ad esempio le impostazioni della campagna. Il valore predefinito è EntityData.

È possibile includere più valori come flag. Il modo in cui si specificano più flag dipende dal linguaggio di programmazione usato. Ad esempio, C# considera questi valori come valori flag e Java li considera come una matrice di stringhe. Soap deve includere una stringa che contiene un elenco di valori delimitato da spazi, <DataScope>EntityData QualityScoreData</DataScope>ad esempio .

Se BidSuggestionsData o QualityScoreData sono inclusi, è necessario richiedere una sincronizzazione completa. Per eseguire una sincronizzazione completa, non impostare LastSyncTimeInUTC , ad esempio, lasciare nullo.		 DataScope
DownloadEntities Entità da includere nel download. Per un elenco delle entità che è possibile scaricare, vedere il set di valori DownloadEntity .

È necessario specificare almeno un'entità di download e in caso contrario l'operazione verrà eseguita in modo errato.		 Matrice DownloadEntity
DownloadFileType Tipo di file del file di download. Per i valori possibili, vedere DownloadFileType. Il valore predefinito è CSV. DownloadFileType
FormatVersion Formato per i record del file di download.

Come procedura consigliata è consigliabile specificare sempre la versione del formato più recente. Attualmente l'unica versione di formato supportata per l'API Bing Ads versione 13 è la 6.0.

È consigliabile gestire i record in base allo schema file bulk per la versione del formato corrispondente.		 Stringa
LastSyncTimeInUTC L'ultima volta che è stato richiesto un download. La data e l'ora sono espresse nell'ora UTC (Coordinated Universal Time).

Se si specifica l'ora dell'ultima sincronizzazione, verranno scaricate solo le entità modificate (aggiunte, aggiornate o eliminate) dalla data e dall'ora specificate. Se la campagna o il gruppo di annunci padre è stato eliminato dall'ultima sincronizzazione specificata, verrà visualizzato solo un record eliminato per la campagna o il gruppo di annunci padre eliminato. Ad esempio, se una campagna è stata eliminata, il file bulk non conterrà record eliminati per i gruppi di annunci, i criteri, gli annunci e le parole chiave presenti nella campagna.

Il criterio di destinazione viene trattato in modo leggermente diverso dalle altre entità e i record eliminati non vengono restituiti. Se sono state apportate modifiche alla destinazione di una campagna o di un gruppo di annunci, vengono restituiti tutti i record dei criteri di destinazione secondaria attualmente attivi.

In genere, si richiede un download completo la prima volta che si chiama l'operazione impostando questo elemento su Null. In tutte le chiamate successive si imposta l'ora dell'ultima sincronizzazione sul timestamp del download precedente.

Il file di download contiene il timestamp del download nella colonna Ora di sincronizzazione del record account . È consigliabile usare l'ora di sincronizzazione dell'account per impostare questo elemento la volta successiva in cui si richiede un download.

Se si imposta una data e un'ora superiori a 30 giorni fa, verrà restituito un errore.		 Datetime

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 DownloadCampaignsByAccountIdsResponse definisce il corpo e gli elementi di 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
DownloadRequestId Identificatore della richiesta di download.

Usare l'identificatore per chiamare l'operazione GetBulkDownloadStatus per controllare lo stato del download.

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 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">DownloadCampaignsByAccountIds</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>
    <DownloadCampaignsByAccountIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <CompressionType i:nil="false">ValueHere</CompressionType>
      <DataScope>ValueHere</DataScope>
      <DownloadEntities i:nil="false">
        <DownloadEntity>ValueHere</DownloadEntity>
      </DownloadEntities>
      <DownloadFileType i:nil="false">ValueHere</DownloadFileType>
      <FormatVersion i:nil="false">ValueHere</FormatVersion>
      <LastSyncTimeInUTC i:nil="false">ValueHere</LastSyncTimeInUTC>
    </DownloadCampaignsByAccountIdsRequest>
  </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>
    <DownloadCampaignsByAccountIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByAccountIdsResponse>
  </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<DownloadCampaignsByAccountIdsResponse> DownloadCampaignsByAccountIdsAsync(
	IList<long> accountIds,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByAccountIdsRequest
	{
		AccountIds = accountIds,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

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

static DownloadCampaignsByAccountIdsResponse downloadCampaignsByAccountIds(
	ArrayOflong accountIds,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByAccountIdsRequest request = new DownloadCampaignsByAccountIdsRequest();

	request.setAccountIds(accountIds);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

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

static function DownloadCampaignsByAccountIds(
	$accountIds,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByAccountIdsRequest();

	$request->AccountIds = $accountIds;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

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

response=bulk_service.DownloadCampaignsByAccountIds(
	AccountIds=AccountIds,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

Requisiti

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