AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、[AWS Marketplace API リファレンス](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS MarketplaceAPIs を使用して再販認可を操作する
を使用してAWS Marketplace Catalog API、再販認可を操作するためのタスクを自動化できます。
*製品*では で販売されているものが説明されていますがAWS Marketplace、*再販認可* (オポチュニティとも呼ばれます) では、この製品の再販の承認方法に関する条件とルールが説明されていますAWS Marketplace。*CPPO* は再販認可のターゲットです。
再販認可には、製造元とチャネルパートナー間のリセラー契約に受け入れられる一連の条件とルールがあります。再販承認の条件に同意すると、リセラーは条件に示されている条件に従って製品のオファーを作成できます。
再販承認には 2 種類のルールがあります。
+ **AvailabilityRule** – での再販認可のライフサイクルを制御しますAWS Marketplace。
+ **PartnerTargetingRule ** – 再販認可に特定のチャネルパートナーがアクセスできるようにするかどうかを指定します。
以下のリソースを参照してください。
+ コード例を使用するend-to-endのラボについては、*AWS Marketplace販売者ワークショップ*の[「ラボ: リセラーの承認](https://catalog.workshops.aws/mpseller/en-US/manage-offers-with-api/authorize-a-reseller)」を参照してください。
+ API リクエストのコード例については、GitHub の*AWS「サンプル*」の[「Python](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/python/src/catalog_api/resale_authorization) と [Java](https://github.com/aws-samples/aws-marketplace-reference-code/tree/main/java/resources/changeSets/channel_partner_offers) の例」を参照してください。
+ 再販認可の作成に関する動画については、YouTube の[AWS Marketplace「カタログ API を使用して再販認可を作成する](https://www.youtube.com/watch?v=vLIbvFYI974)」を参照してください。
以下のトピックでは、 Catalog API を使用して再販承認を作成および更新する方法について説明します。
**Topics**
+ [再販認可の前提条件](#prerequisites)
+ [新しい再販承認を作成する](#create-resale-authorization)
+ [購入者ターゲットの更新](#update-buyer-targeting)
+ [可用性の更新](#update-availability-resale-auth)
+ [将来の日付の契約の有効性を更新する](#update-validity-fda)
+ [法的リソースを更新する](#update-existing-legal-terms)
+ [料金を更新する](#update-existing-pricing-terms)
+ [支払いスケジュールを更新する](#update-payment-schedule-details)
+ [再販承認の詳細を更新する](#update-resale-auth-information)
+ [再販承認の制限](#restricte-resale-auth)
+ [再販認可をリリースし、チャネルパートナーに表示する](#release-resale-auth)
+ [既存の再販承認の説明](#describe-entity-resale-auth)
## 再販認可の前提条件
再販認可を使用するには、独立系ソフトウェアベンダー (ISVs) とAWS Marketplaceチャネルパートナーの両方が、リソース共有アクセス許可を提供するサービスにリンクされたロールを作成する必要がありますAWS。両方のグループがこの前提条件を実行しない場合、ISV からAWS Marketplaceチャネルパートナーに認可リソースを共有AWSすることはできません。詳細については、*AWS Marketplace「 Seller Guide*」の[「Using roles for Resale Authorization for forAWS Marketplace](https://docs.aws.amazon.com/marketplace/latest/userguide/using-roles-for-resale-authorization.html) 」を参照してください。
## 新しい再販承認を作成する
Catalog API を使用して、新しい再販認可を作成できますAWS Marketplace。
リクエストが正常に処理されると、 は再販売承認を `Draft`状態でAWS Marketplace Catalog API生成します。これは不完全な再販承認であり、チャネルパートナーには表示されませんAWS Marketplace。
`Update` 変更タイプを使用して、再販承認を完了します。再販認可が完了したら、`ReleaseResaleAuthorization`変更タイプを使用して再販認可の作成プロセスを完了し、再販認可をリリースします。これにより、再販認可全体が検証され、チャネルパートナーに表示されますAWS Marketplace。
再販売認可を `Draft`状態で作成するには、次の例に示すように、 `CreateResaleAuthorization`変更タイプで `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "CreateResaleAuthorization",
"ChangeName": "xyz",
"Entity":
{
"Type": "ResaleAuthorization@1.0"
},
"DetailsDocument":
{
"ProductId": "prod-ad8EXAMPLE51",
"Name": "Test ResaleAuthorization",
"Description": "Worldwide ResaleAuthorization for Test Product",
"ResellerAccountId": "777788889999"
}
}
]
}
```
`CreateResaleAuthorization` 変更タイプを追加する入力フィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **ProductId** (文字列) (必須) – 再販認可を作成する製品 ID。
+ **名前** (文字列) (必須) – ユーザーとチャネルパートナーが読みやすくするために、ResaleAuthorization に関連付けられた名前。
+ **説明** (文字列) (オプション) – ResaleAuthorization の詳細を追加するために使用できる自由形式のテキストフィールド。
+ **ResellerAccountId** (文字列) (必須) – これを記述して使用`ResaleAuthorization`してプライベートオファーを作成AWS アカウントできるターゲットチャネルパートナーの を追加します。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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`)、新しい `ResaleAuthorization` が生成されます。`SUCCEEDED` ステータスは`CreateResaleAuthorization`変更タイプの呼び出しが完了したことを示しますが、`ResaleAuthorization`ステータスはまだ `Draft` 状態です。
以下は、[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html) API オペレーションからのレスポンスを示しています。
```
{
"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": "CreateResaleAuthorization",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"ProductId": "prod-ad8EXAMPLE51",
"Name": "Test ResaleAuthorization",
"Description": "Worldwide ResaleAuthorization for Test Product",
"ResellerAccountId": "777788889999",
"BulkRequestId": "84977023-5093-4a66-8b24-ef2c5a2f8b1f"
},
"ErrorDetailList":
[]
}
]
}
```
**同期検証**
スキーマの検証は、 の`CreateResaleAuthorization`アクションに固有ですAWS Marketplace Catalog API。検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| ProductId | 必須
null または空にすることはできません
長さは 1～50 文字にする必要があります | 422 |
| ProductId | ユーザーは、特定の製品の ResaleAuthorization を作成する権限を持っている必要があります | 403 |
| ProductId | Draft 状態ではなく、カタログ内の既存の製品である必要があります 再販するには製品をサポートする必要があります | 404 |
| 名前 | 必須
null または空にすることはできません
長さは 1～100 文字にする必要があります
特殊文字は使用できません | 422 |
| 説明 | オプションです。
長さは 1～255 文字にする必要があります
特殊文字は使用できません | 422 |
| ResellerAccountId | 必須
空にすることはできません
AWS アカウントIDsは有効な形式 (12 桁の数字) である必要があります | 422 |
| BulkRequestId | オプションです。
長さは 1～50 文字にする必要があります
UUID 形式である必要があります | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`CreateResaleAuthorization `アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_RESELLER\_ACCOUNT | 有効なリセラーアカウントを指定してください。 |
## 購入者ターゲットの更新
Catalog API を使用して、再販承認の対象となる購入者を更新できますAWS Marketplace。
最新のリクエストに含まれていない既存のターゲティングオプションは、再販承認から削除されます。この変更タイプは、再販認可のリリースではオプションです。
再販承認の対象となる購入者を更新するには、次の例に示すように、 `UpdateBuyerTargetingTerms` API `StartChangeSet`オペレーションを変更タイプで呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType":"UpdateBuyerTargetingTerms",
"Entity":{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"Terms":
[
{
"Type": "BuyerTargetingTerm",
"PositiveTargeting":
{
"BuyerAccounts":
[
"123456789012"
]
}
}
]
}
}
]
}
```
`UpdateBuyerTargetingTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **用語** (構造の配列) (オプション) – 更新する用語をターゲットとする購入者のリスト。特定の購入者に をターゲット`ResaleAuthorization`としない場合、用語フィールドはスキップできます。デフォルトでは、 `ResaleAuthorization`はすべての購入者を対象としています。サポートされている用語は次のとおりです。
+ **BuyerTargetingTerms** (オブジェクト) (オプション) – ResaleAuthorization に対する購入者固有のターゲットを定義します。
+ **タイプ** (文字列) (必須) – 更新する用語のカテゴリ。
+ **PositiveTargeting** (オブジェクト) (必須) – 購入者のプロファイルが へのアクセスを許可するために満たすべき基準を定義します`ResaleAuthorization`。
+ **BuyerAccounts** (文字列の配列) (オプション) – オプションとして一覧表示します。ターゲット購入者の を追加できますAWS アカウント。特定の購入者`ResaleAuthorization`を対象としない場合、このフィールドは省略する必要があります。デフォルトでは、すべての購入者がターゲットになります。ターゲットチャネルパートナーは、プライベートオファーを作成し、指定されている場合は購入者のサブセットをターゲットにすることができます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、ガイドラインを満たしAWS Marketplaceていることを確認するための AWS MarketplaceSeller Operations チームへの情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
スキーマの検証は、 の`UpdateBuyerTargetingTerms`アクションに固有ですAWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| 用語 | オプションです。
null または空にすることはできません
リストでは「BuyerTargetingTerm」のみが許可されます
リストサイズは 1 にする必要があります (現在、複数の購入者条件を必要とするユースケースはありません) |
| BuyerTargetingTerm.PositiveTargeting | 必須
空にすることはできません |
| BuyerTargetingTerm.PositiveTargeting.BuyerAccounts | オプションです。
AWS アカウントIDsは有効な形式 (12 桁の数字) である必要があります
25 個を超えるアカウントを含めることはできません |
| 不明なプロパティ | 追加のプロパティは許可されません |
**非同期エラー**
以下のエラーは、 の`UpdateBuyerTargetingTerms`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_BUYER\_TARGETING | PreExistingBuyerAgreement による ResaleAuthorization には、少なくとも 1 つの購入者アカウントが存在する必要があります。 |
## 可用性の更新
Catalog API を使用して、プライベートオファーの作成数や、プライベートオファーを作成できる特定の時間までの可用性を制限できます。
デフォルトでは、値はこの再販承認の無制限の使用になりますが、ルールリストで可用性を確認できます。
再販認可の可用性と使いやすさを制御するには、次の例に示すように、 `UpdateAvailability`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateAvailability",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"AvailabilityEndDate": "2022-05-31",
"OffersMaxQuantity": 1
}
}
]
}
```
`UpdateAvailability` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **AvailabilityEndDate** (文字列) (オプション) – チャネルパートナーが を活用してオファー`ResaleAuthorization`を作成するまで、終了日を定義します。チャネルパートナーは、指定した終了日までこれを`ResaleAuthorization`複数回使用できます。日付は ISO\_8601 形式で表されます。
+ **OffersMaxQuantity** (整数) (オプション) – ResaleAuthorization を使用して作成できるプライベートオファーの最大数を定義します。これにより、サブスクリプションの数は定義されません。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS MarketplaceSeller Operations チームで情報を検証し、ガイドラインを満たし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 レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| OffersMaxQuantity | オプションです。
負以外の整数である必要があります
許容値「1」のみ (現在、複数の数量をサポートするユースケースはありません) |
| AvailabilityEndDate | オプションです。
ISO\_8601 形式である必要があります
将来の日付である必要があります |
| 可用性 | OffersMaxQuantity または AvailabilityEndDate のいずれかを指定します。 |
| 不明なプロパティ | 追加のプロパティは許可されません |
**非同期エラー**
以下のエラーは、AWS Marketplace Catalog API の`UpdateAvailability`アクションに固有のものです。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_AVAILABILITY\_END\_DATE | ResalePaymentScheduleTerms のすべての ChargeDate より前の AvailabilityEndDate を指定します。 ChargeDate |
| INVALID\_AVAILABILITY\_END\_DATE | 将来の AvailabilityEndDate を指定します。 |
## 将来の日付の契約の有効性を更新する
Catalog API を使用して、将来の日付のサービス開始日を変更および制御できますAWS Marketplace。
この変更セットは、再販認可をリリースするために必須ではありません。
再販認可の製品契約期間を変更および制御するには、次の例に示すように、`UpdateBuyerValidityTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
将来の日付の契約は、SaaS 製品タイプでのみサポートされます。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateBuyerValidityTerms",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"Terms":
[
{
"Type": "BuyerValidityTerm",
"MaximumAgreementStartDate": "2024-05-31"
}
]
}
}
]
}
```
`UpdateBuyerValidityTerms` 変更タイプを追加する入力フィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **条件** (構造の配列) – 更新する契約有効期間のリスト。サポートされている用語は次のとおりです。
+ **BuyerValidityTerm** (オブジェクト) – ResaleAuthorization 内の製品のサービスの可用性を定義します。
+ **タイプ** (文字列) — 更新する用語のカテゴリ。
+ **MaximumAgreementStartDate** (文字列) (必須) – 提供される製品の契約開始日を定義します。将来の日付のオファーは、このサービスの開始日を超えることはできません。日付は ISO\_8601 形式で表されます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`ChangeSetArn`の `ChangeSetId`と を提供し、次のようになります。
```
{
"ChangeSetId": "example123456789012abcdef",
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```
変更リクエストがキューに追加され、処理されます。これには、 AWS MarketplaceSeller Operations チームで情報を検証し、ガイドラインを満たしAWS Marketplaceていることを確認することが含まれます。検証プロセスには数分から数時間かかる場合があります。
リクエストのステータスは、 を通じてAWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog `[DescribeChangeSet](https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html)` API から直接確認できます。
**同期検証**
スキーマの検証は、 の`UpdateBuyerValidityTerms`アクションに固有ですAWS Marketplace Catalog API。検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| 用語 | 必須
null または空にすることはできません
リストには「BuyerValidityTerm」のみを使用できます
リストサイズは 1 である必要があります (現在、複数のサービス可用性条件を必要とするユースケースはありません) |
| MaximumAgreementStartDate | 必須
null または空にすることはできません
将来の日付にする必要があり、現在から 3 年を超えることはできません
ISO\_8601 形式である必要があります |
| 不明なプロパティ | 追加のプロパティは許可されません |
**非同期エラー**
以下のエラーは、 の`UpdateBuyerValidityTerms `アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_PRODUCT | BuyerValidityTerm は製品ではサポートされていません。 |
| INVALID\_MAXIMUM\_AGREEMENT\_START\_DATE | 将来の MaximumAgreementStartDate を許可された制限に指定します。 |
## 法的リソースを更新する
Catalog API を使用して、 で既存の法的条件を完全に置き換えることができますAWS Marketplace。
最新のリクエストに含まれていない法的条件は、再販認可から削除されます。 `BuyerLegalTerm`には、最終的な購入者契約に含まれる EULA と、チャネルパートナーと ISV 間のリセラー契約に含まれるリセラー契約`LegalTerm`が含まれます。
の法的条件を更新するには`ResaleAuthorization`、次の例に示すように、`UpdateLegalTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateLegalTerms",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"Terms":
[
{
"Type": "BuyerLegalTerm",
"Documents":
[
{
"Type": "CustomEula",
"Url": "https://my-public-bucket.s3.amazonaws.com/eula-example12345.txt"
}
]
},
{
"Type": "ResaleLegalTerm",
"Documents":
[
{
"Type": "CustomResellerContract",
"Url": "https://my-public-bucket.s3.amazonaws.com/reseller-example12345.txt"
}
]
}
]
}
}
]
}
```
`UpdateLegalTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **用語** (構造の配列) (必須) – 法的用語のリスト。サポートされている法的条件は次のとおりです。
+ **BuyerLegalTerm** (オブジェクト) (必須) – アクセプタに提案するテキスト契約のリストを定義します。例えば、エンドユーザーライセンス契約 (EULA) などです。
+ **タイプ** (文字列) (必須) – 更新する用語のカテゴリ。
+ **ドキュメント** (構造配列) (必須) – 購入者に提案する法的リソースへの参照のリスト。例えば、EULA などです。各リファレンスは、 `Type`と で構成されます`URL`。
+ **Type** (文字列) (必須) – ドキュメントのタイプ。使用可能なドキュメントタイプは次のとおりです。
+ **StandardEula** – の標準契約AWS Marketplace。詳細については、「 *AWS Marketplace販売者ガイド*」の[「SCMP](https://docs.aws.amazon.com/marketplace/latest/userguide/standardized-license-terms.html#standard-contracts)」を参照してください。このタイプの URL は によって管理されるため、指定する必要はありませんAWS Marketplace。
+ **EnterpriseEula** – Enterprise Contract forAWS Marketplace。詳細については、「 AWS Marketplace販売者ガイド」の「DSA」を参照してください。このタイプの URL は によって管理されるため、指定する必要はありませんAWS Marketplace。
+ **CustomEula** – 製造元として提供されるカスタム EULA。このドキュメントタイプには、アクセス可能な S3 バケットに保存されている EULA の URL が必要です。
+ **URL** (文字列) (条件付きで必須) – 購入者が読むための法的文書への URL。これは、カテゴリタイプが の場合に必要です`CustomEula`。
+ **ResaleLegalTerm** (オブジェクト) (オプション) – チャネルパートナーにのみ提案するテキスト契約のリストを定義します。この用語は購入者は利用できません。
+ **タイプ** (文字列) (必須) — 更新する用語のカテゴリ。
+ **ドキュメント** (構造配列) (必須) — チャネルパートナーに提案するリセラーの法的リソースへの参照のリスト。
+ **タイプ** (文字列) (必須) – ドキュメントのカテゴリ。使用可能なドキュメントタイプは次のとおりです。
+ **StandardResellerContract** – 標準リセラー契約AWS Marketplace。
+ **CustomResellerContract** – お客様が製造元として締結したカスタムリセラー契約。リセラー契約の URL は、アクセス可能な S3 バケットに保存され、このドキュメントタイプに必要です。
+ **URL** (文字列) (条件付きで必須) – チャネルパートナーが読み取るリセラー契約ドキュメントへの URL。タイプが CustomResellerContract の場合は必須です。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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 コード |
| --- | --- | --- |
| 用語 | 必須
null または空にすることはできません | 422 |
| 用語[]。BuyerLegalTerm | 必須
null または空にすることはできません | 422 |
| 用語[]。ResaleLegalTerm | オプションです。
存在する場合は null または空にすることはできません | 422 |
| 用語[]。BuyerLegalTerm.Documents | 必須
null または空にすることはできません | 422 |
| 用語[]。BuyerLegalTerm.Documents[].タイプ | 必須
null または空にすることはできません
許可される値:[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/marketplace/latest/developerguide/work-with-resale-authorizations.html) | 422 |
| 用語[]。BuyerLegalTerm.Documents[].URL | "Type" が "CustomEula" の場合、必須であり、有効な URL である必要があります 「Type」が「StandardEula」、「EnterpriseEula」のいずれかである場合は指定できません。 | 422 |
| 用語[]。ResaleLegalTerm.Documents | 必須
null または空にすることはできません | 422 |
| 用語[]。ResaleLegalTerm.Documents[].タイプ | 必須
null または空にすることはできません 使用できる値:[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/marketplace/latest/developerguide/work-with-resale-authorizations.html) | 422 |
| 用語[]。ResaleLegalTerm.Documents[].URL | 「Type」がCustomResellerContract」の場合、必須であり、有効な URL である必要があります
"Type" が ["StandardContract"] のいずれかである場合は指定できません | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateLegalTerms`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは`DescribeChangeSet`、変更セットの処理後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_BUYER\_LEGAL\_DOCUMENTS | アクセス可能な S3 バケットに保存されている購入者の法的ドキュメントの URLs を指定します。 |
| INVALID\_RESALE\_LEGAL\_DOCUMENTS | アクセス可能な S3 バケットに保存されている再販法的ドキュメントの URLs を指定します。 |
| MISSING\_MANDATORY\_TERMS | BuyerLegalTerm を指定します。 |
## 料金を更新する
Catalog API を使用して、 で既存の料金条件を完全に置き換えることができますAWS Marketplace。
最新のリクエストに含まれていない料金条件は、再販承認から削除されます。この API を使用して、製品の割引料金を更新できます。
再販認可の料金詳細を更新するには、次の例に示すように、`UpdatePricingTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdatePricingTerms",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"PricingModel": "Contract",
"Terms":
[
{
"Type": "ResaleUsageBasedPricingTerm",
"CurrencyCode": "USD",
"RateCards":
[
{
"RateCard":
[
{
"DimensionKey": "m3.large",
"Price": "0.10"
},
{
"DimensionKey": "m4.xlarge",
"Price": "0.20"
}
]
}
]
},
{
"Type": "ResaleConfigurableUpfrontPricingTerm",
"CurrencyCode": "USD",
"RateCards":
[
{
"Selector":
{
"Type": "Duration",
"Value": "P12M"
},
"RateCard":
[
{
"DimensionKey": "m3.large",
"Price": "300"
},
{
"DimensionKey": "m4.xlarge",
"Price": "400"
}
],
"Constraints":
{
"MultipleDimensionSelection": "Allowed",
"QuantityConfiguration": "Allowed"
}
}
]
},
{
"Type": "ResaleFixedUpfrontPricingTerm",
"CurrencyCode": "USD",
"Duration": "P2M",
"Price": "200.0",
"Grants":
[
{
"DimensionKey": "Users",
"MaxQuantity": 10
}
]
}
]
}
}
]
}
```
`UpdatePricingTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **PricingModel** (文字列) (必須) – オファーの料金モデル。料金モデルに使用できる値は次のとおりです。
+ **使用状況** – 製品の使用に対して購入者に請求される使用量ベースの料金モデル。
+ **契約** – 契約ベースの料金モデルでは、購入者は製品の使用に対して事前に請求されるか、柔軟な支払いスケジュールが提供されます。購入者は、契約を超える追加の使用量に対して支払うこともできます。チャネルパートナーは、各ディメンションのこの支払いスケジュールと料金にマークアップを追加できます。
+ **用語** (構造配列) (必須) – 更新する料金条件のリスト。サポートされている料金条件は次のとおりです。
+ **ResaleUsageBasedPricingTerm** (オブジェクト) – 製品の使用量に基づいて顧客に課金されるpay-as-you-go (PAYG) の料金モデルを定義します。
+ **タイプ** (文字列) (必須) – 用語のカテゴリ。
+ **CurrencyCode** (文字列) – この用語で言及されている価格の通貨を定義します。現在、 USD のみがサポートされています。
+ **RateCards** (構造体の配列) – レートカードのリスト。
+ **RateCard** (構造の配列) – レートカードは、製品ディメンションのユニットあたりのレートを定義します。
+ **DimensionKey** (文字列) – 指定された使用権限が適用されるディメンション。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されますAWS Marketplace。
+ **Price** (文字列) – 請求額の計算に使用される製品ディメンションの単価。
+ **制約** (オブジェクト) (オプション) – アクセプタが用語を設定する方法の制限を定義します。
+ **MultipleDimensionSelection** (文字列) (オプション) – 購入者がレートカードで複数のディメンションを選択できるかどうかを決定します。指定できる値は `Allowed` および `Disallowed` です。デフォルト値は `Allowed` です。
+ **QuantityConfiguration** (文字列) (オプション) – アクセプタがレートカードのディメンションごとに数量を設定できるかどうかを決定します。指定できる値は `Allowed` および `Disallowed` です。デフォルト値は `Allowed` です。
+ **ResaleFixedUpfrontPricingTerm** (オブジェクト) – 前払い料金モデルを定義し、顧客に固定前払い料金が請求されます。
+ **タイプ** (文字列) (必須) – 更新する用語のカテゴリ。
+ **CurrencyCode** (文字列) – この用語で言及されている価格の通貨を定義します。この用語で説明されている料金の通貨を定義します。USD、AUD、EUR、GBP、および兄弟がサポートされています。
+ **Price** (文字列) (必須) – この条件が受け入れられたときに顧客に請求される固定額。
+ **Duration** (文字列) (必須) — ResaleAuthorization の契約期間。このフィールドは ISO 8601 形式をサポートしています。
+ **Grants** (構造配列) (必須) – 契約実行の一環として固定前払い料金のアクセプタに付与される権限。
+ **DimensionKey** (文字列) (必須) – 製品ドキュメントで定義された一意のディメンションキー。ディメンションは、製品の容量のカテゴリを表し、製品がリストされているときに指定されますAWS Marketplace。
+ **MaxQuantity** (整数) (必須) – 購入者が製品の特定のディメンションに対する権限を付与できる最大容量。MaxQuantity が指定されていない場合、購入者は指定されたディメンションを無制限に使用できます。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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 から直接確認できます。
**同期検証**
次のスキーマ検証は、AWS Marketplace Catalog API の`UpdatePricingTerms`アクションに固有です。検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール |
| --- | --- |
| 用語 | 必須
null または空にすることはできません
各用語は 1 回のみ存在する必要があります 許可された用語:[See the AWS documentation website for more details](http://docs.aws.amazon.com/ja_jp/marketplace/latest/developerguide/work-with-resale-authorizations.html) |
| 用語[]。ResaleUsageBasedPricingTerm.CurrencyCode | 必須
使用できる値: USD |
| 用語[]。ResaleUsageBasedPricingTerm.Validity | 必須
null または空にすることはできません
予想される形式: ISO 8601 の期間 |
| 用語[]。ResaleUsageBasedPricingTerm.RateCards | 必須
null または空にすることはできません |
| 用語[]。ResaleUsageBasedPricingTerm.RateCards[].DimensionKey | 必須
null または空にすることはできません
長さは 1～60 である必要があります |
| 用語[]。ResaleUsageBasedPricingTerm.RateCards[].料金 | 必須
null または空にすることはできません
データ型は「文字列」です
負でない必要があります
最大 8 つの 10 進数をサポート
特殊文字はサポートされていません |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.CurrencyCode | 必須
使用できる値: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"] |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.RateCards[].Selector.Type | 必須
null または空にすることはできません
許可される値: 期間 |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.RateCards[].Selector.Value | 必須
null または空にすることはできません
予想される形式: ISO 8601 の期間 |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.RateCards[].RateCard.DimensionKey | 必須
null または空にすることはできません
長さは 1～60 である必要があります |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.RateCards[].RateCard.Price | 必須
null または空にすることはできません
データ型は「文字列」です
負でない必要があります
最大 6 つの 10 進数をサポート
特殊文字はサポートされていません |
| 用語[]。ResaleConfigurableUpfrontPricingTerm.RateCards[].制約 | オプションです。 |
| 用語[]。ResaleFixedUpfrontPricingTerm.CurrencyCode | 必須 使用できる値: ["USD"、"AUD"、"EUR"、"GBP"、"JPN"] |
| 用語[]。ResaleFixedUpfrontPricingTerm.Price | 必須
null または空にすることはできません
データ型は「文字列」です
負でない必要があります
最大 6 つの 10 進数をサポート
特殊文字はサポートされていません
使用できる値: 0.0 |
| 用語[]。ResaleFixedUpfrontPricingTerm.Duration | 必須
null または空にすることはできません
予想される形式: ISO 8601 の期間 |
| 用語[]。ResaleFixedUpfrontPricingTerm.Grants[].DimensionKey | 必須
null または空にすることはできません
長さは 1～60 である必要があります |
| 用語[]。ResaleFixedUpfrontPricingTerm.Grants[].MaxQuantty | 必須
null または空にすることはできません |
| 不明なプロパティ | 追加のプロパティは許可されません |
**非同期エラー**
以下のエラーは、 の`UpdatePricingTerms`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件で同じ CurrencyCode を指定します。 |
| INCOMPATIBLE\_PRODUCT | [x] の製品で既存の利用可能なディメンションを使用します。 |
| DUPLICATE\_DImenSION\_KEYS | [x] でディメンションキーの一意のリストをレートカードに提供する |
| INVALID\_RATE\_CARD | [x] で同じ単位を持つディメンションを指定する |
| INVALID\_RATE\_CARD | ResaleUsageBasedPricingTerm で計測されたディメンションのみのレートカードを指定します。 |
| INVALID\_RATE\_CARD | ResaleUsageBasedPricingTerm で使用可能なすべての計測ディメンションの使用ベースのレートを指定します。 |
| TOO\_MANY\_RATES | ResaleUsageBasedPricingTerm で許可されている制限内に RateCards を指定します。 |
| DUPLICATE\_SELECTORS | ResaleConfigurableUpfrontPricingTerm でセレクタの一意のリストを指定します。 |
| INVALID\_RATE\_CARD | ConfigurableUpfrontPricingTerm の期間 [x] に 1 つ以上のディメンションキーがありません。すべての期間で同じディメンションキーのセットの料金を指定します。 |
| INVALID\_RATE\_CARD | [x] で、すべての従量制ディメンションまたはすべての使用権限のあるディメンションを指定します。 |
| INCOMPATIBLE\_RATE\_CARD\_CONSTRAINTS | PricingModel の ResaleConfigurableUpfrontPricingTerm で MultipleDimensionSelection と QuantityConfiguration を Disallowed に設定します。 QuantityConfiguration ResaleConfigurableUpfrontPricingTerm |
| TOO\_MANY\_RATE\_CARDS | 製品には、ConfigurableUpfrontPricingTerm のレートカードを 1 つだけ使用できます。 |
| INCOMPATIBLE\_TERMS | 次の用語は PricingModel と互換性がありません: [x,y,z]。 |
| TOO\_MANY\_RATES | [x term] で許可された制限内に RateCards を指定します。 |
| TOO\_MANY\_GRANTS | [x term] で最大 [N] の許可を提供します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | ResaleConfigurableUpfront で [x] か月から [y] か月の期間を指定します。 |
| TOO\_MANY\_GRANTS | [x] ～ [y] か月の期間を指定します。 |
| INVALID\_SELECTOR\_DURATION\_VALUE | ResaleConfigurableUpfront で計測されたディメンションの期間の詳細度が日レベルであることを確認します。 |
| INVALID\_DURATION | FixedUpfront で計測されたディメンションの期間の詳細度が日レベルであることを確認します。 |
| INVALID\_RATE\_CARD | [x] でエンタイトルメントのあるディメンションのみを指定します。 |
| MISSING\_DURATION | [x] で期間を指定します。 |
| DUPLICATE\_DImenSION\_KEYS | [x] のディメンションキーの一意のリストを Grants に提供します。 |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INVALID\_CURRENCY\_CODE | サポートされている CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件に同じ CurrencyCode を指定します。 |
| INCOMPATIBLE\_CURRENCY\_CODE | オファーのリリース後に CurrencyCode を変更することはできません。 |
## 支払いスケジュールを更新する
Catalog API を使用して、柔軟な支払いスケジュールなどの支払い関連の詳細を変更できますAWS Marketplace。
再販認可の支払い関連の詳細を更新するには、次の例に示すように、`UpdatePaymentScheduleTerms`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdatePaymentScheduleTerms",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"Terms":
[
{
"Type": "ResalePaymentScheduleTerm",
"CurrencyCode": "USD",
"Schedule":
[
{
"ChargeDate": "2021-12-01",
"ChargeAmount": "200.00"
},
{
"ChargeDate": "2022-03-01",
"ChargeAmount": "250.00"
}
]
}
]
}
}
]
}
```
`UpdatePaymentScheduleTerms` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。
+ **条件** (構造の配列) – 更新する支払い条件のリスト。サポートされている支払い条件は次のとおりです。
+ **ResalePaymentScheduleTerm** (オブジェクト) – 契約有効期間中の異なる日付に固定料金が顧客に請求される分割払いベースの料金モデルを定義します。
+ **タイプ** (文字列) — 更新する用語のカテゴリ。
+ **CurrencyCode** (文字列) (必須) – スケジュールに記載されている支払いの通貨を定義します。USD、AUD、EUR、GBP、および両替がサポートされています。
+ **スケジュール** (構造の配列) — 各要素が 1 回の支払いの分割を定義する支払いスケジュールのリスト。これには、支払う価格と顧客が請求される日付を計算するために必要な情報が含まれています。
+ **ChargeDate** (文字列) (必須) – この支払いスケジュール期間で定義された料金を顧客が支払う日付。このフィールドは ISO 8601 形式をサポートしています。
+ **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 |
| --- | --- | --- |
| Terms.Type | 必須
[x] 製品ではサポートされていません
許可される用語: ResalePaymentScheduleTerm | 422 |
| 用語[]。CurrencyCode | 必須
使用できる値: USD | 422 |
| 用語[]。ResalePaymentScheduleTerm.Schedule | 必須
長さは 1～60 である必要があります | 422 |
| 用語[]。ResalePaymentScheduleTerm.Shedule.ChargeDate | 必須
ISO 8601 形式である必要があります
日付は将来の日付にする必要があります | 422 |
| 用語[]。ResalePaymentScheduleTerm.Shedule.ChargeAmount | 必須
負でない必要があります | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`UpdatePaymentScheduleTerms`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。 `DescribeChangeSet`を使用した変更リクエストのステータスの取得の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_TERMS | OffersMaxQuantity と AvailabilityEndDate は、ResalePaymentScheduleTerm に存在する必要があります。 |
| TOO\_MANY\_SCHEDULED\_PAYMENTS | ResalePaymentScheduleTerm で最大 60 のスケジュールされた支払いを提供します。 |
| DUPLICATE\_CHARGE\_DATES | ResalePaymentScheduleTerm で一意の請求日を指定します。 |
| INVALID\_CHARGE\_DATES | 将来の ChargeDate を指定します。 |
| INVALID\_CHARGE\_DATES | [x] より前の最終請求日を入力します。 |
| MISSING\_MANDATORY\_TERMS | ResaleFixedUpfrontPricingTerm と ResalePaymentScheduleTerm を一緒に指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件に同じ CurrencyCode を指定します。 |
| INCOMPATIBLE\_PAYMENT\_SETTINGS | 支払い設定を更新して、CurrencyCode と互換性を持たせます。 |
| INCOMPATIBLE\_SELLER\_VERIFICATION | 必要なすべての販売者検証プロセスを完了します。 |
| INVALID\_CURRENCY\_CODE | サポートされている CurrencyCode を指定します。 |
| INVALID\_CURRENCY\_CODE | すべての料金および支払い条件に同じ CurrencyCode を指定します。 |
| INCOMPATIBLE\_CURRENCY\_CODE | オファーのリリース後に CurrencyCode を変更することはできません。 |
## 再販承認の詳細を更新する
Catalog API を使用して、 で再販認可の詳細を更新できますAWS Marketplace。
再販承認の詳細を更新するには、次の例に示すように、`UpdateInformation`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**注記**
`UpdateInformation` 変更タイプは、リクエストで指定されたセクションのみを更新します。他のすべての情報は変更されません。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "UpdateInformation",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument":
{
"Name": "TestResaleAuthorization",
"Description": "Worldwide ResaleAuthorization for Test Product",
"PreExistingBuyerAgreement":
{
"AcquisitionChannel": "AwsMarketplace",
"PricingModel": "Contract"
}
}
}
]
}
```
`UpdateInformation` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – 再販認可の情報を更新する情報を含む、リクエストの詳細。
+ **名前** (文字列) (オプション) – ユーザーとチャネルパートナーが読みやすくするためにResaleAuthorization に関連付けられている名前。
+ **説明** (文字列) (オプション) – 説明は自由形式のテキストで、ResaleAuthorization の詳細を追加できます。
+ **PreExistingBuyerAgreement** (オブジェクト) (オプション) – このオファーが、同じ基盤となる製品の既存の顧客との既存の契約の更新かどうかを決定します。既存の契約は、 内または外部で監査しAWS MarketplaceAWS、オファーが更新であることを検証できます。がオファーを検証できない場合、 AWSAWSは顧客からオファーと使用権限を取り消す可能性があります。
+ **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 コード |
| --- | --- | --- |
| 名前 | オプションです。
null または空にすることはできません
長さは 1～100 文字にする必要があります
パターン ^[A-Za-z0-9]\*$
特殊文字や空白は使用できません | 422 |
| 説明 | オプションです。
長さは 1～255 文字にする必要があります
パターン ^[A-Za-z0-9\\\\s]\*$
特殊文字は使用できません | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`UpdateInformation`アクションに固有のものですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。 `DescribeChangeSet`を使用した変更リクエストのステータスの取得の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_BUYER\_TARGETING | PreExistingBuyerAgreement による ResaleAuthorization には、少なくとも 1 つの購入者アカウントが存在する必要があります。 |
## 再販承認の制限
Catalog API を使用して、 で再販承認に制限ルールを設定できますAWS Marketplace。
制限付き再販認可は、チャネルパートナーがプライベートオファーを作成するために使用することはできません。既存のプライベートオファーは影響を受けません。
再販承認を制限するには、次の例に示すように、 `RestrictResaleAuthorization`変更タイプを使用して `StartChangeSet` API オペレーションを呼び出します。
**重要**
これは元に戻すことができないオペレーションです。再販認可が とマークされた後`Restricted`、再び `Active`状態になることはできません。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet": [
{
"ChangeType": "RestrictResaleAuthorization",
"Entity": {
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument": {}
}
]
}
```
`RestrictResaleAuthorization` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。の空のオブジェクトである必要があります`RestrictResaleAuthorization`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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 から直接確認できます。
**同期検証**
スキーマの検証は、AWS Marketplace Catalog API の`RestrictResaleAuthorization`アクションに固有です。これらの検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| DetailsDocument | 空にする必要があります | 422 |
| RestrictResaleAuthorization | 期限切れの ResaleAuthorization を としてマークすることはできません `Restricted` | 422 |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`RestrictResaleAuthorization`アクションに固有ですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。 `DescribeChangeSet`を使用した変更リクエストのステータスの取得の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| INCOMPATIBLE\_STATUS | 期限切れの ResaleAuthorization を制限対象としてマークすることはできません。 |
## 再販認可をリリースし、チャネルパートナーに表示する
Catalog API を使用して、 `ResaleAuthorization`を `Active`状態に開始できます。
`ReleaseResaleAuthorization` は再販認可をアクティブにして、チャネルパートナーが再販認可を使用してプライベートオファーを作成できるようにします。
再販認可をリリースするには、次の例に示すように、 `ReleaseResaleAuthorization`変更タイプで `StartChangeSet` API オペレーションを呼び出します。
**リクエストの構文**
```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
"ChangeSet":
[
{
"ChangeType": "ReleaseResaleAuthorization",
"Entity":
{
"Type": "ResaleAuthorization@1.0",
"Identifier": "resaleauthz-123456789"
},
"DetailsDocument": {}
}
]
}
```
`ReleaseResaleAuthorization` 変更タイプを追加するフィールドの情報を入力します。
+ **エンティティ** (オブジェクト) (必須) – 再販認可。
+ **タイプ** (文字列) (必須) – は常に `Type`です`ResaleAuthorization@1.0`。
+ **識別子** (文字列) (必須) – 再販認可 ID。詳細については、「[識別子](catalog-apis.md#identifier)」を参照してください。
+ **DetailsDocument** (オブジェクト) (必須) – リクエストの詳細。では空である必要があります`ReleaseResaleAuthorization`。
**レスポンスの構文**
リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セット`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 から直接確認できます。
**同期検証**
スキーマの検証は、 の`ReleaseResaleAuthorization`アクションに固有ですAWS Marketplace Catalog API。検証は、 を呼び出すときに実行されます`StartChangeSet`。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。
| 入力フィールド | 検証ルール | HTTP コード |
| --- | --- | --- |
| 不明なプロパティ | 追加のプロパティは許可されません | 422 |
**非同期エラー**
以下のエラーは、 の`ReleaseResaleAuthorization`アクションに固有ですAWS Marketplace Catalog API。これらのエラーは、変更セットの処理`DescribeChangeSet`後に を呼び出すと返されます。`DescribeChangeSet` を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください[変更セットの使用](catalog-apis.md#working-with-change-sets)。
| エラーコード | エラーメッセージ |
| --- | --- |
| MISSING\_MANDATORY\_TERMS | BuyerLegalTerm を指定します。 |
| MISSING\_MANDATORY\_TERMS | PricingTerm を指定します。 |
| INCOMPATIBLE\_PRODUCT | 制限付きまたはパブリック状態のアクティブな製品を使用します。 |
| INCOMPATIBLE\_PRICING\_TERM | PaymentScheduleTerm と FixedUpfrontPricingTerm は一緒に存在する必要があります。 |
| INCOMPATIBLE\_BUYER\_TARGETING | PreExistingBuyerAgreement による ResaleAuthorization には、少なくとも 1 つの購入者アカウントが存在する必要があります。 |
| MISSING\_MANDATORY\_TERMS | [x,y,z] を少なくとも 1 つ指定します。 |
| INCOMPATIBLE\_STATUS | [x] リクエストは、再販認可がリリースされた後に実行することはできません。 |
## 既存の再販承認の説明
再販承認の詳細を記述するには、次の例に示すように、 `ResaleAuthorization@1.0`エンティティタイプで `DescribeEntity` API オペレーションを呼び出します。
**リクエストの構文**
```
GET /DescribeEntity?catalog=&entityId= HTTP/1.1
```
`DescribeEntity` 変更タイプを追加するフィールドの情報を入力します。
+ **catalog** (文字列) – リクエストに関連するカタログ。固定値: `AWSMarketplace`。
+ **entityId** (文字列) – 記述`ResaleAuthorization`する の一意の ID。
**レスポンスの構文**
このリクエストに対するレスポンスは、オファーの詳細を提供し、次のようになります。
```
{
"EntityType": "ResaleAuthorization@1.0",
"EntityIdentifier": "resaleauthz-123456789",
"EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/ResaleAuthorization/resaleauthz-123456789",
"LastModifiedDate": "2021-03-10T21:57:16Z",
"DetailsDocument": {
"Name": "TestResaleAuthorization",
"Description": "ResaleAuthorization for Test Product",
"ProductId": "prod-ad8EXAMPLE51",
"ProductName": "TestProduct",
"Status": "Active", /*Draft, Active, Restricted*/
"PreExistingBuyerAgreement": {
"AcquisitionChannel": "Unknown",
"PricingModel": "Unknown"
},
"CreatedDate": "2023-07-18T16:39:31.335Z",
"ManufacturerLegalName": "ChannelCAPI.Inc",
"ManufacturerAccountId": "123456789012",
"Dimensions": [
{
"Name": "Protected Resources",
"Description": "Additional 100 protected resources",
"Key": "hundredresources",
"Unit": "Units",
"Types": [
"Entitled"
]
}
],
"OfferDetails": {
"OfferExtendedStatus": "Not Started", /* Not Started, Completed-Used, Completed-Usable*/
"OfferCreatedCount": 0
},
"Terms": [
{
"Type": "ResaleUsageBasedPricingTerm",
"Id": "term_id_placeholder",
"CurrencyCode": "USD",
"RateCards": [
{
"RateCard": [
{
"DimensionKey": "resource_number",
"Price": "0.05"
},
{
"DimensionKey": "scanned_data",
"Price": "0.05"
}
]
}
]
},
{
"Type": "ResaleConfigurableUpfrontPricingTerm",
"Id": "term_id_placeholder",
"CurrencyCode": "USD",
"RateCards": [
{
"Selector": {
"Type": "Duration",
"Value": "P24M"
},
"RateCard": [
{
"DimensionKey": "hundredresources",
"Price": "0.04"
},
{
"DimensionKey": "tenTBData",
"Price": "0.03"
},
{
"DimensionKey": "channel_custom",
"Price": "0.02"
}
],
"Constraints": {
"MultipleDimensionSelection": "Allowed",
"QuantityConfiguration": "Allowed"
}
}
]
},
{
"Type": "ResaleFixedUpfrontPricingTerm",
"Id": "term-sdh27fb2",
"CurrencyCode": "USD",
"Duration": "P180D",
"Price": "0.0",
"Grants": [
{
"DimensionKey": "sdf73rbns93nl120d10xm1",
"MaxQuantity": 1
}
]
},
{
"Type": "ResalePaymentScheduleTerm",
"Id": "term-sdh27fb2",
"CurrencyCode": "USD",
"Schedule": [
{
"ChargeDate": "2018-07-01T00:00:00.000Z",
"ChargeAmount": "200.00"
},
{
"ChargeDate": "2019-05-01T00:00:00.000Z",
"ChargeAmount": "200.00"
}
]
},
{
"Type": "BuyerLegalTerm",
"Id": "term_id_placeholder",
"Documents": [
{
"Type": "StandardEula",
"Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/a85cace8-6d9d-40ca-a053-78fc265479bf?isSigned=yes"
}
]
},
{
"Type": "ResaleLegalTerm",
"Id": "term_id_placeholder",
"Documents": [
{
"Type": "StandardResellerContract",
"Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/bed55b56-7ab4-4c4c-b633-3bf4f6efcb98?isSigned=yes"
}
]
},
{
"Type": "BuyerValidityTerm",
"Id": "term_id_placeholder",
"MaximumAgreementStartDate": "2023-09-25T23:59:59.000Z"
},
{
"Type": "BuyerTargetingTerm",
"Id": "term_id_placeholder",
"PositiveTargeting": {
"BuyerAccounts": [
{
"AwsAccountId": "444455556666"
}
]
}
}
],
"Rules": [
{
"Type": "AvailabilityRule",
"Id": "availability_rule_id_placeholder",
/* If the AvailabilityEndDate and OffersMaxQuantity not present Usage will be Unlimited*/
"Usage": "Limited",
"AvailabilityEndDate": "2022-05-31T23:59:59Z",
"OffersMaxQuantity": 1
},
{
"Type": "PartnerTargetingRule",
"Id": "partner_targeting_rule_id_placeholder",
"ResellerAccountId": "777777777777",
"ResellerLegalName": "ChannelCAPICP.Inc"
}
]
}
}
```
以下は、`DescribeEntity`レスポンスに表示されるフィールドに関する情報です。
+ **EntityType** (文字列) – エンティティの名前付きタイプ。ResaleAuthorization@1.0。
+ **EntityIdentifier** (文字列) – EntityId@RevisionId の形式のエンティティの識別子。
+ **EntityArn** (文字列) – このリクエストで参照される変更セットの一意の識別子に関連付けられた ARN。
+ **LastModifiedDate** (文字列) – ISO 8601 形式 (2018-02-27T13:45:22Z) のエンティティの最終変更日。
+ **DetailsDocument** (オブジェクト) (必須) – この JSON 文字列にはエンティティの詳細が含まれます。
+ **名前** (文字列) – ユーザーとチャネルパートナーが読みやすくするために、ResaleAuthorization に関連付けられた名前。契約情報の一部として表示されます。
+ **説明** (文字列) - 説明は自由形式のテキストで、お客様のみが使用でき、購入者に公開されることはありません。
+ **ProductId** (文字列) – 説明は自由形式のテキストであり、お客様のみが使用し、購入者に公開されることはありません。
+ **AgreementToken** (文字列) – ResaleAuthorization のコンテンツから生成されます。契約作成時の条件、ルール、提案者に関する情報が含まれています。これは、調達中の認可チェックと検証に使用されます。
+ **用語** (構造配列) — 承諾のために提示された用語のリスト。
+ **ルール** (構造の配列) — ルールまたは一連の指示のリスト。