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

API プロダクトバンドルの管理

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

以下のセクションで説明するように、1 つ以上の API プロダクトを API プロダクトバンドルという単一の収益化されたコンテナにバンドルします。

API プロダクトバンドルとは何ですか？

API プロダクトバンドルは、デベロッパーにグループとして提示される API プロダクトの集合であり、通常は収益化のための 1 つ以上の料金プランに関連付けられます。複数の API プロダクトバンドルを作成し、それぞれに 1 つ以上の API プロダクトを含めることができます。同じ API プロダクトまたはプロダクトを異なるバンドルに配置して、異なる（または同じ）料金プランに関連付けることができます。

デベロッパーは、現在有効な料金プランのいずれかを購入することでのみ、API プロダクトバンドルを使用するようにアプリを登録できます。プロダクトバンドルの料金プランを（公開として）追加して公開するまで、API プロダクトバンドルはデベロッパーに表示されません（現在の日付または将来の日付の開始日で指定）するには、料金プランの管理をご覧ください。料金プランを追加して公開すると、デベロッパーポータルにログインしたデベロッパーが API プロダクトバンドルを選択できるようになります料金プランを選択しますまたは、管理 API を使用してデベロッパーの料金プランを承認することもできます。詳しくは、API を使用して公開料金プランを購入するをご覧ください。

API プロダクトバンドルに API プロダクトを追加した後、その商品の価格帯の設定が必要になる場合があります。 API プロダクト。この操作は、以下の条件をすべて満たす場合にのみ必要です。

API プロダクトの収益分配料金プランを設定します。
デベロッパーは、API プロダクトのリソースの使用に対して第三者に料金を請求します。
デベロッパーが請求できる金額には最小または最大の制限があり、して制限をデベロッパーに通知します。

最低価格と最高価格は、API プロダクトバンドルの詳細に表示されます。

[Product Bundles] ページにアクセスする

以下の手順に沿って [Product Bundles] ページにアクセスします。

Edge

Edge UI を使用して [API product bundle] ページにアクセスするには、[Publish] >収益化 >一括販売商品] をクリックします。

上の図に示すように、[Product Bundles] ページでは次のことができます。

すべてのプロダクトバンドルの概要情報（バンドル名、バンドルに含まれる API プロダクトのリストなど）を表示する
一括販売商品を追加する
一括販売商品を編集する
表示されている項目で商品一括販売のリストを検索します

プロダクトバンドル内の API プロダクトの管理や、プロダクトバンドルの削除（料金プランが定義されていない場合）は、API のみを使用して行うことができます。

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

Classic Edge UI を使用して [API packages] ページにアクセスするには、[Publish] >パッケージ] をクリックします。

[API パッケージ] ページでは、次のことができます。

含まれている API プロダクトや関連する料金プランなど、すべての API パッケージの概要を表示する
API パッケージを追加する
API パッケージを編集する
料金プランの追加と管理
料金プランのアクセス設定の切り替え（公開/限定公開）
パッケージのリストをフィルタする

API パッケージ内の API プロダクトの管理や、API パッケージの削除（料金プランが定義されていない場合）は、API のみを使用して行うことができます。

一括販売商品を追加する

API プロダクトのバンドルを追加するには:

[プロダクトバンドル] ページで [+ API プロダクトバンドル] をクリックします。
API プロダクトのバンドルの名前を入力します。
[Add a Product] フィールドに API プロダクトの名前を入力します。

API プロダクトの名前を入力すると、その文字列を含む API プロダクトのリストがプルダウンに表示されます。 API プロダクトの名前をクリックして、バンドルに追加します。さらに API プロダクトを追加するには、この手順を繰り返します。
さらに API プロダクト名を追加するには、ステップ 3 を繰り返します。
追加する API プロダクトごとに、トランザクション記録ポリシーを構成します。
[一括販売を保存] をクリックします。

一括販売商品を編集する

一括販売商品を編集するには:

[商品バンドル] ページで、編集する商品の一括販売の行内をクリックします。

商品の一括販売のパネルが表示されます。
必要に応じて、商品の一括販売フィールドを編集します。

詳細については、トランザクション記録ポリシーを構成するをご覧ください。
[Update Product Bundle] をクリックします。

API を使用した API プロダクトバンドルの管理

以降のセクションでは、API を使用して API プロダクトバンドルを管理する方法について説明します。

API を使用した API プロダクトバンドルの作成

API プロダクトバンドルを作成するには、POST リクエストを次の宛先に送信します。 /organizations/{org_name}/monetization-packages。このリクエストを発行すると要件:

API プロダクトバンドルに含める API プロダクトを指定します。
API プロダクトバンドルの名前と説明を指定します。
API プロダクトバンドルのステータスインジケーターを設定します。ステータスインジケーターには、 CREATED、ACTIVE、INACTIVE のいずれかです。現在指定したステータスインジケーターの値は、 API プロダクトバンドルで保守されますが、いかなる目的にも使用されません。

