Partager via

Opération de service ApplyOfflineConversions - Gestion des campagnes

  • Article

Applique les conversions hors connexion pour le compte avec l’ID de clic Microsoft parmi d’autres données de conversion hors connexion.

Supposons qu’un client voit votre annonce, clique dessus, mais finit par vous appeler, ce qui entraîne une vente qui a été mise hors connexion. Comment pouvez-vous suivre quand votre annonce de recherche mène à une conversion hors connexion et en dehors de votre site web ? Vous pouvez importer des conversions hors connexion pour mieux mesurer ce qui se passe après un clic sur votre annonce.

Après avoir créé un OfflineConversionGoal, vous devez attendre deux heures avant d’envoyer des conversions hors connexion à Microsoft Advertising. Si vous n’attendez pas deux heures, vos données de conversion hors connexion risquent de ne pas être appliquées. Une fois que vous avez envoyé les conversions hors connexion à Microsoft Advertising, l’affichage des données de conversion peut prendre jusqu’à six heures.

Chaque conversion hors connexion peut être divisée en plusieurs ID de clic. Toutefois, un ID d’un seul clic peut être associé à plusieurs objectifs de conversion et être également associé au même objectif plusieurs fois, tant que le temps de conversion est différent. En outre, la même conversion ne peut pas être importée plusieurs fois. Si plusieurs tentatives sont effectuées, la première instance est utilisée et les autres sont ignorées.

La valeur de la conversion peut être incluse dans le fichier d’importation avec une devise personnalisée. Si aucune devise n’est indiquée, la valeur par défaut de l’objectif de conversion est utilisée.

Pour plus d’informations, consultez Suivi des conversions hors connexion.

Éléments de demande

L’objet ApplyOfflineConversionsRequest 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
OfflineConversions Liste des conversions hors connexion pour le compte.

Vous pouvez ajouter un maximum de 1 000 conversions hors connexion par demande de service.

Chaque conversion hors connexion peut être divisée en plusieurs ID de clic. Toutefois, un ID d’un seul clic peut être associé à plusieurs objectifs de conversion et être également associé au même objectif plusieurs fois, tant que le temps de conversion est différent. En outre, la même conversion ne peut pas être appliquée plusieurs fois. Si vous envoyez des doublons Microsoft Advertising, la première instance sera utilisée et les autres seront ignorées.		 Tableau OfflineConversion

É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 ApplyOfflineConversionsResponse 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
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi.

La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.		 Tableau BatchError

É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">ApplyOfflineConversions</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>
    <ApplyOfflineConversionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <OfflineConversions i:nil="false">
        <OfflineConversion>
          <ConversionCurrencyCode i:nil="false">ValueHere</ConversionCurrencyCode>
          <ConversionName i:nil="false">ValueHere</ConversionName>
          <ConversionTime>ValueHere</ConversionTime>
          <ConversionValue i:nil="false">ValueHere</ConversionValue>
          <ExternalAttributionCredit i:nil="false">ValueHere</ExternalAttributionCredit>
          <ExternalAttributionModel i:nil="false">ValueHere</ExternalAttributionModel>
          <HashedEmailAddress i:nil="false">ValueHere</HashedEmailAddress>
          <HashedPhoneNumber i:nil="false">ValueHere</HashedPhoneNumber>
          <MicrosoftClickId i:nil="false">ValueHere</MicrosoftClickId>
        </OfflineConversion>
      </OfflineConversions>
    </ApplyOfflineConversionsRequest>
  </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>
    <ApplyOfflineConversionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e141="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e141:KeyValuePairOfstringstring>
              <e141:key d4p1:nil="false">ValueHere</e141:key>
              <e141:value d4p1:nil="false">ValueHere</e141:value>
            </e141:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </ApplyOfflineConversionsResponse>
  </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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.ApplyOfflineConversionsAsync(r), request));
}

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

	return CampaignManagementService.getService().applyOfflineConversions(request);
}

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

	return $GLOBALS['CampaignManagementProxy']->GetService()->ApplyOfflineConversions($request);
}

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)

Configuration requise

Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

URL de la demande

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/OfflineConversions/Apply

Éléments de demande

L’objet ApplyOfflineConversionsRequest définit les éléments body et header de la demande d’opération de service.

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
OfflineConversions Liste des conversions hors connexion pour le compte.

Vous pouvez ajouter un maximum de 1 000 conversions hors connexion par demande de service.

Chaque conversion hors connexion peut être divisée en plusieurs ID de clic. Toutefois, un ID d’un seul clic peut être associé à plusieurs objectifs de conversion et être également associé au même objectif plusieurs fois, tant que le temps de conversion est différent. En outre, la même conversion ne peut pas être appliquée plusieurs fois. Si vous envoyez des doublons Microsoft Advertising, la première instance sera utilisée et les autres seront ignorées.		 Tableau OfflineConversion

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

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

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 ApplyOfflineConversionsResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi.

La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.		 Tableau BatchError

É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 JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. 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.

{
  "OfflineConversions": [
    {
      "ConversionCurrencyCode": "ValueHere",
      "ConversionName": "ValueHere",
      "ConversionTime": "ValueHere",
      "ConversionValue": DoubleValueHere,
      "ExternalAttributionCredit": DoubleValueHere,
      "ExternalAttributionModel": "ValueHere",
      "HashedEmailAddress": "ValueHere",
      "HashedPhoneNumber": "ValueHere",
      "MicrosoftClickId": "ValueHere"
    }
  ]
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

Voici un exemple qui s’applique si le type de BatchError est EditorialError.

{
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.ApplyOfflineConversionsAsync(r), request));
}

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

	return CampaignManagementService.getService().applyOfflineConversions(request);
}

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

	return $GLOBALS['CampaignManagementProxy']->GetService()->ApplyOfflineConversions($request);
}

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)