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 benutzerdefinierten Gebotsalgorithmus.
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 benutzerdefinierten Gebotsalgorithmus.

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, 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. Details zu Modellen für die benutzerdefinierte Gebotseinstellung für jeden Werbetreibenden, der Zugriff hat.

Dieses Feld kann nur die Details des angefragten 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 benutzerdefinierte Gebote zugewiesen ist. Es kann sich dabei 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 benutzerdefinierte Gebote 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 aus vom Kunden hochgeladenen Scriptdateien für die benutzerdefinierte Gebotseinstellung generiert wurde.
ADS_DATA_HUB_BASED Algorithmus, der mit dem Ads Data Hub-Produkt erstellt wurde.
GOAL_BUILDER_BASED Algorithmus, der über die Zielerstellung auf der DV3-Benutzeroberfläche erstellt wurde.
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 Modells für den Algorithmus 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 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 kann bereitgestellt werden.
READINESS_STATE_INSUFFICIENT_DATA Es sind nicht genügend Daten vorhanden, um das Auslieferungsmodell zu trainieren.
READINESS_STATE_TRAINING Das Modell wird gerade trainiert und kann noch 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 Es wurde ein gültiges Script bereitgestellt, das aber die Prüfung nicht bestanden hat. Dies gilt für Scripts, die nicht innerhalb der zugewiesenen Zeit ausgewertet werden konnten.

SuspensionState

Mögliche Sperrstatus 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 und wurde entweder vor Kurzem verwendet, wird gerade verwendet oder ist für die Verwendung geplant. 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 möglicherweise ausgesetzt, wenn es nicht verwendet wird.
SUSPENSION_STATE_SUSPENDED Das Modell ist für die Bewertung von Impressionen gesperrt und kann keine Anzeigen ausliefern. Wenn der Algorithmus einer Werbebuchung für diesen Werbetreibenden zugewiesen oder anderweitig aktualisiert wird, wechselt er zurück zum Status ENABLED. Es dauert dann einige Zeit, bis das Auslieferungsmodell wieder bereit ist.

Methoden

create

 Erstellt einen neuen Algorithmus für die benutzerdefinierte Gebotseinstellung.

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 benutzerdefinierte Gebote.

uploadRules

 Erstellt ein Regelreferenzobjekt für eine AlgorithmRules-Datei.

uploadScript

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