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 Algorithmus für benutzerdefinierte Gebote.
customBiddingAlgorithmId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Algorithmus für die benutzerdefinierte Gebotseinstellung. Wird vom System zugewiesen.
displayName

string

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

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

enum (EntityStatus)

Damit wird festgelegt, 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 die benutzerdefinierte Gebotseinstellung.
sharedAdvertiserIds[]

string (int64 format)

Die IDs der Werbetreibenden, die Zugriff auf diesen Algorithmus haben. Wenn advertiserId festgelegt ist, besteht dieses Feld nur aus diesem 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 mit einem Werbetreibenden accessor abgerufen wird.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Optional. Nicht veränderbar. Gibt den Drittanbieter-Optimierungspartner an, der diesen Algorithmus verwaltet.
Gibt das DV360-Objekt an, zu dem der benutzerdefinierte Gebotsalgorithmus gehört. Es kann sich entweder um einen Partner oder einen Werbetreibenden handeln. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
partnerId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Partners, dem der Algorithmus für benutzerdefinierte Gebote 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 nicht angegeben oder in dieser Version unbekannt.
SCRIPT_BASED Algorithmus, der über 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 Kunden auf der Zulassungsliste verfügbar. Andere Kunden, die versuchen, diesen Typ zu verwenden, erhalten eine Fehlermeldung.

CustomBiddingModelDetails

Die Details eines Algorithmusmodells für benutzerdefinierte Gebote für einen einzelnen freigegebenen Werbetreibenden.

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

string (int64 format)

Die eindeutige ID des entsprechenden Werbetreibenden.
readinessState

enum (ReadinessState)

Der Bereitschaftsstatus des benutzerdefinierten Gebotsmodells.
suspensionState

enum (SuspensionState)

Nur Ausgabe. Der Sperrstatus des benutzerdefinierten Gebotsmodells.

ReadinessState

Mögliche Status der Modellbereitschaft.

Enums
READINESS_STATE_UNSPECIFIED Der Status ist nicht angegeben oder in dieser Version 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 Script für benutzerdefinierte Gebote bereitgestellt, mit dem das Modell trainiert werden kann. Dieser Status wird nur auf Algorithmen angewendet, deren customBiddingAlgorithmType SCRIPT_BASED ist.
READINESS_STATE_EVALUATION_FAILURE Es wurde ein gültiges Skript bereitgestellt, aber die Auswertung ist fehlgeschlagen. Dies gilt für Scripts, die nicht in der vorgegebenen Zeit ausgewertet werden konnten.

SuspensionState

Mögliche Sperrstatus von benutzerdefinierten Gebotsmodellen.

Enums
SUSPENSION_STATE_UNSPECIFIED Der Status ist nicht angegeben oder in dieser Version unbekannt.
SUSPENSION_STATE_ENABLED Das Modell ist aktiviert und wurde entweder vor Kurzem verwendet, wird derzeit verwendet oder soll demnächst verwendet werden. Der Algorithmus bewertet aktiv Impressionen für diesen Werbetreibenden.
SUSPENSION_STATE_DORMANT Das Modell wurde in letzter Zeit nicht verwendet. Das Modell fungiert zwar weiterhin als ENABLED, wird aber irgendwann gesperrt, wenn es nicht verwendet wird.
SUSPENSION_STATE_SUSPENDED Das Modell ist von der Bewertung von Impressionen ausgeschlossen und kann nicht ausgeliefert werden. Wenn der Algorithmus einer Werbebuchung dieses Werbetreibenden zugewiesen oder anderweitig aktualisiert wird, wechselt er wieder in den Status ENABLED. Es dauert dann eine Weile, bis das Auslieferungsmodell wieder bereit ist.

ThirdPartyOptimizationPartnerType

Mögliche Typen von Drittanbieter-Optimierungspartnern.

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

Methoden

create

 Erstellt einen neuen Algorithmus für benutzerdefinierte Gebote.

get

 Ruft einen Algorithmus für die benutzerdefinierte Gebotseinstellung ab.

list

 Hier werden Algorithmen für benutzerdefinierte Gebote 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 Gebote.

uploadRules

 Erstellt ein Regelreferenzobjekt für eine AlgorithmRules-Datei.

uploadScript

 Erstellt ein Referenzobjekt für ein Script für benutzerdefinierte Gebote für eine Scriptdatei.