REST Resource: customBiddingAlgorithms

Recurso: CustomBiddingAlgorithm

Um único algoritmo de lances personalizados.

Representação 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

Apenas saída. O nome do recurso do algoritmo de lances personalizados.
customBiddingAlgorithmId

string (int64 format)

Apenas saída. O ID exclusivo do algoritmo de lances personalizados. Atribuído pelo sistema.
displayName

string

Obrigatório. O nome de exibição do algoritmo de lances personalizados.

Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes.
entityStatus

enum (EntityStatus)

Controla se o algoritmo de lances personalizados pode ser usado como uma estratégia de lances.

Os valores aceitos são:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obrigatório. Imutável. O tipo de algoritmo de lances personalizados.
sharedAdvertiserIds[]

string (int64 format)

Os IDs dos anunciantes que têm acesso a esse algoritmo. Se advertiserId estiver definido, esse campo vai consistir apenas nesse valor.

Esse campo não será definido se o algoritmo owner for um parceiro e estiver sendo recuperado usando um accessor de anunciante.
modelDetails[]

object (CustomBiddingModelDetails)

Apenas saída. Os detalhes dos modelos de lances personalizados para cada anunciante que tem acesso.

Esse campo só pode incluir os detalhes do anunciante consultado se o algoritmo owner for um parceiro e estiver sendo recuperado usando um accessor de anunciante.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Opcional. Imutável. Designa o parceiro de otimização terceirizado que gerencia esse algoritmo.
Identifica a entidade do DV360 que é proprietária do algoritmo de lances personalizados. Pode ser um parceiro ou um anunciante. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
partnerId

string (int64 format)

Imutável. O ID exclusivo do parceiro proprietário do algoritmo de lances personalizados.
advertiserId

string (int64 format)

Imutável. O ID exclusivo do anunciante proprietário do algoritmo de lances personalizados.
Fim dos campos mutuamente exclusivos.

CustomBiddingAlgorithmType

Tipos possíveis de algoritmos de lances personalizados.

Tipos enumerados
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED O tipo de algoritmo não foi especificado ou é desconhecido nesta versão.
SCRIPT_BASED Algoritmo gerado por arquivos de script de lances personalizados enviados pelo cliente.
RULE_BASED

Algoritmo baseado em regras definidas. Essas regras são definidas na API usando o objeto AlgorithmRules.

Esse tipo de algoritmo está disponível apenas para clientes na lista de permissões. Outros clientes que tentarem usar esse tipo vão receber um erro.

CustomBiddingModelDetails

Os detalhes de um modelo de algoritmo de lances personalizados para um único anunciante compartilhado.

Representação JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Campos
advertiserId

string (int64 format)

O ID exclusivo do anunciante relevante.
readinessState

enum (ReadinessState)

O estado de prontidão do modelo de lances personalizados.
suspensionState

enum (SuspensionState)

Apenas saída. O estado de suspensão do modelo de lances personalizados.

ReadinessState

Possíveis estados de prontidão do modelo.

Tipos enumerados
READINESS_STATE_UNSPECIFIED O estado não foi especificado ou é desconhecido nesta versão.
READINESS_STATE_ACTIVE O modelo está treinado e pronto para disponibilização.
READINESS_STATE_INSUFFICIENT_DATA Não há dados suficientes para treinar o modelo de veiculação.
READINESS_STATE_TRAINING O modelo está em treinamento e não está pronto para disponibilização.
READINESS_STATE_NO_VALID_SCRIPT Não foi fornecido um script de lances personalizados válido para treinar o modelo. Esse estado só será aplicado a algoritmos em que customBiddingAlgorithmType é SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Um script válido foi fornecido, mas não foi avaliado. Isso é aplicável a scripts que não puderam ser avaliados no tempo alocado.

SuspensionState

Possíveis estados de suspensão de modelos de lances personalizados.

Tipos enumerados
SUSPENSION_STATE_UNSPECIFIED O estado não foi especificado ou é desconhecido nesta versão.
SUSPENSION_STATE_ENABLED O modelo está ativado, foi usado recentemente, está sendo usado ou está programado para ser usado. O algoritmo está pontuando ativamente as impressões para esse anunciante.
SUSPENSION_STATE_DORMANT O modelo não foi usado recentemente. Embora o modelo ainda funcione como ENABLED, ele será suspenso se não for usado.
SUSPENSION_STATE_SUSPENDED O modelo está suspenso de registrar impressões e não pode ser veiculado. Se o algoritmo for atribuído a um item de linha desse anunciante ou atualizado, ele vai voltar ao estado ENABLED e precisará de tempo para preparar o modelo de veiculação novamente.

ThirdPartyOptimizationPartnerType

Possíveis tipos de parceiros de otimização terceirizados.

Tipos enumerados
UNKNOWN O valor do tipo não foi especificado ou é desconhecido nesta versão.
SCIBIDS Provedor de serviços de ciência de dados terceirizado com que os parceiros/anunciantes do DV3 podem fazer parceria.
ADELAIDE Provedor de serviços de medição de atenção de terceiros com que os parceiros/anunciantes do DV3 podem fazer parcerias.

Métodos

create

 Cria um novo algoritmo de lances personalizados.

get

 Recebe um algoritmo de lances personalizados.

list

 Lista os algoritmos de lances personalizados que estão acessíveis ao usuário atual e podem ser usados em estratégias de lances.

patch

 Atualiza um algoritmo de lances personalizados existente.

uploadRules

 Cria um objeto de referência de regras para um arquivo AlgorithmRules.

uploadScript

 Cria um objeto de referência de script de lances personalizados para um arquivo de script.