Development Newsletters

Release: 31-07-2019

Lista wprowadzanych zmian:

  • Refaktoring planów emisyjnych kampanii i zleceń
  • Nowy szablon kreacji - Interscroller

Refaktoring planów emisyjnych kampanii i zleceń

W ciągu kilku najbliższych tygodni wprowadzone zostaną wymienione niżej zmiany w operacjach API. Zmiany te są elementem refaktoryzacji planów emisyjnych kampanii i zleceń, która ułatwi wprowadzanie w AdOcean nowych funkcjonalności.

Usunięcie jednej z opcji planu emisyjnego w interfejsie

Podczas wdrożenia, opcja "Maksymalizuj liczbę emisji dla wskaźnika zasięg" zostanie usunięta z systemu. Była ona do tej pory dostępna w sekcji Liczba zdarzeń, gdy wybrany był wskaźnik zasięg.


Zmiany w operacjach API:


AddCampaign oraz UpdateCampaign

  • Usunięcie parametrów emissionSettings oraz emissionSettingsState. Parametry te były używane do ustawienia opcji "Maksymalizuj liczbę emisji dla wskaźnika zasięg" dla planu emisyjnego kampanii, który nie będzie dłużej dostępny.
  • Parametr impressionMode zostanie zastąpiony przez trzy nowe parametry:
    • emissionMode - parametr może przyjmować następujące wartości: FOR_EACH_ORDER lub FOR_ENTIRE_CAMPAIGN.
      • FOR_ENTIRE_CAMPAIGN - definiuje plan dla całej kampanii, korzystając z parametrów algorithm oraz overMode (opisanych niżej),
      • FOR_EACH_ORDER - definiuje plan dla każdego zlecenia oddzielnie (zastępuje dotychczasowe ustawienie ORDERS).
    • algorithm - parametr może przyjmować następujące wartości: none, STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE, ORDER_PRIORITY:
      • none - w przypadku trybu FOR_EACH_ORDER,
      • STANDARD - wartość domyślna,
      • PUBLISHER_PRIORITY - kampania będzie emitowana zgodnie z predefiniowanymi priorytetami wydawców,
      • PUBLISHER_SHARE - kampania będzie emitowana zgodnie z predefiniowanymi udziałami wydawców,
      • ORDER_PRIORITY - nowa opcja, umożliwiająca emisję kampanii zgodnie z priorytetami zleceń.
      • Jeśli w kampanii został wybrany tryb FOR_EACH_ORDER, parametr algorithm nie może być zdefiniowany (parametr algorithm nie powinien występować w zapytaniu). W przeciwnym wypadku należy ustawić jedną z 4 dostępnych wartości. Jeśli żadna wartość nie zostanie wybrana, system wybierze STANDARD jako wartość domyślną.

    • overMode - parametr może przyjmować następujące wartości: none, NO_OVER, OVER_AFTER_CAMPAIGN:
      • none - w przypadku trybu FOR_EACH_ORDER,
      • NO_OVER - opcja overEmit dla kampanii pozostanie wyłączona,
      • OVER_AFTER_CAMPAIGN - włączona zostanie opcja overEmit po zakończeniu kampanii (kampania będzie emitowana po dacie zakończenia dopóki nie osiągnie założonego planu, nie dłużej jednak niż przez 30 dni).
      • Jeśli kampania jest emitowana w trybie FOR_EACH_ORDER, parametr overMode nie może być zdefiniowany (parametr overMode nie powinien występować w zapytaniu). W przeciwnym wypadku należy ustawić jedną z 3 dostępnych wartości. Jeśli żadna wartość nie zostanie wybrana, system wybierze NO_OVER jako wartość domyślną.

    AddOrder, UpdateOrder, AddSurround, UpdateSurround


    • Usunięcie parametrów emissionSettings oraz emissionSettingsState. Parametry te były używane do ustawienia opcji "Maksymalizuj liczbę emisji dla wskaźnika zasięg" dla planu emisyjnego kampanii, który nie będzie dłużej dostępny.
    • Usunięcie przestarzałego parametru impressionLimit.
    • Parametr impressionMode zostanie zastąpiony przez dwa nowe parametry:
      • algorithm - parametr może przyjmować następujące wartości: none, STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE.
        • none - w przypadku trybu FOR_EACH_ORDER,
        • STANDARD - wartość domyślna,
        • PUBLISHER_PRIORITY - kampania będzie emitowana zgodnie z predefiniowanymi priorytetami wydawców,
        • PUBLISHER_SHARE - kampania będzie emitowana zgodnie z predefiniowanymi udziałami wydawców,
        • Jeśli kampania jest emitowana w trybie FOR_ENTIRE_CAMPAIGN, parametr algorithm dla zlecenia nie może być zdefiniowany (powinien pozostać pusty). W przeciwnym wypadku należy ustawić jedną z 3 dostępnych wartości. Jeśli żadna wartość nie zostanie wybrana, system wybierze STANDARD jako wartość domyślną.

      • overMode - parametr może przyjmować następujące wartości: none, NO_OVER, OVER_AFTER_ORDER, OVER_AFTER_CAMPAIGN:
        • none - w przypadku trybu FOR_ENTIRE_CAMPAIGN,
        • NO_OVER - opcja overEmit dla zlecenia pozostanie wyłączona,
        • OVER_AFTER_ORDER - włączona zostanie opcja overEmit po zakończeniu zlecenia,
        • OVER_AFTER_CAMPAIGN - włączona zostanie opcja overEmit po zakończeniu kampanii.
        • Jeśli kampania jest emitowana w trybie FOR_ENTIRE_CAMPAIGN, parametr overMode dla zlecenia nie może być zdefiniowany (parametr overMode nie powinien występować w zapytaniu). W przeciwnym wypadku należy ustawić jedną z 3 dostępnych wartości. Jeśli żadna wartość nie zostanie wybrana, system wybierze NO_OVER jako wartość domyślną.

        • Uwaga: jeśli kampania emitowana jest w trybie FOR_EACH_ORDER, opcja ASAP może zostać włączona za pomocą parametru impressionSpeed.

      Zmiany w odpowiedziach operacji API:


      GetCampaignInfo / GetCampaignsList


      • Usunięcie pola odpowiedzi impressionMode.
      • Nowe pole odpowiedzi: emissionMode - zawierać będzie jedną z następujących wartości: FOR_EACH_ORDER lub FOR_ENTIRE_CAMPAIGN.
      • Nowe pole odpowiedzi: algorithm - zawierać będzie jedną z następujących wartości: (empty), STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE, ORDER_PRIORITY.
      • Nowe pole odpowiedzi: overMode - zawierać będzie jedną z następujących wartości: (empty), NO_OVER, OVER_AFTER_CAMPAIGN.

      GetOrderInfo / GetOrdersList / GetSurroundInfo


      • Usunięcie z odpowiedzi pola impressionMode.
      • Nowe pole odpowiedzi: algorithm - zwracana będzie jedna z następujących wartości: (empty), STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE.
      • Nowe pole odpowiedzi: overMode - zwracana będzie jedna z następujących wartości: (empty), NO_OVER, OVER_AFTER_ORDER, OVER_AFTER_CAMPAIGN.
      • Usunięcie z odpowiedzi pola emissionSettings.

      Nowy szablon kreacji - Interscroller

      Wprowadzamy nowy format reklamowy, który pozwala na prezentację kreacji podczas przewijania strony. Kreacja zajmować będzie całą szerokość okna przeglądarki, a jej wysokość może zostać ustawiona jako procent wysokości tego okna. Więcej szczegółów znajduje się na stronie demo AdOcean.

adocean api interscroller planowanie plany emisyjne szablony kreacji