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

[アーティクル]
10/04/2023

指定した顧客が所有する指定されたクーポンクラス名のディスパッチクーポン。

既に引き換え済みまたは発送済みのクーポンは発送されません。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
CouponClassName	利用可能なクーポンがディスパッチされるクーポンクラスの名前。	string
Customerid	クーポンクラスが属している顧客の識別子。	long
SendToEmails	クーポンが発送される電子メールアドレス。電子メールアドレスの数は 1000 を超えてはなりません。	string 配列

要求ヘッダー要素

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

Response 要素

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

応答本文の要素

要素	説明	データ型
PartialErrors	クーポンコードを送信できなかったメールアドレスに対応する BatchError オブジェクトの配列。エラーがない場合は、リストを空にすることができます。	BatchError 配列

応答ヘッダー要素

要素	説明	データ型
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">DispatchCoupons</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DispatchCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <SendToEmails i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </SendToEmails>
      <CustomerId>ValueHere</CustomerId>
      <CouponClassName i:nil="false">ValueHere</CouponClassName>
    </DispatchCouponsRequest>
  </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>
    <DispatchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <PartialErrors xmlns:e6="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e6:BatchError>
          <e6:Code>ValueHere</e6:Code>
          <e6:Details d4p1:nil="false">ValueHere</e6:Details>
          <e6:Index>ValueHere</e6:Index>
          <e6:Message d4p1:nil="false">ValueHere</e6:Message>
        </e6:BatchError>
      </PartialErrors>
    </DispatchCouponsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

public async Task<DispatchCouponsResponse> DispatchCouponsAsync(
	IList<string> sendToEmails,
	long customerId,
	string couponClassName)
{
	var request = new DispatchCouponsRequest
	{
		SendToEmails = sendToEmails,
		CustomerId = customerId,
		CouponClassName = couponClassName
	};

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

static DispatchCouponsResponse dispatchCoupons(
	ArrayOfstring sendToEmails,
	java.lang.Long customerId,
	java.lang.String couponClassName) throws RemoteException, Exception
{
	DispatchCouponsRequest request = new DispatchCouponsRequest();

	request.setSendToEmails(sendToEmails);
	request.setCustomerId(customerId);
	request.setCouponClassName(couponClassName);

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

static function DispatchCoupons(
	$sendToEmails,
	$customerId,
	$couponClassName)
{

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

	$request = new DispatchCouponsRequest();

	$request->SendToEmails = $sendToEmails;
	$request->CustomerId = $customerId;
	$request->CouponClassName = $couponClassName;

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

response=customerbilling_service.DispatchCoupons(
	SendToEmails=SendToEmails,
	CustomerId=CustomerId,
	CouponClassName=CouponClassName)

要件

サービス: CustomerBillingService.svc v13
名前空間： https://bingads.microsoft.com/Billing/v13

次の方法で共有