AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、[AWS Marketplace API リファレンス](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS Marketplace APIs
を使用して AWS Marketplace Catalog API 、チャネルパートナーのプライベートオファー (CPPOs) を操作するタスクを自動化できます。
CPPO を作成または更新すると、オファー案には再販承認の条項とルールが含まれ、購入者には表示されません。組織内の複数のペルソナを関与させてプライベートオファーを作成することは可能ですが、必須ではありません。
たとえば、1 つのペルソナが料金の更新を担当し、もう 1 つのペルソナが支払いスケジュールの更新を担当できます。その後、3 番目のペルソナが法的条件の更新に責任を負うことができます。ペルソナにオファーの特定の部分を更新するアクセス許可を付与できます。ただし、再販認可には読み取りアクセス許可のみを付与できます。
変更タイプを呼び出すための前提条件として、1 つ以上の再販認可を受けており、 の操作に精通している必要があります AWS Marketplace Catalog API。
詳細については、「 *AWS Marketplace 販売者ガイド*」の[「チャネルパートナーのプライベートオファー](https://docs.aws.amazon.com/marketplace/latest/userguide/channel-partner-offers.html)」を参照してください。
以下のトピックでは、 Catalog API を使用して CPPOs を作成および更新する方法について説明します。
**Topics**
+ [CPPO の前提条件](#cppo-prerequisites)
+ [CPPO を作成する](#create-offer-using-resale-auth)
+ [チャネルパートナーのプライベート代替オファーを作成する](#create-replacement-offer-using-resale-auth)
+ [マークアップの更新](#update-markup)
+ [ターゲット設定を更新する](#update-targeting-cppo)
+ [法的リソースを更新する](#update-legal-terms-cppo)
+ [CPPO の検出可能性を更新する](#update-availability-cppo)
+ [契約の有効期限を定義する](#update-validity-terms-cppo)
+ [料金を更新する](#update-pricing-terms-cppo)
+ [支払いスケジュールの詳細を更新する](#update-payment-schedule-terms-cppo)
+ [CPPO を発行する](#release-offer-cppo)
+ [既存の CPPO を定義する](#describe-entity-cppo)
## CPPO の前提条件
ResaleAuthorization (SLR) 設定のサービスにリンクされたロールは、再販認可を使用して CPPO を作成するための必須の前提条件です。再販認可を使用するには、独立系ソフトウェアベンダー (ISVs) と AWS Marketplace チャネルパートナーの両方が、 にリソース共有アクセス許可を提供するサービスにリンクされたロールを作成する必要があります AWS。両方のグループがこの前提条件を実行しない場合、ISV から AWS Marketplace チャネルパートナーに認可リソースを共有 AWS することはできません。詳細については、*AWS Marketplace 「 Seller Guide*」の[「Using roles for Resale Authorization for for AWS Marketplace](https://docs.aws.amazon.com/marketplace/latest/userguide/using-roles-for-resale-authorization.html) 」を参照してください。
## CPPO を作成する
再販承認を使用して、 `Draft`状態のチャネルパートナープライベートオファー (CPPO) を作成します AWS Marketplace。
リクエストが正常に処理されると、 は再販承認条件を使用して `Draft` 状態のオファー AWS Marketplace Catalog API を生成します。を使用して`DescribeEntity`、再販承認からオファー案に適用される条件を確認できます。これは不完全なオファーであり、 の購入者には表示されません AWS Marketplace。次に、CPPO に関連付けられた変更タイプを使用してオファーを完了します。
オファーが完了したら、`ReleaseOffer`変更タイプを使用してオファー作成プロセスを完了し、オファーをリリースします。これにより、オファー全体が検証され、オファーが購入者に表示されます AWS Marketplace。
チャネルパートナーのプライベートオファーを作成するには、次の例に示すように、 `CreateOfferUsingResaleAuthorization`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "CreateOfferUsingResaleAuthorization",
"Entity": {
"Type": "Offer@1.0"
},
"DetailsDocument": {
"ResaleAuthorizationId": "resaleauthz-123456789",
"Name": "Test Offer",
"OfferSetId": "offerset-b3f9EXAMPLE27"
}
}
]
}
```
`CreateOfferUsingResaleAuthorization` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **ResaleAuthorizationId** (文字列) (必須) – 提供されている製品、用語、ルールを含む一意の識別子。チャネルパートナーは、更新変更タイプを使用して追加の用語とルールを追加できます。ResaleAuthorization は、パートナーとして利用可能で、ターゲットを絞ったものである必要があります。
+ **名前** (文字列) (オプション) – 読みやすくするためにオファーに関連付けられた名前。契約情報の一部として表示されます。
+ **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 から直接確認できます。
このリクエストに対するレスポンスは、リクエストのステータスを示します。ステータスが の場合`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": "CreateOfferUsingResaleAuthorization",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"ResaleAuthorizationId": "resaleauthz-123456789",
"Name": "Test Offer"
},
"ErrorDetailList": []
}
]
}
```
`GET` `DescribeEntity` リクエストを使用して、 AWS Marketplace Catalog API リファレンスの から作成されたオファーのドラフトルールと条件`ResaleAuthorization`を記述できます。詳細については、「[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)」を参照してください。
**ResaleAuthorization の用語とルール**
+ **LegalTerms** – ResaleAuthorization の EULA など、法的条件を説明する条項がオファー案に追加されます。`UpdateLegalTerms` 変更タイプを使用して法的用語を追加できます。詳細については、「[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-legal-terms-cppo](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-legal-terms-cppo)」を参照してください。
+ **PricingTerms** – ResaleAuthorization `ConfigurableUpfrontPricingTerm`で製造元によって説明されているすべての料金条件 (`FixedUpfrontPricingTerm`、`UsageBasedPricingTerm`、、`PaymentScheduleTerms`) がオファー案に追加されます。`UpdateMarkup` 変更タイプを使用して、ターゲット購入者の価格を (ディメンションごとに) 引き上げることができます。詳細については、このガイドの「[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-markup](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-markup)」を参照してください。
+ **PaymentTerms** – 製造元が ResaleAuthorization で将来の支払いスケジュールを定義している場合、オファー案で支払い条件を確認できます。`UpdateMarkup` 変更タイプを使用して、ターゲット購入者の支払いスケジュール金額を増やすことができます。購入者の支払いスケジュールを設定する場合は、 を使用できます`UpdatePaymentScheduleTerms`。詳細については、「[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-payment-schedule-terms-cppo](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-payment-schedule-terms-cppo)」を参照してください。
+ **TargetingRule** – ResaleAuthorization が特定の購入者を対象としている場合、チャネルパートナーは PositiveTargeting を使用して購入者のサブセットにプライベートオファーを提供できます。デフォルトでは、ルールには ResaleAuthorization のすべての購入者が含まれます。`UpdateTargeting` 変更タイプを使用して、特定の購入者を選択し、オファー案を更新できます。詳細については、「[https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-targeting-cppo](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/cppos.html#update-targeting-cppo)」を参照してください。
```
{
"EntityType": "Offer@1.0",
"EntityIdentifier": "offer-a5EXAMPLEwzpu@1",
"EntityArn": "arn:aws:aws-marketplace:us-east-1:444555666777:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
"LastModifiedDate": "2021-03-10T21:57:16Z",
"DetailsDocument": {
"Id": "offer-3rb23tu92rn",
"Name": "Test Offer",
"Description": "Worldwide private offer for Test Product",
"ProductId": "prod-0bc848d78b51",
"ResaleAuthorizationId": "resaleauthz-123456789",
"Terms": [
{
"Type": "LegalTerm",
"Documents": [
{
"Type": "CustomEula",
"Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
}
]
},
{
"Type": "ConfigurableUpfrontPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"Selector": {
"Type": "Duration",
"Value": "P12M"
},
"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": "PaymentScheduleTerm",
"CurrencyCode": "USD",
"Schedule": [
{
"ChargeDate": "2020-12-01T00:00:00.000Z",
"ChargeAmount": "1000.00"
},
{
"ChargeDate": "2021-06-15T00:00:00.000Z",
"ChargeAmount": "1250.00"
}
]
}
],
"Rules": [
{
"Type": "TargetingRule",
"PositiveTargeting": {
"BuyerAccounts": [
"111222333444"
]
}
}
]
}
}
```
**同期検証**
以下のスキーマ検証は、 の`CreateOfferUsingResaleAuthorization`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 名前 | 必須
長さは 1～150 文字にする必要があります | 422 |
| 説明 | 必須
長さは 1～255 文字にする必要があります | 422 |
| ResaleAuthorizationId | 必須
長さは 1～50 文字にする必要があります | 422 |
| ResaleAuthorizationId | ResaleAuthorization はチャネルパートナーを対象としている必要があります。 | 422 |
| ResaleAuthorizationId | ResaleAuthorization はアクティブである必要があります | 422 |
| チャネルパートナー | チャネルパートナーは で有料販売者である必要があります AWS Marketplace | 422 |
**非同期エラー**
以下のエラーは、 の`CreateOfferUsingResaleAuthorization`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | アクティブな状態で ResaleAuthorization を使用します。 |
| INCOMPATIBLE\_PRODUCT | OfferSetId は、製品のオファーではサポートされていません。 |
## チャネルパートナーのプライベート代替オファーを作成する
Catalog API を使用して、チャネルパートナーのプライベート代替オファーを作成できます AWS Marketplace。
次の例に示すように、 `ResaleAuthorization`を `CreateReplacementOfferUsingResaleAuthorization`変更タイプ`StartChangeSet`で呼び出すことで、ターゲットを絞った と、提案者である 契約を使用して、Catalog API でチャネルパートナーのプライベート代替オファーを `Draft`状態で作成します。代替オファーを使用して、以前のオファーの契約を終了前に置き換えることができます。
`CreateReplacementOfferUsingResaleAuthorization` は、ターゲティングにおける契約アクセプターとのオファー案を作成します。このターゲットは後で変更できません。オファー案には、契約のソースオファー ID も含まれます。
チャネルパートナーのプライベート代替オファーを作成するには、次の例に示すように、 `CreateReplacementOfferUsingResaleAuthorization`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "CreateReplacementOfferUsingResaleAuthorization",
"Entity": {
"Type": "Offer@1.0"
},
"DetailsDocument": {
"ResaleAuthorizationId": "2bd2c761-3b7f-3771-a9a7-e8ad36517698",
"Name": "CAPI-saas-abo-contract-fps",
"AgreementId": "agmt-f2ooEXAMLEamtm7mjj0j59gu"
}
}
]
}
```
`CreateReplacementOfferUsingResaleAuthorization` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **ResaleAuthorizationId** (文字列) (必須) – `ResaleAuthorizationId`は、提供されている製品、条件、ルールを含む一意の識別子です。チャネルパートナーは、更新変更タイプを使用して追加の用語とルールを追加できます。
`ResaleAuthorization` は、パートナーとして利用でき、ターゲットにする必要があります。
+ **名前** (文字列) (オプション) – お客様やお客様の顧客にとって読みやすいようにオファー`Name`に関連付けられています。契約情報の一部としても表示されます。
+ **AgreementId** (文字列) (必須) – ターゲット購入者`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 から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`CreateReplacementOfferUsingResaleAuthorization`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| 名前 | 長さは 1～150 文字にする必要があります |
| AgreementId | 提供された契約はアクティブである必要があります 提供された契約が存在している必要があります
提供された契約はチャネルパートナーが所有している必要があります |
| ResaleAuthorizationId | 必須
長さは 1～50 文字にする必要があります |
| ResaleAuthorizationId | ResaleAuthorization はチャネルパートナーを対象としている必要があります。 |
| ResaleAuthorizationId | ResaleAuthorization はアクティブである必要があります |
| チャネルパートナー | チャネルパートナーは で有料販売者である必要があります AWS Marketplace |
**非同期エラー**
以下のエラーは、 の`CreateReplacementOfferUsingResaleAuthorization`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | アクティブな状態で ResaleAuthorization を使用します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization は、契約に関連付けられているのと同じ製品のものである必要があります。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | 契約のアクセプターを対象とした ResaleAuthorization を使用します。 |
## マークアップの更新
Catalog API を使用して、 オファーの料金条件をパーセンテージ値で更新できます AWS Marketplace。
これにより、ResaleAuthorization で製造元が定義したすべての料金条件と支払い条件 (将来の支払いスケジュールの場合) に、指定されたパーセンテージのマークアップが適用されます。既存のマークアップは上書きされます。を使用して、更新された料金と支払い条件を表示できます`DescribeEntity`。
マークアップを更新するには、次の例に示すように、`UpdateMarkup`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdateMarkup",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"DetailsDocument": {
"Percentage": "5.0"
}
}
]
}
```
`UpdateMarkup` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **パーセンテージ** (文字列) (必須) – パーセンテージ値は製造元の料金または支払い条件に追加されます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace Seller Operations チームで情報を検証し、ガイドラインを満たし AWS Marketplace ていることを確認することが含まれます。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateMarkup`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| パーセンテージ | 必須
データ型は「文字列」です
負でない必要があります
最大 9 個の小数を許可する |
**非同期エラー**
以下のエラーは、 の`UpdateMarkup`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_MARKUP | リクエストされた変更は、オファーのリリース後に実行することはできません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | MarkupPercentage PaymentScheduleTermまたは FixedUpfrontPricingTermがオファーに存在し、 に存在しない場合、 を更新することはできませんResaleAuthorization。 |
| INCOMPATIBLE\_TERMS | 特定の支払い金額で UpdatePaymentScheduleTerms を使用するか、スケジュールされた日付に対して単一のマークアップパーセンテージで UpdateMarkup を使用します。 |
| INVALID\_MARKUP\_PERCENTAGE | UpdateMarkup は、ResaleAuthorization を使用して作成されたオファーに対してのみ呼び出すことができます。 |
## ターゲット設定を更新する
Catalog API を使用して、既存のターゲティング設定を完全に置き換えることができます AWS Marketplace。
最新のリクエストに含まれていない既存のターゲティングオプションは、オファーから削除されます。製造元は、 で特定のターゲット購入者について言及できます`ResaleAuthorization`。チャネルパートナーは、`UpdateTargeting`変更タイプ`PositiveTargeting`で を使用して、購入者のサブセットにプライベートオファーを提供できます。
オファーのターゲット設定を更新するには、次の例に示すように、`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": [
"111222333444"
]
},
"NegativeTargeting": {
"CountryCodes": [
"XX"
]
}
}
}
]
}
```
`UpdateTargeting` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `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 コード |
| --- | --- | --- |
| 詳細 | 必須 | 422 |
| PositiveTargeting | オプションです。 | 422 |
| NegativeTargeting | オプションです。 | 422 |
| PositiveTargeting.CountryCodes | オプションです。
国コードは有効である必要があります (ISO 3166-1 alpha-2) | 422 |
| PositiveTargeting.BuyerAccounts | オプションです。
AWS アカウント IDsは有効な形式 (12 桁の数字) である必要があります
25 個を超えるアカウントを含めることはできません | 422 |
| NegativeTargeting.CountryCodes | オプションです。
国コードは有効である必要があります (ISO 3166-1 alpha-2) | 422 |
| NegativeTargeting.BuyerAccounts | 指定しないでください (BuyerAccounts の否定的なターゲティングはサポートされていません) | 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 を指定します。 |
## 法的リソースを更新する
Catalog API を使用して、再販認可の法的条件をマージし、既存の法的条件を完全に置き換えることができます AWS Marketplace。
この変更は既存の契約には影響しません。最新のリクエストに含まれていない法的条件は、オファーから削除されます。を呼び出すことで、マージされた法的用語を表示できます`DescribeEntity`。
オファーの法的条件を更新するには、次の例に示すように、`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` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **用語** (構造の配列) (必須) – 更新する法的用語のリスト。サポートされている法的条件は次のとおりです。
+ **LegalTerm** (オブジェクト) (必須) – アクセプタに提案するテキスト契約のリストを定義します。このような契約の 1 つの例は、エンドユーザーライセンス契約 (EULA) です。
+ **タイプ** (文字列) (必須) — 更新する用語のカテゴリ。
+ **ドキュメント** (構造配列) (必須) – 購入者に提案する法的リソースへの参照のリスト。このようなリソースの一例は、エンドユーザーライセンス契約 (EULA) です。各リファレンスは、タイプと URL で構成されます。
+ **Type** (文字列) (必須) – ドキュメントのタイプ。使用可能なドキュメントタイプは次のとおりです。
+ **CustomEula** – 販売者として提供されるカスタム EULA。このドキュメントタイプには、アクセス可能な S3 バケットに保存されている EULA の URL が必要です。
+ **StandardEula** – Standard Contract for AWS Marketplace (SCMP)。SCMP の詳細については、 AWS Marketplace 「 販売者ガイド」を参照してください。このタイプの 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)
リクエストの変更セットが作成されます。このリクエストへのレスポンスは、変更セットの ID を提供します。
**レスポンスの構文**
```
{
"ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、ガイドラインを満たし AWS Marketplace ていることを確認するための AWS Marketplace Seller Operations チームへの情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または `DescribeChangeSet`アクションを使用して Catalog API で確認できます。
**同期検証**
以下のスキーマ検証は、 の`UpdateLegalTerms`アクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 用語 | 必須
リストでは LegalTerm のみが許可されます
リストサイズは 1 である必要があります | 422 |
| 用語[]。LegalTerm.Documents | 必須 | 422 |
| 用語[]。LegalTerm.Documents[].タイプ | 必須
許可される値:[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/marketplace/latest/developerguide/work-with-cppos.html) | 422 |
| 用語[]。LegalTerm.Documents[].URL | "Type" が次のいずれかの場合、必須で有効な URL である必要があります[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/marketplace/latest/developerguide/work-with-cppos.html) | 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 | 許可されたサイズ制限内で法的文書を提供します。 |
## CPPO の検出可能性を更新する
Catalog API を使用して、オファーの検出可能性を管理できます AWS Marketplace。この変更タイプは既存の契約には影響しません。
将来の特定の日付を設定してオファーの検出可能性を制限するか、過去に設定してオファーを期限切れにするかを選択できます。
オファーの検出可能性を管理するには、次の例に示すように、`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` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **AvailabilityEndDate** (文字列) – オファーが検出および購入可能になるまでの日付 AWS Marketplace。将来の特定の日付を設定して可用性を制限するか、過去にオファーを期限切れにするかを選択できます。日付は `YYYY-MM-DD` 形式で表されます。オファーは、指定された日付の 23:59:59.999 UTC に期限切れになります。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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 から直接確認できます。
**同期検証**
以下のスキーマ検証は、 の`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`変更タイプを使用して `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` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細の JSON 値。
+ **用語** (構造の配列) **–** 更新する有効期間のリスト。サポートされている有効期間は次のとおりです。
+ **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 コード |
| --- | --- | --- |
| 用語 | 必須
リストでは「ValidityTerm」のみが許可されます
空にするか、1 つの用語のみを含める必要があります | 422 |
| 用語[]。ValidityTerm | サポートされているユースケース:
1. AgreementDuration のみを含む ValidityTerm
2. AgreementStartDate のみを含む ValidityTerm
3. AgreementEndDate のみを含む ValidityTerm
4. AgreementStartDate と AgreementEndDate の両方を含む ValidityTerm | 422 |
| 用語[]。ValidityTerm.AgreementDuration | オプションです。
ISO\_8601 形式で表されます。 | 422 |
| 用語[]。ValidityTerm.AgreementStartDate | オプションです。
形式: "YYYY-MM-DD" | 422 |
| 用語[]。ValidityTerm.AgreementEndDate | オプションです。
形式: "YYYY-MM-DD" | 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 | AgreementStartDate を ConfigurableUpfrontPricingTerm と一緒に使用する場合ValidityTerm ConfigurableUpfrontPricingTerm に AgreementStartDate が存在することを確認します。 |
## 料金を更新する
Catalog API を使用して、既存の料金条件を完全に置き換えることができます。
最新のリクエストに含まれていない料金条件は、オファーから削除されます。チャネルパートナーは、この変更タイプを を渡すためにのみ使用できます`FixedUpFrontPricingTerm`。
オファーの料金条件を更新するには、次の例に示すように、`UpdatePricingTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "UpdatePricingTerms",
"Entity": {
"Type": "Offer@1.0",
"Identifier": "offer-123456789"
},
"Details": {
"PricingModel": "Contract",
"Terms": [
{
"Type": "FixedUpfrontPricingTerm",
"CurrencyCode": "USD",
"Price": "200.00",
"Duration": "P465D",
"Grants": [
{
"DimensionKey": "Users",
"MaxQuantity": 10
}
]
}
]
}
}
]
}
```
`UpdatePricingTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **詳細** (文字列) (必須) – リクエストの詳細。このフィールドは JSON 文字列フィールドです。文字列に含めることができないエスケープ文字 (引用符など) を含む 1 行の文字列フィールドに対して適切にフォーマットする必要があります。
+ **PricingModel** (文字列) (必須) – オファーの料金モデル。料金モデルに使用できる値は次のとおりです。
+ **契約** – 購入者が製品の使用に対して事前に請求されるか、柔軟な支払いスケジュールを提供する契約ベースの料金モデル。購入者は、契約を超える追加の使用量に対して支払うこともできます。
+ **条件** (構造配列) (必須) – 更新する料金条件のリスト。サポートされている料金条件は次のとおりです。
+ **FixedUpfrontPricingTerm** (オブジェクト) — 前払い料金モデルを定義し、顧客に固定前払い料金が請求されます。
+ **Type** (文字列) (必須) – 更新する用語のタイプ。
+ **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 レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| PricingModel | 必須
許可される料金モデル:
Contract |
| 用語 | 必須
許可される用語:
FixedUpfrontPricingTerm |
| 用語[]。FixedUpfrontPricingTerm.CurrencyCode | 必須
使用できる値: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"]
許可される料金モデル:
Contract |
| 用語[]。FixedUpfrontPricingTerm.Price | 必須
データ型は「文字列」で、負でない必要があります
最大 6 つの小数をサポート
特殊文字はサポートされていません |
| 用語[]。FixedUpfrontPricingTerm.Duration | 必須
予想される形式: ISO 8601 の期間 |
| 用語[]。FixedUpfrontPricingTerm.Grants[].DimensionKey | 必須
長さは 1～60 である必要があります |
| 用語[]。FixedUpfrontPricingTerm.Grants[].MaxQuantity | 必須 |
**非同期エラー**
以下のエラーは、 の`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 (0) より大きい場合、FixedUpfrontPricingTerm はサポートされていません。 |
| INCOMPATIBLE\_TERMS | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
| INVALID\_AGREEMENT\_DURATION | [x] ～ [y] か月の期間を指定します。 |
| INVALID\_AGREEMENT\_DURATION | 期間の詳細度が計測されたディメンションの日レベルであることを確認します。 |
| 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\_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\_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 を指定します。 |
## 支払いスケジュールの詳細を更新する
Catalog API を使用して、柔軟な支払いスケジュールなどの支払いスケジュールの詳細を変更できます AWS Marketplace。
製造元が再販認可で支払いスケジュールを提供している場合、チャネルパートナーは次のいずれかを行うことができます。
+ `UpdateMarkup` 変更タイプを使用して、すべての支払いスケジュールに統一されたパーセンテージマークアップを適用します。
+ `UpdatePaymentScheduleTerms` 変更タイプを使用して、カスタム支払い額を再販認可で提供されている以上の値に設定します。支払い日は変更できません。両方のオプションを同時に適用することはできません。最初にマークアップが適用され、支払いスケジュールを適用するように変更する必要がある場合は、`UpdateMarkup`変更タイプ`0`を使用してマークアップを に設定します。支払いスケジュールが最初に適用される場合、変更を元に戻してマークアップを適用することはできません。
オファーの支払い関連の詳細を更新するには、次の例に示すように、`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` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `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.CurrencyCode | 必須
サポートされている通貨: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"] | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[] | 必須
リストサイズは 1～60 の範囲である必要があります | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[].ChargeDate | 必須
形式: "YYYY-MM-DD" | 422 |
| 用語[]。PaymentScheduleTerm.Schedule[].ChargeAmount | 必須データ型は「文字列」です
小数点以下 2 桁までサポートされる負以外の小数点
追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`UpdatePaymentScheduleTerms`アクションに固有です AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| DUPLICATE\_CHARGE\_DATES | PaymentScheduleTerm で一意の請求日を指定します。 |
| INCOMPATIBLE\_MARKUP\_PERCENTAGE | MarkupPercentage がゼロ (0) より大きい場合、 PaymentScheduleTerm はサポートされていません。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | ResaleAuthorization と互換性のある用語 (複数可) を指定します。互換性のない用語: [PaymentScheduleTerm]。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | PaymentScheduleTerm の合計 ChargeAmounts が ResaleAuthorization と互換性があることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | PaymentScheduleTerm の請求日がResaleAuthorization の請求日と同じであることを確認します。 |
| INCOMPATIBLE\_RESALE\_AUTHORIZATION | PaymentScheduleTerm の請求金額が、その日付の ResaleAuthorization の請求金額以上であることを確認します。 |
| INCOMPATIBLE\_TERMS | リクエストされた変更は、オファーのリリース後に実行することはできません。 |
| INCOMPATIBLE\_TERMS | オファーの有効期限が切れた後は、リクエストされた変更を実行できません。 |
| INCOMPATIBLE\_TERMS | 特定の支払い金額で UpdatePaymentScheduleTerms を使用するか、スケジュールされた日付に対して単一のマークアップパーセンテージで UpdateMarkup を使用します。 |
| INVALID\_CHARGE\_DATES | AgreementEndDate より前に請求日を指定します。 |
| TOO\_MANY\_BACKDATED\_CHARGES | AvailabilityEndDate の前に最大 1 つのスケジュールされた支払いを指定します。 |
| エラーコード | エラーメッセージ |
| --- | --- |
| 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 つのスケジュールされた支払いを提供します。 |
## CPPO を発行する
Catalog API を使用して、すべての更新変更タイプから収集された情報をマージし、オファーを公開できます AWS Marketplace。
オファーは、 `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` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – CPPO。
+ **タイプ** (文字列) (必須) – は常に `Type`です`Offer@1.0`。
+ **識別子** (文字列) (必須) – オファー ID。詳細については、「[識別子](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 レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| 詳細 | 空にする必要があります ({}) |
**非同期エラー**
以下のエラーは、 の`ReleaseOffer`アクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_PRODUCT | まず、製品のパブリックオファーを作成します。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INVALID\_UPDATE\_REQUEST | オファーがリリースされた後は、リクエストされた変更を実行できません。 |
| MISSING\_AGREEMENT\_END\_DATE | 代替オファーの AgreementEndDate を指定します。 |
| MISSING\_AVAILABILITY\_END\_DATE | プライベートオファーの AvailabilityEndDate を指定します。 |
| MISSING\_MANDATORY\_TERMS | オファーに FixedUpfrontPricingTerm を指定します。 PaymentScheduleTerm |
| 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 つだけです。 |
## 既存の CPPO を定義する
Catalog API を使用して、CPPO の詳細を定義できます AWS Marketplace。
既存の CPPO を定義するには、次の例に示すように、 `Offer@1.0`エンティティタイプで `DescribeEntity` API オペレーションを呼び出します。
**リクエストの構文**
```
GET /DescribeEntity?catalog=&entityId= HTTP/1.1
```
`DescribeEntity` 変更タイプを追加するフィールドの情報を入力します。
+ **catalog** (文字列) – リクエストに関連するカタログ。固定値: `AWSMarketplace`。
+ **entityId** (文字列) – 記述するオファーの一意の ID。
**レスポンスの構文**
このリクエストに対するレスポンスは、オファーの詳細を提供し、次のようになります。
```
{
"EntityType": "Offer@1.0",
"EntityIdentifier": "offer-a5oEXAMPLEzpu@1",
"EntityArn": "arn:aws:aws-marketplace:us-east-1:446235747164:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
"LastModifiedDate": "2021-03-10T21:57:16Z",
"Details": {
"Id": "offer-3rEXAMPLErn",
"State": "Released",
"Name": "Test Offer",
"Description": "Worldwide private offer for Test Product",
"PreExistingAgreement": {
"AcquisitionChannel": "External",
"PricingModel": "Contract"
},
"ProductId": "prod-0bEXAMPLEb51",
"ResaleAuthorizationId": "resaleauthz-123456789",
"MarkupPercentage": "5.0",
"Terms": [
{
"Type": "LegalTerm",
"Documents": [
{
"Type": "CustomEula",
"Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
}
]
},
{
"Type": "ConfigurableUpfrontPricingTerm",
"CurrencyCode": "USD",
"RateCards": [
{
"Selector": {
"Type": "Duration",
"Value": "P12M"
},
"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": "PaymentScheduleTerm",
"CurrencyCode": "USD",
"Schedule": [
{
"ChargeDate": "2020-12-01T00:00:00Z",
"ChargeAmount": "1000.00"
},
{
"ChargeDate": "2021-06-15T00:00:00Z",
"ChargeAmount": "1250.00"
}
]
}
],
"Rules": [
{
"Type": "TargetingRule",
"PositiveTargeting": {
"CountryCodes": [
"US",
"CA"
],
"BuyerAccounts": [
"118033953248"
]
},
"NegativeTargeting": {
"CountryCodes": [
"XX"
]
}
},
{
"Type": "AvailabilityRule",
"AvailabilityEndDate": "2050-08-30T01:56:03Z"
}
]
}
}
```
`DescribeEntity` レスポンスの入力フィールドの情報を入力します。
+ **EntityType** (文字列) – エンティティの名前付きタイプ。 です`Offer@1.0`。
+ **EntityIdentifier** (文字列) – の形式のエンティティの識別子`EntityId@RevisionId`。
+ **EntityArn** (文字列) – このリクエストで参照される変更セットの一意の識別子に関連付けられた ARN。
+ **LastModifiedDate** (文字列) – ISO 8601 形式 () のエンティティの最終変更日`2018-02-27T13:45:22Z`。
+ **DetailsDocument** (オブジェクト) – JSON オブジェクトにはエンティティの詳細が含まれます。
+ **ID** (文字列) – AWS Marketplace および のオファーエンティティの一意の識別子は、オファーの作成時に生成されます。
+ **状態** (文字列) – オファーのステータス。
+ **名前** (文字列) – お客様およびお客様の顧客にとって読みやすくするために、オファーに関連付けられた名前。契約情報の一部としても表示されます。
+ **説明** (文字列) – 説明は自由形式のテキストであり、お客様だけが使用でき、購入者に公開されることはありません。
+ **PreExistingAgreement** (文字列) – このオファーが、同じ基盤となる製品の既存の顧客との既存の契約の更新かどうかを決定します。既存の契約は、内部でも外部でもかまいません AWS Marketplace。 AWS は、オファーが更新であることを監査して検証できます。 AWS がオファーを検証できない場合、 AWS は顧客からオファーと使用権限を取り消す可能性があります。
+ **AcquisitionChannel** (文字列) – 既存の契約が外部 AWS Marketplace または内部のどちらで署名されたかを示します AWS Marketplace。指定できる値: `External`、`AwsMarketplace`。
+ **PricingModel** (文字列) – 既存の契約が使用する料金モデルを示します。指定できる値: `Contract`、`Usage`、`Byol`、`Free`。
+ **ProductId** (文字列) – 説明は自由形式のテキストであり、お客様のみが使用でき、購入者に公開されることはありません。
+ **ResaleAuthorizationId** (文字列) — ResaleAuthorization はプライベートオファーの作成に使用されます。
+ **MarkupPercentage** (文字列) – チャネルパートナーが`UpdateMarkup`変更タイプで渡したパーセンテージ値。このマークアップはすでに条件に適用されています。
+ **用語** (構造の配列) — 用語のリスト。
+ **ルール** (構造の配列) — ルールのリスト。