SearchCoupons 服務作業 - 客戶計費

從已提供 之 customerID 識別為 ownerCustomer 的優待券集中，搜尋符合指定準則的優待券。 ownerCustomer 指定會在最小化時指派給優待券。

注意事項

SearchCoupons 可讓您查看哪些與 ownerCustomer 相關聯的優待券已由哪個帳戶兌換。 它可能不會傳回與您帳戶相關聯的每個優待券。

要求專案

SearchCouponsRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	根據優待券的指定屬性來決定結果的順序。 您應該只在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 CouponClassName - 訂單是由傳回之 Coupon 的 CouponClassName 元素所決定。 CouponStartDate - 訂單是由傳回之 Coupon 的 CouponStartDate 元素決定。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定要求條件。 此作業的回應將包含符合所有指定述詞的優待券。 您最多可以指定 4 個述詞，其中一個述詞字段必須是 CustomerId。 如需此服務作業之 Predicate 物件支援的 Field 和 Operator 元素清單，請參閱述詞備註。	述詞陣 語
ReturnAdditionalFields	如果設定為 「CouponClaimInfo」，請在響應中傳回 CouponClaimInfo 。	AccountAdditionalField

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchCouponsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
優惠券	符合指定準則的優待券清單。	優待券陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求SOAP

此範本是由工具所產生，用來顯示SOAP要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

<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

此範本是由工具所產生，用來顯示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>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)

需求

服務： CustomerBillingService.svc v13
Namespace： https://bingads.microsoft.com/Billing/v13

要求 URL

生產URL

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

沙箱 URL

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

要求專案

SearchCouponsRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	根據優待券的指定屬性來決定結果的順序。 您應該只在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 CouponClassName - 訂單是由傳回之 Coupon 的 CouponClassName 元素所決定。 CouponStartDate - 訂單是由傳回之 Coupon 的 CouponStartDate 元素決定。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定要求條件。 此作業的回應將包含符合所有指定述詞的優待券。 您最多可以指定 4 個述詞，其中一個述詞字段必須是 CustomerId。 如需此服務作業之 Predicate 物件支援的 Field 和 Operator 元素清單，請參閱述詞備註。	述詞陣 語
ReturnAdditionalFields	如果設定為 「CouponClaimInfo」，請在響應中傳回 CouponClaimInfo 。	AccountAdditionalField

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchCouponsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
優惠券	符合指定準則的優待券清單。	優待券陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

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

回應 JSON

此範本是由工具所產生，用來顯示 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"
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)