REST Resource: customBiddingAlgorithms

Zasób: niestandardowy algorytm określania stawek

Jeden algorytm ustalania stawek niestandardowych.

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. 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 w strategii ustalania stawek niestandardowych można używać algorytmu ustalania stawek niestandardowych.

Akceptowane wartości:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

To pole jest wymagane. Stałe. 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.
modelDetails[]

object (CustomBiddingModelDetails)

Tylko dane wyjściowe. Szczegółowe informacje o modelach ustalania stawek niestandardowych w przypadku każdego reklamodawcy, który ma dostęp.

To pole może zawierać szczegóły reklamodawcy, którego dotyczy zapytanie, tylko wtedy, gdy algorytm owner jest partnerem i jest pobierany przy użyciu reklamodawcy accessor.
Pole sumy owner. Identyfikuje element DV360, do którego należy algorytm ustalania stawek niestandardowych. Może być partnerem lub reklamodawcą. owner może być tylko jedną z tych wartości:
partnerId

string (int64 format)

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

string (int64 format)

Stałe. 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 Typ algorytmu nie jest określony lub jest w tej wersji nieznany.
SCRIPT_BASED Algorytm wygenerowany za pomocą przesłanych przez klientów plików skryptów ustalania stawek niestandardowych.
ADS_DATA_HUB_BASED Algorytm utworzony za pomocą usługi Centrum danych reklam.
GOAL_BUILDER_BASED Algorytm utworzony za pomocą kreatora celów w interfejsie DV360.

CustomBiddingModelDetails

Szczegółowe informacje o modelu algorytmu ustalania stawek niestandardowych w przypadku 1 udostępnianego 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 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.

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 – ostatnio używany, obecnie używany lub zaplanowany do użycia. Algorytm aktywnie ocenia wyświetlenia w przypadku tego reklamodawcy.
SUSPENSION_STATE_DORMANT Model nie był ostatnio używany. Chociaż model nadal będzie działać jako ENABLED, zostanie zawieszony, jeśli nie będzie używany.
SUSPENSION_STATE_SUSPENDED Model jest zawieszony w ocenianiu wyświetleń i nie może realizować wyświetleń. Jeśli algorytm zostanie przypisany do elementu zamówienia w ramach tego reklamodawcy lub w inny sposób zaktualizowany, przełączy się z powrotem na ENABLED. Zaczekaj na ponowne przygotowanie modelu wyświetlania reklam.

Metody

create

 Tworzy nowy algorytm ustalania stawek niestandardowych.

get

 Pobiera algorytm ustalania stawek niestandardowych.

list

 Lista 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 w pliku skryptu obiekt referencyjny skryptu ustalania stawek niestandardowych.