Opération du service RedeemCoupon - Facturation client
Échange une coupon sur le compte spécifié.
Remarque
Seul un utilisateur de la facture du compte au client disposant d’informations d’identification Super Administration ou Standard peut échanger des coupon. Pour plus d’informations, consultez le guide technique rôles d’utilisateur .
Éléments de demande
L’objet RedeemCouponRequest 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 |
|---|---|---|
| AccountId | Identificateur du compte sur lequel le coupon est utilisé. | long |
| CouponCode | Code de coupon à utiliser. | 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 |
| 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 RedeemCouponResponse 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 |
|---|---|---|
| RedemptionDate | Date et heure auxquelles le coupon a été utilisé. | dateTime |
É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">RedeemCoupon</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<RedeemCouponRequest xmlns="https://bingads.microsoft.com/Billing/v13">
<AccountId>ValueHere</AccountId>
<CouponCode i:nil="false">ValueHere</CouponCode>
</RedeemCouponRequest>
</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>
<RedeemCouponResponse xmlns="https://bingads.microsoft.com/Billing/v13">
<RedemptionDate>ValueHere</RedemptionDate>
</RedeemCouponResponse>
</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<RedeemCouponResponse> RedeemCouponAsync(
long accountId,
string couponCode)
{
var request = new RedeemCouponRequest
{
AccountId = accountId,
CouponCode = couponCode
};
return (await CustomerBillingService.CallAsync((s, r) => s.RedeemCouponAsync(r), request));
}
static RedeemCouponResponse redeemCoupon(
java.lang.Long accountId,
java.lang.String couponCode) throws RemoteException, Exception
{
RedeemCouponRequest request = new RedeemCouponRequest();
request.setAccountId(accountId);
request.setCouponCode(couponCode);
return CustomerBillingService.getService().redeemCoupon(request);
}
static function RedeemCoupon(
$accountId,
$couponCode)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new RedeemCouponRequest();
$request->AccountId = $accountId;
$request->CouponCode = $couponCode;
return $GLOBALS['CustomerBillingProxy']->GetService()->RedeemCoupon($request);
}
response=customerbilling_service.RedeemCoupon(
AccountId=AccountId,
CouponCode=CouponCode)
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/Coupon/Redeem
Éléments de demande
L’objet RedeemCouponRequest définit le corps et les éléments d’en-tête 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 |
|---|---|---|
| AccountId | Identificateur du compte sur lequel le coupon est utilisé. | long |
| CouponCode | Code de coupon à utiliser. | chaîne |
É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 RedeemCouponResponse 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 |
|---|---|---|
| RedemptionDate | Date et heure auxquelles le coupon a été utilisé. | dateTime |
É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.
{
"AccountId": "LongValueHere",
"CouponCode": "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.
{
"RedemptionDate": "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<RedeemCouponResponse> RedeemCouponAsync(
long accountId,
string couponCode)
{
var request = new RedeemCouponRequest
{
AccountId = accountId,
CouponCode = couponCode
};
return (await CustomerBillingService.CallAsync((s, r) => s.RedeemCouponAsync(r), request));
}
static RedeemCouponResponse redeemCoupon(
java.lang.Long accountId,
java.lang.String couponCode) throws RemoteException, Exception
{
RedeemCouponRequest request = new RedeemCouponRequest();
request.setAccountId(accountId);
request.setCouponCode(couponCode);
return CustomerBillingService.getService().redeemCoupon(request);
}
static function RedeemCoupon(
$accountId,
$couponCode)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new RedeemCouponRequest();
$request->AccountId = $accountId;
$request->CouponCode = $couponCode;
return $GLOBALS['CustomerBillingProxy']->GetService()->RedeemCoupon($request);
}
response=customerbilling_service.RedeemCoupon(
AccountId=AccountId,
CouponCode=CouponCode)