

A referência Central de Parceiros da AWS da API foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência [Central de Parceiros da AWS da API](https://docs.aws.amazon.com/partner-central/latest/APIReference/Welcome.html).

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Trabalhando com suas ações de receita do Marketplace
<a name="working-with-marketplace-revenue-share"></a>

Uma participação na receita do Marketplace é uma entrada para um produto do AWS Marketplace que declara a parte da receita total do produto coletada por meio do AWS Marketplace.AWS usa essa entrada para correlacionar a Marketplace-collected receita de um parceiro com outros sinais de receita.

O Marketplace Revenue Share Service expõe APIs para criar, recuperar e listar recursos do Marketplace Revenue Share e para gerenciar suas alocações (as porcentagens de participação na receita declaradas pelo parceiro e as janelas de data efetiva). As operações de AWS marcação padrão são suportadas no recurso Marketplace Revenue Share.

## O que é uma participação na receita do Marketplace?
<a name="what-is-a-marketplace-revenue-share"></a>

Uma participação na receita do Marketplace tem duas camadas:
+ **O compartilhamento** — uma entrada para um único produto do AWS Marketplace, identificado pelo Marketplace`ProductId`. Há exatamente uma participação na receita do Marketplace por produto.
+ **Uma ou mais alocações** — cada alocação declara uma `RevenueSharePercent` janela de data efetiva (`EffectiveDate`, opcionalmente). `ExpirationDate` Um compartilhamento pode ter várias alocações ao longo do tempo, mas, a qualquer momento, somente uma `ACTIVE` alocação pode ser aplicada.

As alocações têm as seguintes propriedades principais:
+ **Status** — `ACTIVE` ou`INACTIVE`. Na criação, o status padrão é. `ACTIVE` Somente as `ACTIVE` alocações participam dos cálculos de receita e das verificações de sobreposição.
+ **Invariante de sobreposição** — dentro de um único compartilhamento, duas `ACTIVE` alocações não podem ter intervalos sobrepostos. `[EffectiveDate, ExpirationDate]` No máximo, uma `ACTIVE` alocação aberta (não`ExpirationDate`) é permitida por ação a qualquer momento.

## Trabalhando com suas ações de receita do Marketplace
<a name="managing-marketplace-revenue-shares"></a>

Os parceiros gerenciam o Marketplace Revenue Share e suas alocações por meio do Marketplace Revenue Share Service. O ciclo de vida progride por meio de dois fluxos: o fluxo de compartilhamento (criar, recuperar, listar, marcar) e o fluxo de alocações (criar, atualizar, excluir automaticamente, recuperar, listar).

### Criando uma participação na receita do Marketplace
<a name="creating-a-marketplace-revenue-share"></a>

A primeira etapa é criar uma participação na receita do Marketplace para um produto do AWS Marketplace usando a ação da `CreateMarketplaceRevenueShare` API. O compartilhamento é identificado pelo Marketplace `ProductId` e serve como contêiner para todas as alocações subsequentes.

Ao criar uma participação na receita do Marketplace, os parceiros devem fornecer:
+ **`Catalog`**— `AWS` para produção ou `Sandbox` teste.
+ **`ProductId`**— o ID do produto Marketplace de 25 caracteres. Padrão:`[a-z0-9]{25}`.

Opcionalmente, os parceiros podem fornecer:
+ **`Tags`**— até 50 pares de valores-chave para organização de recursos no momento da criação. Use `TagResource` para adicionar tags após a criação.
+ **`ClientToken`**— um símbolo de idempotência para evitar criações duplicadas ao tentar novamente. Máximo de 64 caracteres. Os SDKs geram automaticamente esse token.

Validação do produto: na criação, o serviço verifica com o AWS Marketplace se o produto é de propriedade da conta do chamador ou de uma conta subsidiária conectada ao chamador via Partner Account Connection (PAC). Se o produto não existir ou a conta proprietária não estiver autorizada para o chamador, a API retornará `ValidationException` com o motivo. `PRODUCT_NOT_FOUND_OR_NOT_OWNED`

Uma ação por produto: uma segunda `CreateMarketplaceRevenueShare` chamada para o mesmo `ProductId` nas mesmas `Catalog` devoluções`ConflictException`.

A resposta retorna o compartilhamento `Arn` (formato`arn:{partition}:partnercentral:{region}:{account-id}:catalog/{catalog}/marketplace-revenue-share/{productId}`), o `Catalog``ProductId`, o `Version` número inicial (que começa em 1 e aumenta em cada mutação de alocação) e quaisquer tags aplicadas na criação.

### Adicionando alocações
<a name="adding-marketplace-revenue-share-allocations"></a>

Depois que uma participação na receita do Marketplace é criada, os parceiros declaram uma porcentagem de participação na receita e uma janela de data efetiva criando uma alocação por meio da ação da API. `CreateMarketplaceRevenueShareAllocation`

Ao criar uma alocação, os parceiros devem fornecer:
+ **`Catalog`**— `AWS` ou`Sandbox`.
+ **`MarketplaceRevenueShareIdentifier`**— o identificador da ação principal.
+ **`RevenueSharePercent`**— a porcentagem da receita do produto coletada por meio do Marketplace fornecida como decimal (por exemplo, `0.45` para 45%).
+ **`EffectiveDate`**— a data do calendário em que essa alocação se torna efetiva. Formato: `YYYY-MM-DD`.

A resposta retorna a alocação `Id` (formato`mrsa-[A-Za-z0-9]{13}`), o status da alocação (`ACTIVE`na criação) e o compartilhamento principal aumentado `Version` (um único número inteiro de versão por compartilhamento é adicionado em cada mutação de alocação, usado para bloqueio otimista em atualizações de alocação subsequentes).

### Atualizando alocações
<a name="updating-marketplace-revenue-share-allocations"></a>

Os parceiros podem atualizar uma alocação usando a ação da `UpdateMarketplaceRevenueShareAllocation` API. Os campos atualizáveis dependem se a alocação está datada do futuro, está em vigor no momento ou está datada do passado.

Ao atualizar uma alocação, os parceiros devem fornecer:
+ **`Catalog`**— `AWS` ou`Sandbox`.
+ **`MarketplaceRevenueShareIdentifier`**— o identificador da ação principal.
+ **`AllocationId`**— o `mrsa-` ID da alocação a ser atualizada.
+ **`MarketplaceRevenueShareVersion`**— a versão atual da ação principal para um bloqueio otimista na alocação. Os conflitos de colisão retornam`ConflictException`.

Opcionalmente, os parceiros podem fornecer:
+ **`RevenueSharePercent`**— a porcentagem atualizada de participação na receita. Editável somente em alocações com data futura.
+ **`EffectiveDate`**— a data efetiva atualizada. Editável somente em alocações com data futura.
+ **`ExpirationDate`**— a data de expiração atualizada. Editável em alocações com data futura (qualquer valor`> EffectiveDate`) e em alocações atualmente efetivas ou abertas (qualquer valor). `≥ today`
+ **`Status`**— `ACTIVE` ou`INACTIVE`. A configuração para `INACTIVE` excluir temporariamente a alocação. Editável somente em alocações com data futura.
+ **`ClientToken`**— um símbolo de idempotência.

### Visualizando detalhes do Marketplace Revenue Share
<a name="viewing-marketplace-revenue-share-details"></a>

Os parceiros podem recuperar informações completas de uma única participação na receita do Marketplace usando a ação de `GetMarketplaceRevenueShare` API. Isso retorna o compartilhamento`Arn`,`Catalog`,`ProductId`, `Version` (a versão atual do compartilhamento principal), `CreatedDate``LastModifiedDate`, e todas as tags aplicadas ao compartilhamento.

Os parceiros podem recuperar uma única alocação usando a ação da `GetMarketplaceRevenueShareAllocation` API com a alocação. `Id` Isso retorna:
+ A alocação `Id` e a participação da controladora. `MarketplaceRevenueShareArn`
+ `RevenueSharePercent`, `EffectiveDate`, `ExpirationDate`.
+ `Status`(`ACTIVE`ou`INACTIVE`).
+ O compartilhamento principal é `MarketplaceRevenueShareVersion` para um bloqueio otimista nas atualizações subsequentes.
+ `CreatedDate` e `LastModifiedDate`.

### Listando ações de receita do Marketplace
<a name="listing-marketplace-revenue-shares"></a>

Os parceiros podem ver todas as ações de receita do Marketplace de propriedade de suas contas usando a ação de `ListMarketplaceRevenueShares` API. Isso retorna uma lista paginada de resumos de compartilhamentos.

Os parceiros podem filtrar os resultados por:
+ **`Catalog`**— `AWS` ou `Sandbox` (obrigatório).
+ **`ProductIds`**— uma lista de IDs de produtos específicos do Marketplace a serem recuperados.

A resposta inclui um resumo de cada compartilhamento: `Arn``Catalog`,`ProductId`,, o mais recente `Version``CreatedDate`, `LastModifiedDate` e.

Use `MaxResults` e `NextToken` para paginar por meio de grandes conjuntos de resultados.

### Listando alocações
<a name="listing-marketplace-revenue-share-allocations"></a>

Os parceiros podem listar as alocações para uma participação na receita específica do Marketplace usando a ação de `ListMarketplaceRevenueShareAllocations` API. Isso retorna uma lista paginada de resumos de alocação com recursos de filtragem.

Os parceiros podem filtrar os resultados por:
+ **`Status`**— `ACTIVE` ou`INACTIVE`.
+ **Intervalo de datas efetivas** —`EffectiveDateOnOrAfter`/`EffectiveDateOnOrBefore`para recuperar alocações cuja data efetiva esteja dentro de uma janela específica.

A resposta inclui informações resumidas para cada alocação:`Id`,,,`RevenueSharePercent`, `EffectiveDate` `ExpirationDate` `Status``MarketplaceRevenueShareVersion`, e registros de data e hora de auditoria.

## Marcação de compartilhamentos de receita do Marketplace
<a name="tagging-marketplace-revenue-shares"></a>

As operações de AWS marcação padrão são suportadas no recurso Marketplace Revenue Share:
+ **`TagResource`**— adicione ou sobrescreva tags em um Marketplace Revenue Share. Máximo de 50 tags por compartilhamento.
+ **`UntagResource`**— remova tags específicas por chave.
+ **`ListTagsForResource`**— recupere todas as tags atualmente aplicadas a um Marketplace Revenue Share.

As alocações não oferecem suporte a tags. Marque o compartilhamento principal para organizar as alocações relacionadas.

Cada operação de marcação aceita o compartilhamento `Arn` (formato`arn:{partition}:partnercentral:{region}:{account-id}:catalog/{catalog}/marketplace-revenue-share/{productId}`) como identificador do recurso. A AWS criação de tags padrão também é suportada por meio do `Tags` campo ativado. `CreateMarketplaceRevenueShare`