Compartilhar via

Gerenciar criativos

  • Artigo

Use esses métodos na API de promoções da Microsoft Store para carregar seus próprios criativos personalizados para usar em campanhas publicitárias promocionais ou obter um criativo existente. Um criativo pode ser associado a uma ou mais linhas de exibição, mesmo em campanhas publicitárias, desde que sempre represente o mesmo aplicativo.

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

Observação

Ao usar essa API para fazer upload do seu próprio criativo, o tamanho máximo permitido para o criativo é de 40 KB. Se você enviar um arquivo de criativo maior que isso, essa API não retornará um erro, mas a campanha não será criada com sucesso.

Pré-requisitos

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

  • Se você ainda não fez isso, conclua todos os pré-requisitos para a API de promoções da Microsoft Store.
  • Obtenha um token de acesso do Azure AD para usar no cabeçalho de solicitação para esses métodos. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. 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 da solicitação Descrição
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Cria um novo criativo.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Obtém o criativo especificado por creativeId.

Observação

No momento, essa API não dá suporte a um método PUT.

parâmetro Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.
ID de rastreamento GUID Opcional. Uma ID que rastreia o fluxo de chamadas.

Corpo da solicitação

O método POST requer um corpo de solicitação JSON com os campos obrigatórios de um objeto Creative .

Exemplos de solicitação

O exemplo a seguir demonstra como chamar o método POST para criar um criativo. Neste exemplo, o valor do conteúdo foi reduzido para fins de brevidade.

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

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

O exemplo a seguir demonstra como chamar o método GET para recuperar um criativo.

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

Resposta

Esses métodos retornam um corpo de resposta JSON com um objeto Creative que contém informações sobre o criativo que foi criado ou recuperado. O exemplo a seguir demonstra um corpo de resposta para esses métodos. Neste exemplo, o valor do conteúdo foi reduzido para fins de brevidade.

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

Objeto criativo

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 o método POST.

Campo Type Description Somente leitura Padrão Necessário para POST
id Número inteiro O ID do criativo. Sim Não
name string O nome do criativo. Não Sim
content string O conteúdo da imagem do criativo, no formato codificado em Base64.

Observação : o tamanho máximo permitido para o criativo é de 40 KB. Se você enviar um arquivo de criativo maior que isso, essa API não retornará um erro, mas a campanha não será criada com sucesso.		 Não Sim
altura Número inteiro A altura do criativo. Não Sim
width Número inteiro A largura do criativo. Não Sim
landingUrl string Se você estiver usando um serviço de rastreamento de campanha, como AppsFlyer, Kochava, Tune ou Vungle, para medir a análise de instalação do seu aplicativo, atribua sua URL de rastreamento nesse campo ao chamar o método POST (se especificado, esse valor deve ser um URI válido). Se você não estiver usando um serviço de rastreamento de campanha, omita esse valor ao chamar o método POST (nesse caso, essa URL será criada automaticamente). Não Sim
format string O formato do anúncio. Atualmente, o único valor com suporte é Banner. Não Faixa Não
atributos de imagem Atributos de imagem Fornece atributos para o criativo. Não Sim
storeProductId string O ID da loja do aplicativo ao qual essa campanha publicitária está associada. Um exemplo de ID da loja para um produto é 9nblggh42cfd. Não No

Objeto ImageAttributes

Campo Type Descrição Somente leitura Valor padrão Necessário para POST
imageExtension string Um dos seguintes valores: PNG ou JPG. Não Sim