REST Resource: customBiddingAlgorithms

Recurso: CustomBiddingAlgorithm

Un algoritmo único de ofertas personalizadas.

Representación 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.
}
Campos
name

string

Solo salida. El nombre del recurso del algoritmo de ofertas personalizadas.
customBiddingAlgorithmId

string (int64 format)

Solo salida. El ID único del algoritmo de ofertas personalizadas. Lo asigna el sistema.
displayName

string

Obligatorio. El nombre visible del algoritmo de ofertas personalizadas.

Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.
entityStatus

enum (EntityStatus)

Controla si el algoritmo de ofertas personalizadas se puede utilizar o no como estrategia de oferta.

Valores aceptados:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obligatorio. Inmutable. Es el tipo de algoritmo de ofertas personalizadas.
sharedAdvertiserIds[]

string (int64 format)

Son los ID de los anunciantes que tienen acceso a este algoritmo. Si se configura advertiserId, este campo solo consistirá en ese valor.

No se establecerá este campo si el algoritmo owner es un socio y se recupera mediante un anunciante accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Solo salida. Detalles de los modelos de ofertas personalizadas para cada anunciante que tiene acceso

Este campo solo puede incluir los detalles del anunciante consultado si el algoritmo owner es un socio y se recupera mediante un anunciante accessor.
Campo de unión owner. Identifica la entidad de DV360 que posee el algoritmo de ofertas personalizadas. Puede ser un socio o un anunciante. Las direcciones (owner) solo pueden ser una de las siguientes opciones:
partnerId

string (int64 format)

Inmutable. Es el ID único del socio propietario del algoritmo de ofertas personalizadas.
advertiserId

string (int64 format)

Inmutable. Es el ID único del anunciante propietario del algoritmo de ofertas personalizadas.

CustomBiddingAlgorithmType

Tipos posibles de algoritmos de ofertas personalizadas.

Enumeradores
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED No se especificó el tipo de algoritmo o se desconoce en esta versión.
SCRIPT_BASED Algoritmo generado a través de archivos de secuencia de comandos de ofertas personalizadas subidos por el cliente.
ADS_DATA_HUB_BASED Algoritmo creado con el producto Centro de Datos de Anuncios
GOAL_BUILDER_BASED Algoritmo que se creó con el creador de objetivos en la IU de DV3.

CustomBiddingModelDetails

Detalles de un modelo de algoritmo de ofertas personalizadas para un solo anunciante compartido.

Representación JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Campos
advertiserId

string (int64 format)

Es el ID único del anunciante correspondiente.
readinessState

enum (ReadinessState)

El estado de preparación del modelo de ofertas personalizadas.
suspensionState

enum (SuspensionState)

Solo salida. Es el estado de suspensión del modelo de ofertas personalizadas.

ReadinessState

Estados posibles de la preparación del modelo.

Enumeradores
READINESS_STATE_UNSPECIFIED No se especificó el estado o es desconocido en esta versión.
READINESS_STATE_ACTIVE El modelo está entrenado y listo para la entrega.
READINESS_STATE_INSUFFICIENT_DATA No hay suficientes datos para entrenar el modelo de entrega.
READINESS_STATE_TRAINING El modelo se está entrenando y no está listo para la entrega.
READINESS_STATE_NO_VALID_SCRIPT No se proporcionó una secuencia de comandos válida de ofertas personalizadas para entrenar el modelo. Este estado solo se aplicará a los algoritmos cuyo customBiddingAlgorithmType es SCRIPT_BASED.

SuspensionState

Posibles estados de suspensión de los modelos de ofertas personalizadas.

Enumeradores
SUSPENSION_STATE_UNSPECIFIED No se especificó el estado o es desconocido en esta versión.
SUSPENSION_STATE_ENABLED El modelo está habilitado, ya sea usado recientemente, en uso actualmente o programado para su uso. El algoritmo califica las impresiones de este anunciante de forma activa.
SUSPENSION_STATE_DORMANT El modelo no se ha usado recientemente. Aunque el modelo aún actúa como ENABLED, con el tiempo se suspenderá si no se usa.
SUSPENSION_STATE_SUSPENDED El modelo está suspendido en las puntuaciones de impresiones y no se puede publicar. Si el algoritmo se asigna a una línea de pedido en este anunciante o se actualiza, volverá al estado ENABLED y necesitará tiempo para volver a preparar el modelo de publicación.

Métodos

create

 Crea un algoritmo de ofertas personalizadas nuevo.

get

 Obtiene un algoritmo de ofertas personalizadas.

list

 Se muestran los algoritmos de ofertas personalizadas a los que puede acceder el usuario actual y que se pueden utilizar en estrategias de ofertas.

patch

 Actualiza un algoritmo de ofertas personalizadas existente.

uploadScript

 Crea un objeto de referencia de secuencia de comandos de ofertas personalizadas para un archivo de secuencia de comandos.