REST Resource: customBiddingAlgorithms

Recurso: CustomBiddingAlgorithm

Un solo algoritmo de ofertas personalizadas.

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

string

Solo salida. Es el nombre del recurso del algoritmo de ofertas personalizadas.
customBiddingAlgorithmId

string (int64 format)

Solo salida. Es el ID único del algoritmo de ofertas personalizadas. Asignado por el sistema.
displayName

string

Obligatorio. Es 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 usar como estrategia de ofertas.

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 IDs de los anunciantes que tienen acceso a este algoritmo. Si se establece advertiserId, este campo solo constará de ese valor.

Este campo no se establecerá si el algoritmo owner es un socio y se recupera con un anunciante accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Solo salida. Son los detalles de los modelos de ofertas personalizadas de 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 con un anunciante accessor.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Opcional. Inmutable. Designa al socio de optimización externo que administra este algoritmo.
Identifica la entidad de DV360 propietaria del algoritmo de ofertas personalizadas. Puede ser un socio o un anunciante. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
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 que posee el algoritmo de ofertas personalizadas.
Fin de los campos mutuamente excluyentes.

CustomBiddingAlgorithmType

Son los posibles tipos de algoritmos de ofertas personalizadas.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED El tipo de algoritmo no se especificó o es desconocido en esta versión.
SCRIPT_BASED Es el algoritmo que se genera a través de los archivos de secuencias de comandos de ofertas personalizadas que sube el cliente.
RULE_BASED

Algoritmo basado en reglas definidas. Estas reglas se definen en la API con el objeto AlgorithmRules.

Este tipo de algoritmo solo está disponible para los clientes incluidos en la lista de entidades permitidas. Otros clientes que intenten usar este tipo recibirán un error.

CustomBiddingModelDetails

Son los 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)

Es 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

Son los estados posibles de preparación del modelo.

Enums
READINESS_STATE_UNSPECIFIED El estado no se especifica o es desconocido en esta versión.
READINESS_STATE_ACTIVE El modelo se entrena y está listo para entregarse.
READINESS_STATE_INSUFFICIENT_DATA No hay datos suficientes 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 de ofertas personalizadas válida para entrenar el modelo. Este estado solo se aplicará a los algoritmos cuyo customBiddingAlgorithmType sea SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Se proporcionó una secuencia de comandos válida, pero falló la evaluación. Esto se aplica a las secuencias de comandos que no se pudieron evaluar en el tiempo asignado.

SuspensionState

Son los posibles estados de suspensión de los modelos de ofertas personalizadas.

Enums
SUSPENSION_STATE_UNSPECIFIED El estado no se especifica o es desconocido en esta versión.
SUSPENSION_STATE_ENABLED El modelo está habilitado, ya sea porque se usó recientemente, se está usando o se programó para usarse. El algoritmo está asignando puntuaciones a las impresiones de este anunciante de forma activa.
SUSPENSION_STATE_DORMANT No se usó el modelo recientemente. Aunque el modelo sigue actuando como ENABLED, se suspenderá con el tiempo si no se usa.
SUSPENSION_STATE_SUSPENDED El modelo se suspendió para la puntuación de impresiones y no puede publicar anuncios. Si el algoritmo se asigna a una línea de pedido de este anunciante o se actualiza de otra manera, volverá al estado ENABLED y requerirá tiempo para volver a preparar el modelo de publicación.

ThirdPartyOptimizationPartnerType

Son los posibles tipos de socios de optimización externos.

Enums
UNKNOWN El valor del tipo no se especificó o es desconocido en esta versión.
SCIBIDS Es un proveedor de servicios de ciencia de datos externo con el que los socios o anunciantes de DV3 pueden asociarse.
ADELAIDE Es un proveedor de servicios de medición de atención de terceros con el que los socios o anunciantes de DV3 pueden asociarse.

Métodos

create

 Crea un algoritmo de ofertas personalizadas nuevo.

get

 Obtiene un algoritmo de ofertas personalizadas.

list

 Enumera los algoritmos de ofertas personalizadas a los que puede acceder el usuario actual y que se pueden usar en las estrategias de ofertas.

patch

 Actualiza un algoritmo de ofertas personalizadas existente.

uploadRules

 Crea un objeto de referencia de reglas para un archivo AlgorithmRules.

uploadScript

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