DownloadCampaignsByCampaignIds Service Operation - Bulk

Article
12/21/2023

Télécharge les paramètres et les données de performances pour les campagnes spécifiées. Vous pouvez demander toutes les données de campagne ou uniquement les données qui ont changé depuis le dernier téléchargement de la campagne.

Vous devez utiliser les mêmes informations d’identification utilisateur pour l’opération de demande de téléchargement ( DownloadCampaignsByAccountIds ou DownloadCampaignsByCampaignIds) et l’opération d’interrogation GetBulkDownloadStatus .

Conseil

Le schéma de fichier en bloc fournit des détails sur les enregistrements que vous pouvez télécharger et charger. Respectez les bonnes pratiques pour garantir une utilisation équitable pour vous et tous les clients Microsoft Advertising. Pour plus d’informations, consultez Meilleures pratiques de téléchargement en bloc et Meilleures pratiques de chargement en bloc.

Éléments de demande

L’objet DownloadCampaignsByCampaignIdsRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
Campagnes	Campagnes à télécharger. Vous pouvez spécifier un maximum de 1 000 campagnes. Les campagnes que vous spécifiez doivent appartenir au même compte.	Tableau CampaignScope
CompressionType	Type de compression du fichier de téléchargement. Pour connaître les valeurs possibles, consultez CompressionType. Le type de compression par défaut est Zip.	CompressionType
Datascope	Vous pouvez inclure des données de score de qualité telles que la pertinence des annonces, en plus des données d’entité telles que les paramètres de campagne. La valeur par défaut est EntityData. Vous pouvez inclure plusieurs valeurs en tant qu’indicateurs. La façon dont vous spécifiez plusieurs indicateurs dépend du langage de programmation que vous utilisez. Par exemple, C# traite ces valeurs comme des valeurs d’indicateur et Java les traite comme un tableau de chaînes. Le soap doit inclure une chaîne qui contient une liste de valeurs délimitées par des espaces, par exemple. `<DataScope>EntityData QualityScoreData</DataScope>` Si BidSuggestionsData ou QualityScoreData sont inclus, vous devez demander une synchronisation complète. Pour effectuer une synchronisation complète, ne définissez pas LastSyncTimeInUTC , c’est-à-dire laissez-la nulle.	Datascope
DownloadEntities	Entités à inclure dans le téléchargement. Pour obtenir la liste des entités que vous pouvez télécharger, consultez l’ensemble de valeurs DownloadEntity . Vous devez spécifier au moins une entité de téléchargement. Sinon, l’opération entraîne une erreur.	Tableau DownloadEntity
DownloadFileType	Format du fichier de téléchargement. Pour connaître les valeurs possibles, consultez DownloadFileType. La valeur par défaut est CSV.	DownloadFileType
FormatVersion	Format des enregistrements du fichier de téléchargement. Il est recommandé de toujours spécifier la dernière version du format. Actuellement, la seule version de format prise en charge pour l’API Bing Ads Version 13 est 6.0. Vous devez gérer les enregistrements en fonction du schéma de fichier en bloc pour la version de format correspondante.	chaîne
LastSyncTimeInUTC	Dernière fois que vous avez demandé un téléchargement. La date et l’heure sont exprimées en temps universel coordonné (UTC). Si vous spécifiez l’heure de la dernière synchronisation, seules les entités qui ont été modifiées (ajoutées, mises à jour ou supprimées) depuis la date et l’heure spécifiées sont téléchargées. Si la campagne parente ou le groupe d’annonces a été supprimé depuis la dernière heure de synchronisation spécifiée, vous verrez uniquement un enregistrement supprimé pour la campagne parente ou le groupe d’annonces supprimé. Par exemple, si une campagne a été supprimée, le fichier en bloc ne contient pas d’enregistrements supprimés pour les groupes d’annonces, les critères, les publicités et les mots clés qui se trouvaient dans la campagne. Les critères cibles sont traités légèrement différemment des autres entités, et les enregistrements supprimés ne sont pas retournés. Si des modifications ont été apportées à la cible d’une campagne ou d’un groupe d’annonces, tous les enregistrements de critères de sous-cible actuellement actifs sont retournés. En règle générale, vous demandez un téléchargement complet la première fois que vous appelez l’opération en définissant cet élément sur null. Sur tous les appels suivants, vous définissez l’heure de la dernière synchronisation sur l’horodatage du téléchargement précédent. Le fichier de téléchargement contient l’horodatage du téléchargement dans la colonne Heure de synchronisation de l’enregistrement de compte . Vous devez utiliser l’heure de synchronisation du compte pour définir cet élément la prochaine fois que vous demandez un téléchargement. Si vous définissez une date et une heure antérieures à plus de 30 jours, une erreur est retournée.	dateTime

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
Customerid	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Password	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet DownloadCampaignsByCampaignIdsResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément	Description	Type de données
DownloadRequestId	Identificateur de la demande de téléchargement. Vous utilisez l’identificateur pour appeler l’opération GetBulkDownloadStatus afin de case activée la status du téléchargement. L’identificateur est valide pendant un maximum de deux jours. Si vous n’avez pas correctement téléchargé le fichier au cours de cette période, il est supprimé du site de téléchargement et vous devrez obtenir un nouvel identificateur de demande de téléchargement. La chaîne a une longueur allant jusqu’à 40 et peut contenir n’importe quel caractère.	chaîne

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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">DownloadCampaignsByCampaignIds</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>
    <DownloadCampaignsByCampaignIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Campaigns i:nil="false">
        <CampaignScope>
          <CampaignId>ValueHere</CampaignId>
          <ParentAccountId>ValueHere</ParentAccountId>
        </CampaignScope>
      </Campaigns>
      <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>
    </DownloadCampaignsByCampaignIdsRequest>
  </s:Body>
</s:Envelope>

Soap de réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>
    <DownloadCampaignsByCampaignIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByCampaignIdsResponse>
  </s:Body>
</s:Envelope>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

public async Task<DownloadCampaignsByCampaignIdsResponse> DownloadCampaignsByCampaignIdsAsync(
	IList<CampaignScope> campaigns,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByCampaignIdsRequest
	{
		Campaigns = campaigns,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

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

static DownloadCampaignsByCampaignIdsResponse downloadCampaignsByCampaignIds(
	ArrayOfCampaignScope campaigns,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByCampaignIdsRequest request = new DownloadCampaignsByCampaignIdsRequest();

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

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

static function DownloadCampaignsByCampaignIds(
	$campaigns,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

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

	$request = new DownloadCampaignsByCampaignIdsRequest();

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

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

response=bulk_service.DownloadCampaignsByCampaignIds(
	Campaigns=Campaigns,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

Configuration requise

Service : BulkService.svc v13
Noms: https://bingads.microsoft.com/CampaignManagement/v13