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
  ],
  "modelReadiness": [
    {
      object (CustomBiddingModelReadinessState)
    }
  ],
  "customBiddingAlgorithmState": enum (State),

  // 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. Asignada por el sistema.
displayName

string

Obligatorio. Indica 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 o no como estrategia de ofertas.

Valores aceptados:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obligatorio. Inmutable. 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 configura advertiserId, este campo solo constará de ese valor.

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

object (CustomBiddingModelReadinessState)

Solo salida. Es el estado del nivel de preparación del modelo de ofertas personalizadas de cada anunciante que tiene acceso.

Este campo solo puede incluir el estado del anunciante consultado si el algoritmo owner es un socio y se recupera mediante un anunciante accessor.
customBiddingAlgorithmState

enum (State)

Solo salida. El estado del algoritmo de ofertas personalizadas.
Campo de unión owner. Identifica la entidad de DV360 que es propietaria del 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.

Enumeraciones
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED En esta versión, el tipo de algoritmo no se especifica o es desconocido.
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 a través del producto del Centro de Datos de Anuncios.
GOAL_BUILDER_BASED Algoritmo creado a través del creador de objetivos en la IU de DV3.

CustomBiddingModelReadinessState

El estado de preparación del modelo del algoritmo de ofertas personalizadas para un solo anunciante compartido.

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

string (int64 format)

Es el ID único del anunciante relevante.
readinessState

enum (ReadinessState)

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

ReadinessState

Posibles estados de preparación del modelo.

Enumeraciones
READINESS_STATE_UNSPECIFIED No se especifica el estado en esta versión o se desconoce.
READINESS_STATE_ACTIVE El modelo está entrenado y listo para la entrega.
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.

Estado

Son los posibles estados de los algoritmos de ofertas personalizadas.

Enumeraciones
STATE_UNSPECIFIED No se especifica el estado en esta versión o se desconoce.
ENABLED El algoritmo está habilitado, se usó recientemente, está en uso actualmente o está programado para usarse. El algoritmo asigna impresiones de forma activa.
DORMANT No se usó el algoritmo recientemente. Aunque el algoritmo aún actúa como ENABLED, con el tiempo se suspenderá si no se usa.
SUSPENDED Se suspende el algoritmo de la puntuación de impresiones y no tiene un modelo de publicación entrenado. Si el algoritmo se asigna a una línea de pedido o se actualiza de alguna otra manera, volverá al estado ENABLED y necesitará tiempo para volver a preparar el modelo de publicación.

Métodos

create

 Crea un nuevo algoritmo de ofertas personalizadas.

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.