SearchCoupons サービス操作 - 顧客の課金

指定された customerID が ownerCustomer として識別される一連のクーポン内から、指定された条件に一致するクーポンを検索します。 ownerCustomer 指定は、造幣時にクーポンに割り当てられます。

注:

SearchCoupons を使用すると、 ownerCustomer に関連付けられているどのクーポンがどのアカウントで引き換えられたかを確認できます。 アカウントに関連付けられているすべてのクーポンが返されるわけではありません。

Request 要素

SearchCouponsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
順序	クーポンの指定されたプロパティによって結果の順序を決定します。 配列では 、OrderBy 要素を 1 つだけ指定する必要があります。 追加の要素はサポートされていないため、サービスによって無視されます。 このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。 CouponClassName - 注文は、返された Coupon の CouponClassName 要素によって決定されます。 CouponStartDate - 注文は、返された Coupon の CouponStartDate 要素によって決定されます。	OrderBy 配列
PageInfo	ページごとの結果のインデックスとサイズを決定します。	Paging
述語	要求条件を決定します。 この操作の応答には、指定されたすべての述語に一致するクーポンが含まれます。 最大 4 つの述語を指定でき、述語フィールドの 1 つが CustomerId である必要があります。 このサービス操作で Predicate オブジェクトのサポートされている Field 要素と Operator 要素の一覧については、「述語の備考」を参照してください。	述語 配列
ReturnAdditionalFields	"CouponClaimInfo" に設定されている場合は、応答で CouponClaimInfo を返します。	AccountAdditionalField

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの 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

Request 要素

SearchCouponsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
順序	クーポンの指定されたプロパティによって結果の順序を決定します。 配列では 、OrderBy 要素を 1 つだけ指定する必要があります。 追加の要素はサポートされていないため、サービスによって無視されます。 このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。 CouponClassName - 注文は、返された Coupon の CouponClassName 要素によって決定されます。 CouponStartDate - 注文は、返された Coupon の CouponStartDate 要素によって決定されます。	OrderBy 配列
PageInfo	ページごとの結果のインデックスとサイズを決定します。	Paging
述語	要求条件を決定します。 この操作の応答には、指定されたすべての述語に一致するクーポンが含まれます。 最大 4 つの述語を指定でき、述語フィールドの 1 つが CustomerId である必要があります。 このサービス操作で Predicate オブジェクトのサポートされている Field 要素と Operator 要素の一覧については、「述語の備考」を参照してください。	述語 配列
ReturnAdditionalFields	"CouponClaimInfo" に設定されている場合は、応答で CouponClaimInfo を返します。	AccountAdditionalField

要求ヘッダー要素

要素	説明	データ型
Authorization	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

SearchCouponsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response 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)