La référence de AWS Partner Central l'API a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez la référence des AWS Partner Central API.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation de vos identifiants d'attribution de revenus

Un identifiant d'attribution de revenus est un identifiant au niveau de l'offre qui associe les revenus de vos produits AWS Marketplace à des opportunités spécifiques liées àAWS Marketplace Offers and/or AWS Partner Central. Il s'appuie sur la mise en œuvre du Partner Revenue Measurement (PRM) au niveau du produit : le PRM capture le chiffre d'affaires total attribué à un produit Marketplace, et un identifiant d'attribution des revenus associe ces revenus à des offres spécifiques en fonction des pourcentages de répartition des coûts mensuels que vous spécifiez.

Le service d'attribution des revenus expose des API pour créer, récupérer, répertorier et mettre à jour les identifiants d'attribution des revenus et pour gérer leurs entrées de répartition des coûts mensuels de manière asynchrone.

Qu'est-ce qu'un identifiant d'attribution de revenus ?

Un identifiant d'attribution de revenus comporte deux couches :

Un identifiant d'attribution de revenus peut être utilisé de deux manières :

Utilisation de vos identifiants d'attribution de revenus

Les partenaires peuvent gérer les identifiants d'attribution des recettes et leurs saisies mensuelles de répartition des coûts par le biais du service d'attribution des recettes. Le cycle de vie suit deux flux indépendants : le flux d'attribution et d'enregistrement (création, mise à jour, récupération, liste) et le flux d'allocations (démarrage d'une tâche par lots, interrogation des résultats, récupération des entrées individuelles, liste les entrées pour une attribution).

Création d'un identifiant d'attribution de revenus

La première étape consiste à créer un ID d'attribution de revenus à l'aide de l'action CreateRevenueAttribution API. Le Id et renvoyé Arn peut être utilisé immédiatement comme valeur de balise de ressource ou dans une chaîne d'agent utilisateur pour attribuer la consommation.AWS

Lors de la création d'un identifiant d'attribution des revenus, les partenaires doivent fournir :

Les partenaires peuvent éventuellement fournir :

Bonne pratique : indiquez MarketplaceProduct.ProductIdentifier chaque fois que votre offre est liée à une annonce Marketplace spécifique. Cela permet de AWS valider que le produit appartient au compte du partenaire appelant ou à un compte subsidiaire connecté via Partner Account Connection (PAC), et de faire apparaître le problème résolu ProductCode et ProductType (par exempleSaaS,AMI,,ML) dans la réponse. Si le produit n'appartient pas à un compte autorisé, l'API revient ValidationException avec raisonPRODUCT_NOT_FOUND_OR_NOT_OWNED.

La réponse renvoie le nouveau Id (formatra-[a-z0-9]{13})Arn, les MarketplaceProduct attributs résolus et le Version numéro initial (qui commence à 1 et augmente à chaque mise à jour suivante).

Ajouter des entrées de répartition des coûts mensuels

Une fois qu'un identifiant d'attribution de revenus est créé, les partenaires y associent AWS Marketplace Offers and/or ACE Opportunities en soumettant un lot de saisies mensuelles de répartition des coûts via l'action de l'StartRevenueAttributionAllocationsTaskAPI. Il s'agit d'une opération asynchrone qui accepte jusqu'à 250 modifications d'allocation (CREATE and/or UPDATE) par tâche.

Chaque entrée d'allocation indique :

Le pourcentage total de répartition des coûts entre toutes les entrées d'allocation pour un ID d'attribution de revenus donné et le même mois de facturation ne doit pas dépasser 100 %. Si le total dépasse 100 %, l'entrée incriminée est rejetée lors de la validation commerciale asynchrone avec un code d'erreur par enregistrement.

Validation synchrone : StartRevenueAttributionAllocationsTask effectue la validation de forme de base de manière synchrone (types de champs, modèles, taille du lot). Si la validation de base réussit, l'API renvoie un état TaskId avecIN_PROGRESS. La validation commerciale (contrôle des plafonds, règles d'immuabilité, recherches de dépendances par rapport à Marketplace et ACE) s'exécute de manière asynchrone et les résultats par enregistrement sont découverts via. GetRevenueAttributionAllocationsTask