必要に応じて、組織を指定できます。

公開されているオプションの一覧については、API プロダクトバンドルの構成プロパティをご覧ください。できます。

例:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

レスポンスの例を次に示します。

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

レスポンスには、API プロダクトに関する追加情報と、任意のカスタム属性を定義できます。（カスタム属性は、作成時に API プロダクト。）API プロダクトのカスタム属性は、さまざまな料金プランで考慮できます。対象たとえば、取引ごとにデベロッパーに請求するレート表プランを設定すると、送信されたバイト数などのカスタム属性に基づいてプランのレートを設定できますあります。

API を使用して API プロダクトバンドル内の API プロダクトを管理する

API を使用して、API プロダクトバンドルに対して API プロダクトの追加や削除を行うことができます。詳細については、以降のセクションで説明します

API プロダクトバンドルに API プロダクトを追加する

API プロダクトを API プロダクトバンドルに追加するには、POST リクエストを organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, ここで、{org_name} には組織の名前（{package_id}）を指定します。には API プロダクトのバンドル名を指定し、{product_id} には API の ID を指定します。説明します。

例:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API を使用して API プロダクトバンドルに API プロダクトを追加するプロダクト固有の料金プラン

API プロダクト固有の料金プランが 1 つ以上ある API プロダクトバンドルに API プロダクトを追加するには（料金表または収益分配率）が定義されると、POST リクエストを発行して organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, ここで、{org_name} には組織の名前（{package_id}）を指定します。には API プロダクトのバンドル名を指定し、{product_id} には API の ID を指定します。説明します。

リクエストの本文で新しい API プロダクトの料金プランの詳細を渡す必要があります。例外を ratePlanRates 配列には、すべての料金プランに指定された使用できます。定義できる料金プラン属性について詳しくは、以下をご覧ください。構成プロパティ料金プランをご覧ください。

例:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API プロダクトバンドルから API プロダクトを削除する

API プロダクトバンドルから API プロダクトを削除するには、 organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, ここで、{org_name} には組織の名前（{package_id}）を指定します。には API プロダクトのバンドル名を指定し、{product_id} には API の ID を指定します。説明します。

例:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API を使用して API プロダクトバンドルを表示する

特定の API プロダクトバンドル、または組織内のすべての API プロダクトのバンドルを取得できます。また、特定の日付範囲の取引がある API プロダクトバンドル（つまり、特定の開始と終了の範囲内で、これらのパッケージ内の API にアクセスするアプリを呼び出すユーザーできます。

特定の API プロダクトバンドルの表示: 特定の API プロダクトバンドルを取得するには、GET リクエストを発行します。 /organizations/{org_name}/monetization-packages/{package_id} に送信します。ここで、 {package_id} は、API プロダクトバンドルの ID です（ID は API プロダクトバンドルの作成時に返されるメッセージです）。例:

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

すべての API プロダクトバンドルの表示: 組織のすべての API プロダクトバンドルを取得するには、GET を発行します。リクエストを /organizations/{org_name}/monetization-packages に送信します。例:

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

次のクエリパラメータを渡して、結果をフィルタリングできます。

クエリパラメータ	説明
`all`	すべての API プロダクトのバンドルを返すかどうかを指定するフラグ。false に設定すると、ページごとに返される API プロダクトバンドルの数は `size` クエリパラメータで定義します。デフォルトは false です。
`size`	ページごとに返される API プロダクトバンドルの数。デフォルトは 20 です。`all` クエリの場合パラメータが `true` に設定されている場合、このパラメータは無視されます。
`page`	返されるページの番号（コンテンツがページ分けされている場合）。条件 `all` クエリパラメータが `true` に設定されている場合、パラメータは無視されます。

組織内のすべての API プロダクトバンドルを表示した場合のレスポンスは次のようになります（表示されます）。

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Communications",
    "displayName" : "Communications",
    "id" : "communications",
    "name" : "Communications",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

トランザクションを含む API プロダクトバンドルの表示: 特定のトランザクションを含む API プロダクトバンドルを取得するには、 GET リクエストを発行して /organizations/{org_name}/packages-with-transactions。リクエストを発行すると期間の開始日と終了日をクエリパラメータとして指定する必要があります。対象たとえば、次のリクエストでは、 2013 年 8 月

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

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

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "messaging package",
    "displayName" : "Messaging Package",
    "id" : "messaging_package",
    "name" : "Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "messaging api product",
      "displayName" : "messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  },
     ...
  } ]
}

API を使用して、デベロッパーまたは会社が承認した API プロダクトバンドルを表示する

