SearchCoupons 服务操作 - 客户计费

从提供的 customerID 标识为 ownerCustomer 的优惠券集中搜索与指定条件匹配的优惠券。 在铸造时， 所有者客户 指定分配给优惠券。

注意

SearchCoupons 允许您查看哪些与 所有者关联的 优惠券已通过哪个帐户兑换。 它可能不会返回与你的帐户关联的每个优惠券。

请求元素

SearchCouponsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
订购	通过优惠券的指定属性确定结果的顺序。 在数组中只应指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值。 CouponClassName - 顺序由返回的 Coupon 的 CouponClassName 元素决定。 CouponStartDate - 顺序由返回的优惠券的 CouponStartDate 元素决定。	OrderBy 数组
PageInfo	确定每页结果的索引和大小。	分页
谓词	确定请求条件。 此操作的响应将包括与所有指定谓词匹配的优惠券。 最多可以指定 4 个谓词，其中一个谓词字段必须为 CustomerId。 有关此服务操作的谓词对象支持的 Field 和 Operator 元素的列表，请参阅 Predicate 备注。	谓词 数组
ReturnAdditionalFields	如果设置为“CouponClaimInfo”，请在响应中返回 CouponClaimInfo 。	AccountAdditionalField

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchCouponsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
优惠 券	符合指定条件的优惠券列表。	优惠券 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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 - 顺序由返回的优惠券的 CouponStartDate 元素决定。	OrderBy 数组
PageInfo	确定每页结果的索引和大小。	分页
谓词	确定请求条件。 此操作的响应将包括与所有指定谓词匹配的优惠券。 最多可以指定 4 个谓词，其中一个谓词字段必须为 CustomerId。 有关此服务操作的谓词对象支持的 Field 和 Operator 元素的列表，请参阅 Predicate 备注。	谓词 数组
ReturnAdditionalFields	如果设置为“CouponClaimInfo”，请在响应中返回 CouponClaimInfo 。	AccountAdditionalField

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchCouponsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
优惠 券	符合指定条件的优惠券列表。	优惠券 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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)