REST Resource: customBiddingAlgorithms

L'

Ressource : CustomBiddingAlgorithm

Algorithme d'enchères personnalisées unique.

Représentation JSON 
{
  "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.
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'algorithme d'enchères personnalisées.
customBiddingAlgorithmId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'algorithme d'enchères personnalisées. Attribué par le système.
displayName

string

Obligatoire. Nom à afficher de l'algorithme d'enchères personnalisé.

Doit être encodé au format UTF-8 et ne pas dépasser 240 octets.
entityStatus

enum (EntityStatus)

Permet de déterminer si l'algorithme d'enchères personnalisées peut être utilisé comme stratégie d'enchères.

Les valeurs acceptées sont les suivantes :

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obligatoire. Immuable. Type d'algorithme d'enchères personnalisées.
sharedAdvertiserIds[]

string (int64 format)

ID des annonceurs ayant accès à cet algorithme. Si advertiserId est défini, ce champ ne contiendra que cette valeur.

Ce champ ne sera pas défini si l'algorithme owner est un partenaire et est récupéré à l'aide d'un accessor d'annonceur.
modelDetails[]

object (CustomBiddingModelDetails)

Uniquement en sortie. Détails des modèles d'enchères personnalisés pour chaque annonceur y ayant accès.

Ce champ ne peut inclure les détails de l'annonceur interrogé que si l'algorithme owner est un partenaire et qu'il est récupéré à l'aide d'un accessor d'annonceur.
Champ d'union owner. Identifie l'entité DV360 propriétaire de l'algorithme d'enchères personnalisées. Il peut s'agir d'un partenaire ou d'un annonceur. owner ne peut être qu'un des éléments suivants :
partnerId

string (int64 format)

Immuable. Identifiant unique du partenaire propriétaire de l'algorithme d'enchères personnalisé.
advertiserId

string (int64 format)

Immuable. Identifiant unique de l'annonceur propriétaire de l'algorithme d'enchères personnalisées.

CustomBiddingAlgorithmType

Types possibles d'algorithmes d'enchères personnalisées.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Le type d'algorithme n'est pas spécifié ou est inconnu dans cette version.
SCRIPT_BASED Algorithme généré à partir de fichiers de script d'enchères personnalisées importés par le client.
ADS_DATA_HUB_BASED

OBSOLÈTE : ADS_DATA_HUB_BASED est obsolète. Algorithme créé avec le produit Ads Data Hub.
GOAL_BUILDER_BASED

OBSOLÈTE : GOAL_BUILDER_BASED est obsolète, n'est plus compatible et a été remplacé par RULE_BASED. Algorithme créé à l'aide de l'outil de création d'objectifs dans l'UI DV360.

Les algorithmes existants de ce type ont été migrés vers RULE_BASED.
RULE_BASED

Algorithme basé sur des règles définies. Ces règles sont définies dans l'API à l'aide de l'objet AlgorithmRules.

Ce type d'algorithme n'est disponible que pour les clients inclus dans la liste d'autorisation. Les autres clients qui tentent d'utiliser ce type recevront un message d'erreur.

CustomBiddingModelDetails

Détails d'un modèle d'algorithme d'enchères personnalisées pour un seul annonceur partagé.

Représentation JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Champs
advertiserId

string (int64 format)

Identifiant unique de l'annonceur concerné.
readinessState

enum (ReadinessState)

État de préparation du modèle d'enchères personnalisées.
suspensionState

enum (SuspensionState)

Uniquement en sortie. État de suspension du modèle d'enchères personnalisées.

ReadinessState

États possibles de préparation du modèle.

Enums
READINESS_STATE_UNSPECIFIED L'état n'est pas spécifié ou est inconnu dans cette version.
READINESS_STATE_ACTIVE Le modèle est entraîné et prêt à être utilisé.
READINESS_STATE_INSUFFICIENT_DATA Les données sont insuffisantes pour entraîner le modèle de diffusion.
READINESS_STATE_TRAINING Le modèle est en cours d'entraînement et n'est pas prêt à être mis en service.
READINESS_STATE_NO_VALID_SCRIPT Aucun script d'enchères personnalisées valide n'a été fourni pour entraîner le modèle. Cet état ne s'appliquera qu'aux algorithmes dont customBiddingAlgorithmType est défini sur SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Un script valide a été fourni, mais l'évaluation a échoué. Cela s'applique aux scripts qui n'ont pas pu être évalués dans le délai imparti.

SuspensionState

États de suspension possibles des modèles d'enchères personnalisées.

Enums
SUSPENSION_STATE_UNSPECIFIED L'état n'est pas spécifié ou est inconnu dans cette version.
SUSPENSION_STATE_ENABLED Le modèle est activé, utilisé récemment, en cours d'utilisation ou prévu pour être utilisé. L'algorithme évalue activement les impressions pour cet annonceur.
SUSPENSION_STATE_DORMANT Le modèle n'a pas été utilisé récemment. Bien que le modèle agisse toujours en tant que ENABLED, il finira par être suspendu s'il n'est pas utilisé.
SUSPENSION_STATE_SUSPENDED Le modèle est suspendu et ne peut pas évaluer les impressions ni diffuser d'annonces. Si l'algorithme est attribué à un élément de campagne de cet annonceur ou mis à jour d'une autre manière, il repassera à l'état ENABLED et nécessitera du temps pour préparer à nouveau le modèle de diffusion.

Méthodes

create

 Crée un algorithme d'enchères personnalisées.

get

 Permet d'obtenir un algorithme d'enchères personnalisées.

list

 Liste les algorithmes d'enchères personnalisées accessibles à l'utilisateur actuel et pouvant être utilisés dans les stratégies d'enchères.

patch

 Met à jour un algorithme d'enchères personnalisées existant.

uploadRules

 Crée un objet de référence de règles pour un fichier AlgorithmRules.

uploadScript

 Crée un objet de référence de script d'enchères personnalisées pour un fichier de script.