View a markdown version of this page

収益属性 IDs の使用 - AWS Partner Central
収益属性 ID とは収益属性 IDs の使用

AWS パートナーセントラル API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、 AWS パートナーセントラル API リファレンスを参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

収益属性 IDs の使用

収益属性 ID は、AWSマーケットプレイス製品の収益を特定のAWSマーケットプレイスオファーやAWS Partner Central Opportunities にマッピングするディールレベルの識別子です。これは、製品レベルの Partner Revenue Measurement (PRM) 実装に基づいて構築されます。PRM は Marketplace 製品の属性収益の合計をキャプチャし、Revenue Attribution ID は、指定した毎月のコスト配分の割合に従ってその収益を特定の取引にマッピングします。

Revenue Attribution Service は、Revenue Attribution IDs を作成、取得、一覧表示、更新し、毎月のコスト配分エントリを非同期的に管理するための APIs を公開します。

収益属性 ID とは

収益属性 ID には 2 つのレイヤーがあります。

  • ra- プレフィックス ID (例: ra-aabbccddee001) と ARN によって識別される、パートナーの名前付き、パートナーの説明付きリソースの属性。各属性は、 Catalog (AWS本番稼働用、テストSandbox用) とパートナーのアカウントに限定されます。

  • 各エントリの 1 つ以上の毎月のコスト配分エントリは、単一の (オファー ID またはオポチュニティ ID、請求月) の組み合わせをコスト配分の割合にマッピングします。エントリは、割り当てタスクパターンを通じて非同期的にバッチで管理されます。

収益属性 ID は、次の 2 つの方法で使用できます。

  • 既存の製品レベルの PRM 実装のディールレベルのオーバーレイとして。収益属性 ID を作成し、該当する Marketplace オファーや ACE オポチュニティを関連付け、すでに測定済みの製品収益をそれらの特定の取引にAWSマッピングします。既存のリソースタグやユーザーエージェント文字列に変更を加える必要はありません。

  • リソースタグ値 (aws-apn-id = <RA ID>) またはユーザーエージェント文字列 (APN_1.1/pc_<RA ID>$) として直接使用されるスタンドアロン識別子として、消費を最初から特定のディールに属性AWS付けします。

収益属性 IDs の使用

パートナーは、Revenue Attribution Service を通じて、Revenue Attribution IDs とその毎月のコスト配分エントリを管理できます。ライフサイクルは、属性レコードフロー (作成、更新、取得、一覧表示) と割り当てフロー (バッチタスクの開始、結果のポーリング、個々のエントリの取得、属性のエントリのリスト) の 2 つの独立したフローを通じて進行します。

収益属性 ID の作成

最初のステップは、 CreateRevenueAttribution API アクションを使用して収益属性 ID を作成することです。返された Idと は、リソースタグ値としてすぐに使用したり、ユーザーエージェント文字列で使用してAWS消費を属性Arn化したりできます。

収益属性 ID を作成する場合、パートナーは以下を指定する必要があります。

  • Catalog — 本番AWS稼働用またはテストSandbox用。

  • Name — アトリビューションの人間が読み取れる名前。Catalog とパートナーのアカウント内で一意である必要があります。最大 128 文字

パートナーはオプションで以下を提供できます。

  • Description — アトリビューションのフリーテキストの説明。最大1024文字

  • MarketplaceProduct —AWSこの属性に関連付ける Marketplace 製品。(25 文字の Marketplace 製品 ID) と TenancyModel (MULTI_TENANT または ) ProductIdentifierを指定しますSINGLE_TENANT。作成時に省略すると、顧客が購入した Marketplace 製品に関係なく、Revenue Attribution ID で測定されるすべての消費に属性が適用されます。これは、単一のデプロイが複数の Marketplace リストにまたがる場合に便利です。

  • Tags — リソース組織に対して最大 200 個のキーと値のペア。タグキーは、リクエスト内で一意である必要があります。

ベストプラクティス: 取引が特定の Marketplace 出品に固定されるMarketplaceProduct.ProductIdentifierたびに を指定します。これによりAWS、 は、製品が呼び出し元のパートナーアカウントまたは Partner Account Connection (PAC) を介して接続された子会社アカウントによって所有されていることを検証し、解決された ProductCode と ProductType (、SaaSAMI、 などML) をレスポンスに表示します。製品が認可されたアカウントによって所有されていない場合、API は理由 ValidationExceptionで を返しますPRODUCT_NOT_FOUND_OR_NOT_OWNED。

レスポンスは、新しい Id (形式 ra-[a-z0-9]{13})Arn、、解決されたMarketplaceProduct属性、および初期Version数 (1 から始まり、それ以降の更新ごとに増分) を返します。