Pour surveiller une tâche soumise, les partenaires interrogent à l'GetRevenueAttributionAllocationsTaskaide de l'identifiant ou de l'ARN de la ressource d'attribution des revenus. La réponse passe de IN_PROGRESS à COMPLETED (indépendamment de la réussite ou de l'échec des enregistrements individuels) et renvoie :

Les partenaires doivent récupérer rapidement les résultats des tâches. Une fois la tâche terminée, les résultats par enregistrement peuvent être rapprochés et toute entrée ayant échoué peut être corrigée et soumise à nouveau dans le cadre d'une nouvelle tâche.

Modification des entrées de répartition des coûts mensuelles

Les saisies de répartition des coûts sont gérées par mois de facturation selon les règles suivantes :

Après le 7 du mois en cours, l'attribution pour le mois de facturation précédent ne peut plus être modifiée. Les mises à jour de la saisie d'un mois en cours ou à venir s'appliquent à compter du prochain cycle de facturation mensuel. L'attribution historique pour les mois précédents n'est pas recalculée rétroactivement.

Les mises à jour des entrées d'allocation sont soumises par le biais de la même action d'StartRevenueAttributionAllocationsTaskAPI, Operation définie sur UPDATE pour chaque entrée affectée. Le modèle de tâche asynchrone gère les mises à jour et les créations de manière uniforme.

Mettre à jour un identifiant d'attribution de revenus

Les partenaires peuvent mettre à jour un identifiant d'attribution Description de revenus existant à l'aide de l'action de l'UpdateRevenueAttributionAPI. L'enregistrement d'attribution lui-même est par ailleurs immuable — NameMarketplaceProduct, et les valeurs tag-on-create ne peuvent pas être modifiées après la création. Pour réétiqueter la ressource, utilisez les opérations de AWS balisage standard sur l'ARN de l'attribution.

Lors de la mise à jour d'un identifiant d'attribution de revenus, les partenaires doivent fournir :

Les partenaires peuvent éventuellement fournir :

Verrouillage optimiste : le Version champ garantit que les mises à jour ne s'appliquent que si l'attribution n'a pas changé depuis sa dernière extraction. Si le document soumis Version ne correspond pas à la version actuelle de la ressource, la mise à jour est rejetée avec ConflictException un message contenant les numéros de version soumis et actuel. La meilleure pratique consiste à récupérer la dernière version GetRevenueAttribution avant chaque mise à jour.

Afficher les détails de l'identifiant d'attribution des revenus

Les partenaires peuvent récupérer des informations complètes pour un identifiant d'attribution de revenus unique à l'aide de l'action GetRevenueAttribution API. Cela renvoie :

Métadonnées des ressources :

Attributs du produit Marketplace (s'MarketplaceProductils ont été définis lors de la création) :

Informations d'audit :

Les partenaires peuvent éventuellement fournir un élément spécifique Version dans la demande pour récupérer une version historique de l'attribution. Omettez Version de renvoyer la dernière version.

Pour récupérer une entrée de répartition des coûts mensuelle spécifique, les partenaires utilisent l'action GetRevenueAttributionAllocation API associée à cette entréeAllocationId. Cela renvoie le numéro d'offre ou l'identifiant d'opportunité, le mois de facturation, le % de répartition des coûts, l'identifiant du AWS compte client, ainsi que le statut et les informations d'audit de l'entrée.

Identifiants d'attribution des revenus de la liste

Les partenaires peuvent consulter tous les identifiants d'attribution des revenus de leur compte à l'aide de l'action ListRevenueAttributions API. Cela renvoie une liste paginée de résumés d'attribution avec des fonctionnalités de filtrage et de tri.

Les partenaires peuvent filtrer les résultats par :

Les partenaires peuvent configurer le tri des résultats à l'aide du Sort paramètre :

La réponse inclut un résumé pour chaque attribution :Arn,,Id, CatalogName, les MarketplaceProduct attributs résolus,CreatedDate,LastModifiedDate, les plus récents Version et TotalRevenueAttributionAssociationCount (le nombre d'entrées de répartition des coûts mensuelles actives liées à l'attribution).

Utilisez MaxResults (par défaut 25, maximum 100) et NextToken pour paginer dans de grands ensembles de résultats. La réponse indique NextToken si des pages supplémentaires sont disponibles.

Répertorier les entrées de répartition des coûts mensuelles

Les partenaires peuvent répertorier les entrées de répartition des coûts mensuelles pour un ID d'attribution de revenus spécifique à l'aide de l'action ListRevenueAttributionAllocations API. Cela renvoie une liste paginée de résumés d'allocation avec des fonctionnalités de filtrage.

Les partenaires peuvent filtrer les résultats par :

La réponse inclut des informations récapitulatives pour chaque entrée : le numéro d'offre ou l'identifiant d'opportunité associéAllocationId, l'identifiant du AWS compte client, le mois de facturation, le % de répartition des coûts, le nom et le statut de l'entrée, ainsi que les horodatages d'audit.

Création de tableaux de bord : combinaison de ListRevenueAttributions et ListRevenueAttributionAllocations conçue pour faciliter la création de tableaux de bord pour les partenaires. Les partenaires peuvent développer des points de vue tels que :