GET を発行して特定のデベロッパーまたは会社が承認した API プロダクトバンドルを表示するリクエストを次の API にそれぞれ送信します。

/organizations/{org_name}/developers/{developer_id}/monetization-packages、ここで {developer_id} は、デベロッパーの ID（メールアドレス）です。
/organizations/{org_name}/companies/{company_id}/monetization-packages、ここで {company_id} は会社の ID です。

リクエストを発行するときに、必要に応じて次のクエリパラメータを指定できます。

クエリパラメータ	説明	デフォルト
`current`	アクティブな API プロダクトバンドル（`current=true`）のみを取得するか、すべてを取得するかを指定するフラグパッケージ（`current=false`）。有効なパッケージ内のすべての料金プランは、できます。	`current=false`
`allAvailable`	使用可能なすべての API プロダクトバンドルを取得するか（`allAvailable=true`）、またはデベロッパーまたは会社（`allAvailable=false`）専用の API プロダクトバンドルのみ。「利用可能なすべて」とは、指定したデベロッパーや会社に加えて、利用可能な API プロダクトバンドルを指します。他の開発者や企業とやり取りできます。企業またはデベロッパーのみが利用できる API プロダクトバンドルには、料金プランのみが含まれます。その企業やデベロッパーだけが利用できるリソースもあります	`allAvailable=true`

たとえば、次のリクエストでは、特定のサービスアカウントによって受け入れられたすべての API プロダクトバンドルを取得します。開発者:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

次のリクエストは、特定の会社が受け入れたアクティブな API パッケージのみを取得します。

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

API を使用した API プロダクトバンドルの削除

API プロダクトのバンドルは、料金プランが定義されていない場合にのみ削除できます。

</ph> 注: 下書きの料金プランが定義された API プロダクトバンドルがある場合は、 API プロダクトバンドルを削除する前に下書きの料金プランが必要です。料金プランの下書きの削除をご覧ください。 API を使用します。

取引アクティビティとレポートの整合性を確保するため、削除したり変更したりすることはできません料金プランを公開した後の API プロダクトバンドル。API プロダクトバンドルは、API 呼び出しの API プロダクトと、それに続く API プロダクトの更新は、既存の API プロダクトバンドルを使用します特に、料金プランが設定された API プロダクトのバンドルを変更または削除できる場合は複数の料金プランを設定している場合変更される API プロダクトバンドルと過去のトランザクションを照合できます。

公開されている料金プランが設定された API プロダクトバンドルがある場合は、パッケージを削除する代わりに、既存の料金プランを期限切れにして API プロダクトバンドルを使用できなくなるようにするか、新しい料金プランを作成する API プロダクトバンドルを確認し、代わりにこれらの使用を開始するようデベロッパーコミュニティに働きかけてください。レートを高く設定して API プロダクトバンドルを廃止する方法としてプランが期限切れになった場合、そのトランザクションレコードは保持されます。

料金プランが定義されていない API プロダクトバンドルを削除するには、DELETE リクエストを発行します。 organizations/{org_name}/monetization-packages/{package_id} 行き、ここで、{org_name} には組織の名前を指定します。 {package_id} には API プロダクトのバンドル名を指定します。

例:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \
-u email:password

API 用の API プロダクトバンドル構成プロパティ

API では、次の API プロダクトバンドル構成オプションが公開されます。

名前	説明	デフォルト	必須
`description`	API プロダクトバンドルの説明。	なし	○
`displayName`	API プロダクトバンドルに表示する名前（API のカタログ内など）あります。	なし	○
`name`	API プロダクトのバンドルの名前。	なし	○
`organization`	API プロダクトのバンドルを含む組織。	なし	いいえ
`product`	API プロダクトバンドル内の 1 つ以上のプロダクトの配列。	なし	いいえ
`status`	API プロダクトバンドルのステータスインジケーター。ステータスインジケーターには、 CREATED、ACTIVE、INACTIVE のいずれかです。注: 現在、ステータスインジケーターの値は Google Cloud コンソールで維持されます使用されませんが、使用されません。	なし	はい

API プロダクト バンドルの管理

API プロダクト バンドルとは何ですか？

[Product Bundles] ページにアクセスする

Edge

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

一括販売商品を追加する

一括販売商品を編集する

API を使用した API プロダクト バンドルの管理

API を使用した API プロダクト バンドルの作成

API を使用して API プロダクト バンドル内の API プロダクトを管理する

API プロダクト バンドルに API プロダクトを追加する

API を使用して API プロダクト バンドルに API プロダクトを追加する プロダクト固有の料金プラン

API プロダクト バンドルから API プロダクトを削除する

API を使用して API プロダクト バンドルを表示する

API を使用して、デベロッパーまたは会社が承認した API プロダクト バンドルを表示する

API を使用した API プロダクト バンドルの削除

API 用の API プロダクト バンドル構成プロパティ