Compartilhar via

Gerenciar linhas de entrega

Use esses métodos na API de promoções da Microsoft Store para criar uma ou mais linhas de entrega para comprar inventário e entregar seus anúncios para uma campanha promocional de anúncios. Para cada linha de entrega, você pode definir a segmentação, definir o preço do lance e decidir quanto deseja gastar definindo um orçamento e vinculando-se aos criativos que deseja usar.

Para obter mais informações sobre a relação entre linhas de distribuição e campanhas publicitárias, perfis de direcionamento e materiais criativos, consulte Realizar campanhas publicitárias usando os serviços da Microsoft Store.

Observação Antes de criar com êxito linhas de entrega para campanhas publicitárias usando essa API, você deve primeiro criar uma campanha publicitária paga usando a página de campanhas publicitárias do no Partner Centere adicionar pelo menos um instrumento de pagamento nesta página. Depois de fazer isso, você poderá criar com êxito linhas de entrega faturáveis para campanhas publicitárias usando essa API. As campanhas publicitárias criadas usando a API cobrarão automaticamente o instrumento de pagamento padrão escolhido na página campanhas do Ad no Partner Center.

Pré-requisitos

Para usar esses métodos, primeiro você precisa fazer o seguinte:

  • Se você ainda não o fez, conclua todos os pré-requisitos para a API de promoções da Microsoft Store.

    Observação

    Como parte dos pré-requisitos, certifique-se de que você crie pelo menos uma campanha publicitária paga no Partner Center e que você adicione pelo menos um instrumento de pagamento para a campanha publicitária no Partner Center. As linhas de entrega criadas usando essa API cobrarão automaticamente o instrumento de pagamento padrão escolhido na página de campanhas de anúncios no Partner Center.

  • Obter um token de acesso do Azure AD a ser usado no cabeçalho de solicitação para esses métodos. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitação

Esses métodos têm as URIs a seguir.

Tipo de método URI de solicitação Descrição
PUBLICAR https://manage.devcenter.microsoft.com/v1.0/my/promotion/line Cria uma nova linha de entrega.
COLOCAR https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Edita a linha de entrega especificada por lineId.
OBTER https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Obtém a linha de entrega especificada por lineId.
Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.
ID de acompanhamento Identificador Globalmente Único (GUID) Opcional. Uma ID que rastreia o fluxo de chamadas.

Corpo da solicitação

Os métodos POST e PUT exigem um corpo de solicitação JSON com os campos necessários de uma linha de entrega objeto e quaisquer campos adicionais que você deseja definir ou alterar.

Solicitar exemplos

O exemplo a seguir demonstra como chamar o método POST para criar uma linha de entrega.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/line HTTP/1.1
Authorization: Bearer <your access token>

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

O exemplo a seguir demonstra como chamar o método GET para recuperar uma linha de entrega.

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/31019990  HTTP/1.1
Authorization: Bearer <your access token>

Resposta

Esses métodos retornam um corpo de resposta JSON com um objeto Delivery line , que contém informações sobre a linha de entrega que foi criada, atualizada ou recuperada. O exemplo a seguir demonstra o corpo de resposta destes métodos.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Objeto de linha de entrega

Os corpos de solicitação e resposta para esses métodos contêm os campos a seguir. Esta tabela mostra quais campos são somente leitura (o que significa que eles não podem ser alterados no método PUT) e quais campos são necessários no corpo da solicitação para os métodos POST ou PUT.

Campo Tipo Descrição Somente leitura Padrão Necessário para POST/PUT
id número inteiro A ID da linha de entrega. Sim Não
nome corda O nome da linha de entrega. Não PUBLICAR
estadoConfigurado corda Um dos seguintes valores que especifica o status da linha de entrega especificada pelo desenvolvedor:
  • Ativo
  • Inativo
 Não PUBLICAR
effectiveStatus corda Um dos seguintes valores que especifica o status efetivo da linha de entrega com base na validação do sistema:
  • Ativo
  • Inativo
  • Em processamento
  • Com falha
 Sim Não
razões de status efetivo conjunto Um ou mais dos seguintes valores que especificam o motivo do status efetivo da linha de entrega:
  • AdCreativesInactive
  • FalhaDeValidação
 Sim Não
startDatetime corda A data e a hora de início da linha de entrega, no formato ISO 8601. Esse valor não poderá ser alterado se já estiver no passado. Não POST, PUT
endDatetime corda A data e a hora de término da linha de entrega, no formato ISO 8601. Esse valor não poderá ser alterado se já estiver no passado. Não POST, PUT
createdDatetime corda A data e a hora em que a linha de entrega foi criada, no formato ISO 8601. Sim Não
bidType corda Um valor que especifica o tipo de licitação da linha de entrega. Atualmente, o único valor com suporte é CPM . Não Custo Por Mil (CPM) Não
bidAmount decimal O valor da oferta a ser usado para licitar qualquer solicitação de anúncio. Não O valor médio do CPM com base nos mercados de destino (esse valor é revisado periodicamente). Não
dailyBudget decimal O orçamento diário da linha de entrega. Deve ser definido dailyBudget ou lifetimeBudget. Não POST, PUT (caso lifetimeBudget não esteja definido)
orçamento vitalício decimal O orçamento de tempo de vida da linha de entrega. lifetimeBudget* ou dailyBudget precisam ser configurados. Não POST, PUT (caso dailyBudget não esteja definido)
ID de Perfil de Segmentação objeto Um objeto que identifica o perfil-alvo , que descreve os usuários, geografias e tipos de inventário que você deseja direcionar para essa linha de entrega. Esse objeto consiste em um único id campo que especifica a ID do perfil de destino. Não Não
criativos conjunto Um ou mais objetos que representam os criativos que estão associados à linha de entrega. Cada objeto nesse campo consiste em um único campo de ID que especifica o ID de um criativo. Não Não
Id de campanha número inteiro O ID da campanha principal de publicidade. Não Não
minMinutosPorImp número inteiro Especifica o intervalo de tempo mínimo (em minutos) entre duas impressões mostradas ao mesmo usuário dessa linha de entrega. Não 4000 Não
tipo de marca-passo corda Um dos seguintes valores que especificam o tipo de ritmo:
  • Gastar Uniformemente
  • GasteTãoRápidoQuantoPossível
 Não SpendEvenly Não
identificadorDeMoeda número inteiro O identificador da moeda da campanha. Sim A moeda da conta de desenvolvedor (você não precisa especificar esse campo em chamadas POST ou PUT) Não
  • Last updated on