REST Resource: customBiddingAlgorithms

Typ zasobu: CustomBiddingAlgorithm

1 niestandardowy algorytm określania stawek.

Zapis JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu algorytmu ustalania stawek niestandardowych.
customBiddingAlgorithmId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator algorytmu ustalania stawek niestandardowych. Przypisany przez system.
displayName

string

Wymagane. Wyświetlana nazwa algorytmu ustalania stawek niestandardowych.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.
entityStatus

enum (EntityStatus)

Określa, czy algorytm ustalania stawek niestandardowych może być używany jako strategia ustalania stawek.

Akceptowane wartości:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Wymagane. Niezmienna. Typ algorytmu ustalania stawek niestandardowych.
sharedAdvertiserIds[]

string (int64 format)

Identyfikatory reklamodawców, którzy mają dostęp do tego algorytmu. Jeśli ustawisz wartość advertiserId, to pole będzie zawierać tylko tę wartość.

To pole nie będzie ustawione, jeśli algorytm owner jest partnerem i jest pobierany za pomocą reklamodawcy accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Tylko dane wyjściowe. Szczegóły modeli ustalania stawek niestandardowych dla każdego reklamodawcy, który ma do nich dostęp.

To pole może zawierać szczegóły zapytanego reklamodawcy tylko wtedy, gdy algorytm owner jest partnerem i jest pobierany za pomocą reklamodawcy accessor.
Pole unii owner. Określa element DV360, który jest właścicielem algorytmu ustalania stawek niestandardowych. Może to być partner lub reklamodawca. owner może być tylko jednym z tych elementów:
partnerId

string (int64 format)

Niezmienna. Unikalny identyfikator partnera, do którego należy algorytm ustalania stawek niestandardowych.
advertiserId

string (int64 format)

Niezmienna. Unikalny identyfikator reklamodawcy, do którego należy algorytm ustalania stawek niestandardowych.

CustomBiddingAlgorithmType

Możliwe typy algorytmów ustalania stawek niestandardowych

Wartości w polu enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED W tej wersji nie podano typu algorytmu lub jest on nieznany.
SCRIPT_BASED algorytm wygenerowany na podstawie przesłanych przez klienta plików skryptu ustalania stawek niestandardowych;
ADS_DATA_HUB_BASED Algorytm utworzony w usłudze Centrum danych reklam.
GOAL_BUILDER_BASED Algorytm utworzony za pomocą kreatora celów w interfejsie DV3.
RULE_BASED

algorytm na podstawie zdefiniowanych reguł. Te reguły są definiowane w interfejsie API za pomocą obiektu AlgorithmRules.

Ten typ algorytmu jest dostępny tylko dla klientów z białej listy. Inni klienci, którzy spróbują użyć tego typu, zobaczą komunikat o błędzie.

CustomBiddingModelDetails

Szczegóły modelu algorytmu stawek niestandardowych w przypadku jednego udostępnionego reklamodawcy.

Zapis JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Pola
advertiserId

string (int64 format)

Unikalny identyfikator odpowiedniego reklamodawcy.
readinessState

enum (ReadinessState)

Stan gotowości modelu ustalania stawek niestandardowych.
suspensionState

enum (SuspensionState)

Tylko dane wyjściowe. Stan zawieszenia modelu ustalania stawek niestandardowych.

ReadinessState

Możliwe stany gotowości modelu.

Wartości w polu enum
READINESS_STATE_UNSPECIFIED Stan jest nieznany lub nie został określony w tej wersji.
READINESS_STATE_ACTIVE Model został wytrenowany i jest gotowy do wyświetlania.
READINESS_STATE_INSUFFICIENT_DATA Nie ma wystarczającej ilości danych do wytrenowania modelu wyświetlania.
READINESS_STATE_TRAINING Model jest trenowany i nie jest gotowy do wyświetlania.
READINESS_STATE_NO_VALID_SCRIPT Nie został przesłany prawidłowy skrypt ustalania stawek niestandardowych, który służy do trenowania modelu. Ten stan będzie stosowany tylko do algorytmów, których customBiddingAlgorithmType ma wartość SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Podano prawidłowy skrypt, ale nie udało się go ocenić. Dotyczy to skryptów, których nie udało się ocenić w przydzielonym czasie.

SuspensionState

Możliwe stany zawieszenia modeli ustalania stawek niestandardowych.

Wartości w polu enum
SUSPENSION_STATE_UNSPECIFIED Stan jest nieznany lub nie został określony w tej wersji.
SUSPENSION_STATE_ENABLED Model jest włączony – jest ostatnio używany, obecnie używany lub ma być używany. Algorytm aktywnie określa liczbę wyświetleń w przypadku tego reklamodawcy.
SUSPENSION_STATE_DORMANT Model nie był używany w ostatnim czasie. Chociaż model nadal działa jako ENABLED, ostatecznie zostanie zawieszony, jeśli nie będzie używany.
SUSPENSION_STATE_SUSPENDED Ocena wyświetleń przez model jest zawieszona i nie może się wyświetlać. Jeśli algorytm zostanie przypisany do elementu zamówienia tego reklamodawcy lub zostanie w inny sposób zaktualizowany, wróci do stanu ENABLED i będzie wymagać ponownego przygotowania modelu wyświetlania.

Metody

create

 Tworzy nowy algorytm ustalania stawek niestandardowych.

get

 Pobiera algorytm ustalania stawek niestandardowych.

list

 Wyświetla listę algorytmów określania stawek, które są dostępne dla bieżącego użytkownika i mogą być używane w strategiach ustalania stawek.

patch

 Aktualizuje dotychczasowy algorytm ustalania stawek niestandardowych.

uploadRules

 Tworzy obiekt odwołania do reguł dla pliku AlgorithmRules.

uploadScript

 Tworzy obiekt referencyjny skryptu ustalania stawek niestandardowych dla pliku skryptu.