REST Resource: customBiddingAlgorithms

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)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
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ées.

Doit être encodé en UTF-8 avec une taille maximale de 240 octets.
entityStatus

enum (EntityStatus)

Détermine 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 qu'il 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ées pour chaque annonceur qui y a 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.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Facultatif. Immuable. Désigne le partenaire d'optimisation tiers qui gère cet algorithme.
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. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
partnerId

string (int64 format)

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

string (int64 format)

Immuable. Identifiant unique de l'annonceur propriétaire de l'algorithme d'enchères personnalisées.
Fin des champs mutuellement exclusifs.

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.
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 figurant sur la liste d'autorisation. Les autres clients qui tentent d'utiliser ce type recevront une 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 l'aptitude 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 mis en service.
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 pour la mise 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 sera appliqué qu'aux algorithmes dont l'état customBiddingAlgorithmType est 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 temps 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é, qu'il ait été utilisé récemment, qu'il soit en cours d'utilisation ou qu'il soit programmé 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 sera suspendu s'il n'est pas utilisé.
SUSPENSION_STATE_SUSPENDED Le modèle est suspendu de l'évaluation des impressions et ne peut pas être diffusé. Si l'algorithme est attribué à un élément de campagne de cet annonceur ou s'il est mis à jour, il repasse à l'état ENABLED et nécessite un certain temps pour préparer à nouveau le modèle de diffusion.

ThirdPartyOptimizationPartnerType

Types de partenaires d'optimisation tiers possibles.

Enums
UNKNOWN La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
SCIBIDS Fournisseur de services de data science tiers avec lequel les partenaires/annonceurs DV3 peuvent s'associer.
ADELAIDE Fournisseur tiers de services de mesure de l'attention avec lequel les partenaires/annonceurs DV3 peuvent s'associer.

Méthodes

create

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

get

 Récupère un algorithme d'enchères personnalisées.

list

 Répertorie 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.