Przepływy pracy interfejsu API

Ten przewodnik opisuje typowe przepływy pracy w interfejsie API dotyczące tworzenia, anulowania, pobierania, aktualizowania i negocjowania umów za pomocą interfejsu Deal Sync API.

Tworzenie umowy

  1. Sprawdź, czy produkt został już utworzony, wywołując LIST products z filtrem externalDealId. Pamiętaj, że w ciągu filtra obsługiwane są zarówno externalDealId w notacji camelCase, jak i external_deal_id w notacji snake_case. external_deal_id musi być unikalny we wszystkich produktach.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"
    
  2. Utwórz zamówienie. Nazwa zamówienia jest generowana przez DV360. Zalecamy zapisanie tego identyfikatora w systemie, aby można go było później pobrać.

  3. Utwórz produkt w ramach zamówienia. Nazwa produktu jest generowana przez DV360. Zalecamy zapisanie tego identyfikatora w systemie, aby można go było później pobrać.

Możesz też wywołać LIST z parametrem external_deal_id. Nazwa zasobu zawiera zarówno identyfikator zamówienia, jak i identyfikator produktu, dzięki czemu możesz zidentyfikować zamówienie nadrzędne.

Anulowanie umowy

  1. Zaktualizuj stan zamówienia na CANCELED. Anulowanie jest obsługiwane tylko wtedy, gdy zamówienie nie zostało jeszcze zaakceptowane. Stan anulowania jest stanem końcowym. Anulowanego zamówienia nie można ponownie aktywować. Jeśli zamówienie zawierało jakieś produkty, ich external_deal_id nie można ponownie użyć.

Pobieranie szczegółów umowy

  1. Pobierz szczegóły zamówienia. Stan jest aktualizowany, gdy użytkownik zaakceptuje, zarchiwizuje lub anuluje zamówienie.
  2. Pobierz szczegóły produktu.

Pobieranie listy umów

  1. Wywołaj LIST orders z filtrem stanu, aby uzyskać wszystkie zaakceptowane zamówienia lub zamówienia oczekujące na akceptację.
  2. Wywołaj LIST products z filtrem external_deal_id.
  3. LIST wszystkie produkty w ramach Zamówienia.

Aktualizowanie umowy

  1. Zaktualizuj zamówienie, aby podać dane kontaktowe wydawcy.
    1. name nie można zaktualizować (nie można go ustawić w updateMask). Za pomocą interfejsu API można ustawić tylko stan CANCELED.
    2. partner_id nie można zaktualizować.
  2. Zaktualizuj produkt, aby wprowadzić konkretne zmiany w warunkach umowy.
    1. name, externalDealId, transactionType, pricingType, i updateTime nie mogą zostać zaktualizowane.
    2. Aktualizacja displayName nie wymaga ponownej akceptacji przez użytkownika.
    3. Aktualizacja rateDetails lub creativeConfig zmienia stan zamówienia nadrzędnego na PENDING_ACCEPTANCE. Reklamodawcy DV360 będą musieli zaakceptować nowe warunki na stronie Negocjacje, niezależnie od tego, czy poprzednie zamówienie zostało już zaakceptowane.

Sprawdzanie, czy użytkownik zaakceptował umowę

  1. Wywołaj Get Order , jeśli znasz odpowiednią nazwę zamówienia. Sprawdź pole status.
  2. Jeśli nazwa zamówienia nie była śledzona: wywołaj LIST Products z filtrem external_deal_id, zidentyfikuj nazwę zamówienia na podstawie nazwy produktu, a następnie wywołaj Get Order. Sprawdź pole status.

Sprawdzanie, czy użytkownik skonfigurował umowę (tylko w przypadku automatyzacji gwarantowanej)

  1. Wywołaj Get Inventory Source. Nazwa zasobu to exchanges/{exchangeId}/inventorysources/{external_deal_id}. Sprawdź stan kupującego.
    1. Umowy rezerwacyjne:
      1. BUYER_STATUS_ACTIVE: umowa została zaakceptowana i skonfigurowana. Wydatki w ramach umowy zaczną się, gdy DV360 otrzyma żądania stawek zgodne z warunkami umowy. Podczas konfigurowania umowy element zamówienia jest generowany automatycznie. Więcej informacji znajdziesz w artykule Konfigurowanie umowy.
      2. BUYER_STATUS_PENDING: zamówienie zostało zaakceptowane, ale umowa nie została jeszcze skonfigurowana. W tym stanie nie są ponoszone żadne wydatki.
      3. BUYER_STATUS_PAUSED: umowa została wstrzymana przez reklamodawcę. W tym stanie nie są ponoszone żadne wydatki.
    2. Umowy nierezewacyjne:
      1. BUYER_STATUS_ACTIVE: umowa została zaakceptowana. Wydatki w ramach umowy zaczną się, gdy DV360 otrzyma pasujące żądania stawek, aktywny element zamówienia będzie kierowany na umowę, a żądania stawek będą zgodne z kryteriami kierowania elementu zamówienia. Więcej informacji znajdziesz w artykule Elementy zamówienia. (Uwaga: nie ma interfejsu API sprzedawcy, który umożliwiałby sprawdzenie, czy umowa jest kierowana przez elementy zamówienia).
      2. BUYER_STATUS_PENDING: nie dotyczy umów nierezewacyjnych.
      3. BUYER_STATUS_PAUSED: umowa została wyraźnie wstrzymana przez reklamodawcę. W tym stanie nie są ponoszone żadne wydatki.

Wstrzymywanie i wznawianie umowy po jej zaakceptowaniu

  1. Zaktualizuj stan sprzedawcy źródła zasobów reklamowych.
    1. Wstrzymanie lub wznowienie nie powoduje zatrzymania wyświetlania umowy. Gdy sprzedawca wstrzyma umowę, reklamodawcy zobaczą w interfejsie DV360 komunikat informacyjny, który pomoże im rozwiązać problemy z umowami, w ramach których nie są ponoszone wydatki.

Ponowne negocjacje (aktualizowanie umowy po jej zaakceptowaniu)

Ponowne negocjacje to zmiany wprowadzane w umowie po jej zaakceptowaniu przez kupującego. Umożliwia to giełdom i kupującym dostosowywanie warunków istniejących umów. Na przykład giełda może stwierdzić, że czas zakończenia wyświetlania okresowego w zaakceptowanej umowie jest nieprawidłowy. Giełda może użyć Product Patch aby przesłać aktualizacje do kupujących w DV360, zanim umowa zacznie być wyświetlana.

Dozwolone i niedozwolone zmiany

Pełne omówienie negocjacji i ponownych negocjacji umów znajdziesz w artykułach w Centrum pomocy Display &Video 360: