Partager via

Opération de service ClaimFeatureAdoptionCoupons - Facturation client

  • Article

Revendiquer des coupons d’adoption des fonctionnalités.

Éléments de demande

L’objet ClaimFeatureAdoptionCouponsRequest 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
AccountCouponPairs Liste des paires de codes ID de compte et coupon. Tableau KeyValueEntityOflongstring

É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
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 ClaimFeatureAdoptionCouponsResponse 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
ClaimedDateByAccountId Date à laquelle une demande a été faite pour un compte. Tableau KeyValueEntityOflongdateTime
OperationErrors Tableau d’objets OperationError qui contient les raisons expliquant pourquoi l’opération de service a échoué lorsque l’erreur n’est pas liée à un élément spécifique dans le lot d’éléments. Tableau OperationError
PartialErrors Tableau d’objets OperationError qui correspondent à toutes les adresses e-mail auxquelles le code coupon n’a pas pu être envoyé.

La liste peut être vide s’il n’y a pas d’erreur.		 Tableau OperationError

É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/Billing/v13">
    <Action mustUnderstand="1">ClaimFeatureAdoptionCoupons</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <ClaimFeatureAdoptionCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <AccountCouponPairs xmlns:e3="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e3:KeyValueEntityOflongstring>
          <e3:Key>ValueHere</e3:Key>
          <e3:Value i:nil="false">ValueHere</e3:Value>
        </e3:KeyValueEntityOflongstring>
      </AccountCouponPairs>
    </ClaimFeatureAdoptionCouponsRequest>
  </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/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <ClaimFeatureAdoptionCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <ClaimedDateByAccountId xmlns:e4="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e4:KeyValueEntityOflongdateTime>
          <e4:Key>ValueHere</e4:Key>
          <e4:Value>ValueHere</e4:Value>
        </e4:KeyValueEntityOflongdateTime>
      </ClaimedDateByAccountId>
      <OperationErrors xmlns:e5="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e5:OperationError>
          <e5:Code>ValueHere</e5:Code>
          <e5:Details d4p1:nil="false">ValueHere</e5:Details>
          <e5:Message d4p1:nil="false">ValueHere</e5:Message>
        </e5:OperationError>
      </OperationErrors>
      <PartialErrors xmlns:e6="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e6:ArrayOfOperationError>
          <e6:OperationError>
            <e6:Code>ValueHere</e6:Code>
            <e6:Details d4p1:nil="false">ValueHere</e6:Details>
            <e6:Message d4p1:nil="false">ValueHere</e6:Message>
          </e6:OperationError>
        </e6:ArrayOfOperationError>
      </PartialErrors>
    </ClaimFeatureAdoptionCouponsResponse>
  </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<ClaimFeatureAdoptionCouponsResponse> ClaimFeatureAdoptionCouponsAsync(
	IList<KeyValueEntityOflongstring> accountCouponPairs)
{
	var request = new ClaimFeatureAdoptionCouponsRequest
	{
		AccountCouponPairs = accountCouponPairs
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.ClaimFeatureAdoptionCouponsAsync(r), request));
}

static ClaimFeatureAdoptionCouponsResponse claimFeatureAdoptionCoupons(
	ArrayOfKeyValueEntityOflongstring accountCouponPairs) throws RemoteException, Exception
{
	ClaimFeatureAdoptionCouponsRequest request = new ClaimFeatureAdoptionCouponsRequest();

	request.setAccountCouponPairs(accountCouponPairs);

	return CustomerBillingService.getService().claimFeatureAdoptionCoupons(request);
}

static function ClaimFeatureAdoptionCoupons(
	$accountCouponPairs)
{

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

	$request = new ClaimFeatureAdoptionCouponsRequest();

	$request->AccountCouponPairs = $accountCouponPairs;

	return $GLOBALS['CustomerBillingProxy']->GetService()->ClaimFeatureAdoptionCoupons($request);
}

response=customerbilling_service.ClaimFeatureAdoptionCoupons(
	AccountCouponPairs=AccountCouponPairs)

Configuration requise

Service : CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

URL de la demande

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/FeatureAdoptionCoupons/Claim

Éléments de demande

L’objet ClaimFeatureAdoptionCouponsRequest 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
AccountCouponPairs Liste des paires de codes ID de compte et coupon. Tableau KeyValueEntityOflongstring

É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
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 ClaimFeatureAdoptionCouponsResponse 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
ClaimedDateByAccountId Date à laquelle une demande a été faite pour un compte. Tableau KeyValueEntityOflongdateTime
OperationErrors Tableau d’objets OperationError qui contient les raisons expliquant pourquoi l’opération de service a échoué lorsque l’erreur n’est pas liée à un élément spécifique dans le lot d’éléments. Tableau OperationError
PartialErrors Tableau d’objets OperationError qui correspondent à toutes les adresses e-mail auxquelles le code coupon n’a pas pu être envoyé.

La liste peut être vide s’il n’y a pas d’erreur.		 Tableau OperationError

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

{
  "AccountCouponPairs": [
    {
      "Key": "LongValueHere",
      "Value": "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.

{
  "ClaimedDateByAccountId": [
    {
      "Key": "LongValueHere",
      "Value": "ValueHere"
    }
  ],
  "OperationErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "Message": "ValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "Message": "ValueHere"
    }
  ]
}

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<ClaimFeatureAdoptionCouponsResponse> ClaimFeatureAdoptionCouponsAsync(
	IList<KeyValueEntityOflongstring> accountCouponPairs)
{
	var request = new ClaimFeatureAdoptionCouponsRequest
	{
		AccountCouponPairs = accountCouponPairs
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.ClaimFeatureAdoptionCouponsAsync(r), request));
}

static ClaimFeatureAdoptionCouponsResponse claimFeatureAdoptionCoupons(
	ArrayOfKeyValueEntityOflongstring accountCouponPairs) throws RemoteException, Exception
{
	ClaimFeatureAdoptionCouponsRequest request = new ClaimFeatureAdoptionCouponsRequest();

	request.setAccountCouponPairs(accountCouponPairs);

	return CustomerBillingService.getService().claimFeatureAdoptionCoupons(request);
}

static function ClaimFeatureAdoptionCoupons(
	$accountCouponPairs)
{

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

	$request = new ClaimFeatureAdoptionCouponsRequest();

	$request->AccountCouponPairs = $accountCouponPairs;

	return $GLOBALS['CustomerBillingProxy']->GetService()->ClaimFeatureAdoptionCoupons($request);
}

response=customerbilling_service.ClaimFeatureAdoptionCoupons(
	AccountCouponPairs=AccountCouponPairs)