Partager via

Opération du service SearchCoupons - Facturation client

  • Article

Recherche les coupons qui correspondent à un critère spécifié dans l’ensemble de coupons où le customerID fourni est identifié comme ownerCustomer. La désignation ownerCustomer est attribuée aux coupons au moment de la frappe.

Remarque

SearchCoupons vous permet de voir quels coupons associés à un propriétaireCustomer ont été utilisés par quel compte. Il se peut qu’elle ne retourne pas toutes les coupon associées à votre compte.

Éléments de demande

L’objet SearchCouponsRequest 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
Classement Détermine l’ordre des résultats par la propriété spécifiée d’un coupon.

Vous ne devez spécifier qu’un seul élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service.

Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy .

CouponClassName : l’ordre est déterminé par l’élément CouponClassName du Coupon retourné.

CouponStartDate : l’ordre est déterminé par l’élément CouponStartDate du coupon retourné.		 Tableau OrderBy
PageInfo Détermine l’index et la taille des résultats par page. Pagination
Prédicats Détermine les conditions de la demande. La réponse de cette opération inclut des coupons qui correspondent à tous les prédicats spécifiés.

Vous pouvez spécifier jusqu’à 4 prédicats, et l’un des champs de prédicat doit être CustomerId.

Pour obtenir la liste des éléments Field et Operator pris en charge d’un objet Predicate pour cette opération de service, consultez Remarques sur le prédicat.		 Tableau de prédicats
ReturnAdditionalFields Si la valeur est « CouponClaimInfo », renvoyez CouponClaimInfo dans la réponse. AccountAdditionalField

É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 SearchCouponsResponse 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
Coupons Liste des coupons qui répondent aux critères spécifiés. Tableau de coupons

