AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、[AWS Marketplace API リファレンス](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS Marketplace APIs
を使用して AWS Marketplace Catalog API 、オファーを操作するタスクを自動化できます。
*製品*では販売内容が説明されていますが AWS Marketplace、*オファー*では製品の購入方法と消費方法の利用規約が説明されています。 AWS Marketplace 製品では、さまざまな販売者が複数のオファーを販売できます。ただし、各 AWS Marketplace オファーは 1 つの製品に対してのみ作成できます。*オファー*には、2 者間の契約条項のコレクションが含まれています。承諾されたオファー条件は、取引の証明として契約に変換されます。
オファーには 2 つのタイプがあります。
+ **プライベートオファー**は、販売者と購入者が価格を交渉するためのものです。販売者は、ソフトウェア購入のエンドユーザーライセンス契約 (EULA) に署名します AWS Marketplace。オファーは、指定された購入者にのみ表示されます。詳細については、「 *AWS Marketplace 販売者ガイド*」の[「プライベートオファー](https://docs.aws.amazon.com/marketplace/latest/userguide/private-offers-overview.html)」を参照してください。
+ **パブリックオファー**は、グローバル購入プログラムを対象としています。販売者は、利用可能なプログラムと地理的場所に基づいて顧客を識別し、特定の顧客のみがオファーにアクセスできるようにします。
以下のリソースを参照してください。
+ コード例については、「 *AWS Marketplace 販売者ワークショップ*」の[「API でオファーを管理する](https://catalog.workshops.aws/mpseller/en-US/manage-offers-with-api)」を参照してください。
+ API リクエストコードの例については、GitHub の*AWS 「サンプル*」の[「Python](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/python/src/catalog_api/offers) と [Java](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java/resources/changeSets/offers) の例」を参照してください。
+ プライベートオファーの作成に関する動画については、YouTube の[AWS Marketplace 「カタログ API を使用してプライベートオファーを作成する](https://www.youtube.com/watch?v=Gg9JR0tB330)」を参照してください。
+ AMI 料金の更新に関する動画については、YouTube [の AWS Marketplace 「カタログ API を使用した AMI 製品の料金の更新](https://www.youtube.com/watch?v=AVIRlzHKEJw)」を参照してください。
以下のトピックでは、 Catalog API を使用してオファーを作成および更新する方法について説明します。
**Topics**
+ [オファーを作成する](#create-offer)
+ [代替オファーを作成する](#create-replacement-offer)
+ [オファー情報の更新](#update-offer-information)
+ [ターゲット設定を更新する](#update-targeting-offers)
+ [返金ポリシーを更新する](#update-support-terms)
+ [法的リソースの更新](#update-legal-terms)
+ [料金を更新する](#update-pricing-terms)
+ [オファーの検出可能性を更新する](#update-availability)
+ [オファーを使用して作成された契約の有効期限を定義する](#update-validity-terms)
+ [支払いスケジュールの詳細を更新する](#update-payment-schedule-terms)
+ [正味支払い条件を更新する](#update-net-payment-terms)
+ [更新オプションを変更する](#update-renewal-terms)
+ [オファーを公開する](#release-offer)
+ [既存のオファーの詳細を記述する](#describe-entity)
## オファーを作成する
Catalog API を使用して、 で新しいオファーを作成できます AWS Marketplace。リクエストが正常に処理されると、 は AWS Marketplace Catalog API を作成します。これは`Draft`購入者には見えない不完全なオファーです。オファーを完了するには、 `Update` 変更タイプを使用します。オファーが完了したら、[`ReleaseOffer`](#release-offer)変更タイプを使用してオファーを作成してリリースします。オファーをリリースすると、オファーが検証され、購入者に表示されます AWS Marketplace。
新しいオファーを作成するには、次の例に示すように、 `CreateOffer`変更タイプで `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "CreateOffer",
"Entity": {
"Type": "Offer@1.0"
},
"DetailsDocument": {
"ProductId": "prod-ad8EXAMPLE51",
"Name": "Test Offer",
"OfferSetId": "offerset-b3f9EXAMPLE27"
}
}
]
}
```
`CreateOffer` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **ProductId** (文字列) (必須) – 提供されている製品の一意の識別子。
+ **名前** (文字列) (オプション) – 自分と顧客にとって読みやすいようにオファーに関連付けられた名前。契約情報の一部としても表示されます。
+ **OfferSetId** (文字列) (オプション) – このオファーを関連付けるオファーセットの ID。このフィールドは、オファーセットの一部となるオファーを作成する場合にのみ指定します。OfferSetId が指定されていない場合、スタンドアロンで購入できる個別のオファーが作成されます。オファーの作成時に OfferSetId を指定すると、オファーをそのオファーセットに関連付ける意図のみを示すことに注意してください。関連付けを完了するには、オファーの作成後に [ AssociateOffers の変更タイプを使用する必要があります](work-with-offer-sets.md#associate-offers)。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
`Status` が の場合`SUCCEEDED`、新しい `OfferId` が生成されます。
レスポンスは以下のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
"ChangeSetName": "Submitted by 123456789012",
"StartTime": "2021-05-27T22:21:26Z",
"EndTime": "2021-05-27T22:32:19Z",
"Status": "SUCCEEDED",
"ChangeSet": [
{
"ChangeType": "CreateOffer",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"ProductId": "prod-ad8EXAMPLE51",
"Name": "Test Offer"
},
"ErrorDetailList": []
}
]
}
```
**同期検証**
以下のスキーマ検証は、 の`CreateOffer`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| ProductId | 必須
長さは 1～50 文字にする必要があります
無効な文字を含めることはできません (\\、＜、>) | 422 |
| ProductId | 必須ユーザーは、特定の製品のオファーを作成する権限を持っている必要があります | 403 |
| ProductId | 必須カタログ内の既存の製品であるか、同じ変更セットで作成されている必要があります | 404 |
| 名前 | オプションです。
長さは 1～150 文字にする必要があります
無効な文字を含めることはできません (\\、＜、>) | 422 |
**非同期エラー**
以下のエラーは、 の`CreateOffer`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT | Limitedまたは Public状態でアクティブな製品を使用します。 |
| INCOMPATIBLE\_PRODUCT | 選択した製品タイプのオファーの管理は、現在 ではサポートされていません AWS Marketplace Catalog API。 |
| INCOMPATIBLE\_PRODUCT | 製品のオファーの管理は、現在 ではサポートされていません AWS Marketplace Catalog API。 |
| INCOMPATIBLE\_PRODUCT | OfferSetId は、製品のオファーではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | CreateOffer 変更タイプを呼び出して製品のオファーを作成することはできません。CreateOfferUsingResaleAuthorization の変更タイプを使用します。 |
## 代替オファーを作成する
Catalog API を使用して、 で代替オファー (契約ベースのオファーとも呼ばれます) を作成できます AWS Marketplace。
リクエストが正常に処理されると、 は AWS Marketplace Catalog API `Draft`状態のオファーを生成します。これは不完全なオファーであり、購入者には表示されません AWS Marketplace。`Update` 変更タイプを使用してオファーを完了します。オファーが完了したら、[`ReleaseOffer`](#release-offer)変更タイプを使用してオファー作成プロセスを完了し、オファーをリリースします。これにより、オファー全体が検証され、オファーが購入者に表示されます AWS Marketplace。そこから、購入者は代替オファーを受け入れるか、元の契約の下で引き続き運用するかを選択できます。
代替オファーを作成するには、次の例に示すように、`CreateReplacementOffer`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出し、既存の契約 ID を指定します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "CreateReplacementOffer",
"Entity": {
"Type": "Offer@1.0"
},
"DetailsDocument": {
"AgreementId": "agmt-12345",
"Name": "Offer name"
}
}
]
}
```
`CreateReplacementOffer` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **AgreementId** (文字列) (必須) – 置き換える現在の契約の一意の識別子。
+ **名前** (文字列) (オプション) – お客様やお客様の顧客にとって読みやすいようにオファーに関連付けられた名前。契約情報の一部としても表示されます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`CreateReplacementOffer`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| AgreementId | 必須長さは 1～64 文字にする必要があります | 422 |
| AgreementId | 必須ユーザーは、特定の契約のオファーを作成する権限を持っている必要があります | 403 |
| 名前 | オプションです。長さは 1～150 文字にする必要があります
無効な文字を含めることはできません (\\、＜、>) | 422 |
**非同期エラー**
以下のエラーは、 の`CreateReplacementOffer`アクションに固有です AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT | 代替オファーは、製品ではサポートされていません。 |
| INCOMPATIBLE\_AGREEMENT | CreateReplacementOffer 変更タイプを呼び出して、契約の代替オファーを作成することはできません。CreateReplacementOfferUsingResaleAuthorization の変更タイプを使用します。 |
## オファー情報の更新
Catalog API を使用して、オファー情報を更新できます AWS Marketplace。
オファー情報を更新するには、次の例に示すように、`UpdateInformation`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。他のすべての情報は変更されません。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateInformation",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Name": "New offer name",
"Description": "New offer description",
"PreExistingAgreement": {
"AcquisitionChannel": "External",
"PricingModel": "Contract"
}
}
}
]
}
```
`UpdateInformation` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **名前** (文字列) (オプション) – 読みやすくするためにオファーに関連付けられた名前。契約情報の一部として表示されます。
+ **説明** (文字列) (オプション) – ユーザーのみが使用し、購入者には表示されない自由形式のテキスト。
+ **PreExistingAgreement** (オブジェクト) (オプション) – このオファーが、同じ基盤となる製品の既存の顧客との既存の契約の更新かどうかを決定します。既存の契約は、内部でも外部でもかまいません AWS Marketplace。 AWS は、オファーが更新であることを監査して検証する場合があります。 AWS がオファーを検証できない場合、 AWS は顧客からオファーと使用権限を取り消す可能性があります。
+ **AcquisitionChannel** (文字列) (必須) – 既存の契約が外部 AWS Marketplace または内部のどちらで署名されたかを示します AWS Marketplace。
使用できる値: `External`、`AwsMarketplace`
+ **PricingModel** (文字列) (必須) – 既存の契約が使用する料金モデルを示します。
使用できる値: `Contract`、`Usage`、`Byol`、`Free`
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateInformation`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| プロパティ | 次のプロパティの少なくとも 1 つを指定する必要があります | 422 |
| 名前 | オプションです。
長さは 1～150 文字にする必要があります
無効な文字を含めることはできません (\\、＜、>) | 422 |
| 説明 | オプションです。
長さは 1～255 文字にする必要があります | 422 |
| PreExistingAgreement | オプションです。オファー`PreExistingAgreement`から削除するには null にすることができます | 422 |
| PreExistingAgreement.PricingModel | 必須
次のいずれかの値を指定できます: [`Byol`、`Free`、`Usage`、`Contract`] | 422 |
| PreExistingAgreement.AcquisitionChannel | 必須
次のいずれかの値を指定できます: [`AwsMarketplace`, `External`] | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateInformation`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRE\_EXISTING\_AGREEMENT | PreExistingAgreement は、オファーのリリース後に変更することはできません。 |
## ターゲット設定を更新する
Catalog API を使用して、 でオファーのターゲティング設定を更新できます AWS Marketplace。
最新のリクエストに含まれておらず、オファーから削除される既存のすべてのターゲティングオプション。
**注記**
オファーにはオプションで `PositiveTargeting`または を含めることができますが`NegativeTargeting`、両方を含めることはできません。
**正のターゲットオプション:**
**国コードのみ** – 指定された国の購入者が利用できる公開オファーを作成します。
**購入者アカウントのみ** – 特定の AWS アカウントを対象としたプライベートオファーを作成します。
**国コードと購入者アカウントの両方** – ターゲットアカウントが指定された国のいずれかにある場合にのみオファーを受け入れることができるプライベートオファーを作成します。
**負のターゲットオプション:**
**国コード** – 指定された国から購入者を除外します。これにより、リストされている国を除くすべての国で利用可能なパブリックオファーが作成されます。
オファーのターゲット設定を更新するには、次の例に示すように、`UpdateTargeting`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateTargeting",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"PositiveTargeting": {
"CountryCodes": [
"US",
"CA"
],
"BuyerAccounts": [
"111122223333"
]
},
"NegativeTargeting": {
"CountryCodes": [
"XX"
]
}
}
}
]
}
```
`UpdateTargeting` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **PositiveTargeting** (オブジェクト) (オプション) – ポジティブターゲティングは、オファーへのアクセスを許可するために購入者のプロファイルが満たす必要がある基準を定義します。このフィールドはオプションですが、このフィールドが存在する場合は少なくとも 1 つのターゲティングオプションを指定する必要があります。
+ **CountryCodes** (文字列の配列) (オプション) – 国に基づいてターゲット設定を許可するオプションとして一覧表示します。オファーを国を対象としない場合、このフィールドは省略する必要があります。存在する場合、リストには少なくとも 1 つの国コードが含まれている必要があります。このリストの各要素は、次の形式を使用して有効な 2 文字の国コードである必要があります: ISO 3166-1 alpha-2。
+ **BuyerAccounts** (文字列の配列) (オプション) – AWS アカウント (プライベートオファーとも呼ばれます) に基づくターゲティングを許可するオプションとして一覧表示します。オファーを にターゲットにしない場合 AWS アカウント、このフィールドは省略する必要があります。
+ **NegativeTargeting** (オブジェクト) (オプション) – ネガティブターゲティングは、オファーへのアクセスを制限するために顧客のプロファイルが満たすべき基準を定義します。このフィールドはオプションですが、このフィールドが存在する場合は少なくとも 1 つのターゲティングオプションを指定する必要があります。
+ **CountryCodes** (文字列の配列) (必須) – 国に基づいてターゲット設定を許可するオプションとして一覧表示します。オファーを特定の国を対象としない場合、このフィールドは省略する必要があります。存在する場合、リストには少なくとも 1 つの国コードが含まれている必要があります。このリストの各要素は、次の形式を使用する有効な 2 文字の国コードである必要があります: ISO 3166-1 alpha-2。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateTargeting`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| NegativeTargeting | オプションです。
次のいずれかを指定できます: [`CountryCodes`] | 422 |
| NegativeTargeting.CountryCodes | オプションです。
リストサイズは 1～244 の範囲である必要があります
国コードは有効である必要があります (ISO 3166-1 alpha-2) | 422 |
| PositiveTargeting | オプションです。
次のいずれかを指定できます: [`CountryCodes`, `BuyerAccounts`] | 422 |
| PositiveTargeting.BuyerAccounts | オプションです。
リストサイズは 1～26 である必要があります
AWS アカウント IDsは有効な形式 (12 桁の数字) である必要があります | 422 |
| PositiveTargeting.CountryCodes | オプションです。
リストサイズは 1～244 の範囲である必要があります
国コードは有効である必要があります (ISO 3166-1 alpha-2) | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateTargeting`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_BUYER\_ACCOUNTS | 有効な購入者アカウントを指定します。無効なアカウント: [x]。 |
| INVALID\_COUNTRY\_CODES | サポートされている国コードを指定します。 |
| INVALID\_TARGETING | 同じ属性に対して負または正のターゲティングを使用します。 |
| INCOMPATIBLE\_PRODUCT | 国ベースのターゲティングは、製品ではサポートされていません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization と互換性のある BuyerAccounts を指定します。 |
| INCOMPATIBLE\_TARGETING | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TARGETING | リクエストされた変更は、オファーの有効期限が切れた後は実行できません。 |
| INCOMPATIBLE\_TARGETING | ターゲット設定は、代替オファーでは更新できません。購入者が提供された AgreementId に関連付けられていない場合は、購入者に関連付けられた AgreementId を指定して新しいプライベートオファーを作成します。 |
| TOO\_MANY\_BUYER\_ACCOUNTS | 許可された制限内で BuyerAccounts を指定します。 |
| INCOMPATIBLE\_TARGETING | オファーのリリース後に BuyerAccounts を削除することはできません。 |
| INCOMPATIBLE\_TARGETING | オファーのリリース後に BuyerAccounts を追加することはできません。 |
| MISSING\_COUNTRY\_CODES | CountryCodes で PositiveTargeting を指定します: [x]。 |
| INCOMPATIBLE\_COUNTRY\_CODES | 互換性のある CountryCodes を指定します。 |
| INCOMPATIBLE\_BUYER\_ACCOUNTS | 契約と互換性のある BuyerAccounts を指定します。 |
## 返金ポリシーを更新する
Catalog API を使用して、オファーの返金ポリシーを更新できます AWS Marketplace。
この変更は既存の契約には影響しません。最新のリクエストに含まれていないサポート条件は、オファーから削除されます。
返金ポリシーを更新するには、次の例に示すように、`UpdateSupportTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateSupportTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "SupportTerm",
"RefundPolicy": "Updated refund policy description"
}
]
}
}
]
}
```
`UpdateSupportTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **用語** (構造の配列) (必須) - 更新するサポート用語のリスト。受け入れられるサポート条件は次のとおりです。
+ **SupportTerm** (オブジェクト) (必須) – アクセプタがソフトウェアを購入するときに利用できるカスタマーサポートを定義します。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`"SupportTerm"`。
+ **RefundPolicy** (文字列) (必須) – ウェブサイトとコンソールにそのまま表示される返金ポリシーの説明に関するフリーテキストフィールド。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateSupportTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 用語 | 必須 | 422 |
| 用語[]。RefundPolicy | 必須
長さは 1～500 である必要があります
先頭または末尾にスペースを使用することはできません | 422 |
| 用語[]。タイプ | 必須は のみです `SupportTerm` | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateSupportTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT | SupportTerm は、製品のプライベートオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | SupportTerm は、無料トライアルオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | リクエストされた変更は、オファーのリリース後に実行することはできません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
## 法的リソースの更新
Catalog API を使用して、エンドユーザーライセンス契約 (EULA) などの既存の法的ドキュメントを置き換えることができます。最新のリクエストに含まれていない法的条件は、オファーから削除されます。
オファーの法的リソースを更新するには、次の例に示すように、`UpdateLegalTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateLegalTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "LegalTerm",
"Documents": [
{
"Type": "CustomEula",
"Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
}
]
}
]
}
}
]
}
```
`UpdateLegalTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **LegalTerm** (オブジェクト) (必須) – アクセプタに提案するテキスト契約のリストを定義します。このような契約の 1 つの例は、エンドユーザーライセンス契約 (EULA) です。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`"LegalTerm"`。
+ **ドキュメント** (構造配列) (必須) – 購入者に提案する法的リソースへの参照のリスト。このようなリソースの一例は、エンドユーザーライセンス契約 (EULA) です。各リファレンスは、 `Type`と で構成されます`URL`。
+ **Type** (文字列) (必須) – ドキュメントのタイプ。使用可能なドキュメントタイプは次のとおりです。
+ **CustomEula** – 販売者として提供されるカスタム EULA。このドキュメントタイプには、パブリック S3 URL または[署名付き URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html) のいずれかが必要です。
+ **StandardEula** – Standard Contract for AWS Marketplace (SCMP)。SCMP の詳細については、 AWS Marketplace 「 Seller Guide」を参照してください。このタイプの URL は によって管理されるため、指定しません AWS Marketplace。
+ **URL** (文字列) (条件付きで必須) – 購入者が読む法的文書への URL。`Type` が次のいずれかの場合に必要です [`CustomEula`]。
+ **バージョン** (文字列) (条件付きで必要) — が提供する標準契約のバージョン AWS Marketplace。`Type` が [] の場合は必須です`StandardEula`。使用可能なバージョン:
+ **2022-07-14** – このバージョンの の標準契約 AWS Marketplace は、次の Amazon S3 バケットから入手できます: [https://s3.amazonaws.com/aws-mp-standard-contracts/Standard-Contact-for-AWS-Marketplace-2022-07-14.pdf](https://s3.amazonaws.com/aws-mp-standard-contracts/Standard-Contact-for-AWS-Marketplace-2022-07-14.pdf)
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateLegalTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 用語 | 必須
リストでは のみ`LegalTerm`が許可されます
リストサイズは 1 である必要があります | 422 |
| 用語[]。タイプ | 必須は のみです `LegalTerm` | 422 |
| 用語[]。LegalTerm.Documents | 必須 | 422 |
| 用語[]。LegalTerm.Documents[].タイプ | 必須
許可される値:+ `CustomEula`
+ `StandardEula` | 422 |
| 用語[]。LegalTerm.Documents[].URL | が の場合、必須Typeであり、有効な URL である必要があります CustomEula | 422 |
| 用語[]。LegalTerm.Documents[].バージョン | Type が の場合、必須であり、有効なバージョンである必要があります StandardEula有効な`StandardEula`バージョン: ["2019-04-24", "2022-07-14"] | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateLegalTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_TERMS | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
| INVALID\_LEGAL\_DOCUMENTS | アクセス可能な S3 バケットに保存されている法的ドキュメントURLs を指定します。 |
| INVALID\_LEGAL\_DOCUMENTS | 新しいオファーでは、最新バージョンの StandardEula のみがサポートされています。 |
| INVALID\_LEGAL\_DOCUMENTS | サポートされているファイル形式で法的文書を提供します。 |
| INVALID\_LEGAL\_DOCUMENTS | サポートされているドキュメントタイプを使用して法的ドキュメントを提供します。 |
| LIMIT\_EXCEEDED\_LEGAL\_DOCUMENT\_SIZE | 許可されたサイズ制限内で法的文書を提供します。 |
| INVALID\_LEGAL\_DOCUMENTS | LegalTerm にはパスワードで保護されたドキュメント (複数可) が含まれています。LegalTerm でアクセス可能なドキュメントを提供します。 |
| INVALID\_LEGAL\_DOCUMENTS | LegalTerm に無効な PDF ドキュメント (複数可) が含まれています。LegalTerm でアクセス可能なドキュメントを提供します。 |
## 料金を更新する
Catalog API を使用して、既存の料金条件を完全に置き換えることができます。最新のリクエストに含まれていない料金条件は、オファーから削除されます。
オファーの料金条件を更新するには、次の例に示すように、`UpdatePricingTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
次のリクエスト構文は、複数の例を組み合わせたものです。この組み合わせは有効なペイロードとしては機能しません。たとえば、`Terms`配列に用語タイプ `FixedUpfrontPricingTerm`と用語タイプ の両方を含めることはできません`ConfigurableUpfrontPricingTerm`。さまざまな用語タイプをさまざまな料金ユースケースで組み合わせる方法の例については、*AWS Marketplace 販売者ワークショップ*の[「API でオファーを管理する](https://catalog.workshops.aws/mpseller/en-US/manage-offers-with-api)」を参照してください。
**注記**
無料料金モデルを使用する SaaS 製品の場合、すべての料金が 0.00 USD に設定されている RateCard (ディメンション) `ConfigurableUpfrontPricingTerm`を少なくとも 1 つ持つ `UsageBasedPricingTerm`または を含める必要があります。この要件は SaaS 製品に固有のものです。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdatePricingTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"PricingModel": "Usage",
"Terms": [
{
"Type": "UsageBasedPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"RateCard": [
{
"DimensionKey": "m3.large",
"Price": "0.10"
},
{
"DimensionKey": "m4.xlarge",
"Price": "0.20"
}
]
}
]
},
{
"Type": "ConfigurableUpfrontPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"Selector": {
"Type": "Duration",
"Value": "P365D"
},
"RateCard": [
{
"DimensionKey": "m3.large",
"Price": "300"
},
{
"DimensionKey": "m4.xlarge",
"Price": "400"
}
],
"Constraints": {
"MultipleDimensionSelection": "Allowed",
"QuantityConfiguration": "Allowed"
}
}
]
},
{
"Type": "ByolPricingTerm"
},
{
"Type": "RecurringPaymentTerm",
"CurrencyCode": "USD",
"BillingPeriod": "Monthly",
"Price": "100.0"
},
{
"Type": "FixedUpfrontPricingTerm",
"CurrencyCode": "USD",
"Price": "200.00",
"Grants": [
{
"DimensionKey": "Users",
"MaxQuantity": 10
}
]
},
{
"Type": "FreeTrialPricingTerm",
"Duration": "P30D",
"Grants": [
{
"DimensionKey": "m3.xlarge",
"MaxQuantity": 10
},
{
"DimensionKey": "m4.xlarge",
"MaxQuantity": 10
}
]
}
]
}
}
]
}
```
`UpdatePricingTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **PricingModel** (文字列) (必須) – オファーの料金モデル。料金モデルに使用できる値は次のとおりです。
+ **使用状況** – 製品の使用に対して購入者に請求される使用量ベースの料金モデル。
+ **契約** – 購入者が製品の使用に対して事前に請求されるか、柔軟な支払いスケジュールを提供する契約ベースの料金モデル。購入者は、契約を超える追加の使用量に対して支払うこともできます。
+ **無料** – 製品の使用に対して購入者に課金されない無料料金モデル。この料金モデルを使用する場合、料金条件または支払いスケジュール期間に 0 以外の料金を設定することはできません。
+ **Byol** – 購入者が製品の使用に関する独自のライセンスを持ち込む Byol 料金モデル。
+ **用語** (構造の配列) (必須) – 更新する料金条件のリスト。サポートされている料金条件は次のとおりです。
+ **FreeTrialPricingTerm** (オブジェクト) – 購入者に指定された制限内で課金されない短期無料料金モデルを定義します。
+ **Type** (文字列) – 更新する用語のタイプ。これはオブジェクト値 です`"FreeTrialPricingTerm"`。
+ **期間** (文字列) — 無料トライアル期間。
+ **権限** (構造の配列) – 契約の実行の一環として無料トライアルのアクセプタに付与される権限。
+ **DimensionKey** (文字列) – 製品ドキュメントで定義された一意のディメンションキー。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されます AWS Marketplace。
+ **MaxQuantity** (整数) (オプション) – 購入者が製品の特定のディメンションに対して資格を持つことができる最大容量。が指定され`MaxQuantity`ていない場合、購入者は指定されたディメンションを無制限に使用できます。
+ **UsageBasedPricingTerm** (オブジェクト) – 製品の使用量に基づいて顧客に課金されるpay-as-you-go (PAYG) の料金モデルを定義します。
+ **タイプ** (文字列) (必須) – 更新する用語のカテゴリ。これはオブジェクト値 です`UsageBasedPricingTerm`。
+ **CurrencyCode** (文字列) – この用語で言及されている価格の通貨を定義します。現在、USD のみがサポートされています。
+ **RateCards** (構造体の配列) – レートカードのリスト。
+ **RateCard** (構造の配列) – レートカードは、製品ディメンションのユニットあたりのレートを定義します。
+ **DimensionKey** (文字列) – 指定された使用権限が適用されるディメンション。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されます AWS Marketplace。
+ **Price** (文字列) – 購入者に請求される金額の計算に使用される製品ディメンションの単価。
+ **ConfigurableUpfrontPricingTerm** (オブジェクト) – 購入者が購入するエンタイトルメントとエンタイトルメントの期間を設定できるようにする前払い支払いモデルを定義します。各契約期間のレートと各ディメンションのエンタイトルメントのリストを更新できます。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`ConfigurableUpfrontPricingTerm`。
+ **CurrencyCode** (文字列) (必須) – この用語で説明されている価格の通貨を定義します。パブリックオファーでは、USD のみがサポートされています。プライベートオファーでは、USD、AUD、EUR、GBP、および両替がサポートされています。
+ **RateCards** (構造体の配列) (必須) – レートカードのリスト。
+ **セレクタ** (オブジェクト) (必須) – セレクタは、購入者が選択する同じ料金期間中の相互排他的レートカードを区別するために使用されます。
+ **タイプ** (文字列) (必須) – Selector のカテゴリ。現時点では、 `Duration`のみがサポートされています。
+ **値** (文字列) (必須) — 契約期間。このフィールドは ISO 8601 形式をサポートしています。
+ **RateCard** (構造の配列) (必須) – レートカードは、製品ディメンションのユニットあたりのレートを定義します。
+ **DimensionKey** (文字列) (必須) – 製品ドキュメントで定義された一意のディメンションキー。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されます AWS Marketplace。
+ **Price** (文字列) (必須) – 購入者に請求される金額の計算に使用される製品ディメンションの単価。
+ **制約** (オブジェクト) (必須) – アクセプタが用語を設定する方法に関する制約を定義します。
**注記**
現在、**MultipleDimensionSelection** と **QuantityConfiguration** の値は同じである必要があります。
+ **MultipleDimensionSelection** (文字列) (必須) – 購入者がレートカードで複数のディメンションを選択できるかどうかを決定します。指定できる値は `Allowed` および `Disallowed` です。
+ **QuantityConfiguration** (文字列) (必須) – アクセプタがレートカードのディメンションごとに数量を設定できるかどうかを決定します。指定できる値は `Allowed` および `Disallowed` です。
+ **ByolPricingTerm** (オブジェクト) – お客様とお客様の顧客が既存の契約を移動できるようにします AWS Marketplace。顧客は、 の製品の使用量に対して課金されません。これは、 の外部で製品の料金を既に支払っている AWS Marketplace ためです AWS Marketplace。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`ByolPricingTerm`。
+ **RecurringPaymentTerm** (オブジェクト) – 各請求期間の終了時に固定定額料金が顧客に請求される料金モデルを定義します。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`RecurringPaymentTerm`。
+ **BillingPeriod** (文字列) (必須) – 購入者に課金される繰り返しを定義します。現在サポートされているの`Monthly`は のみです。
+ **Price** (文字列) (必須) – 請求期間ごとに購入者に請求される金額。
+ **CurrencyCode** (文字列) (必須) – この用語で説明されている価格の通貨を定義します。現在は、`USD` のみがサポートされます。
+ **FixedUpfrontPricingTerm** (オブジェクト) – 前払い料金モデルを定義し、顧客に固定前払い料金が請求されます。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。これはオブジェクト値 です`FixedUpfrontPricingTerm`。
+ **CurrencyCode** (文字列) (必須) – この用語で説明されている価格の通貨を定義します。パブリックオファーでは、USD のみがサポートされています。プライベートオファーでは、USD、AUD、EUR、GBP、および両替がサポートされています。
+ **Price** (文字列) (必須) – この条件が受け入れられたときに顧客に請求される固定額。
+ **権限** (構造の配列) (必須) – 契約の実行の一環として固定前払いのアクセプタに付与される権限。
+ **DimensionKey** (文字列) (必須) – 製品ドキュメントで定義された一意のディメンションキー。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されます AWS Marketplace。
+ **MaxQuantity** (整数) (必須) – 購入者が製品の特定のディメンションに対して資格を持つことができる最大容量。が指定され`MaxQuantity`ていない場合、購入者は指定されたディメンションを無制限に使用できます。
+ **Duration** (文字列) (オプション) – 用語がアクティブのままである期間を定義します。このフィールドは ISO 8601 形式をサポートしています。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdatePricingTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP |
| --- | --- | --- |
| PricingModel | 必須許可される料金モデル: ["Byol"、"Free"、"Usage"、"Contract"] | 422 |
| 用語 | 必須許可される用語: ["ConfigurableUpfrontPricingTerm"、"ByolPricingTerm"、"FreeTrialPricingTerm"、"UsageBasedPricingTerm"、"RecurringPaymentTerm"、"FixedUpfrontPricingTerm"] | 422 |
| 用語[]。ByolPricingTerm | 必須 | 422 |
| 用語[]。ByolPricingTerm.Type | 必須「ByolPricingTerm」のみを使用できます | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm | 必須 | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.Type | 必須「ConfigurableUpfrontPricingTerm」のみを使用できます | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.CurrencyCode | 必須サポートされている通貨: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"] | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards | 必須リストサイズは 1～5 にする必要があります | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].制約 | 必須 | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].Contraints.MultipleDimensionSelection | 必須使用できる値: ["Allowed"、"Disallowed"] | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].Contraints.QuantityConfiguration | 必須使用できる値: ["Allowed"、"Disallowed"] | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].RateCard | 必須リストサイズは 1～800 にする必要があります | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].RateCard[]。DimensionKey | 必須長さは 1～100 である必要があります | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].RateCard[]。料金 | 必須データ型は「文字列」です
小数点以下第 3 位までサポートされる負以外の小数点 | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].セレクタ | 必須 | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].Selector.Type | 必須使用できる値: ["Duration"] | 422 |
| 用語[]。ConfigurableUpfrontPricingTerm.RateCards[].Selector.Value | 必須セレクタタイプあたりの想定形式: ISO 8601 期間 | 422 |
| 用語[]。FixedUpfrontPricingTerm | 必須 | 422 |
| 用語[]。FixedUpfrontPricingTerm.Type | 必須「FixedUpfrontPricingTerm」のみを使用できます | 422 |
| 用語[]。FixedUpfrontPricingTerm.CurrencyCode | 必須サポートされている通貨: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"] | 422 |
| 用語[]。FixedUpfrontPricingTerm.Duration | 必須セレクタタイプあたりの想定形式: ISO 8601 期間 | 422 |
| 用語[]。FixedUpfrontPricingTerm.Grants | 必須リストサイズは 1～200 の範囲である必要があります | 422 |
| 用語[]。FixedUpfrontPricingTerm.Grants[].DimensionKey | 必須長さは 1～100 である必要があります | 422 |
| 用語[]。FixedUpfrontPricingTerm.Grants[].MaxQuantity | RequiredValue は 0 より大きい必要があります | 422 |
| 用語[]。FixedUpfrontPricingTerm.Price | 必須データ型は「文字列」です
小数点以下第 3 位までサポートされる負以外の小数点 | 422 |
| 用語[]。FreeTrialPricingTerm | 必須 | 422 |
| 用語[]。FreeTrialPricingTerm.Type | 必須「FreeTrialPricingTerm」のみを使用できます | 422 |
| 用語[]。FreeTrialPricingTerm.Duration | 必須予想される形式: ISO 8601 の期間 | 422 |
| 用語[]。FreeTrialPricingTerm.Grants | 必須リストサイズは 1～800 にする必要があります | 422 |
| 用語[]。FreeTrialPricingTerm.Grants[].DimensionKey | 必須長さは 1～100 である必要があります | 422 |
| 用語[]。FreeTrialPricingTerm.Grants[].MaxQuantity | オプションです。値は 0 より大きい必要があります | 422 |
| 用語[]。RecurringPaymentTerm | 必須 | 422 |
| 用語[]。RecurringPaymentTerm.Type | 必須「RecurringPaymentTerm」のみを使用できます | 422 |
| 用語[]。RecurringPaymentTerm.BillingPeriod | 必須使用できる値: ["Monthly"] | 422 |
| 用語[]。RecurringPaymentTerm.CurrencyCode | 必須サポートされている通貨: ["USD"] | 422 |
| 用語[]。RecurringPaymentTerm.Price | 必須データ型は「文字列」です
小数点以下第 3 位までサポートされる負以外の小数点 | 422 |
| 用語[]。UsageBasedPricingTerm | 必須 | 422 |
| 用語[]。UsageBasedPricingTerm.Type | 必須「UsagedBasedPricingTerm」のみを使用できます | 422 |
| 用語[]。UsageBasedPricingTerm.CurrencyCode | 必須サポートされている通貨: ["USD"] | 422 |
| 用語[]。UsageBasedPricingTerm.RateCards | 必須サイズは 1 である必要があります | 422 |
| 用語[]。UsageBasedPricingTerm.RateCards[].RateCard | 必須リストサイズは 1～800 にする必要があります | 422 |
| 用語[]。UsageBasedPricingTerm.RateCards[].RateCard[]。DimensionKey | 必須長さは 1～100 である必要があります | 422 |
| 用語[]。UsageBasedPricingTerm.RateCards[].RateCard[]。料金 | 必須データ型は「文字列」です
小数点以下 8 桁までサポートされる負以外の小数点 | 422 |
**非同期エラー**
以下のエラーは、 の`UpdatePricingTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| DUPLICATE\_DImenSION\_KEYS | [x] のディメンションキーの一意のリストを Grants に提供します。 |
| DUPLICATE\_DImenSION\_KEYS | RateCard に [x] のディメンションキーの一意のリストを提供します。 |
| DUPLICATE\_SELECTORS | ConfigurableUpfrontPricingTerm でセレクタの一意のリストを指定します。 |
| DUPLICATE\_TERM\_TYPES | 用語タイプの一意のリストを指定します。 |
| INCOMPATIBLE\_AGREEMENT | 代替オファーから次の用語を削除することはできません: [x, y, z]。 |
| INCOMPATIBLE\_AGREEMENT | 代替オファーに次の用語を追加することはできません: [x, y, z]。 |
| INCOMPATIBLE\_CURRENCY\_CODE | オファーのリリース後に CurrencyCode を変更することはできません。 |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_PRODUCT | 使用量料金モデルは、製品ではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | 契約料金モデルは、製品ではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | Byol 料金モデルは、製品ではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | 無料料金モデルは、製品ではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | [x] は、製品のオファーではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | 提供された支払い条件と料金条件には互換性がありません。 |
| INCOMPATIBLE\_PRODUCT | [x] の製品で既存の利用可能なディメンションを使用します。 |
| INCOMPATIBLE\_PRODUCT | オファーの唯一の料金期間としての FreeTrialPricingTerm は、製品ではサポートされていません。 |
| INCOMPATIBLE\_PRODUCT | 製品では、次の用語はサポートされていません: [x,y,z]。 |
| INCOMPATIBLE\_PRODUCT | 代替オファーは、契約料金モデルでのみサポートされています。 |
| INCOMPATIBLE\_PRODUCT | 製品ディメンションと互換性のある料金条件 (複数可) を指定します。互換性のない料金条件: [x,y,z]。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | 使用料金モデルの ConfigurableUpfrontPricingTerm で、MultipleDimensionSelection と QuantityConfiguration を Allowed に設定します。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | 使用料金モデルの ConfigurableUpfrontPricingTerm で MultipleDimensionSelection と QuantityConfiguration を Disallowed に設定します。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | ConfigurableUpfrontPricingTerm の QuantityConfiguration は、オファーのリリース後に変更することはできません。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | ConfigurableUpfrontPricingTerm の MultipleDimensionSelection は、オファーのリリース後に変更することはできません。 |
| INCOMPATIBLE\_RATES | 無料料金モデルを使用する場合は、すべての料金額と料金をゼロ (0) に設定します。 |
| INCOMPATIBLE\_RATES | UsageBasedPricingTerm では、製品の無料トライアルオファーに対して 0 (0) の料金のみが許可されています。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization で指定されているのと同じ CurrencyCode を指定します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | FixedUpfrontPricingTerm の期間がResaleAuthorization で指定された期間と一致することを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization と互換性のある用語 (複数可) を指定します。互換性のない用語: [x, y, z]。 |
| INCOMPATIBLE\_SELECTOR\_DURATION | オファーのリリース後は、ConfigurableUpfrontPricingTerm のレートカードから期間を削除することはできません。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INCOMPATIBLE\_TERMS | [x] は、次の用語と一緒にはサポートされていません: [y,z]。 |
| INCOMPATIBLE\_TERMS | オファーのリリース後に次の条件を追加することはできません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | オファーのリリース後に次の条件を削除することはできません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | [x] はプライベートオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | 無制限の使用を許可する FreeTrialPricingTerm では、次の用語はサポートされていません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | 製品の FreeTrialPricingTerm では、次の用語はサポートされていません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | オファーに PaymentScheduleTerm FixedUpfrontPricingTerm にゼロ (0) 料金を指定します。 |
| INCOMPATIBLE\_TERMS | 次の用語は PricingModel と互換性がありません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | MarkupPercentage がゼロ (0) より大きい場合、FixedUpfrontPricingTerm はサポートされていません。 |
| INCOMPATIBLE\_TERMS | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
| INVALID\_AGREEMENT\_DURATION | [x] ～ [y] か月の期間を指定します。 |
| INVALID\_AGREEMENT\_DURATION | 期間の詳細度が計測されたディメンションの日レベルであることを確認します。 |
| INVALID\_CURRENCY\_CODE | サポートされている CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件で同じ CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | サポートされている CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件に同じ CurrencyCode を指定します。 |
| INVALID\_DURATION | FreeTrialPricingTerm の持続時間が許容範囲内にあることを確認します。 |
| INVALID\_DURATION | AgreementStartDate と AgreementEndDateの間の期間に一致する FixedUpfrontPricingTerm で期間を指定します。 |
| INVALID\_DURATION | [x] ～ [y] か月の期間を指定します。 |
| INVALID\_DURATION | 期間の詳細度が計測されたディメンションの日レベルであることを確認します。 |
| INVALID\_GRANTS | FreeTrialPricingTerm のすべてのグラントに同じ MaxQuantity を指定します。 |
| INVALID\_GRANTS | FreeTrialPricingTerm で使用可能なすべての従量制ディメンションに Grants を提供します。 |
| INVALID\_GRANTS | The combination of Dimensions in grants is invalid in FixedUpfrontPricingTerm for the product. |
| INVALID\_GRANTS | The combination of Dimensions in grants is invalid in FreeTrialPricingTerm for the product. |
| INVALID\_GRANTS | FixedUpfrontPricingTerm with MaxQuantity is not supported for this product. |
| INVALID\_PRICE\_CHANGE | [x] は、過去 120 日間に値上げをリクエストしたため、[y] まで更新できません。以前の値上げリクエストをキャンセルする場合、または詳細については、 AWS Marketplace Managed Catalog Operations チームにお問い合わせください。 |
| INVALID\_PRICE\_CHANGE | [x] での料金の引き上げとディメンションの追加は、同じリクエストではサポートされていません。最初にディメンションを追加します。 |
| INVALID\_PRICE\_CHANGE | UsageBasedPricingTerm の料金の増減は、同じリクエストではサポートされていません。最初に価格を下げます。 |
| INVALID\_PRICE\_CHANGE | RecurringPaymentTerm の料金引き上げと UsageBasedPricingTerm の料金引き下げは、同じリクエストではサポートされていません。最初に価格を下げます。 |
| INVALID\_PRICE\_CHANGE | RecurringPaymentTerm の料金削減と UsageBasedPricingTerm の料金引き上げは、同じリクエストではサポートされていません。最初に価格を下げます。 |
| INVALID\_RATE\_CARD | ConfigurableUpfrontPricingTerm の期間 [x] に 1 つ以上のディメンションキーがありません。すべての期間で同じディメンションキーのセットの料金を指定します。 |
| INVALID\_RATE\_CARD | UsageBasedPricingTerm で計測されたディメンションのみのレートカードを指定します。 |
| INVALID\_RATE\_CARD | レートを [x] から削除することはできません。既存のレートカードのすべてのディメンションの料金を指定します。 |
| INVALID\_RATE\_CARD | [x] に同じ単位を持つディメンションを指定します。 |
| INVALID\_RATE\_CARD | すべての従量制ディメンションまたはすべての使用権限のあるディメンションを [x] で指定します。 |
| INVALID\_RATE\_CARD | [x] でエンタイトルメントのあるディメンションのみを指定します。 |
| INVALID\_RATE\_CARD | UsageBasedPricingTerm で使用可能なすべての従量制ディメンションの使用ベースのレートを指定します。 |
| INVALID\_RATE\_CARD | すべての無料トライアルディメンションの使用ベースのレートを指定します。 |
| INVALID\_RATE\_CARD | UsageBasedPricingTerm で、小数点以下第 8 位までの料金を指定します。 |
| INVALID\_RATE\_CARD | The combination of Dimensions in rate card is invalid in UsageBasedPricingTerm for the product. |
| INVALID\_SELECTOR\_DURATION\_VALUE | [x] ～ [y] か月の期間を指定します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | 期間の詳細度が計測されたディメンションの日レベルであることを確認します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | ConfigurableUpfrontPricingTerm の期間が許容範囲内にあることを確認します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | サポートされている契約期間を 1 つ以上指定します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | 1 つ以上のサポートされている契約期間または 1 つのカスタム期間を指定します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | AgreementStartDate と AgreementEndDateの間の期間に一致する ConfigurableUpfrontPricingTerm で期間を指定します。 |
| MISSING\_DURATION | FixedUpfrontPricingTerm で期間を指定します。 |
| MISSING\_MANDATORY\_TERMS | FixedUpfrontPricingTerm は、ByolPricingTerm または PaymentScheduleTerm と組み合わせる場合にのみサポートされます。 |
| MISSING\_MANDATORY\_TERMS | [x,y,z] を少なくとも 1 つ指定します。 |
| MISSING\_MANDATORY\_TERMS | ByolPricingTerm を指定します。 |
| TOO\_MANY\_GRANTS | [y] で最大 [x] の許可を指定します。 |
| TOO\_MANY\_RATE\_CARDS | 製品には、ConfigurableUpfrontPricingTerm のレートカードを 1 つだけ使用できます。 |
| TOO\_MANY\_RATE\_CARDS | 製品の ConfigurableUpfrontPricingTerm では、最大 [x] のレートカードが許可されます。 |
| TOO\_MANY\_RATES | ConfigurableUpfrontPricingTerm で許可されている制限内に RateCards を指定します。 |
| TOO\_MANY\_RATES | UsageBasedPricingTerm で許可されている制限内に RateCards を指定します。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | ConfigurableUpfrontPricingTerm で MultipleDimensionSelection と QuantityConfiguration の両方を同じ値 (許可または禁止) に設定します。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | ConfigurableUpfrontPricingTerm のすべてのレートカードに同じ制約を指定します。 |
| INVALID\_UPDATE\_REQUEST | [x] は更新できません。料金変更のリクエストや詳細については、 AWS Marketplace Managed Catalog Operations Team にお問い合わせください。 |
| INCOMPATIBLE\_PRICING\_MODEL | PricingModel を [x] から [y] に変更することはできません。 |
| INVALID\_GRANTS | FreeTrialPricingTerm MaxQuantityには、製品に対する制限があります。[x] 以下の MaxQuantity を指定します。詳細については、 AWS Marketplace Managed Catalog Operations Team にお問い合わせください。 |
| INVALID\_GRANTS | FixedUpfrontPricingTerm のすべてのグラントに MaxQuantity を指定します。 |
| INVALID\_GRANTS | MaxQuantity は、製品の FixedUpfrontPricingTerm ではサポートされていません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | FixedUpfrontPricingTerm の Grants が、ResaleAuthorization で指定された RateCardsと一致することを確認します。 |
## オファーの検出可能性を更新する
Catalog API を使用して、オファーの検出可能性を制御できます AWS Marketplace。
将来の特定の日付を設定してオファーの検出可能性を制限するか、過去に設定してオファーを期限切れにするかを選択できます。`UpdateAvailability` 変更タイプは既存の契約には影響しません。
**注記**
`UpdateAvailability` 変更タイプは、すでに[公開](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#release-offer)されているプライベートオファー (*リリース*とも呼ばれます) で使用できます。購入者がプライベートオファーを既に承諾している場合、それらの既存の契約は影響を受けません。
既存のプライベートオファー`AvailabilityEndDate`の を変更するときは、[契約期間の制約](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-validity-terms)に従う必要があります。そうでない場合は、この`UpdateValidityTerms`変更セットに追加の変更タイプを含めて、新しい有効期限に準拠するように契約期間を変更します。`UpdateValidityTerms` 変更タイプは、リリース済みまたはまだリリースされていないプライベートオファーで使用できます。
既存のプライベートオファー`AvailabilityEndDate`の を変更するときは、[支払いスケジュールの制約](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-payment-schedule-terms)に従う必要があります。そうではなく、プライベートオファー*がまだリリースされていない場合*は、この`UpdatePaymentScheduleTerms`変更セットに追加の変更タイプを含めて、新しい有効期限に準拠するように支払いスケジュールを変更します。プライベートオファー*がすでにリリース*されている場合は、新しい日付が支払いスケジュールの制約に従っている`AvailabilityEndDate`限り、 に変更を加えることができます。
オファーの検出可能性を制御するには、次の例に示すように、 `UpdateAvailability`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateAvailability",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"AvailabilityEndDate": "2024-05-31"
}
}
]
}
```
`UpdateAvailability` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **AvailabilityEndDate** (文字列) (必須) – オファーが検出および購入可能になるまでの日付です AWS Marketplace。将来の特定の日付を設定して可用性を制限するか、過去にオファーを期限切れにするかを選択できます。日付は `YYYY-MM-DD` 形式で表されます。
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットの ID と ARN を提供し、次のようになります。
**レスポンスの構文**
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または `DescribeChangeSet`アクションを使用して Catalog API で確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateAvailability`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| AvailabilityEndDate | 必須
形式: "YYYY-MM-DD" | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateAvailability`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_AVAILABILITY\_END\_DATE | AvailabilityEndDate はパブリックオファーではサポートされていません。 |
| INVALID\_AVAILABILITY\_END\_DATE | 将来の AvailabilityEndDate を指定します。 |
| INVALID\_AVAILABILITY\_END\_DATE | AgreementEndDate より前の AvailabilityEndDate を指定します。 AgreementEndDate |
| MISSING\_AVAILABILITY\_END\_DATE | 契約終了日より前の AvailabilityEndDate を指定します。 |
## オファーを使用して作成された契約の有効期限を定義する
Catalog API を使用して、オファーを使用して作成された契約の有効期限の詳細を定義できます AWS Marketplace。
この変更タイプは既存の契約には影響しません。
**注記**
`UpdateValidityTerms` 変更タイプは、既に[公開](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#release-offer)されているプライベートオファー (*リリース*とも呼ばれます) で使用できます。購入者がプライベートオファーを既に承諾している場合、それらの既存の契約は影響を受けません。
**AMI ベース**および**コンテナベースの**製品の場合、プライベートオファーの[料金条件](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-pricing-terms)に を含む用語タイプ `Duration` (たとえば、用語タイプ `FixedUpfrontPricingTerm`または `ConfigurableUpfrontPricingTerm`) が含まれている場合、この変更タイプの `AgreementDuration` セットは、今日から[プライベートオファーの有効期限](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-availability)までの日数に、それらの用語タイプの `Duration` で設定された日数を足した日数よりも大きくする必要があります。これは、購入者がプライベートオファーを受け入れて契約が作成されると、プライベートオファーの有効期限が切れるまで、オプションでこれらの期間タイプで指定された追加のエンタイトルメントを購入できるためです。さらに、追加の使用権限はすべて、契約前に終了する必要があります。たとえば、購入者が最初の利用可能日にプライベートオファーを受け入れ、最後の利用可能日に使用権限を購入した場合、それらの使用権限は契約終了日以降に終了してはいけません。
オファーを使用して作成された契約の有効期限の詳細を定義するには、次の例に示すように、`UpdateValidityTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateValidityTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "ValidityTerm",
"AgreementDuration": "P12M",
"AgreementStartDate": "2021-08-01",
"AgreementEndDate": "2022-08-01"
}
]
}
}
]
}
```
`UpdateValidityTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **用語** (構造の配列) – 更新する有効期間のリスト。サポートされている有効期間は次のとおりです。
+ **ValidityTerm** (オブジェクト) – このオファーから作成された契約を保持する条件を定義します。
+ **タイプ** (文字列) — 更新する用語のカテゴリ。 `ValidityTerm`
+ **AgreementDuration** (文字列) – 契約が有効な期間を定義します。が指定され`AgreementStartDate`ていない場合、契約期間は契約の署名時刻を基準とします。期間は ISO\_8601 形式で表されます。
+ **AgreementStartDate** (文字列) – 契約開始日を定義します。 `AgreementStartDate`は `YYYY-MM-DD` 形式で表されます。契約は、指定された日付の 00:00:00.000 UTC に開始されます。が指定され`AgreementStartDate`ていない場合、契約開始日は契約の署名時刻に基づいて決定されます。
+ **AgreementEndDate** (文字列) – 契約が終了した日付を定義します。`AgreementEndDate` は `YYYY-MM-DD`形式で表されます。契約は、指定された日付の 23:59:59.999 UTC に終了します。が指定され`AgreementEndDate`ていない場合、契約終了日は個々の条件の有効性によって決まります。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateValidityTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 用語 | 必須 | 422 |
| 用語[]。タイプ | 必須
のみ可能 `"ValidityTerm"` | 422 |
| 用語[]。AgreementDuration | オプションです。
セレクタタイプあたりの想定形式: ISO 8601 期間
単独でも、 と組み合わせてもかまいません。 `AgreementStartDate` | 422 |
| 用語[]。AgreementEndDate | オプションです。
日付は次のようにフォーマットする必要があります `"YYYY-MM-DD"` | 422 |
| 用語[]。AgreementStartDate | オプションです。
日付は次のようにフォーマットする必要があります `"YYYY-MM-DD"`
`AgreementEndDate` および とのみペアリングできます `AgreementDuration` | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateValidityTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_AGREEMENT | 置き換える現在の契約が将来の日付でない場合、 AgreementStartDate を将来の日付にすることはできません。 |
| INCOMPATIBLE\_AGREEMENT\_END\_DATE | オファーのリリース後に AgreementEndDate を更新することはできません。 |
| INCOMPATIBLE\_AGREEMENT\_START\_DATE | AgreementStartDate は、オファーのリリース後に更新することはできません。 |
| INCOMPATIBLE\_PRODUCT | 将来の AgreementStartDate はサポートされていません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | AgreementStartDate と AgreementEndDate の間の期間が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | AgreementStartDate が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | AgreementEndDate が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | AgreementStartDate と AgreementEndDate の間の期間が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | AgreementDuration が ResaleAuthorization で指定された期間と一致することを確認します。 |
| INCOMPATIBLE\_TERMS | ValidityTerm はパブリックオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | リクエストされた変更は、オファーの有効期限が切れた後は実行できません。 |
| INVALID\_AGREEMENT\_DURATION | [x] 日以上の AgreementDuration を指定します。 |
| INVALID\_AGREEMENT\_END\_DATE | 将来の AgreementEndDate を指定します。 |
| INVALID\_AGREEMENT\_END\_DATE | [x] 以降の AgreementEndDate を指定します。 |
| INVALID\_AGREEMENT\_START\_DATE | AvailabilityEndDate より後の AgreementStartDate を指定します。 AvailabilityEndDate |
| INVALID\_AGREEMENT\_START\_DATE | AgreementStartDate より前の AgreementEndDate を指定します。 |
| INVALID\_AGREEMENT\_START\_DATE | 本日から [x] 年以内の AgreementStartDate を指定してください。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | AgreementDuration と AgreementEndDate の両方を含む ValidityTerm はサポートされていません。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | AgreementStartDate と AgreementDuration の両方を含む ValidityTerm は、製品のオファーではサポートされていません。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | AgreementStartDate を使用した ValidityTerm は、製品のオファーではサポートされていません。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | AgreementStartDate のみを含む ValidityTerm はサポートされていません。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | AgreementEndDate は、将来の AgreementStartDate と組み合わせて使用するか、代替オファーに使用する場合を除き、サポートされていません。 |
| INVALID\_AGREEMENT\_TIME\_INTERVAL | 差が [x] 年以下の AgreementStartDate と AgreementEndDate を指定します。 |
| MISSING\_AGREEMENT\_START\_DATE | ConfigurableUpfrontPricingTerm ValidityTerm に AgreementStartDate が存在することを確認します。 |
| INVALID\_AGREEMENT\_END\_DATE | 本日から [x] 年以内の AgreementEndDate を指定してください。 |
| INCOMPATIBLE\_AGREEMENT\_START\_DATE | 契約に将来の開始日がある場合、契約で定義されているのと同じ AgreementStartDate を指定します。 |
| INCOMPATIBLE\_AGREEMENT | AgreementStartDate は、契約が将来の日付でない場合、将来の日付にすることはできません。 |
## 支払いスケジュールの詳細を更新する
Catalog API を使用して、柔軟な支払いスケジュールなど、オファーの支払いスケジュールの詳細を更新できます AWS Marketplace。
**注記**
すでに[公開](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#release-offer)されている (*リリース*とも呼ばれる) オファーで`UpdatePaymentScheduleTerms`変更タイプを使用することはできません。
プライベートオファーは、プライベートオファーの作成から[有効期限](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-availability) ( で設定) までの間、いつでも承諾できます`AvailabilityEndDate`。支払いスケジュールの 1 つの`ChargeDate`値のみを、購入者がプライベートオファーを承諾できる最終日 (プライベートオファーの有効期限) 以前の日付にすることができます。の残りの値は、プライベートオファーの有効期限が切れた後である必要がありますが、プライベートオファーがすぐに承諾された場合は契約の終了までに`ChargeDate`する必要があります。契約の終了は、プライベートオファーが承諾された日時 (契約の作成) と[契約期間に基づきます](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/offers.html#update-validity-terms)。
オファーの支払いスケジュールの詳細を更新するには、次の例に示すように、`UpdatePaymentScheduleTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdatePaymentScheduleTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "PaymentScheduleTerm",
"Schedule": [
{
"ChargeDate": "2021-12-01",
"ChargeAmount": "200.00"
},
{
"ChargeDate": "2022-03-01",
"ChargeAmount": "250.00"
}
]
}
]
}
}
]
}
```
`UpdatePaymentScheduleTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **条件** (構造の配列) – 更新する支払い条件のリスト。サポートされている支払い条件は次のとおりです。
+ **PaymentScheduleTerm** (オブジェクト) – 契約有効期間中の異なる日付に顧客が固定価格を請求される分割ベースの料金モデルを定義します。
+ **Type** (文字列) – 更新する用語のタイプ。これはオブジェクト値 です`"PaymentScheduleTerm"`。
+ **スケジュール** (構造の配列) – 各要素が 1 回の支払いの分割を定義する支払いスケジュールのリスト。これには、支払う料金と顧客に請求される日付を計算するために必要な情報が含まれています。
+ **ChargeDate** (文字列) – この支払いスケジュール期間で定義された料金を顧客が支払う日付。 `ChargeDate`は YYYY-MM-DD 形式で表されます。請求書は指定された日付に生成されます。
+ **ChargeAmount ** (文字列) – 顧客が予定日に支払う料金 (`ChargeDate`)。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdatePaymentScheduleTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP |
| --- | --- | --- |
| 用語 | 必須
のみ許可`PaymentScheduleTerm`されます
リストサイズは 2 未満にする必要があります | 422 |
| 用語[]。タイプ | 必須
は のみです `PaymentScheduleTerm` | 422 |
| 用語[]。PaymentScheduleTerm.CurrencyCode | 必須
サポートされている通貨: ["USD"、"AUD"、"EUR"、"GBP"、"JPY"] | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[] | 必須 | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[].ChargeAmount | 必須日付タイプは「文字列」です
小数点以下 2 桁までサポートされる負以外の小数点 | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[].ChargeDate | 必須
日付は「YYYY-MM-DD」の形式にする必要があります | 422 |
**非同期エラー**
以下のエラーは、 の`UpdatePaymentScheduleTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| DUPLICATE\_CHARGE\_DATES | PaymentScheduleTerm で一意の請求日を指定します。 |
| INCOMPATIBLE\_CURRENCY\_CODE | オファーのリリース後に CurrencyCode を変更することはできません。 |
| INCOMPATIBLE\_MARKUP\_PERCENTAGE | MarkupPercentage がゼロ (0) より大きい場合、 PaymentScheduleTerm はサポートされていません。 |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization と互換性のある用語 (複数可) を指定します。互換性のない用語: [PaymentScheduleTerm]。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | PaymentScheduleTerm の合計 ChargeAmounts が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INCOMPATIBLE\_TERMS | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
| INVALID\_CHARGE\_DATES | AgreementEndDate より前に請求日を指定します。 |
| INVALID\_CURRENCY\_CODE | サポートされている CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件で同じ CurrencyCode を指定します。 |
| TOO\_MANY\_BACKDATED\_CHARGES | AvailabilityEndDate より前に最大 1 つのスケジュールされた支払いを提供します。 |
| INVALID\_CHARGE\_DATES | AgreementEndDate より前の最終請求日を入力します。 |
| INVALID\_CHARGE\_DATES | 過去にない最初の請求日を入力します。 |
| TOO\_MANY\_CHARGES | PaymentScheduleTerm で最大 [x] のスケジュールされた支払いを指定します。 |
## 正味支払い条件を更新する
Catalog API を使用して、オファーの正味支払い条件を設定できます AWS Marketplace。正味支払い期間とは、請求書の発行から支払い期限までの日数を指定する期間です。
**注記**
正味支払い条件はプライベートオファーでのみサポートされ、 pay-by-invoiceの支払い方法を持つ購入者にのみ適用されます AWS。正味支払い条件を設定しない場合、購入者の の支払い条件 AWS が適用されます。
オファーの正味支払い期間を設定するには、次の例に示すように、`UpdateNetPaymentTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateNetPaymentTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "NetPaymentTerm",
"PaymentDuePeriod": "P30D"
}
]
}
}
]
}
```
`UpdateNetPaymentTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **条件** (構造配列) (必須) – 更新する正味支払い条件のリスト。オファーには、最大 1 つの正味支払い期間を含めることができます。サポートされている用語は次のとおりです。
+ **NetPaymentTerm** (オブジェクト) – 購入者と交渉される正味支払い条件を定義します。
+ **Type** (文字列) – 更新する用語のタイプ。これはオブジェクト値 です`"NetPaymentTerm"`。
+ **PaymentDuePeriod** (文字列) – 支払い期日の請求書発行日からの日数。このフィールドは ISO 8601 形式をサポートしています。サポートされている値は `P15D`、`P30D`、`P45D`、`P60D`、`P90D`、`P120D` です。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateNetPaymentTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP |
| --- | --- | --- |
| 用語 | 必須
のみ許可`NetPaymentTerm`されます
リストサイズは 2 未満にする必要があります | 422 |
| 用語[]。タイプ | 必須
は のみです `NetPaymentTerm` | 422 |
| 用語[]。NetPaymentTerm.PaymentDuePeriod | 必須
予想される形式: ISO 8601 の期間
使用できる値: ["P15D"、"P30D"、"P45D"、"P60D"、"P90D"、"P120D"] | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateNetPaymentTerms`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_PAYMENT\_DUE\_PERIOD | サポートされている PaymentDuePeriod を指定します。 |
| INCOMPATIBLE\_PRODUCT | 製品では、次の用語はサポートされていません: [x,y,z]。 |
| INCOMPATIBLE\_TERMS | NetPaymentTerm はパブリックオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization に NetPaymentTerm が含まれていないため、NetPaymentTerm はサポートされていません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization に NetPaymentTerm が含まれているため、NetPaymentTerm を削除することはできません。 ResaleAuthorization |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | NetPaymentTerm の PaymentDuePeriod が ResaleAuthorization と互換性があることを確認します。 |
| DUPLICATE\_TERM\_TYPES | 用語タイプの一意のリストを指定します。 |
## 更新オプションを変更する
Catalog API を使用して、このオファーを使用して作成された契約の更新オプションを制御できます AWS Marketplace。
Catalog API を使用して作成されたオファーの場合、自動更新を許可するように`UpdateRenewalTerms`変更タイプを呼び出すまで、自動更新はデフォルトで無効のままになります。この変更は、既存の契約には影響しません。
このオファーを使用して作成された契約の更新オプションを制御するには、次の例に示すように、`UpdateRenewalTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateRenewalTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Terms": [
{
"Type": "RenewalTerm"
}
]
}
}
]
}
```
`UpdateRenewalTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – オファー。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **条件** (構造の配列) – 更新する更新条件のリスト。サポートされている更新条件は次のとおりです。
+ **RenewalTerm** (オブジェクト) – 契約の正常な終了 (購入者または AWS Marketplace キャンセルではなく `ValidityTerm`の失効) 時に、既存の契約で承諾された条件を使用して新しい契約が作成されることを定義します。つまり、契約は更新されます。オファー`RenewalTerm`に が存在するということは、自動更新が許可されていることを意味します。購入者は、オファーの承諾/契約の作成時に自動更新を承諾または拒否することができます。
+ **Type** (文字列) – 更新する用語のタイプ。 `RenewalTerm`
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateRenewalTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 用語 | 必須 | 422 |
| 用語[]。タイプ | 必須RenewalTerm」のみを使用できます | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateRenewalTerms`アクションに固有です AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT | RenewalTerm は、製品のプライベートオファーではサポートされていません。 |
| INCOMPATIBLE\_TERMS | RenewalTerm は PaymentScheduleTerm と一緒にはサポートされていません。 |
| INCOMPATIBLE\_TERMS | RenewalTerm は PricingModel ではサポートされていません。 |
| INCOMPATIBLE\_TERMS | リクエストされた変更は、オファーのリリース後に実行することはできません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
## オファーを公開する
Catalog API を使用して、すべての更新変更タイプから収集された情報をマージし、オファーを発行できます。
オファーは、 `ReleaseOffer` が呼び出されるまで `Draft`状態のままです。オファーがリリースされると、 で検出できます AWS Marketplace。
オファーを公開するには、次の例に示すように、 `ReleaseOffer`変更タイプで `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "ReleaseOffer",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {}
}
]
}
```
`ReleaseOffer` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) — 作成されるエンティティの名前付きタイプ。`Identifier` はオファー ID で、 は常に `Type`です`Offer@1.0`。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) – リクエストの詳細の JSON 値。では空である必要があります`ReleaseOffer`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`ReleaseOffer`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| DetailsDocument | 空にする必要があります ({}) |
**非同期エラー**
以下のエラーは、 の`ReleaseOffer`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_PRODUCT | まず、製品のパブリックオファーを作成します。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INCOMPATIBLE\_TARGETING | PreExistingAgreement は、購入者ターゲットオファーでのみサポートされています。 |
| INCOMPATIBLE\_TARGETING | OfferSetId は、購入者ターゲットオファーでのみサポートされています。 |
| INVALID\_TAX\_INFORMATION | 税金情報が不完全です。プロフェッショナルサービスを販売するには AWS Marketplace、DAC7 税アンケートを完了する必要があります。支払い情報セクションに移動し、DAC7 納税申告書を選択します。税金情報が更新されるまでに最大 2 時間かかる場合があります。 |
| INVALID\_UPDATE\_REQUEST | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| MISSING\_AGREEMENT\_END\_DATE | 代替オファーの AgreementEndDate を指定します。 |
| MISSING\_AVAILABILITY\_END\_DATE | プライベートオファーの AvailabilityEndDate を指定します。 |
| MISSING\_BUYER\_ACCOUNTS | ResaleAuthorization を使用して作成されたオファーについて、PositiveTargeting を BuyersAccounts に提供します。 |
| MISSING\_BUYER\_ACCOUNTS | 製品のすべてのオファーはプライベートである必要があります。BuyersAccounts に PositiveTargeting を指定します。 |
| MISSING\_DESCRIPTION | オファーをリリースする前に説明を設定します。 |
| MISSING\_MANDATORY\_TERMS | オファーに [x] を追加します。 |
| MISSING\_MANDATORY\_TERMS | オファーに FixedUpfrontPricingTerm を指定します。 PaymentScheduleTerm |
| MISSING\_NAME | オファーをリリースする前に名前を設定します。 |
| TOO\_MANY\_OFFERS | 製品ごとに作成できるパブリック無料トライアルオファーは 1 つだけです。 |
| TOO\_MANY\_OFFERS | 製品ごとに作成できるパブリックオファーは 1 つだけです。 |
| MISSING\_MANDATORY\_TERMS | 製品の契約料金でパブリックオファーRenewalTermを提供します。 |
| MISSING\_AGREEMENT\_END\_DATE | 代替オファーの AgreementEndDate を指定します。 |
## 既存のオファーの詳細を記述する
Catalog API を使用して、既存のオファーの詳細を記述できます AWS Marketplace。
既存のオファーの詳細を記述するには、次の例に示すように、 `Offer@1.0`エンティティタイプで `DescribeEntity` API オペレーションを呼び出します。
**リクエストの構文**
```
GET /DescribeEntity?catalog=&entityId= HTTP/1.1
```
`DescribeEntity` 変更タイプを追加するフィールドの情報を入力します。
+ **catalog** (文字列) – リクエストに関連するカタログ。固定値: `AWSMarketplace`。
+ **entityId** (文字列) – 記述するオファーの一意の ID。
**レスポンスの構文**
このリクエストに対するレスポンスは、オファーの詳細を提供し、次のようになります。
```
{
"EntityType": "Offer@1.0",
"EntityIdentifier": "offer-ad8EXAMPLE51@1",
"EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51",
"LastModifiedDate": "2021-03-10T21:57:16Z",
"DetailsDocument": {
"Id": "offer-3rEXAMPLErn",
"State": "Released",
"Name": "Test Offer",
"Description": "Worldwide offer for Test Product",
"PreExistingAgreement": {
"AcquisitionChannel": "External",
"PricingModel": "Contract"
},
"ProductId": "prod-ad8EXAMPLE51",
"OfferSetId": "offerset-b3f9EXAMPLE27",
"Terms": [
{
"Type": "SupportTerm",
"RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service."
},
{
"Type": "LegalTerm",
"Documents": [
{
"Type": "CustomEula",
"Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
}
]
},
{
"Type": "FreeTrialPricingTerm",
"Duration": "P30D",
"Grants": [
{
"DimensionKey": "m3.xlarge",
"MaxQuantity": 10
},
{
"DimensionKey": "m4.xlarge",
"MaxQuantity": 10
}
]
},
{
"Type": "ConfigurableUpfrontPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"Selector": {
"Type": "Duration",
"Value": "P365D"
},
"RateCard": [
{
"DimensionKey": "m3.large",
"Price": "300.00"
},
{
"DimensionKey": "m4.xlarge",
"Price": "400.00"
}
],
"Constraints": {
"MultipleDimensionSelection": "Allowed",
"QuantityConfiguration": "Allowed"
}
}
]
},
{
"Type": "UsageBasedPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"RateCard": [
{
"DimensionKey": "m3.large",
"Price": "0.10"
},
{
"DimensionKey": "m4.xlarge",
"Price": "0.20"
}
]
}
]
},
{
"Type": "FixedUpfrontPricingTerm",
"CurrencyCode": "USD",
"Price": "200.00",
"Grants": [
{
"DimensionKey": "Users",
"MaxQuantity": 10
}
]
},
{
"Type": "RecurringPaymentTerm",
"CurrencyCode": "USD",
"BillingPeriod": "Monthly",
"Price": "100.0"
},
{
"Type": "PaymentScheduleTerm",
"CurrencyCode": "USD",
"Schedule": [
{
"ChargeDate": "2020-12-01T00:00:00.000Z",
"ChargeAmount": "1000.00"
},
{
"ChargeDate": "2021-06-15T00:00:00.000Z",
"ChargeAmount": "1250.00"
}
]
},
{
"Type": "ByolPricingTerm"
},
{
"Type": "RenewalTerm"
},
{
"Type": "NetPaymentTerm",
"PaymentDuePeriod": "P30D"
}
],
"Rules": [
{
"Type": "TargetingRule",
"PositiveTargeting": {
"CountryCodes": [
"US",
"CA"
],
"BuyerAccounts": [
"444455556666"
]
},
"NegativeTargeting": {
"CountryCodes": [
"XX"
]
}
},
{
"Type": "AvailabilityRule",
"AvailabilityEndDate": "2024-08-30T01:56:03.000Z"
}
]
}
}
```
以下は、`DescribeEntity`レスポンスに表示されるフィールドに関する情報です。
+ **EntityType** (文字列) – エンティティの名前付きタイプ。 です`Offer@1.0`。
+ **EntityIdentifier** (文字列) – の形式のエンティティの識別子`EntityId@RevisionId`。
+ **EntityArn** (文字列) – このリクエストで参照される変更セットの一意の識別子に関連付けられた ARN。
+ **LastModifiedDate** (文字列) – ISO 8601 形式 (例: ) のエンティティの最終更新日`2018-02-27T13:45:22Z`。
+ **詳細** (文字列) – この文字列化された JSON オブジェクトには、エンティティの次の詳細が含まれます。
+ **ID** (文字列) – AWS Marketplace および のオファーエンティティの一意の識別子は、オファーの作成時に生成されます。
+ **状態** (文字列) – オファーのステータス。
+ **名前** (文字列) – 自分と顧客にとって読みやすいようにオファーに関連付けられた名前。契約情報の一部としても表示されます。
+ **説明** (文字列) - 説明は自由形式のテキストであり、お客様のみが使用でき、購入者に公開されることはありません。
+ **PreExistingAgreement** (文字列) – このオファーが、同じ基盤となる製品の既存の顧客との既存の契約の更新かどうかを決定します。既存の契約は、内部または外部にすることができます AWS Marketplace。 AWS は、オファーが更新であることを監査して検証できます。 AWS がオファーを検証できない場合、 AWS は顧客からオファーと使用権限を取り消す可能性があります。
+ **AcquisitionChannel** (文字列) – 既存の契約が外部 AWS Marketplace または内部のどちらで署名されたかを示します AWS Marketplace。指定できる値: `External`、`AwsMarketplace`。
+ **PricingModel** (文字列) – 既存の契約が使用する料金モデルを示します。指定できる値: `Contract`、`Usage`、`Byol`、`Free`。
+ **ProductId** (文字列) – 提供されている製品の一意の識別子。
+ **OfferSetId** (文字列) – このオファーを関連付けるオファーセットの一意の識別子。
+ **用語** (構造の配列) — 用語のリスト。
+ **ルール** (構造の配列) – ルールのリスト。