Fluxos de trabalho de API

Este guia descreve fluxos de trabalho comuns da API para criar, cancelar, recuperar, atualizar e negociar transações usando a API Deal Sync.

Criar uma transação

  1. Verifique se um produto já foi criado chamando LIST products com o externalDealId filtro. Os formatos camelCase externalDealId e snake_case external_deal_id são aceitos na string de filtro. O external_deal_id precisa ser exclusivo em todos os produtos.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"

  2. Criar Pedido. O nome do pedido é gerado pelo DV360. Recomendamos armazenar esse ID no seu sistema para recuperação futura.

  3. Crie um produto no pedido. O nome do produto é gerado pelo DV360. Recomendamos armazenar esse ID no seu sistema para recuperação futura.

Como alternativa, você pode chamar LIST com external_deal_id. O nome do recurso contém o código do pedido e o ID do produto. Assim, você pode identificar o pedido principal.

Cancelar uma transação

  1. Atualize o status do pedido para CANCELED. O cancelamento só é aceito se o pedido ainda não tiver sido aceito. Canceled é um estado final. Um pedido não pode ser reativado depois de cancelado. Se o pedido contiver produtos, o external_deal_id deles não poderá ser reutilizado.

Receber detalhes de uma transação

  1. Receba detalhes de um pedido. O status é atualizado quando o usuário aceita, arquiva ou cancela o pedido.
  2. Receba detalhes de um produto.

Receber uma lista de transações

  1. LIST pedidos com um filtro de status para receber todos os pedidos aceitos ou pendentes de aceitação pedidos.
  2. LIST products com o filtro external_deal_id.
  3. LIST todos os produtos dentro de um pedido.

Atualizar uma transação

  1. Atualize o pedido para informações de contato do editor.
    1. O name não pode ser atualizado (não pode ser definido no updateMask). O status só pode ser definido como CANCELED usando a API.
    2. O partner_id não pode ser atualizado.
  2. Atualize o produto para uma atualização específica do termo da transação.
    1. name, externalDealId, transactionType, pricingType, e updateTime não podem ser atualizados.
    2. A atualização do displayName não exige que o usuário aceite novamente.
    3. A atualização de rateDetails ou creativeConfig muda o status do pedido principal para PENDING_ACCEPTANCE. Os anunciantes do DV360 vão precisar aceitar os novos termos na página "Negociações", mesmo que o pedido anterior já tenha sido aceito.

Verificar se o usuário aceitou a transação

  1. Receba o pedido se você souber o nome correspondente. Verifique o campo status.
  2. Se o nome do pedido não foi rastreado: liste os produtos com o filtro external_deal_id, identifique o nome do pedido pelo nome do produto, e chame Receber pedido. Verifique o campo status.

Verificar se o usuário configurou a transação (somente programática garantida)

  1. Receba a origem do inventário. O nome do recurso é exchanges/{exchangeId}/inventorysources/{external_deal_id}. Verifique o status do comprador.
    1. Transações de reserva:
      1. BUYER_STATUS_ACTIVE: a transação foi aceita e configurada. A transação vai começar a gastar quando o DV360 receber solicitações de lances que correspondam aos termos da transação. Um item de linha é gerado automaticamente durante a configuração da transação. Consulte Configuração da transação para mais detalhes.
      2. BUYER_STATUS_PENDING: o pedido foi aceito, mas a transação ainda não foi configurada. Nenhum gasto ocorre nesse estado.
      3. BUYER_STATUS_PAUSED: a transação foi pausada pelo anunciante. Nenhum gasto ocorre nesse estado.
    2. Transações sem reserva:
      1. BUYER_STATUS_ACTIVE: a transação foi aceita. A transação vai começar a gastar quando o DV360 receber solicitações de lances correspondentes, um item de linha ativo segmentar a transação e as solicitações de lances corresponderem aos critérios de segmentação do item de linha. Consulte Itens delinha para mais detalhes. (Observação: não há uma API do vendedor para consultar se uma transação é segmentada por itens de linha).
      2. BUYER_STATUS_PENDING: não aplicável a transações sem reserva.
      3. BUYER_STATUS_PAUSED: a transação foi pausada explicitamente pelo anunciante. Nenhum gasto ocorre nesse estado.

Pausar e reativar uma transação após a aceitação

  1. Atualize o status do vendedor da origem do inventário.
    1. A pausa ou reativação não interrompe a veiculação da transação. Um vendedor que pausa uma transação mostra uma mensagem informativa aos anunciantes na interface do DV360 para ajudar a resolver problemas de transações sem gastos.

Renegociação (atualização de uma transação após a aceitação)

A renegociação se refere a atualizações feitas em uma transação depois que ela é aceita pelo comprador. Isso permite que as exchanges e os compradores ajustem os termos das transações atuais. Por exemplo, uma exchange pode descobrir que o horário de término de uma transação aceita está incorreto. A exchange pode usar o patch de produto para enviar atualizações aos compradores do DV360 antes que a transação comece a ser veiculada.

Alterações permitidas e não permitidas

Consulte os artigos da Central de Ajuda do Display &Video 360 para conferir uma análise completa das negociações e regras de renegociação de transações:

Anterior
Estrutura da entidade
Avançar
Processo Beta