REST Resource: customBiddingAlgorithms

Risorsa: CustomBiddingAlgorithm

Un unico algoritmo di offerte personalizzate.

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

string

Solo output. Il nome della risorsa dell'algoritmo di offerta personalizzata.
customBiddingAlgorithmId

string (int64 format)

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

string

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

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
entityStatus

enum (EntityStatus)

Controlla se l'algoritmo delle 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 delle offerte personalizzate.
sharedAdvertiserIds[]

string (int64 format)

Gli ID degli inserzionisti che hanno accesso a questo algoritmo. Se advertiserId è impostato, questo campo sarà composto 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 per cui è stata eseguita la query solo se l'algoritmo owner è un partner e viene recuperato utilizzando un inserzionista accessor.
Campo unione owner. Identifica l'entità DV360 proprietaria dell'algoritmo delle offerte personalizzate. Può essere un partner o un inserzionista. owner può essere solo uno dei seguenti:
partnerId

string (int64 format)

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

string (int64 format)

Immutabile. L'ID univoco dell'inserzionista proprietario dell'algoritmo delle offerte personalizzate.

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 i file di script di offerte personalizzate caricati dal cliente.
ADS_DATA_HUB_BASED Algoritmo creato tramite il prodotto Ads Data Hub.
GOAL_BUILDER_BASED Algoritmo creato tramite il Generatore di obiettivi nell'interfaccia utente di DV3.
RULE_BASED

Algoritmo basato su regole definite. Queste regole sono 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 per le 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 pubblicazione.
READINESS_STATE_INSUFFICIENT_DATA Non sono disponibili dati sufficienti per addestrare il modello di pubblicazione.
READINESS_STATE_TRAINING Il modello è in fase di addestramento e non è pronto per l'erogazione.
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 è andata a buon fine. Questo vale per gli script che non hanno potuto essere valutati 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 è attivato, utilizzato di recente, in uso o pianificato per l'utilizzo. L'algoritmo assegna attivamente un punteggio alle impressioni per questo inserzionista.
SUSPENSION_STATE_DORMANT Il modello non è stato utilizzato di recente. Anche se il modello continua a funzionare come ENABLED, verrà sospeso se non viene utilizzato.
SUSPENSION_STATE_SUSPENDED Il modello è stato 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 viene aggiornato in altro modo, tornerà allo stato ENABLED e sarà necessario del tempo per preparare nuovamente il modello di pubblicazione.

Metodi

create

 Crea un nuovo algoritmo di offerte personalizzate.

get

 Recupera un algoritmo di offerta personalizzata.

list

 Elenca gli algoritmi di offerte personalizzate accessibili all'utente corrente e utilizzabili nelle strategie di offerta.

patch

 Aggiorna un algoritmo di offerte personalizzate esistente.

uploadRules

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

uploadScript

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