Aracılığıyla paylaş

SearchCoupons Hizmeti İşlemi - Müşteri Faturalaması

  • Makale

Belirtilen ölçütlere uyan kuponları arar.

İstek Öğeleri

SearchCouponsRequest nesnesi, hizmet işlemi isteğinin gövde ve üst bilgi öğelerini tanımlar. Öğelerin İstek SOAP'sinde gösterildiği gibi aynı sırada olması gerekir.

Not

Aşağıda aksi belirtilmedikçe, tüm istek öğeleri gereklidir.

İstek Gövdesi Öğeleri

Öğe Açıklama Veri Türü
Sipariş Sonuçların sırasını bir kuponun belirtilen özelliğine göre belirler.

Dizide yalnızca bir OrderBy öğesi belirtmelisiniz. Ek öğeler desteklenmez ve hizmet tarafından yoksayılır.

Bu hizmet işlemi için, bir OrderBy nesnesinin Field öğesinde aşağıdaki değerler desteklenir.

ClassName - Sipariş, döndürülen KuponunClassName öğesi tarafından belirlenir.

StartDate - Sipariş, döndürülen KuponunStartDate öğesi tarafından belirlenir.		 OrderBy dizisi
PageInfo Sayfa başına sonuçların dizinini ve boyutunu belirler. Sayfalama
Yüklemler İstek koşullarını belirler. Bu işlemin yanıtı, belirtilen tüm koşullarla eşleşen kuponları içerir.

En fazla 4 koşul belirtebilirsiniz ve koşul alanlarından biri CustomerId olmalıdır.

Bu hizmet işlemi için bir Koşul nesnesinin desteklenen Alan ve İşleç öğelerinin listesi için bkz. Koşul Açıklamaları.		 Koşul dizisi
ReturnAdditionalFields "CouponClaimInfo" olarak ayarlanırsa yanıtta CouponClaimInfo değerini döndürür. AccountAdditionalField

İstek Üst Bilgisi Öğeleri

Öğe Açıklama Veri Türü
AuthenticationToken Microsoft Advertising hesaplarına izinleri olan bir kullanıcının kimlik bilgilerini temsil eden OAuth erişim belirteci.

Daha fazla bilgi için bkz. OAuth ile kimlik doğrulaması.		 dize
DeveloperToken Bing Ads API'sine erişmek için kullanılan geliştirici belirteci.

Daha fazla bilgi için bkz . Geliştirici Belirteci Alma.		 dize
Password Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. dize
Kullanıcı adı Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. dize

Yanıt Öğeleri

SearchCouponsResponse nesnesi, hizmet işlemi yanıtının gövde ve üst bilgi öğelerini tanımlar. Öğeler , Yanıt SOAP'sinde gösterildiği gibi aynı sırada döndürülür.

Yanıt Gövdesi Öğeleri

Öğe Açıklama Veri Türü
Kupon Belirtilen ölçütlere uyan kuponların listesi. Kupon dizisi

Yanıt Üst Bilgisi Öğeleri

Öğe Açıklama Veri Türü
TrackingId API çağrısının ayrıntılarını içeren günlük girdisinin tanımlayıcısı. dize

SOAP isteme

Bu şablon, SOAP isteği için gövde ve üst bilgi öğelerinin sırasını gösteren bir araç tarafından oluşturulmuştur. Bu hizmet işlemiyle kullanabileceğiniz desteklenen türler için yukarıdaki İstek Gövdesi Öğeleri başvurusuna bakın.

<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:e19="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e19:Predicate>
          <e19:Field i:nil="false">ValueHere</e19:Field>
          <e19:Operator>ValueHere</e19:Operator>
          <e19:Value i:nil="false">ValueHere</e19:Value>
        </e19:Predicate>
      </Predicates>
      <Ordering xmlns:e20="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e20:OrderBy>
          <e20:Field>ValueHere</e20:Field>
          <e20:Order>ValueHere</e20:Order>
        </e20:OrderBy>
      </Ordering>
      <PageInfo xmlns:e21="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e21:Index>ValueHere</e21:Index>
        <e21:Size>ValueHere</e21:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchCouponsRequest>
  </s:Body>
</s:Envelope>

Yanıt SOAP

Bu şablon, SOAP yanıtı için gövde ve üst bilgi öğelerinin sırasını gösteren bir araç tarafından oluşturulmuştur.

