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)
    }
  ],

  // 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 benutzerdefinierten Gebotsalgorithmus. Vom System zugewiesen.
displayName

string

Erforderlich. Der Anzeigename des benutzerdefinierten Gebotsalgorithmus.

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

enum (EntityStatus)

Legt fest, ob der benutzerdefinierte Gebotsalgorithmus 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 Werbetreibenden accessor abgerufen wird.
Union-Feld owner. Kennzeichnet die DV360-Einheit, zu der der benutzerdefinierte Gebotsalgorithmus gehört. 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, der den benutzerdefinierten Gebotsalgorithmus besitzt.
advertiserId

string (int64 format)

Nicht veränderbar. Die eindeutige ID des Werbetreibenden, dem der benutzerdefinierte Gebotsalgorithmus 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 durch vom Kunden hochgeladene Scriptdateien für benutzerdefinierte Gebote generiert wird.
ADS_DATA_HUB_BASED

EINGESTELLT: ADS_DATA_HUB_BASED wurde eingestellt. Algorithmus, der über das Ads Data Hub-Produkt erstellt wurde.
GOAL_BUILDER_BASED

DEPRECATED: GOAL_BUILDER_BASED wurde eingestellt, wird nicht mehr unterstützt und wurde durch RULE_BASED ersetzt. Algorithmus, der über das Tool zur Zielerstellung in der DV3-Benutzeroberfläche erstellt wurde.

Vorhandene Algorithmen dieses Typs wurden zu RULE_BASED migriert.
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 diesen Typ verwenden, erhalten eine Fehlermeldung.

CustomBiddingModelDetails

Die Details eines Modells für benutzerdefinierte Gebotsalgorithmen 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 relevanten Werbetreibenden.
readinessState

enum (ReadinessState)

Der Bereitschaftsstatus des Modells für benutzerdefiniertes Gebot.
suspensionState

enum (SuspensionState)

Nur Ausgabe. Der Status des benutzerdefinierten Gebotsmodells.

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 ist noch nicht bereit für die Bereitstellung.
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 angegeben, das die Überprüfung jedoch nicht bestanden hat. Dies gilt für Scripts, die in der zugewiesenen Zeit nicht ausgewertet werden konnten.

SuspensionState

Mögliche Sperrungsstatus 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 vor Kurzem verwendet, wird gerade 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 bei Nichtverwendung irgendwann gesperrt.
SUSPENSION_STATE_SUSPENDED Das Modell bewertet keine Impressionen mehr 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 Bereitstellungsmodell wieder vorbereitet ist.

Methoden

create

 Erstellt einen neuen Algorithmus für benutzerdefinierte Gebote.

get

 Ruft einen Algorithmus für benutzerdefinierte Gebote 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 Regelnreferenzobjekt für eine AlgorithmRules-Datei.

uploadScript

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