毎月のコスト配分エントリの追加

収益属性 ID が作成されると、パートナーは StartRevenueAttributionAllocationsTask API アクションを通じて毎月のコスト配分エントリのバッチを送信することで、AWSマーケットプレイスオファーや ACE オポチュニティを関連付けます。これは、タスクごとに最大 250 個の割り当て変更 (CREATE および/または UPDATE) を受け入れる非同期オペレーションです。

各割り当てエントリは以下を指定します。

  • オファー ID またはオポチュニティ ID — 関連付けられている取引の一意の識別子。Marketplace オファーが既に ACE オポチュニティにリンクされている場合、パートナーはオファー ID を提供するだけで済みます。リンクされたオポチュニティに収益AWSを自動的に属性付けます。

  • 請求月 — コスト配分が適用される暦月 (例: 2026-04)。

  • コスト配分 % — この請求月のこの取引に起因する製品の合計AWS消費量の一部。お客様がインフラストラクチャを共有するハイブリッドデプロイ用のパートナーホストコンポーネントなど、マルチテナント SaaS 製品に必要です。

  • 顧客AWSアカウント ID — 製品を消費する顧客のAWSアカウント。マルチテナント SaaS 製品に必要です。

特定の収益属性 ID と同じ請求月のすべての配分エントリに対するコスト配分率の合計は、100% を超えることはできません。合計が 100% を超えると、レコードごとのエラーコードを使用して非同期ビジネス検証中に問題のあるエントリが拒否されます。

