Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.topsort.com/llms.txt

Use this file to discover all available pages before exploring further.

Conexão do Topsort com Sistemas de Gestão de Ativos Digitais

Os sistemas de gestão de ativos digitais (DAM), como Adobe Experience Manager Assets, Bynder e outros, centralizam os ativos criativos e geram URLs otimizadas para uso em campanhas. Diferentemente da conectividade com os sistemas de gestão de organizações (OMS), a conectividade com os sistemas DAM é possível atualmente com as APIs existentes do Topsort.
Este guia explica como integrar as APIs do Topsort com sistemas DAM para otimizar os fluxos de trabalho criativos e automatizar a gestão de ativos.
Diagrama mostrando conectividade DAM

Como Funcionam os Sistemas DAM com o Topsort

Sistemas DAM como Adobe Experience Manager Assets, Bynder ou Webdam:
  1. Centralizar recursos: Armazenar todos os banners, imagens de produtos e vídeos em um repositório organizado.
  2. Gerar URLs de CDN: Criar URLs otimizadas e de acesso público para cada recurso.
  3. Gerenciar versões: Realizar o acompanhamento das versões aprovadas e evitar o uso de recursos obsoletos.
  4. Controle de conformidade da marca: Garantir que apenas os ativos aprovados e de acordo com a marca cheguem às campanhas.

Fluxos de Trabalho

A integração de DAM envolve quatro fluxos de trabalho distintos para diferentes funções e momentos:
Fluxo de trabalhoQuemQuandoObjetivo
Guia de implementaçãoEquipe de DevOps/IntegraçãoConfiguração únicaEstabelecer sincronização automatizada de DAM ↔ Topsort
Fluxo de trabalho da interfaceFornecedores/Administradores do marketplacePor campanhaCriar campanhas de banners através do painel com URLs de DAM
Fluxo de trabalho APIGestores de campanhas/AnunciantesPor campanhaCriar campanhas de banners de forma programática utilizando recursos DAM
Leilão e visualizaçãoDesenvolvedores de MarketplaceCada vez que a página é carregadaMostrar banners vencedores aos usuários

Criação de Campanhas de Banners com Ativos DAM

Fluxo de Trabalho da Interface

Função: Administradores de fornecedores/marketplace | Frequência: Configuração por campanha
Início da criação do template de marcas patrocinadas
Para criar campanhas de banners com URLs de DAM externas através da Plataforma de Anúncios, consulte o guia completo de Campanhas de Anúncios em Banners que mostra o processo da interface passo a passo, incluindo como referenciar URLs externas na configuração da campanha.

Fluxo de Trabalho API: Criação Completa de uma Campanha de Banners

Função: Gestores de campanhas/Anunciantes | Frequência: Configuração por campanha
1

Criar ativo com URL do DAM

Primeiro, crie um ativo no Topsort que faça referência à sua URL do DAM:
const assetResponse = await fetch("https://api.topsort.com/v2/assets", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Banner de Férias 728x90 - Aprovado v2",
    url: "https://dam-cdn.retailer.com/campaigns/holiday/banner-728x90-v2.jpg",
    dimensions: {
      width: 728,
      height: 90,
    },
    metadata: {
      approved: true,
      brand_compliant: true,
      expiry_date: "2024-12-31",
      version: "v2",
    },
  }),
});

const asset = await assetResponse.json();
2

Criar uma campanha de banners utilizando o recurso

Em seguida, crie uma campanha de banners que faça referência ao recurso que você acabou de criar:
const campaignResponse = await fetch("https://api.topsort.com/v2/campaigns", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Campanha de Banner de Férias",
    type: "banners",
    vendor_id: "vendor-123",
    bidding_strategy: "target_roas",
    target_roas: 4.5,
    budget: {
      amount: 5000,
      currency: "USD",
      period: "lifetime",
    },
    start_date: "2024-11-01",
    end_date: "2024-12-31",
    assets: [asset.id], // Referência ao ativo criado
    slot_id: "homepage_banner_top",
  }),
});

const campaign = await campaignResponse.json();

Resposta ao Leilão com URLs do DAM

Função: Desenvolvedores de Marketplace | Frequência: Cada vez que a página é carregada
1

Realizar um leilão para o espaço do banner

Solicite um leilão para o espaço publicitário onde sua campanha baseada em DAM pode competir:
const auctionResponse = await fetch("https://api.topsort.com/v2/auctions", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    auctions: [
      {
        type: "banners",
        slots: 1,
        slotId: "homepage_banner_top",
        device: "desktop",
      },
    ],
  }),
});

const auctionResult = await auctionResponse.json();
2

Receber URL do DAM na resposta

Quando sua campanha de banners vence, a resposta ao leilão inclui a URL original do DAM:
{
  "results": [
    {
      "winners": [
        {
          "rank": 1,
          "type": "product",
          "id": "p_PJbnN",
          "resolvedBidId": "WyJlX1BKYm5OIiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwiYmFubmVyQWRzIiwiZGVmYXVsdCIsIiJd",
          "asset": [
            {
              "url": "https://dam-cdn.retailer.com/campaigns/holiday/banner-728x90-v2.jpg"
            }
          ]
        }
      ],
      "error": false
    }
  ]
}
3

Renderizar banner com o recurso DAM

Utilize a URL retornada para exibir o banner e acompanhar o desempenho:
// Extrair a URL do DAM da resposta do leilão
const winner = auctionResult.results[0].winners[0];
const damImageUrl = winner.asset[0].url;
const resolvedBidId = winner.resolvedBidId;

// Renderizar banner na sua interface
const bannerElement = document.createElement("img");
bannerElement.src = damImageUrl;
bannerElement.addEventListener("click", () => {
  // Rastrear evento de clique para faturamento e atribuição
  fetch("/api/topsort/events", {
    method: "POST",
    body: JSON.stringify({
      type: "click",
      resolvedBidId: resolvedBidId,
    }),
  });
});

