REST Resource: customBiddingAlgorithms

Ressource: CustomBiddingAlgorithm

Ein einzelner Algorithmus für benutzerdefinierte Gebote.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname des benutzerdefinierten Gebotsalgorithmus.
customBiddingAlgorithmId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des benutzerdefinierten Gebotsalgorithmus. Vom System zugewiesen.
displayName

string

Erforderlich. Der Anzeigename des benutzerdefinierten Algorithmus für die Gebotseinstellung.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein.
entityStatus

enum (EntityStatus)

Steuert, ob der Algorithmus für benutzerdefinierte Gebote als Gebotsstrategie verwendet werden kann.

Zulässige Werte:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Erforderlich. Nicht veränderbar. Der Typ des Algorithmus für benutzerdefinierte Gebote.
sharedAdvertiserIds[]

string (int64 format)

Die IDs der Werbetreibenden, die Zugriff auf diesen Algorithmus haben. Wenn advertiserId festgelegt ist, enthält dieses Feld nur diesen Wert.

Dieses Feld wird nicht festgelegt, wenn der Algorithmus owner ein Partner ist und über einen Werbetreibenden accessor abgerufen wird.
modelDetails[]

object (CustomBiddingModelDetails)

Nur Ausgabe. Die Details der benutzerdefinierten Gebotsmodelle für jeden Werbetreibenden, der Zugriff hat.

Dieses Feld darf nur die Details des abgefragten Werbetreibenden enthalten, wenn der Algorithmus owner ein Partner ist und über einen accessor-Werbetreibenden abgerufen wird.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Optional. Nicht veränderbar. Gibt den Drittanbieter-Optimierungspartner an, der diesen Algorithmus verwaltet.
Kennzeichnet die DV360-Einheit, zu der der benutzerdefinierte Gebotsalgorithmus gehört. Das kann ein Partner oder ein Werbetreibender sein. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
partnerId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Partners, dem der benutzerdefinierte Gebotsalgorithmus gehört.
advertiserId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Werbetreibenden, dem der Algorithmus für benutzerdefinierte Gebote gehört.
Ende der sich gegenseitig ausschließenden Felder.

CustomBiddingAlgorithmType

Mögliche Arten von Algorithmen für die benutzerdefinierte Gebotseinstellung.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Der Algorithmustyp ist in dieser Version nicht angegeben oder unbekannt.
SCRIPT_BASED Algorithmus, der durch vom Kunden hochgeladene Scriptdateien für benutzerdefinierte Gebote generiert wird.
RULE_BASED

Algorithmus, der auf definierten Regeln basiert. Diese Regeln werden in der API mit dem Objekt AlgorithmRules definiert.

Dieser Algorithmustyp ist nur für zugelassene Kunden verfügbar. Andere Kunden, die diesen Typ verwenden möchten, erhalten eine Fehlermeldung.

CustomBiddingModelDetails

Die Details eines Modells für benutzerdefinierte Gebotsalgorithmen für einen einzelnen gemeinsamen Werbetreibenden.

JSON-Darstellung 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Felder
advertiserId

string (int64 format)

Die eindeutige ID des relevanten Werbetreibenden.
readinessState

enum (ReadinessState)

Der Bereitschaftsstatus des Modells für benutzerdefiniertes Gebot.
suspensionState

enum (SuspensionState)

Nur Ausgabe. Der Status des Modells für benutzerdefiniertes Gebot.

ReadinessState

Mögliche Status der Modellbereitschaft.

Enums
READINESS_STATE_UNSPECIFIED Der Status ist in dieser Version nicht angegeben oder unbekannt.
READINESS_STATE_ACTIVE Das Modell ist trainiert und kann bereitgestellt werden.
READINESS_STATE_INSUFFICIENT_DATA Es sind nicht genügend Daten vorhanden, um das Bereitstellungsmodell zu trainieren.
READINESS_STATE_TRAINING Das Modell wird trainiert und kann noch nicht bereitgestellt werden.
READINESS_STATE_NO_VALID_SCRIPT Es wurde kein gültiges benutzerdefiniertes Gebotsscript für das Training des Modells bereitgestellt. Dieser Status wird nur auf Algorithmen angewendet, deren customBiddingAlgorithmType SCRIPT_BASED ist.
READINESS_STATE_EVALUATION_FAILURE Es wurde ein gültiges Script bereitgestellt, das die Auswertung jedoch nicht bestanden hat. Dies gilt für Scripts, die im zugewiesenen Zeitraum nicht ausgewertet werden konnten.

SuspensionState

Mögliche Sperrstatus von Modellen für benutzerdefinierte Gebote.

Enums
SUSPENSION_STATE_UNSPECIFIED Der Status ist in dieser Version nicht angegeben oder unbekannt.
SUSPENSION_STATE_ENABLED Das Modell ist aktiviert, wurde entweder kürzlich verwendet, wird derzeit verwendet oder soll verwendet werden. Der Algorithmus bewertet aktiv Impressionen für diesen Werbetreibenden.
SUSPENSION_STATE_DORMANT Das Modell wurde in letzter Zeit nicht verwendet. Obwohl das Modell weiterhin als ENABLED fungiert, wird es irgendwann gesperrt, wenn es nicht verwendet wird.
SUSPENSION_STATE_SUSPENDED Das Modell ist für die Bewertung von Impressionen gesperrt und kann nicht ausgeliefert werden. Wenn der Algorithmus einer Werbebuchung unter diesem Werbetreibenden zugewiesen oder anderweitig aktualisiert wird, wechselt er zurück in den Status ENABLED und es dauert einige Zeit, bis das Auslieferungsmodell wieder vorbereitet ist.

ThirdPartyOptimizationPartnerType

Mögliche Arten von Drittanbieter-Optimierungspartnern.

Enums
UNKNOWN Der Typwert ist in dieser Version nicht angegeben oder unbekannt.
SCIBIDS Datenserviceanbieter von Drittanbietern, mit denen DV3-Partner/Werbetreibende zusammenarbeiten können.
ADELAIDE Drittanbieter für die Messung der Aufmerksamkeit, mit denen DV3-Partner/Werbetreibende zusammenarbeiten können.

Methoden

create

 Erstellt einen neuen Algorithmus für benutzerdefinierte Gebote.

get

 Ruft einen Algorithmus für benutzerdefinierte Gebote ab.

list

 Hier werden benutzerdefinierte Gebotsalgorithmen aufgeführt, auf die der aktuelle Nutzer zugreifen kann und die in Gebotsstrategien verwendet werden können.

patch

 Aktualisiert einen vorhandenen Algorithmus für benutzerdefinierte Gebotseinstellungen.

uploadRules

 Erstellt ein Regelnreferenzobjekt für eine AlgorithmRules-Datei.

uploadScript

 Erstellt ein Referenzobjekt für ein Script für die benutzerdefinierte Gebotseinstellung für eine Scriptdatei.