このページは Cloud Translation API によって翻訳されました。

請求額の調整

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。詳細

はじめに

収益化により、お支払い情報を調整できます。たとえば、CPU 使用率が特定の請求月の収益分配率または料金を増減できます。検出できます。

[請求調整額] ページの詳細

以下の説明に従い、[請求調整] ページにアクセスします。

Edge

Edge UI を使用して [請求調整] ページにアクセスするには:

apigee.com/edge にログインします。
[公開 >収益化 >請求調整額] をクリックします。

[請求調整額] ページが表示されます。

図に示すように、[請求調整] ページでは以下のことができます。

請求額の調整の現在のリストを表示する
請求額の調整を追加する
請求額の調整を編集する
請求額の調整のリストを検索する

Classic Edge（プライベートクラウド）

Classic Edge UI を使用して [請求調整] ページにアクセスするには:

http://ms-ip:9000（ms-ip の部分）にログインします。 Management Server ノードの IP アドレスまたは DNS 名。
[収益化 >調整] をクリックします。

[請求調整] ページでは、以下のことができます。

請求額の調整の現在のリストを表示する
請求額の調整を追加
請求額の調整を編集する
請求額の調整のリストを検索する

請求額の調整を追加

請求額の調整を追加するには:

[請求調整額] ページにアクセスします。
[+ 調整] をクリックします。

次の情報を入力します。

フィールド	説明
名前	請求書類に記載されるわかりやすい名前です。
調整 %	調整額の正または負のパーセンテージ。肯定的なトランザクションの収益分配または手数料をパーセンテージ。マイナスの調整は、示されています正または負の小数を入力してください小数点以下 2 桁）。
請求月	調整の請求月。プルダウンリストから月を選択します。
取引の種類	調整を適用する取引の種類です。選択値] を選択します。すべての料金の履歴請求（課金モデルのトランザクション）購入（収益分配モデルによる取引）払い戻し（収益分配モデルの取引）
プロダクト	調整を適用する API プロダクト。適用することはできません。複数の API プロダクトに対して 1 回の調整を行えます。需要予測に調整を適用する必要がある場合 API プロダクトが複数ある場合は、プロダクトごとに調整を作成します。API プロダクトを選択するを選択します。
デベロッパー	調整を適用するデベロッパー。「新規顧客の獲得」目標をすべてのデベロッパー（デフォルト）または特定のデベロッパーに個別に適用できます。[すべて] を選択デベロッパー」または特定のデベロッパーを選択します。注: 特定のキャンペーンに対する調整は、デベロッパーがすべてのデベロッパーに対して行われた調整をオーバーライドする。

[調整を作成] をクリックします。

請求額の調整の編集

請求額の調整を編集するには:

[請求調整額] ページにアクセスします。
編集する請求額の調整にカーソルを合わせて、操作メニューのをクリックします。
必要に応じて、請求額の調整を更新します。
[調整を更新] をクリックします。

API を使用した請求額の調整

以降のセクションでは、API を使用して請求額の調整を行う方法について説明します。

API を使用して請求額の調整を行う

請求の詳細を調整するには、POST リクエストを /organizations/{org_name}/billing-adjustments.リクエストを行う際、リクエスト本文:

請求調整の名前。
調整のパーセンテージ、すなわち、正または負のパーセント値請求額が増減します
請求月。
請求年。
請求の調整が適用される組織。

次のような他のプロパティを指定することもできます。

調整を適用する取引の種類（購入など）あります。
調整を適用するデベロッパー。
この調整を前払いデベロッパー、後払いデベロッパー、あります。
調整を適用する API パッケージ。
調整を適用する API プロダクト。

次の一覧については、請求額の調整の構成設定をご覧ください。調整リクエストで指定できる請求調整プロパティ。

オプションのプロパティが指定されていない場合、請求ドキュメントの調整はすべて含まれます。たとえば、トランザクションタイプが指定されていない場合、調整はすべての取引タイプに適用されます。

次の例では、未決済請求月（2013 年 6 月）の請求調整を行います。「 3% の減額が適用され、購入取引に適用されると、決済サービス、後払いデベロッパーがあります特定の商品を識別するためのプロパティは、デベロッパーまたは API パッケージが指定されていない場合、調整はすべてのデベロッパー（（後払いデベロッパー）およびすべての API パッケージの決済プロダクトです。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

