AWS パートナーセントラル API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、 AWS パートナーセントラル API リファレンスを参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Marketplace 収益共有の使用
Marketplace 収益共有は、 AWS Marketplace を通じて収集された製品の総収益の一部を宣言する AWS Marketplace 製品の入力です。 はこの入力 AWS を使用して、パートナーの Marketplace で収集された収益を他の収益シグナルと関連付けます。
Marketplace Revenue Share Service は、 Marketplace Revenue Share リソースを作成、取得、一覧表示し、その割り当て (パートナーが宣言した収益共有の割合と発効日ウィンドウ) を管理する APIs を公開します。標準の AWS タグ付けオペレーションは、 Marketplace Revenue Share リソースでサポートされています。
Marketplace 収益配分とは
Marketplace 収益共有には 2 つのレイヤーがあります。
-
共有 — Marketplace によって識別される単一の Marketplace 製品の入力 AWS
ProductId。製品ごとに Marketplace 収益配分が 1 つだけあります。 -
1 つ以上の割り当て — 各割り当ては、
RevenueSharePercentと有効日ウィンドウ (EffectiveDate、オプションで ) を宣言しますExpirationDate。共有には時間の経過とともに多くの割り当てを含めることができますが、いつでも適用できるACTIVE割り当ては 1 つだけです。
割り当てには、次のキープロパティがあります。
-
ステータス —
ACTIVEまたはINACTIVE。作成時、ステータスはデフォルトで になりますACTIVE。ACTIVE配分のみが収益計算と重複チェックに参加します。 -
重複不変 — 1 つの共有内で、2 つの
ACTIVE割り当てが重複する[EffectiveDate, ExpirationDate]範囲を持つことはできません。共有ごとにいつでも最大 1 つのオープンエンドACTIVE割り当て ( なしExpirationDate) が許可されます。
Marketplace 収益共有の使用
パートナーは、 Marketplace Revenue Share Service を通じて Marketplace Revenue Shares とその割り当てを管理します。ライフサイクルは、共有フロー (作成、取得、リスト、タグ) と割り当てフロー (作成、更新、ソフト削除、取得、リスト) の 2 つのフローを通じて進行します。
Marketplace 収益共有の作成
最初のステップでは、 CreateMarketplaceRevenueShare API アクションを使用して Marketplace 製品の AWS Marketplace 収益共有を作成します。共有は Marketplace によって識別ProductIdされ、後続のすべての割り当てのコンテナとして機能します。
Marketplace 収益共有を作成する場合、パートナーは以下を提供する必要があります。
-
Catalog— 本番AWS稼働用またはテストSandbox用。 -
ProductId— 25 文字の Marketplace 製品 ID。パターン:[a-z0-9]{25}。
パートナーはオプションで以下を提供できます。
-
Tags— 作成時にリソース組織に対して最大 50 個のキーと値のペア。を使用してTagResource、作成後にタグを追加します。 -
ClientToken— 再試行時の重複作成を防ぐためのべき等性トークン。最大 64 文字。SDKsトークンを自動生成します。
製品検証: 作成時に、サービスは、製品が発信者のアカウントまたは Partner Account Connection (PAC) を介して発信者に接続された子会社アカウントによって所有されていることを AWS Marketplace で検証します。製品が存在しないか、所有アカウントが発信者に対して承認されていない場合、API は理由 ValidationExceptionで を返しますPRODUCT_NOT_FOUND_OR_NOT_OWNED。
製品ごとに 1 つの共有: 同じ ProductId の 2 番目のCreateMarketplaceRevenueShare呼び出しは Catalogを返しますConflictException。
レスポンスは、共有 Arn (形式 arn:{partition}:partnercentral:{region}:{account-id}:catalog/{catalog}/marketplace-revenue-share/{productId})、Catalog、、ProductId初期Version数 (各割り当てミューテーションで 1 から始まり、増分)、および作成時に適用されるタグを返します。
割り当ての追加
Marketplace 収益共有が作成されると、パートナーは CreateMarketplaceRevenueShareAllocation API アクションを使用して配分を作成することにより、収益共有の割合と発効日ウィンドウを宣言します。
割り当てを作成する場合、パートナーは以下を提供する必要があります。
-
Catalog—AWSまたはSandbox。 -
MarketplaceRevenueShareIdentifier— 親共有の識別子。 -
RevenueSharePercent— 10 進数で提供される Marketplace を通じて収集された製品の収益の割合 (例:0.4545%)。 -
EffectiveDate— この割り当てが有効になるカレンダーの日付。形式:YYYY-MM-DD。
レスポンスは、割り当ての Id (形式 mrsa-[A-Za-z0-9]{13})、割り当てステータス (ACTIVE作成時)、親共有のバンプ Version (割り当てミューテーションごとに 1 つのバージョン整数がバンプされ、その後の割り当て更新で楽観的ロックに使用されます) を返します。
割り当ての更新
パートナーは API UpdateMarketplaceRevenueShareAllocationアクションを使用して割り当てを更新できます。更新可能なフィールドは、割り当てが将来の日付であるか、現在有効であるか、過去の日付であるかによって異なります。
割り当てを更新する場合、パートナーは以下を提供する必要があります。
-
Catalog—AWSまたはSandbox。 -
MarketplaceRevenueShareIdentifier— 親共有の識別子。 -
AllocationId— 更新する割り当てのmrsa-ID。 -
MarketplaceRevenueShareVersion— 割り当てを楽観的にロックするための親共有の最新バージョン。バンプ競合は を返しますConflictException。
パートナーはオプションで以下を提供できます。
-
RevenueSharePercent— 更新された収益共有の割合。将来の日付の割り当てでのみ編集できます。 -
EffectiveDate— 更新された発効日。将来の日付の割り当てでのみ編集できます。 -
ExpirationDate— 更新された有効期限。将来の日付の割り当て (任意の値> EffectiveDate) および現在有効な割り当てまたはオープンエンド割り当て (任意の値 ) で編集できます≥ today。 -
Status—ACTIVEまたはINACTIVE。を に設定すると、割り当てがINACTIVEソフトに削除されます。将来の日付の割り当てでのみ編集できます。 -
ClientToken— べき等性トークン。
Marketplace 収益共有の詳細の表示
パートナーは GetMarketplaceRevenueShare API アクションを使用して、単一の Marketplace 収益共有の完全な情報を取得できます。これにより、共有の Arn、CatalogProductId、、 Version (親共有の最新バージョン)CreatedDate、LastModifiedDate、、および共有に適用されるタグが返されます。
パートナーは、割り当ての で GetMarketplaceRevenueShareAllocation API アクションを使用して 1 つの割り当てを取得できますId。これにより、次が返されます。
-
割り当ての
Idと親共有のMarketplaceRevenueShareArn。 -
RevenueSharePercent,EffectiveDate,ExpirationDate. -
Status(ACTIVEまたはINACTIVE)。 -
後続の更新で楽観的にロック
MarketplaceRevenueShareVersionするための親共有の 。 -
「
CreatedDate」および「LastModifiedDate」。
Marketplace 収益共有の一覧表示
パートナーは、 ListMarketplaceRevenueShares API アクションを使用して、自分のアカウントが所有するすべての Marketplace 収益共有を表示できます。これにより、共有の概要のページ分割されたリストが返されます。
パートナーは、次の方法で結果をフィルタリングできます。
-
Catalog—AWSまたはSandbox(必須)。 -
ProductIds— 取得する特定の Marketplace 製品 IDsのリスト。
レスポンスには、各共有の概要 Arn、Catalog、ProductId、、最新の Version、CreatedDate、および が含まれますLastModifiedDate。
MaxResults と を使用してNextToken、大きな結果セットをページ分割します。
割り当ての一覧表示
パートナーは、 ListMarketplaceRevenueShareAllocations API アクションを使用して、特定の Marketplace 収益共有の割り当てを一覧表示できます。これにより、フィルタリング機能を備えた割り当ての概要のページ分割されたリストが返されます。
パートナーは、次の方法で結果をフィルタリングできます。
-
Status—ACTIVEまたはINACTIVE。 -
有効日付範囲 —
EffectiveDateOnOrAfter/EffectiveDateOnOrBefore有効日が特定のウィンドウ内にある割り当てを取得します。
レスポンスには、各割り当ての概要情報、Id、RevenueSharePercent、EffectiveDate、ExpirationDateStatusMarketplaceRevenueShareVersion、、および監査タイムスタンプが含まれます。
Marketplace 収益共有のタグ付け
Marketplace Revenue Share リソースでは、標準の AWS タグ付けオペレーションがサポートされています。
-
TagResource— Marketplace 収益共有にタグを追加または上書きします。共有あたり最大 50 タグ。 -
UntagResource— キーで特定のタグを削除します。 -
ListTagsForResource— Marketplace 収益共有に現在適用されているすべてのタグを取得します。
割り当てはタグをサポートしていません。親共有にタグを付けて、関連する割り当てを整理します。
各タグ付けオペレーションは、共有の Arn (形式 arn:{partition}:partnercentral:{region}:{account-id}:catalog/{catalog}/marketplace-revenue-share/{productId}) をリソース識別子として受け入れます。Standard AWS tag-on-create は、 の TagsフィールドでもサポートされていますCreateMarketplaceRevenueShare。