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)

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

Zulässige Werte sind:

  • 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 das Feld nur aus diesem Wert.

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

object (CustomBiddingModelDetails)

Nur Ausgabe Details zu benutzerdefinierten Gebotsmodellen für jeden Werbetreibenden, der Zugriff hat.

Dieses Feld darf die Details des abgefragten Werbetreibenden nur enthalten, wenn der Algorithmus owner ein Partner ist und mithilfe eines Werbetreibenden accessor abgerufen wird.
Union-Feld owner. Bezeichnet die DV360-Entität, die Inhaber des Algorithmus für die benutzerdefinierte Gebotseinstellung ist. Das kann entweder ein Partner oder ein Werbetreibender sein. 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 nicht angegeben oder in dieser Version unbekannt.
SCRIPT_BASED Algorithmus, der durch von 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 Mit der Zielerstellung in der DV3-Benutzeroberfläche erstellter Algorithmus.
RULE_BASED

Algorithmus, der auf definierten Regeln basiert. 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

Details zum Algorithmusmodell 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)

Bereitschaftsstatus des benutzerdefinierten Gebotsmodells.
suspensionState

enum (SuspensionState)

Nur Ausgabe Der Sperrungsstatus 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 bereit für die Bereitstellung.
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 nicht bereitgestellt werden.
READINESS_STATE_NO_VALID_SCRIPT Es wurde kein gültiges Script für die benutzerdefinierte Gebotseinstellung 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 angegeben, aber die Auswertung ist fehlgeschlagen. Dies gilt für Skripts, die nicht in der vorgesehenen Zeit ausgewertet werden konnten.

SuspensionState

Mögliche Sperrungsstatus von benutzerdefinierten Gebotsmodellen.

Enums
SUSPENSION_STATE_UNSPECIFIED Der Status ist nicht angegeben oder in dieser Version unbekannt.
SUSPENSION_STATE_ENABLED Das Modell ist aktiviert, entweder vor Kurzem verwendet, wird aktuell verwendet oder ist zur Verwendung geplant. Der Algorithmus bewertet die Impressionen für diesen Werbetreibenden aktiv.
SUSPENSION_STATE_DORMANT Das Modell wurde in letzter Zeit nicht verwendet. Obwohl das Modell weiterhin als ENABLED fungiert, wird es möglicherweise gesperrt, wenn es nicht verwendet wird.
SUSPENSION_STATE_SUSPENDED Das Modell ist für das Bewerten von Impressionen gesperrt und kann nicht ausgeliefert werden. Wenn der Algorithmus einer Werbebuchung dieses Werbetreibenden zugewiesen oder anderweitig aktualisiert wird, wird er auf den Status ENABLED zurückgesetzt und es dauert etwas, bis das Auslieferungsmodell noch einmal vorbereitet 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, die für den aktuellen Nutzer zugänglich sind und für 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 Skriptreferenzobjekt für die benutzerdefinierte Gebotseinstellung für eine Skriptdatei.