Flussi di lavoro delle API

Questa guida descrive i workflow API comuni per creare, annullare, recuperare, aggiornare e negoziare deal utilizzando l'API Deal Sync.

Creare un deal

  1. Verifica se un prodotto è già stato creato chiamando LIST products con il externalDealId filtro. Tieni presente che nella stringa del filtro sono supportati sia externalDealId in camel case sia external_deal_id in snake case. external_deal_id deve essere univoco per tutti i prodotti.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"
    
  2. Crea un ordine. Il nome dell'ordine viene generato da DV360 e ti consigliamo di memorizzare questo ID nel tuo sistema per recuperarlo in futuro.

  3. Crea un prodotto nell' ordine. Il nome del prodotto viene generato da DV360 e ti consigliamo di memorizzare questo ID nel tuo sistema per recuperarlo in futuro.

In alternativa, puoi chiamare LIST con external_deal_id. Il nome della risorsa contiene sia l'ID ordine sia l'ID prodotto, quindi puoi identificare l'ordine principale.

Annullare un deal

  1. Aggiorna lo stato dell'ordine a CANCELED. L'annullamento è supportato solo se l'ordine non è ancora stato accettato. Canceled è uno stato finale; un ordine non può essere riattivato una volta annullato. Se l'ordine conteneva dei prodotti, il relativo external_deal_id non può essere riutilizzato.

Ottenere i dettagli di un deal

  1. Ottieni i dettagli di un ordine. Lo stato viene aggiornato quando l'utente accetta, archivia o annulla l'ordine.
  2. Ottieni i dettagli di un prodotto.

Ottenere un elenco di deal

  1. ELENCA gli ordini con un filtro di stato per ottenere tutti gli ordini accettati o in attesa di accettazione ordini.
  2. Elenca i prodotti con il external_deal_id filtro.
  3. ELENCA tutti i prodotti all'interno di un ordine.

Aggiornare un deal

  1. Aggiorna l'ordine per le informazioni di contatto del publisher.
    1. name non può essere aggiornato (non può essere impostato in updateMask). Lo stato può essere impostato solo su CANCELED utilizzando l'API.
    2. partner_id non può essere aggiornato.
  2. Aggiorna il prodotto per un aggiornamento specifico dei termini del deal.
    1. name, externalDealId, transactionType, pricingType, e updateTime non possono essere aggiornati.
    2. L'aggiornamento di displayName non richiede una nuova accettazione da parte dell'utente.
    3. L'aggiornamento di rateDetails o creativeConfig modifica lo stato dell'ordine principale in PENDING_ACCEPTANCE. Agli inserzionisti DV360 verrà chiesto di accettare i nuovi termini nella pagina Negoziazioni, indipendentemente dal fatto che l'ordine precedente sia già stato accettato.

Verificare se l'utente ha accettato il deal

  1. Ottieni l'ordine se conosci il nome dell'ordine corrispondente. Controlla il campo status.
  2. Se il nome dell'ordine non è stato monitorato: elenca i prodotti con il filtro external_deal_id, identifica il nome dell'ordine dal nome del prodotto, e poi chiama Get Order. Controlla il campo status.

Verificare se l'utente ha configurato il deal (solo pubblicità programmatica garantita)

  1. Ottieni l'origine dell'inventario. Il nome della risorsa è exchanges/{exchangeId}/inventorysources/{external_deal_id}. Controlla lo stato dell'acquirente.
    1. Deal di prenotazione:
      1. BUYER_STATUS_ACTIVE: il deal è stato accettato e configurato. Il deal inizierà a generare spesa quando DV360 riceverà richieste di offerta che corrispondono ai termini del deal. Durante la configurazione del deal viene generato automaticamente un elemento pubblicitario. Per maggiori dettagli, consulta Configurazione del deal.
      2. BUYER_STATUS_PENDING: l'ordine è stato accettato, ma il deal non è ancora stato configurato. In questo stato non si verifica alcuna spesa.
      3. BUYER_STATUS_PAUSED: il deal è stato messo in pausa dall'inserzionista. In questo stato non si verifica alcuna spesa.
    2. Deal non di prenotazione:
      1. BUYER_STATUS_ACTIVE: il deal è stato accettato. Il deal inizierà a generare spesa quando DV360 riceverà richieste di offerta corrispondenti, un elemento pubblicitario attivo indirizzerà il deal e le richieste di offerta corrisponderanno ai criteri di targeting dell'elemento pubblicitario. Per maggiori dettagli, consulta Line Items for details. (Nota: non esiste un'API Seller per verificare se un deal è indirizzato dagli elementi pubblicitari).
      2. BUYER_STATUS_PENDING: non applicabile ai deal non di prenotazione.
      3. BUYER_STATUS_PAUSED: il deal è stato messo in pausa esplicitamente dall'inserzionista. In questo stato non si verifica alcuna spesa.

Mettere in pausa e riattivare un deal dopo l'accettazione

  1. Aggiorna lo stato del venditore dell'origine dell'inventario.
    1. La messa in pausa o la riattivazione non interrompe la pubblicazione del deal. Se un venditore mette in pausa un deal, nell'interfaccia utente di DV360 viene visualizzato un messaggio informativo per gli inserzionisti per aiutarli a risolvere i problemi relativi ai deal che non generano spesa.

Rinegoziazione (aggiornamento di un deal dopo l'accettazione)

La rinegoziazione si riferisce agli aggiornamenti apportati a un deal dopo che è stato accettato dall'acquirente. In questo modo, gli exchange e gli acquirenti possono modificare i termini dei deal esistenti. Ad esempio, un exchange potrebbe scoprire che l'ora di fine della pubblicazione di un deal accettato non è corretta; l'exchange può utilizzare Product Patch per inviare gli aggiornamenti agli acquirenti DV360 prima che il deal inizi a essere pubblicato.

Modifiche consentite e non consentite

Per una suddivisione completa delle regole di negoziazione e rinegoziazione dei deal, consulta gli articoli del Centro assistenza Display &Video 360: