通过

GetCouponInfo 服务作 - 客户计费

获取有关与客户 ID 关联的优惠券的信息。

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
CustomerId 客户 ID。 long

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CouponInfoData 优惠券信息数据对象的列表。 CouponInfoData 数组

响应标头元素

元素 说明 数据类型
跟踪 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">GetCouponInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCouponInfoRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <CustomerId>ValueHere</CustomerId>
    </GetCouponInfoRequest>
  </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>
    <GetCouponInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <CouponInfoData xmlns:e19="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e19:CouponInfoData>
          <e19:AccountId>ValueHere</e19:AccountId>
          <e19:CouponId d4p1:nil="false">ValueHere</e19:CouponId>
          <e19:ClaimDate d4p1:nil="false">ValueHere</e19:ClaimDate>
          <e19:Status d4p1:nil="false">ValueHere</e19:Status>
          <e19:RedemptionDate d4p1:nil="false">ValueHere</e19:RedemptionDate>
          <e19:ExpirationDate d4p1:nil="false">ValueHere</e19:ExpirationDate>
          <e19:PercentOff d4p1:nil="false">ValueHere</e19:PercentOff>
          <e19:CouponValue d4p1:nil="false">ValueHere</e19:CouponValue>
          <e19:UpfrontSpending d4p1:nil="false">ValueHere</e19:UpfrontSpending>
          <e19:ActiveDuration d4p1:nil="false">ValueHere</e19:ActiveDuration>
          <e19:SpendToThreshold d4p1:nil="false">ValueHere</e19:SpendToThreshold>
          <e19:StartDate d4p1:nil="false">ValueHere</e19:StartDate>
          <e19:EndDate d4p1:nil="false">ValueHere</e19:EndDate>
          <e19:Balance d4p1:nil="false">ValueHere</e19:Balance>
          <e19:CurrencyCode d4p1:nil="false">ValueHere</e19:CurrencyCode>
          <e19:FeatureId d4p1:nil="false">ValueHere</e19:FeatureId>
          <e19:CouponType d4p1:nil="false">ValueHere</e19:CouponType>
        </e19:CouponInfoData>
      </CouponInfoData>
    </GetCouponInfoResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

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

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

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

static function GetCouponInfo(
	$customerId)
{

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

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

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

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)

要求

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

请求 URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/CouponInfo/Query

请求元素

GetCouponInfoRequest 对象定义服务作请求的正文和标头元素。

注意

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

请求正文元素

元素 说明 数据类型
CustomerId 客户 ID。 long

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CouponInfoData 优惠券信息数据对象的列表。 CouponInfoData 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "CustomerId": "LongValueHere"
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "CouponInfoData": [
    {
      "AccountId": IntValueHere,
      "ActiveDuration": IntValueHere,
      "Balance": DecimalValueHere,
      "ClaimDate": "ValueHere",
      "CouponId": IntValueHere,
      "CouponType": "ValueHere",
      "CouponValue": DecimalValueHere,
      "CurrencyCode": "ValueHere",
      "EndDate": "ValueHere",
      "ExpirationDate": "ValueHere",
      "FeatureId": IntValueHere,
      "PercentOff": DoubleValueHere,
      "RedemptionDate": "ValueHere",
      "SpendToThreshold": DecimalValueHere,
      "StartDate": "ValueHere",
      "Status": "ValueHere",
      "UpfrontSpending": DecimalValueHere
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

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

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

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

static function GetCouponInfo(
	$customerId)
{

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

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

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

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)