レスポンスは次のようになります（レスポンスの一部のみが表示されています）。

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

API を使用して請求額の調整を表示する

組織の特定の請求調整またはすべての請求調整を表示できます。特定の請求額の調整を表示するには、次の宛先に GET リクエストを発行します。 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}、ここで {billing_adjustment_id} は、特定の請求額の調整の ID です。（請求調整を作成すると、レスポンスで ID が返されます）。例:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

組織の請求額の調整をすべて表示するには、次の宛先に GET リクエストを発行します。 /organizations/{org_name}/billing-adjustments。例:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

レスポンスは次のようになります（レスポンスの一部のみが表示されています）。

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

API を使用して請求額の調整を更新する

請求額の調整を更新するには、PUT リクエストを /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}、ここで {billing_adjustment_id} は、特定の請求額の調整の ID です。更新を行うときは、リクエストの本文で、更新されたプロパティと更新する請求調整の ID。また、必須項目を請求調整のプロパティ、つまり名前、調整の割合、請求月、請求年、組織です。

たとえば、次の API 呼び出しでは、調整割合の係数と名前（更新されたプロパティは例でハイライト表示されています）。

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

API を使用して請求額の調整を削除する

請求額の調整を削除するには、次の宛先に DELETE リクエストを発行します。 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}、ここで {billing_adjustment_id} は、請求調整の ID です。削除されました。例:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

API の請求額の調整の構成設定

請求額の調整では、次の構成オプションを使用できます。

名前	説明	デフォルト	必須
`name`	請求額の調整のわかりやすい名前。	なし	○
`adjustmentPercentageFactor`	調整額を正または負の数値の割合で表します。肯定的なトランザクションの収益分配または手数料を、その割合で調整します。マイナスのパーセンテージでは、トランザクションの収益分配または手数料がパーセンテージ。値の範囲は -100 ～ 999.9999 です。	なし	○
`billingMonth`	請求調整の請求月です。整数で指定します。例: 11 12 月分のみです	なし	○
`billingYear`	請求調整の請求年。次の形式で指定します。 YYYY 年。（2017 年など）。	なし	○
`organization`	請求額の調整が適用される組織。	なし	○
`isPublished`	調整を公開するかどうかを指定するフラグ。値は 1 にできます。次の選択肢があります。 `true`。請求額の調整が公開されます。 `false`。請求調整は公開しないでください。	なし	いいえ
`transactionType`	請求額の調整が適用される取引の種類。タイプには 1 つの次の選択肢があります。 `PURCHASE` `CHARGE` `REFUND` `CREDIT` `BALANCE` `SETUPFEES` `TERMINATIONFEES` `RECURRINGFEES` `TRUEUPS`。評価額の再調整に使用される取引ですあります。以前の請求で税額の変更が行われたときに呼び出されます。あります。	なし	いいえ
`developerBillingType`	請求額の調整が適用されるデベロッパーの請求タイプ。値は次のいずれかです。次のいずれかになります。 `PREPAID.`。前払いデベロッパー。 `POSTPAID`。後払いデベロッパー: `BOTH`。プリペイドと後払いのデベロッパーです。	なし	いいえ
`product`	請求額の調整が適用される API プロダクト。この値を指定しない場合、このプロパティを使用すると、請求額の調整がすべての API プロダクトに適用されます。注: 1 つの調整を複数の API に適用することはできません。プロダクトの複数の API プロダクトに調整を適用する必要がある場合は、調整を加えます。	なし	いいえ
`monetizationPackage`	請求額の調整が適用される API パッケージ。この値を指定しない場合、このプロパティを使用すると、請求額の調整はすべての API パッケージに適用されます。注: 1 つの調整を複数の API に適用することはできません。提供します。複数の API パッケージに調整を適用する必要がある場合は、パッケージごとに調整されます。	なし	いいえ
`developer`	請求額の調整が適用されるデベロッパー。この値を指定しない場合、プロパティを使用すると、請求額の調整がすべてのデベロッパーに適用されます。注: 特定のデベロッパーのために行った調整すべてのデベロッパーに行われた調整は、常にオーバーライドされます。	なし	いいえ

次のステップ

収益化により、デベロッパーにクレジットを柔軟に発行できます。必要に応じてデベロッパーがサービスに満足しておらず、使用料の一部または全額払い戻しをリクエストした場合に発生する料金おすすめします。クレジットの発行方法については、クレジットの発行をご覧ください。