REST Resource: customBiddingAlgorithms

Zasób: algorytm ustalania stawek niestandardowych

Jeden algorytm ustalania stawek niestandardowych.

Zapis JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelReadiness": [
    {
      object (CustomBiddingModelReadinessState)
    }
  ],
  "customBiddingAlgorithmState": enum (State),

  // 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. Przypisana przez system.
displayName

string

To pole jest wymagane. Wyświetlana nazwa algorytmu ustalania stawek niestandardowych.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 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 to:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

To pole jest wymagane. 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 przy użyciu reklamodawcy accessor.
modelReadiness[]

object (CustomBiddingModelReadinessState)

Tylko dane wyjściowe. Stan gotowości modelu ustalania stawek niestandardowych w przypadku każdego reklamodawcy, który ma do niego dostęp.

To pole może zawierać stan reklamodawcy, którego dotyczy zapytanie, tylko wtedy, gdy algorytm owner jest partnerem i jest pobierany przy użyciu reklamodawcy accessor.
customBiddingAlgorithmState

enum (State)

Tylko dane wyjściowe. Stan algorytmu ustalania stawek niestandardowych.
Pole sumy owner. Identyfikuje encję DV360, do której należy algorytm 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, do którego należy algorytm ustalania stawek niestandardowych.
advertiserId

string (int64 format)

Niezmienne. Unikalny identyfikator reklamodawcy, który jest właścicielem algorytmu 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 typ algorytmu nie jest określony lub jest nieznany.
SCRIPT_BASED Algorytm generowany na podstawie przesłanych przez klientów plików skryptu ustalania stawek niestandardowych.
ADS_DATA_HUB_BASED Algorytm utworzony w Centrum danych reklam.
GOAL_BUILDER_BASED Algorytm utworzony za pomocą kreatora celów w interfejsie DV360.

CustomBiddingModelReadinessState

Stan gotowości modelu algorytmu ustalania stawek niestandardowych w przypadku 1 udostępnianego reklamodawcy.

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

string (int64 format)

Unikalny identyfikator odpowiedniego reklamodawcy.
readinessState

enum (ReadinessState)

Stan gotowości 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 został wytrenowany i jest gotowy do wyświetlania.
READINESS_STATE_INSUFFICIENT_DATA Nie ma wystarczającej ilości danych, aby wytrenować model obsługi.
READINESS_STATE_TRAINING Model jest trenowany i nie jest gotowy do obsługi.
READINESS_STATE_NO_VALID_SCRIPT Nie przekazano prawidłowego skryptu ustalania stawek niestandardowych do trenowania modelu. Ten stan będzie stosowany tylko do algorytmów, których customBiddingAlgorithmType ma wartość SCRIPT_BASED.

Stan

Możliwe stany algorytmów ustalania stawek niestandardowych.

Wartości w polu enum
STATE_UNSPECIFIED Stan nie jest określony lub jest nieznany w tej wersji.
ENABLED Algorytm jest włączony – ostatnio używany, obecnie używany lub zaplanowany do użycia. Algorytm aktywnie nalicza wyświetlenia.
DORMANT Algorytm nie był ostatnio używany. Chociaż algorytm nadal działa jako ENABLED, zostanie zawieszony, jeśli nie będzie używany.
SUSPENDED Algorytm jest używany z oceniania wyświetleń i nie ma wytrenowanego modelu wyświetlania. Jeśli algorytm jest przypisany do elementu zamówienia lub w inny sposób zaktualizowany, powróci do stanu ENABLED i będzie potrzebować czasu na ponowne przygotowanie modelu wyświetlania.

Metody

create

 Tworzy nowy algorytm ustalania stawek niestandardowych.

get

 Pobiera algorytm ustalania stawek niestandardowych.

list

 Zawiera listę algorytmów ustalania stawek niestandardowych, które są dostępne dla bieżącego użytkownika i których można używać w strategiach ustalania stawek.

patch

 Aktualizuje obecny algorytm ustalania stawek niestandardowych.

uploadScript

 Tworzy obiekt referencyjny skryptu ustalania stawek niestandardowych na potrzeby pliku skryptu.