REST Resource: customBiddingAlgorithms

Zasób: CustomBiddingAlgorithm

jeden algorytm ustalania stawek niestandardowych.

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

  // 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

Wymagany. Wyświetlana nazwa algorytmu określania 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)

Wymagany. Niezmienne. Typ algorytmu ustalania stawek niestandardowych.
sharedAdvertiserIds[]

string (int64 format)

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

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

object (CustomBiddingModelDetails)

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

To pole może zawierać szczegóły dotyczące reklamodawcy, którego dotyczy zapytanie, tylko wtedy, gdy algorytm owner jest partnerem i jest pobierany przy użyciu reklamodawcy accessor.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Opcjonalnie. Niezmienne. Określa zewnętrznego partnera ds. optymalizacji, który zarządza tym algorytmem.
Pole unii owner. Określa jednostkę DV360, która jest właścicielem algorytmu ustalania stawek niestandardowych. Może to być partner lub reklamodawca. owner może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

Niezmienne. Unikalny identyfikator partnera, który jest właścicielem algorytmu określania stawek niestandardowych.
advertiserId

string (int64 format)

Niezmienne. Unikalny identyfikator reklamodawcy, który jest właścicielem algorytmu określania stawek niestandardowych.

CustomBiddingAlgorithmType

Możliwe typy algorytmów ustalania stawek niestandardowych.

Wartości w polu enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Typ algorytmu nie jest określony lub jest nieznany w tej wersji.
SCRIPT_BASED Algorytm wygenerowany na podstawie przesłanych przez klienta plików skryptów ustalania stawek niestandardowych.
RULE_BASED

Algorytm oparty na zdefiniowanych regułach. Reguły te 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, otrzymają komunikat o błędzie.

CustomBiddingModelDetails

Szczegóły modelu algorytmu stawek niestandardowych dla 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 nie jest określony lub jest nieznany w tej wersji.
READINESS_STATE_ACTIVE Model jest wytrenowany i gotowy do wyświetlania.
READINESS_STATE_INSUFFICIENT_DATA Nie ma wystarczającej ilości danych, aby wytrenować model wyświetlania reklam.
READINESS_STATE_TRAINING Model jest trenowany i nie jest gotowy do wyświetlania.
READINESS_STATE_NO_VALID_SCRIPT Nie podano prawidłowego skryptu ustalania stawek niestandardowych, za pomocą którego można wytrenować model. Ten stan będzie stosowany tylko w przypadku algorytmów, których wartość customBiddingAlgorithmType wynosi SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Podano prawidłowy skrypt, ale nie przeszedł on weryfikacji. 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 nie jest określony lub jest nieznany w tej wersji.
SUSPENSION_STATE_ENABLED Model jest włączony, ponieważ był ostatnio używany, jest obecnie używany lub ma być używany w przyszłości. Algorytm aktywnie ocenia wyświetlenia tego reklamodawcy.
SUSPENSION_STATE_DORMANT Model nie był ostatnio używany. Chociaż model nadal działa jako ENABLED, w przypadku braku aktywności zostanie ostatecznie zawieszony.
SUSPENSION_STATE_SUSPENDED Model nie nalicza wyświetleń i nie może wyświetlać reklam. Jeśli algorytm zostanie przypisany do elementu zamówienia tego reklamodawcy lub w inny sposób zaktualizowany, wróci do stanu ENABLED i będzie wymagał czasu na ponowne przygotowanie modelu wyświetlania.

ThirdPartyOptimizationPartnerType

Możliwe typy partnerów zewnętrznych ds. optymalizacji.

Wartości w polu enum
UNKNOWN Wartość typu nie jest określona lub jest nieznana w tej wersji.
SCIBIDS Zewnętrzny dostawca usług z zakresu analizy danych, z którym mogą współpracować partnerzy i reklamodawcy DV3.
ADELAIDE Zewnętrzny dostawca usług pomiaru uwagi, z którym mogą współpracować partnerzy i reklamodawcy DV3.

Metody

create

 Tworzy nowy algorytm ustalania stawek niestandardowych.

get

 Pobiera algorytm ustalania stawek niestandardowych.

list

 Zawiera listę niestandardowych 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 istniejący 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.