Opération de service GetBulkDownloadStatus - En bloc

Article
12/21/2023

Obtient la status d’une demande de téléchargement en bloc.

Remarque

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 .

Éléments de demande

L’objet GetBulkDownloadStatusRequest définit le corps et les éléments d’en-tête 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
RequestId	Identificateur de la demande de téléchargement. Les opérations DownloadCampaignsByAccountIds et DownloadCampaignsByCampaignIds retournent cet élément en tant que DownloadRequestId. 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 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 GetBulkDownloadStatusResponse définit le corps et les éléments d’en-tête 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
Erreurs	Tableau d’objets OperationError correspondant aux erreurs rencontrées lors du traitement système du fichier en bloc après l’envoi de votre demande de téléchargement.	Tableau OperationError
ForwardCompatibilityMap	Liste des chaînes de clé et de valeur pour la compatibilité avant afin d’éviter les changements cassants lorsque de nouveaux éléments sont ajoutés dans la version actuelle de l’API. Les modifications de compatibilité avant seront notées ici dans les versions ultérieures. Il n’existe actuellement aucune modification de compatibilité avant pour cette opération.	Tableau KeyValuePairOfstringstring
PercentComplete	Pourcentage d’achèvement de la progression du traitement système du fichier de téléchargement en bloc.	int
RequestStatus	Status du téléchargement. Les valeurs possibles sont les suivantes. Terminé : le téléchargement s’est terminé avec succès. InProgress : le téléchargement est en cours. Échec : le téléchargement a échoué. Vous pouvez soumettre un nouveau téléchargement avec moins d’entités, sans le score de qualité et les données de suggestions d’enchères, ou réessayer d’envoyer le même téléchargement ultérieurement. FailedFullSyncRequired : l’élément LastSyncTimeInUTC de la requête doit être défini sur null, par exemple si le compte spécifié a été inclus dans une migration de données. Après avoir demandé un téléchargement complet, vous pouvez recommencer à demander des téléchargements delta.	chaîne
ResultFileUrl	URL qui contient les données de téléchargement lorsque la valeur RequestStatus est Terminée. Vous avez cinq minutes à partir du moment où cette URL est retournée pour télécharger le fichier. Si vous ne démarrez pas le téléchargement pendant cette période, vous devez appeler à nouveau GetBulkDownloadStatus pour obtenir une nouvelle URL. Vous ne devez pas dépendre du domaine de l’URL de téléchargement, car elle est susceptible d’être modifiée. Le fichier de téléchargement étant compressé (au format zip), vous devez décompresser le fichier pour accéder aux données. Pour plus d’informations sur le format de fichier en bloc, consultez Schéma de fichier en bloc.	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">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 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>
    <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>

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

Configuration requise

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

Partager via