REST Resource: customBiddingAlgorithms

Risorsa: CustomBiddingAlgorithm

Un singolo algoritmo di offerte personalizzate.

Rappresentazione 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.
}
Campi
name

string

Solo output. Il nome della risorsa dell'algoritmo di offerte personalizzate.
customBiddingAlgorithmId

string (int64 format)

Solo output. L'ID univoco dell'algoritmo di offerte personalizzate. Assegnato dal sistema.
displayName

string

Obbligatorio. Il nome visualizzato dell'algoritmo di offerte personalizzate.

Deve avere codifica UTF-8 e una dimensione massima di 240 byte.
entityStatus

enum (EntityStatus)

Controlla se l'algoritmo di offerte personalizzate può essere utilizzato o meno come strategia di offerta.

I valori accettati sono:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Obbligatorio. Immutabile. Il tipo di algoritmo di offerte personalizzate.
sharedAdvertiserIds[]

string (int64 format)

Gli ID degli inserzionisti che hanno accesso a questo algoritmo. Se advertiserId è impostato, questo campo sarà costituito solo da quel valore.

Questo campo non verrà impostato se l'algoritmo owner è un partner e viene recuperato utilizzando un inserzionista accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Solo output. I dettagli dei modelli di offerte personalizzate per ogni inserzionista che ha accesso.

Questo campo può includere i dettagli dell'inserzionista oggetto della query solo se l'algoritmo owner è un partner e viene recuperato utilizzando un inserzionista accessor.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Facoltativo. Immutabile. Indica il partner di ottimizzazione di terze parti che gestisce questo algoritmo.
Identifica l'entità DV360 proprietaria dell'algoritmo di offerte personalizzate. Può essere un partner o un inserzionista. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
partnerId

string (int64 format)

Immutabile. L'ID univoco del partner proprietario dell'algoritmo di offerte personalizzate.
advertiserId

string (int64 format)

Immutabile. L'ID univoco dell'inserzionista proprietario dell'algoritmo di offerte personalizzate.
Fine dei campi che si escludono a vicenda.

CustomBiddingAlgorithmType

Possibili tipi di algoritmi di offerte personalizzate.

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Il tipo di algoritmo non è specificato o è sconosciuto in questa versione.
SCRIPT_BASED Algoritmo generato tramite file di script di offerte personalizzate caricati dal cliente.
RULE_BASED

Algoritmo basato su regole definite. Queste regole vengono definite nell'API utilizzando l'oggetto AlgorithmRules.

Questo tipo di algoritmo è disponibile solo per i clienti inclusi nella lista consentita. Gli altri clienti che tentano di utilizzare questo tipo riceveranno un errore.

CustomBiddingModelDetails

I dettagli di un modello di algoritmo di offerte personalizzate per un singolo inserzionista condiviso.

Rappresentazione JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Campi
advertiserId

string (int64 format)

L'ID univoco dell'inserzionista pertinente.
readinessState

enum (ReadinessState)

Lo stato di idoneità del modello di offerte personalizzate.
suspensionState

enum (SuspensionState)

Solo output. Lo stato di sospensione del modello di offerte personalizzate.

ReadinessState

Possibili stati di idoneità del modello.

Enum
READINESS_STATE_UNSPECIFIED Lo stato non è specificato o è sconosciuto in questa versione.
READINESS_STATE_ACTIVE Il modello è addestrato e pronto per la distribuzione.
READINESS_STATE_INSUFFICIENT_DATA I dati non sono sufficienti per addestrare il modello di pubblicazione.
READINESS_STATE_TRAINING Il modello è in fase di addestramento e non è pronto per la pubblicazione.
READINESS_STATE_NO_VALID_SCRIPT Non è stato fornito uno script di offerte personalizzate valido con cui addestrare il modello. Questo stato verrà applicato solo agli algoritmi il cui customBiddingAlgorithmType è SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE È stato fornito uno script valido, ma la valutazione non è riuscita. Questo vale per gli script che non è stato possibile valutare nel tempo assegnato.

SuspensionState

Possibili stati di sospensione dei modelli di offerte personalizzate.

Enum
SUSPENSION_STATE_UNSPECIFIED Lo stato non è specificato o è sconosciuto in questa versione.
SUSPENSION_STATE_ENABLED Il modello è attivo, utilizzato di recente, attualmente in uso o programmato per l'utilizzo. L'algoritmo sta assegnando attivamente un punteggio alle impressioni per questo inserzionista.
SUSPENSION_STATE_DORMANT Il modello non è stato utilizzato di recente. Anche se il modello funge ancora da ENABLED, alla fine verrà sospeso se non viene utilizzato.
SUSPENSION_STATE_SUSPENDED Il modello è sospeso dall'assegnazione del punteggio delle impressioni e non può essere pubblicato. Se l'algoritmo viene assegnato a un elemento pubblicitario di questo inserzionista o aggiornato in altro modo, tornerà allo stato ENABLED e richiederà tempo per preparare nuovamente il modello di pubblicazione.

ThirdPartyOptimizationPartnerType

Possibili tipi di partner di ottimizzazione di terze parti.

Enum
UNKNOWN Il valore del tipo non è specificato o è sconosciuto in questa versione.
SCIBIDS Fornitore di servizi di data science di terze parti con cui i partner/inserzionisti DV3 possono collaborare.
ADELAIDE Fornitore di servizi di misurazione dell'attenzione di terze parti con cui i partner/inserzionisti di DV3 possono collaborare.

Metodi

create

 Crea un nuovo algoritmo di offerte personalizzate.

get

 Recupera un algoritmo di offerte personalizzate.

list

 Elenca gli algoritmi di offerte personalizzate accessibili all'utente corrente e che possono essere utilizzati nelle strategie di offerta.

patch

 Aggiorna un algoritmo di offerte personalizzate esistente.

uploadRules

 Crea un oggetto di riferimento delle regole per un file AlgorithmRules.

uploadScript

 Crea un oggetto di riferimento dello script di offerte personalizzate per un file di script.