REST Resource: customBiddingAlgorithms

Ressource: CustomBiddingAlgorithm

Ein einzelner Algorithmus für die benutzerdefinierte Gebotseinstellung

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname des Algorithmus für die benutzerdefinierte Gebotseinstellung.
customBiddingAlgorithmId

string (int64 format)

Nur Ausgabe. Die eindeutige ID des Algorithmus für die benutzerdefinierte Gebotseinstellung. 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 die benutzerdefinierte Gebotseinstellung 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, enthält dieses Feld nur diesen Wert.

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

object (CustomBiddingModelDetails)

Nur Ausgabe. Details zu Modellen für die benutzerdefinierte Gebotseinstellung 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 Werbetreibenden accessor abgerufen wird.
Union-Feld owner. Die DV360-Entität, der der Algorithmus für die benutzerdefinierte Gebotseinstellung gehört. Dabei kann es sich entweder um einen Partner oder einen Werbetreibenden handeln. Für owner ist nur einer der folgenden Werte zulässig:
partnerId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Partners, dem der Algorithmus für die benutzerdefinierte Gebotseinstellung gehört.
advertiserId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Werbetreibenden, dem der Algorithmus für die benutzerdefinierte Gebotseinstellung gehört.

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 über vom Kunden hochgeladene Scriptdateien für die benutzerdefinierte Gebotseinstellung generiert wird
ADS_DATA_HUB_BASED Algorithmus, der über Ads Data Hub erstellt wurde.
GOAL_BUILDER_BASED Algorithmus, der mit der Funktion „Zielerstellung“ in der DV3-Benutzeroberfläche erstellt wurde
RULE_BASED

Auf definierten Regeln basierender Algorithmus. Diese Regeln werden in der API mithilfe des AlgorithmRules-Objekts definiert.

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

CustomBiddingModelDetails

Die Details eines Algorithmusmodells für die benutzerdefinierte Gebotseinstellung 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 entsprechenden Werbetreibenden.
readinessState

enum (ReadinessState)

Der Bereitschaftsstatus des Modells für die benutzerdefinierte Gebotseinstellung.
suspensionState

enum (SuspensionState)

Nur Ausgabe. Der Sperrungsstatus des Modells für die benutzerdefinierte Gebotseinstellung.

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 einsatzbereit.
READINESS_STATE_INSUFFICIENT_DATA Es sind nicht genügend Daten vorhanden, um das Bereitstellungsmodell zu trainieren.
READINESS_STATE_TRAINING Das Modell wird noch trainiert und kann nicht bereitgestellt werden.
READINESS_STATE_NO_VALID_SCRIPT Es wurde kein gültiges Script für die benutzerdefinierte Gebotseinstellung zum Trainieren des Modells angegeben. Dieser Status wird nur auf Algorithmen angewendet, deren customBiddingAlgorithmType SCRIPT_BASED ist.
READINESS_STATE_EVALUATION_FAILURE Ein gültiges Skript wurde angegeben, die Auswertung ist jedoch fehlgeschlagen. Dies gilt für Skripts, die nicht in der vorgesehenen Zeit ausgewertet werden konnten.

SuspensionState

Mögliche Sperrungsstatus von Modellen für die benutzerdefinierte Gebotseinstellung.

Enums
SUSPENSION_STATE_UNSPECIFIED Der Status ist in dieser Version nicht angegeben oder unbekannt.
SUSPENSION_STATE_ENABLED Das Modell ist aktiviert, entweder „kürzlich verwendet“, „derzeit verwendet“ oder „Verwendung geplant“. Durch den Algorithmus werden Impressionen für diesen Werbetreibenden aktiv bewertet.
SUSPENSION_STATE_DORMANT Das Modell wurde in letzter Zeit nicht verwendet. Das Modell fungiert zwar weiterhin als ENABLED, wird aber möglicherweise ausgesetzt, wenn es nicht verwendet wird.
SUSPENSION_STATE_SUSPENDED Das Modell kann keine Impressionen mehr bewerten und kann nicht ausgeliefert werden. Wenn der Algorithmus einer Werbebuchung unter diesem Werbetreibenden zugewiesen oder anderweitig aktualisiert wird, wechselt er zurück zum Status ENABLED und braucht Zeit, um das Auslieferungsmodell noch einmal vorzubereiten.

Methoden

create

 Ein neuer Algorithmus für die benutzerdefinierte Gebotseinstellung wird erstellt.

get

 Ruft einen Algorithmus für die benutzerdefinierte Gebotseinstellung ab.

list

 Listet benutzerdefinierte Gebotsalgorithmen auf, auf die der aktuelle Nutzer zugreifen kann und die in Gebotsstrategien verwendet werden können.

patch

 Aktualisiert einen vorhandenen Algorithmus für die benutzerdefinierte Gebotseinstellung.

uploadRules

 Erstellt ein Regelreferenzobjekt für eine AlgorithmRules-Datei.

uploadScript

 Erstellt ein Skript-Referenzobjekt für die benutzerdefinierte Gebotseinstellung für eine Skriptdatei.