Partager via


Opération de service GetBulkUploadStatus - En bloc

Obtient l’état et la progression de l’achèvement d’une demande de chargement en bloc.

Éléments de demande

L’objet GetBulkUploadStatusRequest 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
RequestId Identificateur de la demande de chargement.

L’identificateur est valide jusqu’à 15 minutes. Si vous n’avez pas correctement chargé le fichier au cours de cette période, vous devez obtenir un nouvel identificateur de demande et une URL de chargement.
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
Mot de passe 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 GetBulkUploadStatusResponse 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
Erreurs Tableau d’objets OperationError correspondant aux erreurs rencontrées pendant le traitement système du fichier en bloc une fois votre chargement HTTP POST terminé.

Par exemple, un OperationError inclut le code d’erreur BulkServiceFormatVersionNotSupported si le fichier chargé contient un ou plusieurs enregistrements en bloc qui ne sont pas pris en charge avec la version de format de fichier correspondante.
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 en bloc chargé. La plage de valeurs est comprise entre 0 et 100.

Vous devez également comparer l’état du chargement. Si le chargement échoue, le pourcentage d’achèvement est réinitialisé à zéro (0).
int
RequestStatus État du chargement. Voici les valeurs d’état retournées possibles.

Terminé : le fichier de chargement a été accepté et traité avec succès sans erreur.

CompletedWithErrors : le chargement s’est terminé avec une ou plusieurs erreurs. Bien que le chargement global ait réussi, une ou plusieurs erreurs d’ajout ou de mise à jour ont pu se produire. Nous vous recommandons de demander des informations d’erreur via l’élément ResponseMode lors de l’appel de GetBulkUploadUrl et de vérifier les erreurs éventuelles dans ResultFileUrl .

Échec : l’intégralité du chargement a échoué en raison d’une erreur inattendue. Vous pouvez soumettre un nouveau chargement avec moins d’entités ou réessayer d’envoyer le même chargement ultérieurement.

FileUploaded : la demande de chargement a été reçue et se trouve dans la file d’attente pour traitement.

InProgress : le fichier de chargement a été accepté et le chargement est en cours.

PendingFileUpload : le fichier de chargement n’a pas été reçu pour le RequestId correspondant.

UploadFileRowCountExceeded : la limite d’enregistrements en bloc dans le fichier de chargement a été dépassée. Pour plus d’informations sur les limites et les meilleures pratiques de chargement, consultez Chargement en bloc.

UploadFileFormatNotSupported : le champ Nom de la version de format spécifié dans le chargement n’est pas pris en charge pour cette version de l’API en bloc.
chaîne
ResultFileUrl URL du fichier qui contient les résultats demandés, par exemple charger des informations d’erreur.

L’URL doit être utilisée dans les cinq minutes suivant le moment où l’opération GetBulkUploadStatus retourne la chaîne de réponse d’état Completed ou CompletedWithErrors . Si vous ne démarrez pas le téléchargement dans ce délai, vous devez appeler à nouveau GetBulkUploadStatus 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.
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">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 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>
    <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>

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

Configuration requise

Service : BulkService.svc v13
Espace de noms: https://bingads.microsoft.com/CampaignManagement/v13