<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:e22="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e22:Coupon>
          <e22:CouponCode d4p1:nil="false">ValueHere</e22:CouponCode>
          <e22:ClassName d4p1:nil="false">ValueHere</e22:ClassName>
          <e22:CouponType d4p1:nil="false">ValueHere</e22:CouponType>
          <e22:Amount>ValueHere</e22:Amount>
          <e22:SpendThreshold>ValueHere</e22:SpendThreshold>
          <e22:CurrencyCode d4p1:nil="false">ValueHere</e22:CurrencyCode>
          <e22:PercentOff d4p1:nil="false">ValueHere</e22:PercentOff>
          <e22:ActiveDuration d4p1:nil="false">ValueHere</e22:ActiveDuration>
          <e22:ExpirationDate d4p1:nil="false">ValueHere</e22:ExpirationDate>
          <e22:StartDate d4p1:nil="false">ValueHere</e22:StartDate>
          <e22:EndDate d4p1:nil="false">ValueHere</e22:EndDate>
          <e22:SendToEmail d4p1:nil="false">ValueHere</e22:SendToEmail>
          <e22:SendToDate d4p1:nil="false">ValueHere</e22:SendToDate>
          <e22:IsRedeemed>ValueHere</e22:IsRedeemed>
          <e22:RedemptionInfo d4p1:nil="false">
            <e22:AccountId>ValueHere</e22:AccountId>
            <e22:AccountNumber d4p1:nil="false">ValueHere</e22:AccountNumber>
            <e22:SpendToThreshold>ValueHere</e22:SpendToThreshold>
            <e22:Balance>ValueHere</e22:Balance>
            <e22:CurrencyCode d4p1:nil="false">ValueHere</e22:CurrencyCode>
            <e22:RedemptionDate>ValueHere</e22:RedemptionDate>
            <e22:ExpirationDate>ValueHere</e22:ExpirationDate>
            <e22:ActivationDate d4p1:nil="false">ValueHere</e22:ActivationDate>
          </e22:RedemptionInfo>
          <e22:ClaimInfo d4p1:nil="false">
            <e22:AccountId>ValueHere</e22:AccountId>
            <e22:AccountNumber d4p1:nil="false">ValueHere</e22:AccountNumber>
            <e22:ClaimDate>ValueHere</e22:ClaimDate>
          </e22:ClaimInfo>
        </e22:Coupon>
      </Coupons>
    </SearchCouponsResponse>
  </s:Body>
</s:Envelope>

Kod Söz Dizimi

Örnek söz dizimi Bing Reklam SDK'ları ile kullanılabilir. Daha fazla örnek için bkz . Bing Ads API Kod Örnekleri .

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)

Gereksinimler

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

İstek Url'si

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/Coupons/Search

İstek Öğeleri

SearchCouponsRequest nesnesi, hizmet işlemi isteğinin gövde ve üst bilgi öğelerini tanımlar.

Not

Aşağıda aksi belirtilmedikçe, tüm istek öğeleri gereklidir.

İstek Gövdesi Öğeleri

Öğe Açıklama Veri Türü
Sipariş Sonuçların sırasını bir kuponun belirtilen özelliğine göre belirler.

Dizide yalnızca bir OrderBy öğesi belirtmelisiniz. Ek öğeler desteklenmez ve hizmet tarafından yoksayılır.

Bu hizmet işlemi için, bir OrderBy nesnesinin Field öğesinde aşağıdaki değerler desteklenir.

ClassName - Sipariş, döndürülen KuponunClassName öğesi tarafından belirlenir.

StartDate - Sipariş, döndürülen KuponunStartDate öğesi tarafından belirlenir.		 OrderBy dizisi
PageInfo Sayfa başına sonuçların dizinini ve boyutunu belirler. Sayfalama
Yüklemler İstek koşullarını belirler. Bu işlemin yanıtı, belirtilen tüm koşullarla eşleşen kuponları içerir.

En fazla 4 koşul belirtebilirsiniz ve koşul alanlarından biri CustomerId olmalıdır.

Bu hizmet işlemi için bir Koşul nesnesinin desteklenen Alan ve İşleç öğelerinin listesi için bkz. Koşul Açıklamaları.		 Koşul dizisi
ReturnAdditionalFields "CouponClaimInfo" olarak ayarlanırsa yanıtta CouponClaimInfo değerini döndürür. AccountAdditionalField

İstek Üst Bilgisi Öğeleri

Öğe Açıklama Veri Türü
İzin Microsoft Advertising hesaplarına izinleri olan bir kullanıcının kimlik bilgilerini temsil eden OAuth erişim belirteci. Belirtecin ön ekinin "Taşıyıcı" olduğundan emin olun, bu doğru kimlik doğrulaması için gereklidir.

Daha fazla bilgi için bkz. OAuth ile kimlik doğrulaması.		 dize
DeveloperToken Bing Ads API'sine erişmek için kullanılan geliştirici belirteci.

Daha fazla bilgi için bkz . Geliştirici Belirteci Alma.		 dize
Password Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. dize
Kullanıcı adı Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. dize

Yanıt Öğeleri

SearchCouponsResponse nesnesi, hizmet işlemi yanıtının gövde ve üst bilgi öğelerini tanımlar. Öğeler , Yanıt JSON'unda gösterildiği gibi aynı sırada döndürülür.

Yanıt Gövdesi Öğeleri

Öğe Açıklama Veri Türü
Kupon Belirtilen ölçütlere uyan kuponların listesi. Kupon dizisi

Yanıt Üst Bilgisi Öğeleri

Öğe Açıklama Veri Türü
TrackingId API çağrısının ayrıntılarını içeren günlük girdisinin tanımlayıcısı. dize

JSON isteme

Bu şablon, JSON isteğinin gövde ve üst bilgi öğelerini gösteren bir araç tarafından oluşturulmuştur. Bu hizmet işlemiyle kullanabileceğiniz desteklenen türler için yukarıdaki İstek Gövdesi Öğeleri başvurusuna bakın.

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  },
  "ReturnAdditionalFields": "ValueHere"
}

Yanıt JSON

Bu şablon, JSON yanıtının gövde ve üst bilgi öğelerini göstermek için bir araç tarafından oluşturulmuştur.

{
  "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"
    }
  ]
}

Kod Söz Dizimi

SDK'lar aracılığıyla REST API'yi çağırmak için SDK'yı belirli bir sürüme yükseltmeniz ve sistem parametrelerini yapılandırmanız gerekir. Örnek söz dizimi Bing Reklam SDK'ları ile kullanılabilir. Daha fazla örnek için bkz . Bing Ads API Kod Örnekleri .

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)