同期検証: は、基本的なシェイプ検証を同期的にStartRevenueAttributionAllocationsTask実行します (フィールドタイプ、パターン、バッチサイズ）。基本検証に合格すると、API はステータス TaskIdの を返しますIN_PROGRESS。ビジネス検証 (上限チェック、イミュータビリティルール、 Marketplace と ACE に対する依存関係検索) は非同期的に実行され、レコードごとの結果は を通じて検出されますGetRevenueAttributionAllocationsTask。

送信されたタスクをモニタリングするために、パートナーは収益属性リソース ID または ARN GetRevenueAttributionAllocationsTaskを使用してポーリングします。レスポンスは から COMPLETED (個々のレコードが成功したか失敗したかに関係なく) IN_PROGRESSに進行し、以下を返します。

  • TaskStatus — IN_PROGRESS、COMPLETED、または FAILED (最上位タスクの失敗）。

  • RecordResults — 各入力レコード: 割り当てられた AllocationId (成功した場合）、レコードごとのステータス (SUCCEEDED または FAILED)、およびレコードが失敗した場合は構造化エラーコードとメッセージ。

パートナーはタスク結果をすぐに取得する必要があります。タスクが完了すると、レコードごとの結果を照合し、失敗したエントリを修正して新しいタスクで再送信できます。

毎月のコスト配分エントリの編集

コスト配分エントリは、請求月ごとに以下のルールで管理されます。

  • パートナーは、現在または将来の請求月の新しい月次エントリをいつでも追加できます。

  • パートナーは、現在または将来の請求月の毎月のエントリをいつでも更新できます。

  • パートナーは、先月のエントリを当月の 7 日まで更新できます。 このウィンドウにより、パートナーは前月の割り当てを確定する前に、AWS Cost Explorer で実際の使用状況を確認できます。

当月 7 日以降は、前の請求月の属性を変更できなくなります。当月または将来の月のエントリの更新は、次の毎月の請求サイクルから適用されます。過去 1 か月の履歴属性は遡及的に再計算されません。

割り当てエントリの更新は、影響を受けるエントリUPDATEごとに を Operation に設定して、同じ StartRevenueAttributionAllocationsTask API アクションを介して送信されます。非同期タスクパターンは、更新と作成を均一に処理します。

収益属性 ID の更新

パートナーは UpdateRevenueAttribution API アクションを使用して、既存の収益属性 ID Descriptionの を更新できます。属性レコード自体は変更不可です。Name、MarketplaceProduct、および tag-on-create 値は作成後に変更できません。リソースに再度タグを付けるには、属性の ARN で標準のAWSタグ付けオペレーションを使用します。

収益属性 ID を更新する場合、パートナーは以下を提供する必要があります。

  • Catalog — AWSまたは Sandbox。

  • Identifier — 更新する属性の ra- ID。

  • Version — オプティミスティックロックの属性の最新バージョン。

パートナーはオプションで以下を提供できます。

  • Description — 更新されたフリーテキストの説明。最大1024文字

  • ClientToken — 更新のべき等性トークン。

オプティミスティックロック: Versionフィールドは、属性が最後に取得されてから変更されていない場合にのみ更新が適用されるようにします。送信された Versionが現在のリソースバージョンと一致しない場合、更新は ConflictExceptionと、送信された と現在のバージョン番号を含むメッセージで拒否されます。ベストプラクティスは、各更新GetRevenueAttributionの前に で最新バージョンを取得することです。

収益属性 ID の詳細の表示

パートナーは GetRevenueAttribution API アクションを使用して、単一の収益属性 ID の完全な情報を取得できます。これにより、次が返されます。

リソースメタデータ:

  • 一意の識別子 (Id) と Amazon リソースネーム ()Arn。

  • 属性Catalogが存在する 。

  • 「Name」および「Description」。

  • 取得された Versionと LatestVersion (後続の更新には最新の を使用します）。

Marketplace 製品属性 (作成時に MarketplaceProductが設定されている場合):

  • ProductId — パートナーから提供された Marketplace 製品 ID。

  • ProductCode — から解決されたAWS Marketplace 製品コードProductId。

  • ProductType — SaaS、AMI、Container、ML、Data、または Professional Services。

  • TenancyModel — MULTI_TENANTまたは SINGLE_TENANT。

監査情報:

  • 「CreatedDate」および「LastModifiedDate」。

パートナーはオプションVersionで、属性の履歴バージョンを取得するリクエストに特定の を指定できます。を省略Versionして最新の を返します。

特定の月額コスト配分エントリを取得するには、パートナーはエントリの で GetRevenueAttributionAllocation API アクションを使用しますAllocationId。これにより、オファー ID またはオポチュニティ ID、請求月、コスト配分 %、顧客AWSアカウント ID、エントリのステータスと監査情報が返されます。

収益属性 IDs の一覧表示

パートナーは、 ListRevenueAttributions API アクションを使用して、アカウント内のすべての収益属性 IDs を表示できます。これにより、フィルタリングとソート機能を備えた属性の概要のページ分割されたリストが返されます。

パートナーは、次の方法で結果をフィルタリングできます。

  • Catalog — AWSまたは Sandbox (必須）。

  • Identifiers — 取得する最大 100 個の特定の ra- ID のリスト。 IDs

  • CreatedAfter / CreatedBefore — 作成タイムスタンプ範囲 (含む) でフィルタリングします。

パートナーは、 Sortパラメータを使用して結果のソートを設定できます。

  • SortBy — CreatedDateまたは LastModifiedDate。

  • SortOrder — ASCENDINGまたは DESCENDING。

レスポンスには、各属性の概要が含まれます: Arn、Id、Catalog、Name、解決されたMarketplaceProduct属性、CreatedDate、LastModifiedDate最新の Version、および TotalRevenueAttributionAssociationCount (属性にリンクされたアクティブな毎月のコスト配分エントリの数）。

(MaxResultsデフォルトは 25、最大は 100) と NextToken を使用して、大きな結果セットをページ分割します。追加ページが利用可能なNextToken場合、レスポンスには が含まれます。

毎月のコスト配分エントリの一覧表示

パートナーは、 ListRevenueAttributionAllocations API アクションを使用して、特定の収益属性 ID の毎月のコスト配分エントリを一覧表示できます。これにより、フィルタリング機能を備えた割り当ての概要のページ分割されたリストが返されます。

パートナーは、次の方法で結果をフィルタリングできます。

  • MarketplaceOfferId — 特定の Marketplace オファーに関連付けられたエントリのみを一覧表示します。

  • AwsPartnerCentralOpportunityId — 特定の Partner Central オポチュニティに関連付けられたエントリのみを一覧表示します。

  • BillingMonth — 特定の暦月のエントリのみを一覧表示します。

レスポンスには、各エントリの概要情報としてAllocationId、、関連付けられたオファー ID またはオポチュニティ ID、顧客AWSアカウント ID、請求月、コスト配分 %、エントリの名前とステータス、監査タイムスタンプが含まれます。

ダッシュボードの構築: ListRevenueAttributionsと の組み合わせListRevenueAttributionAllocationsは、パートナーダッシュボードの作成をサポートするように設計されています。パートナーは、次のようなビューを構築できます。

  • 過去 30 日間に作成されたすべての収益属性 IDs、作成日でソートされます。

  • 複数の収益属性 IDs にわたる特定の Marketplace オファーのすべての月額コスト配分エントリ。

  • 現在の請求月のすべてのコスト配分エントリ。合計が属性ごとに 100% を超えないことを検証します。

  • 少なくとも 1 つのアクティブな割り当てエントリ () を持つすべての収益属性 IDsTotalRevenueAttributionAssociationCount > 0。