Benefícios Principais da Integração de DAM

  • Consistência de marca: Apenas os ativos aprovados e em conformidade chegam às campanhas publicitárias. - Eficiência do fluxo de trabalho: As equipes criativas trabalham com ferramentas DAM conhecidas e os recursos são sincronizados automaticamente. - Controle de versões: Quando os elementos criativos são atualizados no DAM, os recursos da campanha são atualizados automaticamente. - Gestão de direitos: Controlar as licenças de uso e impedir o uso de ativos expirados. - Distribuição global de ativos: Um repositório de ativos serve a múltiplos canais de marketing.

Guia de Implementação

Função: Equipe de DevOps/Integração | Frequência: Configuração única
1

Preparação do sistema de represas

Configure seu sistema DAM para una conectividade óptima com Topsort:
  • Organização de recursos: Estructure os recursos com carpetas e metadatos específicos da campanha.
  • Configuração de CDN: Asegurar que o DAM genere URLs optimizadas e accesibles públicamente.
  • Flujos de trabajo de aprobação: Configurar procesos para marcar os activos como listos para a campanha.
  • Estándares de metadatos: Definir un etiquetado coherente para dimensiones, versiones e fechas de caducidade.
2

Topsort Activos API Configuração

Configure a conectividade entre seu DAM e Topsort:
  • Autenticação: Configure as credenciales Topsort e API.
  • URL Validação: Asegurar que as URL de DAM sean accesibles para os sistemas Topsort
  • Sincronização automatizada: Configure webhooks ou tareas programadas para sincronizar os recursos aprobados.
  • Manejo de errores: Implementar lógica de reintento para referencias a recursos fallidas.
3

Automatização de flujos de trabajo

Implementar a sincronização automatizada de ativos:
// Exemplo de sincronização automatizada de ativos do DAM para o Topsort
const syncApprovedAssets = async () => {
  const approvedAssets = await dam.getAssetsByStatus("approved");

  for (const asset of approvedAssets) {
    if (!asset.syncedToTopsort) {
      await topsortAssetsAPI.create({
        name: asset.name,
        url: asset.cdnUrl,
        dimensions: asset.dimensions,
        metadata: asset.metadata,
      });
      await dam.markAsSynced(asset.id);
    }
  }
};

Referência da API

APIs do Topsort para Integração de DAM

APICaso de uso de integraçãoStatusDocumentação
API de RecursosReferenciar URLs de DAM em campanhas✅ DisponívelGestão e coleções de recursos
API de CampanhasCriar campanhas com recursos DAM✅ DisponívelGestão completa do ciclo de vida da campanha

Autenticação

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Melhores Práticas

Gestão de Ativos

  • Otimizar as URLs: Garantir que o DAM gere URLs de carregamento rápido e otimizadas para CDN. - Controle de versões: Implemente um controle de versões claro para evitar que os recursos das campanhas fiquem obsoletos. - Padrões de metadados: Utilize uma rotulagem consistente para dimensões, tipos de campanha e status de aprovação. - Controle de acesso: Garanta que as URLs dos recursos sejam acessíveis publicamente para os sistemas do Topsort.

Automatização de Fluxos de Trabalho

  • Requisitos de aprovação: Sincronize apenas os recursos aprovados e em conformidade com a marca com o Topsort. - Limpeza automatizada: Remova os recursos expirados ou desatualizados das campanhas ativas. - Monitoramento de erros: Acompanhe referências a recursos com falha e problemas de sincronização.

Solução de Problemas

Problemas Comuns de Integração de DAM

  1. Problemas com URLs de ativos
  • Verificar que as URLs do DAM sejam de acesso público (não estejam protegidas por autenticação). - Verificar que as URLs retornem os códigos de status HTTP adequados (200). - Garantir que as URLs da CDN estejam otimizadas para carregamento rápido. - Validar que as dimensões do ativo correspondam aos requisitos do Topsort.
  1. Falha de sincronização
  • Verificar a autenticação e as permissões da API. - Verificar a compatibilidade do formato de metadados dos ativos. - Monitorar as taxas de sucesso de entrega de webhooks. - Implementar um registro de erros adequado para as sincronizações com falha.
  1. Problemas de controle de versões - Garantir que os ativos atualizados acionem as atualizações dos ativos da campanha. - Verificar que os ativos expirados sejam removidos das campanhas ativas. - Verificar que apenas as versões de ativos aprovadas sejam sincronizadas com o Topsort.

Questões Gerais da API

  1. Falha de autenticação
  • Verificar a validade da chave de API e as permissões de escopo. - Verificar o formato do cabeçalho de autenticação. - Monitorar a expiração do token.
  1. Limitação de taxa - Implementar uma limitação de taxa adequada no código de conectividade. - Utilizar operações em lote quando disponíveis. - Adicionar lógica de nova tentativa com recuo exponencial.

Começando

Etapas de Implementação

  1. Avaliação: Revise as capacidades de geração de URL e API do seu sistema DAM atual.
  2. Credenciais da API: Obtenha as chaves de API do Topsort e configure a autenticação.
  3. Prova de conceito: Comece com um pequeno conjunto de recursos para testar o fluxo de trabalho de conectividade.
  4. Automatização: Implemente processos de sincronização automatizados para os ativos aprovados.
  5. Monitoramento: Configure o acompanhamento para o sucesso da sincronização de ativos e o desempenho da campanha.

Recursos Relacionados

Esta documentação reflete as capacidades atuais do Topsort e da API. A conectividade DAM já está disponível através das APIs existentes. Para o desenvolvimento de conectividade personalizada, entre em contato com seu representante do Topsort.