É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">SearchCoupons</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <Predicates xmlns:e165="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e165:Predicate>
          <e165:Field i:nil="false">ValueHere</e165:Field>
          <e165:Operator>ValueHere</e165:Operator>
          <e165:Value i:nil="false">ValueHere</e165:Value>
        </e165:Predicate>
      </Predicates>
      <Ordering xmlns:e166="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e166:OrderBy>
          <e166:Field>ValueHere</e166:Field>
          <e166:Order>ValueHere</e166:Order>
        </e166:OrderBy>
      </Ordering>
      <PageInfo xmlns:e167="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e167:Index>ValueHere</e167:Index>
        <e167:Size>ValueHere</e167:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchCouponsRequest>
  </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>
    <SearchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <Coupons xmlns:e168="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e168:Coupon>
          <e168:CouponCode d4p1:nil="false">ValueHere</e168:CouponCode>
          <e168:ClassName d4p1:nil="false">ValueHere</e168:ClassName>
          <e168:CouponType d4p1:nil="false">ValueHere</e168:CouponType>
          <e168:Amount>ValueHere</e168:Amount>
          <e168:SpendThreshold>ValueHere</e168:SpendThreshold>
          <e168:CurrencyCode d4p1:nil="false">ValueHere</e168:CurrencyCode>
          <e168:PercentOff d4p1:nil="false">ValueHere</e168:PercentOff>
          <e168:ActiveDuration d4p1:nil="false">ValueHere</e168:ActiveDuration>
          <e168:ExpirationDate d4p1:nil="false">ValueHere</e168:ExpirationDate>
          <e168:StartDate d4p1:nil="false">ValueHere</e168:StartDate>
          <e168:EndDate d4p1:nil="false">ValueHere</e168:EndDate>
          <e168:SendToEmail d4p1:nil="false">ValueHere</e168:SendToEmail>
          <e168:SendToDate d4p1:nil="false">ValueHere</e168:SendToDate>
          <e168:IsRedeemed>ValueHere</e168:IsRedeemed>
          <e168:RedemptionInfo d4p1:nil="false">
            <e168:AccountId>ValueHere</e168:AccountId>
            <e168:AccountNumber d4p1:nil="false">ValueHere</e168:AccountNumber>
            <e168:SpendToThreshold>ValueHere</e168:SpendToThreshold>
            <e168:Balance>ValueHere</e168:Balance>
            <e168:CurrencyCode d4p1:nil="false">ValueHere</e168:CurrencyCode>
            <e168:RedemptionDate>ValueHere</e168:RedemptionDate>
            <e168:ExpirationDate>ValueHere</e168:ExpirationDate>
            <e168:ActivationDate d4p1:nil="false">ValueHere</e168:ActivationDate>
          </e168:RedemptionInfo>
          <e168:ClaimInfo d4p1:nil="false">
            <e168:AccountId>ValueHere</e168:AccountId>
            <e168:AccountNumber d4p1:nil="false">ValueHere</e168:AccountNumber>
            <e168:ClaimDate>ValueHere</e168:ClaimDate>
          </e168:ClaimInfo>
        </e168:Coupon>
      </Coupons>
    </SearchCouponsResponse>
  </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<SearchCouponsResponse> SearchCouponsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchCouponsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchCouponsResponse searchCoupons(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchCouponsRequest request = new SearchCouponsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchCoupons(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchCouponsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customerbilling_service.SearchCoupons(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

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/Coupons/Search

Éléments de demande

L’objet SearchCouponsRequest 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
Classement Détermine l’ordre des résultats par la propriété spécifiée d’un coupon.

Vous ne devez spécifier qu’un seul élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service.

Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy .

CouponClassName : l’ordre est déterminé par l’élément CouponClassName du Coupon retourné.

CouponStartDate : l’ordre est déterminé par l’élément CouponStartDate du coupon retourné.		 Tableau OrderBy
PageInfo Détermine l’index et la taille des résultats par page. Pagination
Prédicats Détermine les conditions de la demande. La réponse de cette opération inclut des coupons qui correspondent à tous les prédicats spécifiés.

Vous pouvez spécifier jusqu’à 4 prédicats, et l’un des champs de prédicat doit être CustomerId.

Pour obtenir la liste des éléments Field et Operator pris en charge d’un objet Predicate pour cette opération de service, consultez Remarques sur le prédicat.		 Tableau de prédicats
ReturnAdditionalFields Si la valeur est « CouponClaimInfo », renvoyez CouponClaimInfo dans la réponse. AccountAdditionalField

É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 SearchCouponsResponse 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
Coupons Liste des coupons qui répondent aux critères spécifiés. Tableau de coupons

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

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  },
  "ReturnAdditionalFields": "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.

{
  "Coupons": [
    {
      "ActiveDuration": IntValueHere,
      "Amount": DoubleValueHere,
      "ClaimInfo": {
        "AccountId": "LongValueHere",
        "AccountNumber": "ValueHere",
        "ClaimDate": "ValueHere"
      },
      "ClassName": "ValueHere",
      "CouponCode": "ValueHere",
      "CouponType": "ValueHere",
      "CurrencyCode": "ValueHere",
      "EndDate": "ValueHere",
      "ExpirationDate": "ValueHere",
      "IsRedeemed": "ValueHere",
      "PercentOff": DoubleValueHere,
      "RedemptionInfo": {
        "AccountId": "LongValueHere",
        "AccountNumber": "ValueHere",
        "ActivationDate": "ValueHere",
        "Balance": DoubleValueHere,
        "CurrencyCode": "ValueHere",
        "ExpirationDate": "ValueHere",
        "RedemptionDate": "ValueHere",
        "SpendToThreshold": DoubleValueHere
      },
      "SendToDate": "ValueHere",
      "SendToEmail": "ValueHere",
      "SpendThreshold": DoubleValueHere,
      "StartDate": "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<SearchCouponsResponse> SearchCouponsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchCouponsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchCouponsResponse searchCoupons(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchCouponsRequest request = new SearchCouponsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchCoupons(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchCouponsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customerbilling_service.SearchCoupons(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)