REST Resource: customBiddingAlgorithms

Zasób: CustomBidAlgorithm

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

Wymagane. Wyświetlana nazwa algorytmu ustalania stawek niestandardowych.

Musi być zakodowany w standardzie UTF-8 i 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:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Wymagane. Stały. Typ algorytmu ustalania stawek niestandardowych.
sharedAdvertiserIds[]

string (int64 format)

Identyfikatory reklamodawców, którzy mają dostęp do tego algorytmu. Jeśli jest ustawiona 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.
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 za pomocą reklamodawcy accessor.
customBiddingAlgorithmState

enum (State)

Tylko dane wyjściowe. Stan algorytmu ustalania stawek niestandardowych.
Pole sumy owner. Identyfikuje element DV360, do którego 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)

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

string (int64 format)

Stały. 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 Typ algorytmu nie został określony lub jest nieznany w tej wersji.
SCRIPT_BASED Algorytm wygenerowany na podstawie przesłanych przez klientów plików skryptów 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.

CustomBiddingModelReadinessState

Stan gotowości modelu algorytmu ustalania stawek niestandardowych w przypadku pojedynczego reklamodawcy współdzielonego.

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 W tej wersji stan nie został określony lub jest nieznany.
READINESS_STATE_ACTIVE Model został wytrenowany i jest gotowy do wyświetlania.
READINESS_STATE_INSUFFICIENT_DATA Za mało danych, by wytrenować model wyświetlania.
READINESS_STATE_TRAINING Model jest trenowany i nie jest gotowy do udostępniania.
READINESS_STATE_NO_VALID_SCRIPT Nie dostarczono prawidłowego skryptu ustalania stawek niestandardowych, którego można użyć 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 W tej wersji stan nie został określony lub jest nieznany.
ENABLED Algorytm jest włączony – jest ostatnio używany, obecnie używany lub ma być używany. Algorytm aktywnie określa liczbę wyświetleń.
DORMANT Algorytm nie był ostatnio używany. Chociaż algorytm nadal działa jako ENABLED, jeśli nie jest używany, zostanie w końcu zawieszony.
SUSPENDED Algorytm jest używany na podstawie określania wyświetleń i nie został wytrenowany model wyświetlania. Jeśli algorytm zostanie przypisany do elementu zamówienia lub zostanie w inny sposób zaktualizowany, powróci do stanu ENABLED i ponowne przygotowanie modelu wyświetlania będzie wymagało czasu.

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 dotychczasowy algorytm ustalania stawek niestandardowych.

uploadScript

 Tworzy obiekt referencyjny skryptu ustalania stawek niestandardowych dla pliku skryptu.